From 78b202b485606019be5f52a3d7e6988a3685d4e4 Mon Sep 17 00:00:00 2001 From: zengyawen Date: Mon, 14 Mar 2022 20:30:30 +0800 Subject: [PATCH] update docs Signed-off-by: zengyawen --- en/application-dev/Readme-EN.md | 51 +- en/application-dev/device/Readme-EN.md | 9 + .../device/device-location-geocoding.md | 60 + .../device/device-location-info.md | 187 + .../device/device-location-overview.md | 39 + .../figures/en-us_image_0000001237821727.png | Bin .../public_sys-resources/icon-caution.gif | Bin .../public_sys-resources/icon-danger.gif | Bin .../public_sys-resources/icon-note.gif | Bin .../public_sys-resources/icon-notice.gif | Bin .../public_sys-resources/icon-tip.gif | Bin .../public_sys-resources/icon-warning.gif | Bin .../{usb => device}/usb-guidelines.md | 0 .../{usb => device}/usb-overview.md | 0 .../quick-start/installing-openharmony-app.md | 1 - .../reference/apis/Readme-EN.md | 2 + .../apis/js-apis-distributed-data.md | 120 +- .../reference/apis/js-apis-geolocation.md | 1119 +++++ .../reference/apis/js-apis-rpc.md | 3818 +++++++++++++++++ .../reference/arkui-js/Readme-EN.md | 2 +- .../reference/arkui-ts/figures/Column.png | Bin 0 -> 17074 bytes en/application-dev/ui/ts-types.md | 4 +- en/application-dev/usb/Readme-EN.md | 4 - zh-cn/application-dev/Readme-CN.md | 10 +- .../background-task-dev-guide.md | 12 +- .../device-usage-statistics/Readme-CN.md | 5 +- zh-cn/application-dev/device/Readme-CN.md | 9 + .../device/device-location-geocoding.md | 60 + .../device/device-location-info.md | 187 + .../device/device-location-overview.md | 39 + .../figures/zh-cn_image_0000001237821727.png | Bin .../public_sys-resources/icon-caution.gif | Bin .../public_sys-resources/icon-danger.gif | Bin .../public_sys-resources/icon-note.gif | Bin .../public_sys-resources/icon-notice.gif | Bin .../public_sys-resources/icon-tip.gif | Bin .../public_sys-resources/icon-warning.gif | Bin .../{usb => device}/usb-guidelines.md | 0 .../{usb => device}/usb-overview.md | 0 .../reference/apis/Readme-CN.md | 2 + .../apis/js-apis-abilityrunninginfo.md | 16 +- .../reference/apis/js-apis-camera.md | 2 +- .../apis/js-apis-distributed-data.md | 134 +- .../apis/js-apis-extensionrunninginfo.md | 18 +- .../reference/apis/js-apis-geolocation.md | 1119 +++++ .../reference/apis/js-apis-media.md | 2 +- .../reference/apis/js-apis-rpc.md | 3818 +++++++++++++++++ .../figures/zh-cn_image_0000001188551432.png | Bin 11318 -> 0 bytes .../figures/zh-cn_image_0000001188711340.png | Bin 25553 -> 0 bytes ...ponents-canvas-canvasrenderingcontext2d.md | 2 +- zh-cn/application-dev/usb/Readme-CN.md | 4 - 51 files changed, 10664 insertions(+), 191 deletions(-) create mode 100644 en/application-dev/device/Readme-EN.md create mode 100644 en/application-dev/device/device-location-geocoding.md create mode 100644 en/application-dev/device/device-location-info.md create mode 100644 en/application-dev/device/device-location-overview.md rename en/application-dev/{usb => device}/figures/en-us_image_0000001237821727.png (100%) rename en/application-dev/{usb => device}/public_sys-resources/icon-caution.gif (100%) rename en/application-dev/{usb => device}/public_sys-resources/icon-danger.gif (100%) rename en/application-dev/{usb => device}/public_sys-resources/icon-note.gif (100%) rename en/application-dev/{usb => device}/public_sys-resources/icon-notice.gif (100%) rename en/application-dev/{usb => device}/public_sys-resources/icon-tip.gif (100%) rename en/application-dev/{usb => device}/public_sys-resources/icon-warning.gif (100%) rename en/application-dev/{usb => device}/usb-guidelines.md (100%) rename en/application-dev/{usb => device}/usb-overview.md (100%) create mode 100644 en/application-dev/reference/apis/js-apis-geolocation.md create mode 100644 en/application-dev/reference/apis/js-apis-rpc.md create mode 100644 en/application-dev/reference/arkui-ts/figures/Column.png delete mode 100644 en/application-dev/usb/Readme-EN.md create mode 100644 zh-cn/application-dev/device/Readme-CN.md create mode 100644 zh-cn/application-dev/device/device-location-geocoding.md create mode 100644 zh-cn/application-dev/device/device-location-info.md create mode 100644 zh-cn/application-dev/device/device-location-overview.md rename zh-cn/application-dev/{usb => device}/figures/zh-cn_image_0000001237821727.png (100%) rename zh-cn/application-dev/{usb => device}/public_sys-resources/icon-caution.gif (100%) rename zh-cn/application-dev/{usb => device}/public_sys-resources/icon-danger.gif (100%) rename zh-cn/application-dev/{usb => device}/public_sys-resources/icon-note.gif (100%) rename zh-cn/application-dev/{usb => device}/public_sys-resources/icon-notice.gif (100%) rename zh-cn/application-dev/{usb => device}/public_sys-resources/icon-tip.gif (100%) rename zh-cn/application-dev/{usb => device}/public_sys-resources/icon-warning.gif (100%) rename zh-cn/application-dev/{usb => device}/usb-guidelines.md (100%) rename zh-cn/application-dev/{usb => device}/usb-overview.md (100%) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-geolocation.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-rpc.md delete mode 100644 zh-cn/application-dev/reference/arkui-js/figures/zh-cn_image_0000001188551432.png delete mode 100644 zh-cn/application-dev/reference/arkui-js/figures/zh-cn_image_0000001188711340.png delete mode 100644 zh-cn/application-dev/usb/Readme-CN.md diff --git a/en/application-dev/Readme-EN.md b/en/application-dev/Readme-EN.md index dd682c80aa..8d1b735cba 100644 --- a/en/application-dev/Readme-EN.md +++ b/en/application-dev/Readme-EN.md @@ -1,22 +1,35 @@ # Application Development -- [Application Development Overview](application-dev-guide.md) -- [DevEco Studio \(OpenHarmony\) User Guide](quick-start/deveco-studio-user-guide-for-openharmony.md) -- [Directory Structure](quick-start/package-structure.md) -- [ArkUI](ui/ui-arkui.md) - - [JavaScript-based Web-like Development Paradigm](ui/ui-arkui-js.md) +[Application Development Overview](application-dev-guide.md) - - [TypeScript-based Declarative Development Paradigm](ui/ui-arkui-ts.md) -- [Agent-Powered Scheduled Reminders ](background-agent-scheduled-reminder/Readme-EN.md) -- [Background Task Management ](background-task-management/Readme-EN.md) -- [Media](media/Readme-EN.md) -- [Security](security/Readme-EN.md) -- [Connectivity](connectivity/Readme-EN.md) -- [Data Management](database/Readme-EN.md) -- [USB Service](usb/Readme-EN.md) -- [DFX](dfx/Readme-EN.md) -- [WebGL](webgl/Readme-EN.md) -- [Development References](reference/Readme-EN.md) - - [JavaScript-based Web-like Development Paradigm](reference/arkui-js/Readme-EN.md) - - [TypeScript-based Declarative Development Paradigm](reference/arkui-ts/Readme-EN.md) - - [APIs](reference/apis/Readme-EN.md) +- Learn About the OpenHarmony Community + - [OpenHarmony Community](../OpenHarmony-Overview.md) + - [OpenHarmony OS](../readme) + - [Glossary ](../device-dev/glossary/glossary.md) + - [OpenHarmony Release Notes](../release-notes/Readme.md) +- Quick Start + - [Getting Started with Application Development](quick-start/Readme-EN.md) + - [Directory Structure](quick-start/package-structure.md) + +- Development + - [ArkUI](ui/Readme-EN.md) + - Basic Functions + - [Agent-Powered Scheduled Reminders ](background-agent-scheduled-reminder/Readme-EN.md) + - [Background Task Management ](background-task-management/Readme-EN.md) + - [WebGL](webgl/Readme-EN.md) + - [Media](media/Readme-EN.md) + - [Security](security/Readme-EN.md) + - [Connectivity](connectivity/Readme-EN.md) + - [Data Management](database/Readme-EN.md) + - [Device](device/Readme-EN.md) + - [DFX](dfx/Readme-EN.md) +- Tools + - [DevEco Studio \(OpenHarmony\) User Guide](quick-start/deveco-studio-user-guide-for-openharmony.md) +- Hands-On Tutorials + - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) +- API References + - [Compent Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md) + - [Compent Reference (TypeScript-based Declarative Development Paradigm)](reference/arkui-ts/Readme-EN.md) + - [APIs](reference/apis/Readme-EN.md) +- Contribution + - [How to Contribute](../contribute/documentation-contribution.md) diff --git a/en/application-dev/device/Readme-EN.md b/en/application-dev/device/Readme-EN.md new file mode 100644 index 0000000000..db4a15e18c --- /dev/null +++ b/en/application-dev/device/Readme-EN.md @@ -0,0 +1,9 @@ +# Device + +- USB Service + - [USB Service Overview](usb-overview.md) + - [USB Service Development](usb-guidelines.md) +- Location + - [Location Overview](device-location-overview.md) + - [Obtaining Device Location Information](device-location-info.md) + - [Geocoding and Reverse Geocoding Capabilities](device-location-geocoding.md) diff --git a/en/application-dev/device/device-location-geocoding.md b/en/application-dev/device/device-location-geocoding.md new file mode 100644 index 0000000000..cfb2504ff3 --- /dev/null +++ b/en/application-dev/device/device-location-geocoding.md @@ -0,0 +1,60 @@ +# Geocoding and Reverse Geocoding Capabilities + + +## When to Use + +Describing a location using coordinates is accurate, but neither intuitive nor user-friendly. + +With the geocoding and reverse geocoding capabilities, you will be able to convert geographic description into specific coordinates and vice versa. The geocoding information describes a location using several attributes, including the country, administrative region, street, house number, and address, etc. + + +## Available APIs + +The following table describes APIs available for mutual conversion between coordinates and location information. + + **Table1** APIs for geocoding and reverse geocoding + +| API | Description | +| -------- | -------- | +| isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void | Checks whether the (reverse) geocoding service is available. This function uses an asynchronous callback to return the result. | +| isGeoServiceAvailable() : Promise<boolean> | Checks whether the (reverse) geocoding service is available. This function uses a promise to return the result. | +| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | Converts coordinates into geographic description through reverse geocoding. This function uses an asynchronous callback to return the result. | +| getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>>; | Converts coordinates into geographic description through reverse geocoding. This function uses a promise to return the result. | +| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | Converts geographic description into coordinates through geocoding. This function uses an asynchronous callback to return the result. | +| getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> | Converts geographic description into coordinates through geocoding. This function uses a promise to return the result. | + + +## How to Develop + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **Note：** +> The **GeoConvert** instance needs to access backend services to obtain information. Therefore, before performing the following steps, ensure that your device is connected to the network. + +1. Import the **geolocation** module by which you can implement all APIs related to the geocoding and reverse geocoding conversion capabilities. + + ``` + import geolocation from '@ohos.geolocation'; + ``` + +2. Obtain the conversion result. + - Call **getAddressesFromLocation** to convert coordinates into geographical location information. + + ``` + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geolocation.getAddressesFromLocation(reverseGeocodeRequest, (data) => { + console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + }); + ``` + + Your application can obtain the **GeoAddress** list that matches the specified coordinates and then read location information from it. For details, see the _API Reference_. + - Call **getAddressesFromLocationName** to convert geographic description into coordinates. + + ``` + var geocodeRequest = {"description": "No. xx, xx Road, Pudong District, Shanghai", "maxItems": 1}; + geolocation.getAddressesFromLocationName(geocodeRequest, (data) => { + console.log('getAddressesFromLocationName: ' + JSON.stringify(data)); + }); + ``` + + Your application can obtain the **GeoAddress** list that matches the specified location information and read coordinates from it. For details, see the _API Reference_. + + To improve the accuracy of location results, you can set the longitude and latitude ranges in **GeoCodeRequest**. diff --git a/en/application-dev/device/device-location-info.md b/en/application-dev/device/device-location-info.md new file mode 100644 index 0000000000..6c1fa0e7dc --- /dev/null +++ b/en/application-dev/device/device-location-info.md @@ -0,0 +1,187 @@ +# Obtaining Device Location Information + + +## When to Use + +You can call location-related APIs in OpenHarmony to obtain the real-time location or last known location of a mobile device. + +Real-time location of the device is recommended for location-sensitive services. If you want to lower power consumption when the real-time location of the device is not needed, you may consider obtaining the last known location of the device. + + +## Available APIs + +The following table describes APIs available for obtaining device location information. + + **Table1** APIs for obtaining device location information + +| API | Description | +| -------- | -------- | +| on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>) : void | Registers a listener for location changes with a location request initiated. | +| off(type: 'locationChange', callback?: Callback<Location>) : void | Unregisters the listener for location changes with the corresponding location request deleted. | +| on(type: 'locationServiceState', callback: Callback<boolean>) : void | Registers a listener for location service status change events. | +| off(type: 'locationServiceState', callback: Callback<boolean>) : void | Unregisters the listener for location service status change events. | +| on(type: 'cachedGnssLocationsReporting', request: CachedGnssLoactionsRequest, callback: Callback<Array<Location>>) : void; | Registers a listener for cached GNSS location reports. | +| off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>) : void; | Unregisters the listener for cached GNSS location reports. | +| on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : void; | Registers a listener for satellite status change events. | +| off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : void; | Unregisters the listener for satellite status change events. | +| on(type: 'nmeaMessageChange', callback: Callback<string>) : void; | Registers a listener for GNSS NMEA message change events. | +| off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; | Unregisters the listener for GNSS NMEA message change events. | +| on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | Registers a listener for status change events of the specified geofence. | +| off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | Unregisters the listener for status change events of the specified geofence. | +| getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>) : void | Obtains the current location. This function uses an asynchronous callback to return the result. | +| getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> | Obtains the current location. This function uses a promise to return the result. | +| getLastLocation(callback: AsyncCallback<Location>) : void | Obtains the previous location. This function uses an asynchronous callback to return the result. | +| getLastLocation() : Promise<Location> | Obtains the previous location. This function uses a promise to return the result. | +| isLocationEnabled(callback: AsyncCallback<boolean>) : void | Checks whether the location service is enabled. This function uses an asynchronous callback to return the result. | +| isLocationEnabled() : Promise<boolean> | Checks whether the location service is enabled. This function uses a promise to return the result. | +| requestEnableLocation(callback: AsyncCallback<boolean>) : void | Requests to enable the location service. This function uses an asynchronous callback to return the result. | +| requestEnableLocation() : Promise<boolean> | Requests to enable the location service. This function uses a promise to return the result. | +| enableLocation(callback: AsyncCallback<boolean>) : void | Enables the location service. This function uses an asynchronous callback to return the result. | +| enableLocation() : Promise<boolean> | Enables the location service. This function uses a promise to return the result. | +| disableLocation(callback: AsyncCallback<boolean>) : void | Disables the location service. This function uses an asynchronous callback to return the result. | +| disableLocation() : Promise<boolean> | Disables the location service. This function uses a promise to return the result. | +| getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; | Obtains the number of cached GNSS locations. This function uses an asynchronous callback to return the result. | +| getCachedGnssLocationsSize() : Promise<number>; | Obtains the number of cached GNSS locations. This function uses a promise to return the result. | +| flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; | Obtains all cached GNSS locations and clears the GNSS cache queue. This function uses an asynchronous callback to return the result. | +| flushCachedGnssLocations() : Promise<boolean>; | Obtains all cached GNSS locations and clears the GNSS cache queue. This function uses a promise to return the result. | +| sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : void; | Sends extended commands to the location subsystem. This function uses an asynchronous callback to return the result. | +| sendCommand(command: LocationCommand) : Promise<boolean>; | Sends extended commands to the location subsystem. This function uses a promise to return the result. | +| isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>) : void; | Checks whether a user agrees with the privacy statement of the location service. This function uses an asynchronous callback to return the result. | +| isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean>; | Checks whether a user agrees with the privacy statement of the location service. This function uses a promise to return the result. | +| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean, callback: AsyncCallback<boolean>) : void; | Sets the user confirmation status for the privacy statement of the location service. This function uses an asynchronous callback to return the result. | +| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise<boolean>; | Sets the user confirmation status for the privacy statement of the location service. This function uses a promise to return the result. | + + +## How to Develop + +1. Before using basic location capabilities, check whether your application has been granted the permission to access the device location information. If not, your application needs to obtain the permission from the user. For details, see . + The system provides the following location permissions: + - ohos.permission.LOCATION + + - ohos.permission.LOCATION_IN_BACKGROUND + + The **ohos.permission.LOCATION** permission is a must if your application needs to access the device location information. + + If your application needs to access the device location information when running on the background, it must be allowed to run on the background in the configuration file and also granted the **ohos.permission.LOCATION_IN_BACKGROUND** permission. In this way, the system continues to report device location information even when your application moves to the background. + + To allow your application to access device location information, you can declare the required permissions in the **config.json** file of your application. The sample code is as follows: + + + ``` + { + "module": { + "reqPermissions": [{ + "name": "ohos.permission.LOCATION", + "reason": "$string:reason_description", + "usedScene": { + "ability": ["com.myapplication.LocationAbility"], + "when": "inuse" + }, { + ... + } + ] + } + } + ``` + + For details about the fields, see . + +2. Import the **geolocation** module by which you can implement all APIs related to the basic location capabilities. + + ``` + import geolocation from '@ohos.geolocation'; + ``` + +3. Instantiate the **LocationRequest** object. This object provides APIs to notify the system of the location service type and the interval of reporting location information. + **Method 1:** + + To better serve your needs for using APIs, the system has categorized APIs into different packages to match your common use cases of the location function. In this way, you can directly use the APIs specific to a certain use case, making application development much easier. The following table lists the use cases currently supported. + + + ``` + export enum LocationRequestScenario { + UNSET = 0x300, + NAVIGATION, + TRAJECTORY_TRACKING, + CAR_HAILING, + DAILY_LIFE_SERVICE, + NO_POWER, + } + ``` + + + **Table2** Common use cases of the location function + + | Use Case | Constant | Description | + | -------- | -------- | -------- | + | Navigation | NAVIGATION | Applicable when your application needs to obtain the real-time location of a mobile device outdoors, such as navigation for driving or walking. In this scenario, the GNSS positioning technology is mainly used to ensure the location accuracy. However, due to its limitations, the technology may be unable to provide the location service when navigation is just started or when the user moves into a shielded environment such as indoors or a garage. To resolve this issue, the system uses the network positioning technology as an alternative to provide the location service for your application until the GNSS can provide stable location results. This helps achieve a smooth navigation experience for users.
By default, the system reports location results at a minimal interval of 1s. To adopt this use case, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + | Trajectory tracking | TRAJECTORY_TRACKING | Applicable when your application needs to record user trajectories, for example, the track recording function of sports applications. In this scenario, the GNSS positioning technology is mainly used to ensure the location accuracy.
By default, the system reports location results at a minimal interval of 1s. To adopt this use case, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + | Ride hailing | CAR_HAILING | Applicable when your application needs to obtain the current location of a user who is hailing a taxi.
By default, the system reports location results at a minimal interval of 1s. To adopt this use case, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + | Life service | DAILY_LIFE_SERVICE | Applicable when your application only needs the approximate user location for recommendations and push notifications in scenarios such as when the user is browsing news, shopping online, and ordering food.
By default, the system reports location results at a minimal interval of 1s. To adopt this use case, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + | Power efficiency | NO_POWER | Applicable when your application does not proactively start the location service for a higher battery efficiency. When responding to another application requesting the same location service, the system marks a copy of the location result to your application. In this way, your application will not consume extra power for obtaining the user location.
By default, the system reports location results at a minimal interval of 1s. To adopt this use case, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + + The following example instantiates the **RequestParam** object for navigation: + + ``` + var requestInfo = {'scenario': 0x301, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ``` + + **Method 2:** + + If the predefined use cases do not meet your needs, you can also use the basic location priority policies provided by the system. + + + ``` + export enum LocationRequestPriority { + UNSET = 0x200, + ACCURACY, + LOW_POWER, + FIRST_FIX, + } + ``` + + + **Table3** Location priority policies + + | Policy | Constant | Description | + | -------- | -------- | -------- | + | Location accuracy priority | ACCURACY | This policy mainly uses the GNSS positioning technology. In an open area, the technology can achieve the meter-level location accuracy, depending on the hardware performance of the device. However, in a shielded environment, the location accuracy may significantly decrease.
To use this policy, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + | Fast location priority | FAST_FIRST_FIX | This policy uses the GNSS positioning, base station positioning, WLAN positioning, and Bluetooth positioning technologies simultaneously to obtain the device location in both the indoor and outdoor scenarios. When all positioning technologies provide a location result, the system provides the most accurate location result for your application. This policy can lead to significant hardware resource consumption and power consumption.
To use this policy, you must declare the **ohos.permission.LOCATION** permission and obtain users' authorization. | + | Power efficiency priority | LOW_POWER | This policy mainly uses the base station positioning, WLAN positioning, and Bluetooth positioning technologies to obtain device location in both indoor and outdoor scenarios. The location accuracy depends on the distribution of surrounding base stations, visible WLANs, and Bluetooth devices and therefore may fluctuate greatly. This policy is recommended and can reduce power consumption when your application does not require high location accuracy or when base stations, visible WLANs, and Bluetooth devices are densely distributed.
To use this policy, you must declare at least the **ohos.permission.LOCATION** permission and obtain users' authorization. | + + The following example instantiates the **RequestParam** object for the location accuracy priority policy: + + ``` + var requestInfo = {'priority': 0x201, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ``` + +4. Instantiate the **Callback** object for the system to report location results. + Your application needs to implement the callback interface defined by the system. When the system successfully obtains the real-time location of a device, it will report the location result to your application through the callback interface. Your application can implement the callback interface in such a way to complete your own service logic. + + ``` + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + ``` + +5. Start device location. + + ``` + geolocation.on('locationChange', requestInfo, locationChange); + ``` + +6. (Optional) Stop device location. + + ``` + geolocation.off('locationChange', locationChange); + ``` + + If your application does not need the real-time device location, it can use the last known device location cached in the system instead. + + ``` + geolocation.getLastLocation((data) => { + console.log('getLastLocation: data: ' + JSON.stringify(data)); + }); + ``` + + To call this method, your application needs to request the **ohos.permission.LOCATION** permission from the user. diff --git a/en/application-dev/device/device-location-overview.md b/en/application-dev/device/device-location-overview.md new file mode 100644 index 0000000000..99bfb6805d --- /dev/null +++ b/en/application-dev/device/device-location-overview.md @@ -0,0 +1,39 @@ +# Location Overview + + +People take their mobile devices wherever they go. Mobile devices have become a necessity in people's daily routines, whether it be for looking at the weather forecast, browsing news, hailing a taxi, navigating, or recording data from a workout. All these activities are so much associated with the location services on mobile devices. + + +With the location awareness capability offered by , mobile devices will be able to obtain real-time, accurate location data. Building location awareness into your application can also lead to a better contextual experience for application users. + + +Your application can call location-specific APIs to obtain the location information of a mobile device for offering location-based services such as drive navigation and motion track recording. + + +## Basic Concepts + +Location awareness helps determine where a mobile device locates. The system identifies the location of a mobile device with its coordinates, and uses location technologies such as Global Navigation Satellite System (GNSS) and network positioning (for example, base station positioning or WLAN/Bluetooth positioning) to provide diverse location-based services. These advanced location technologies make it possible to obtain the accurate location of the mobile device, regardless of whether it is indoors or outdoors. + +- **Coordinate** + A coordinate describes a location on the earth using the longitude and latitude in reference to the World Geodetic Coordinate System 1984. + +- **GNSS positioning** + GNSS positioning locates a mobile device by using the location algorithm offered by the device chip to compute the location information provided by the Global Navigation Satellite System, for example, GPS, GLONASS, BeiDou, and Galileo. Whichever positioning system will be used during the location process depends on a hardware capability of the device. + +- **Base station positioning** + Base station positioning estimates the current location of a mobile device based on the location of the resident base station in reference to the neighboring base stations. This technology provides only a low accuracy and requires access to the cellular network. + +- **WLAN or Bluetooth positioning** + WLAN or Bluetooth positioning estimates the current location of a mobile device based on the locations of WLANs and Bluetooth devices that can be discovered by the device. The location accuracy of this technology depends on the distribution of fixed WLAN access points (APs) and Bluetooth devices around the device. A high density of WLAN APs and Bluetooth devices can produce a more accurate location result than base station positioning. This technology also requires access to the network. + + +## Working Principles + +Location awareness is offered by the system as a basic service for applications. Depending on the service scenario, an application needs to initiate a location request to the system and stop the location request when the service scenario ends. In this process, the system reports the location information to the application on a real-time basis. + + +## Limitations and Constraints + +Your application can use the location function only after the user has granted the permission and turned on the function. If the location function is off, the system will not provide the location service for any application. + +Since the location information is considered sensitive, your application still needs to obtain the location access permission from the user even if the user has turned on the location function. The system will provide the location service for your application only after it has been granted the permission to access the device location information. diff --git a/en/application-dev/usb/figures/en-us_image_0000001237821727.png b/en/application-dev/device/figures/en-us_image_0000001237821727.png similarity index 100% rename from en/application-dev/usb/figures/en-us_image_0000001237821727.png rename to en/application-dev/device/figures/en-us_image_0000001237821727.png diff --git a/en/application-dev/usb/public_sys-resources/icon-caution.gif b/en/application-dev/device/public_sys-resources/icon-caution.gif similarity index 100% rename from en/application-dev/usb/public_sys-resources/icon-caution.gif rename to en/application-dev/device/public_sys-resources/icon-caution.gif diff --git a/en/application-dev/usb/public_sys-resources/icon-danger.gif b/en/application-dev/device/public_sys-resources/icon-danger.gif similarity index 100% rename from en/application-dev/usb/public_sys-resources/icon-danger.gif rename to en/application-dev/device/public_sys-resources/icon-danger.gif diff --git a/en/application-dev/usb/public_sys-resources/icon-note.gif b/en/application-dev/device/public_sys-resources/icon-note.gif similarity index 100% rename from en/application-dev/usb/public_sys-resources/icon-note.gif rename to en/application-dev/device/public_sys-resources/icon-note.gif diff --git a/en/application-dev/usb/public_sys-resources/icon-notice.gif b/en/application-dev/device/public_sys-resources/icon-notice.gif similarity index 100% rename from en/application-dev/usb/public_sys-resources/icon-notice.gif rename to en/application-dev/device/public_sys-resources/icon-notice.gif diff --git a/en/application-dev/usb/public_sys-resources/icon-tip.gif b/en/application-dev/device/public_sys-resources/icon-tip.gif similarity index 100% rename from en/application-dev/usb/public_sys-resources/icon-tip.gif rename to en/application-dev/device/public_sys-resources/icon-tip.gif diff --git a/en/application-dev/usb/public_sys-resources/icon-warning.gif b/en/application-dev/device/public_sys-resources/icon-warning.gif similarity index 100% rename from en/application-dev/usb/public_sys-resources/icon-warning.gif rename to en/application-dev/device/public_sys-resources/icon-warning.gif diff --git a/en/application-dev/usb/usb-guidelines.md b/en/application-dev/device/usb-guidelines.md similarity index 100% rename from en/application-dev/usb/usb-guidelines.md rename to en/application-dev/device/usb-guidelines.md diff --git a/en/application-dev/usb/usb-overview.md b/en/application-dev/device/usb-overview.md similarity index 100% rename from en/application-dev/usb/usb-overview.md rename to en/application-dev/device/usb-overview.md diff --git a/en/application-dev/quick-start/installing-openharmony-app.md b/en/application-dev/quick-start/installing-openharmony-app.md index 7811ca957e..61640c8636 100644 --- a/en/application-dev/quick-start/installing-openharmony-app.md +++ b/en/application-dev/quick-start/installing-openharmony-app.md @@ -31,4 +31,3 @@ You can install your OpenHarmony app in either of the following methods: For details about how to use hdc and the command format, see [hdc\_std Usage Guidelines](https://gitee.com/openharmony/docs/blob/master/en/device-dev/subsystems/oem_subsys_toolchain_hdc_guide.md). - diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index e762c752f1..283e3e8f0b 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -46,6 +46,7 @@ - Network and Connectivity - [WLAN](js-apis-wifi.md) - [Bluetooth](js-apis-bluetooth.md) + - [RPC](js-apis-rpc.md) - Device Management - [Sensor](js-apis-sensor.md) - [Vibrator](js-apis-vibrator.md) @@ -60,6 +61,7 @@ - [Display](js-apis-display.md) - [Update](js-apis-update.md) - [USB](js-apis-usb.md) + - [Location](js-apis-geolocation.md) - Basic Features - [Application Context](js-apis-basic-features-app-context.md) - [Console Logs](js-apis-basic-features-logs.md) diff --git a/en/application-dev/reference/apis/js-apis-distributed-data.md b/en/application-dev/reference/apis/js-apis-distributed-data.md index eb9d6b4f59..843d49ad0e 100644 --- a/en/application-dev/reference/apis/js-apis-distributed-data.md +++ b/en/application-dev/reference/apis/js-apis-distributed-data.md @@ -1139,7 +1139,7 @@ Resets the **Query** object that contains common query options. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object reset.| +| [Query](#query8) |**Query** object reset.| - Example @@ -1174,7 +1174,7 @@ Creates a **Query** object to match the specified field whose value is equal to | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1207,7 +1207,7 @@ Creates a **Query** object to match the specified field whose value is not equal | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1240,7 +1240,7 @@ Creates a **Query** object to match the specified field whose value is greater t | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1273,7 +1273,7 @@ Creates a **Query** object to match the specified field whose value is less than | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1306,7 +1306,7 @@ Creates a **Query** object to match the specified field whose value is greater t | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1339,7 +1339,7 @@ Creates a **Query** object to match the specified field whose value is less than | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1371,7 +1371,7 @@ Creates a **Query** object to match the specified field whose value is **null**. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1404,7 +1404,7 @@ Creates a **Query** object to match the specified field whose value is within th | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1438,7 +1438,7 @@ Creates a **Query** object to match the specified field whose value is within th | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1471,7 +1471,7 @@ Creates a **Query** object to match the specified field whose value is not withi | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1504,7 +1504,7 @@ Creates a **Query** object to match the specified field whose value is not withi | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1537,7 +1537,7 @@ Creates a **Query** object to match the specified field whose value is similar t | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1570,7 +1570,7 @@ Creates a **Query** object to match the specified field whose value is not simil | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1596,7 +1596,7 @@ Creates a **Query** object with the AND condition. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1624,7 +1624,7 @@ Creates a **Query** object with the OR condition. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1658,7 +1658,7 @@ Creates a **Query** object to sort the query results in ascending order. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1691,7 +1691,7 @@ Creates a **Query** object to sort the query results in descending order. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1726,7 +1726,7 @@ Creates a **Query** object to specify the number of results and where to start. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1759,7 +1759,7 @@ Creates a **Query** object with a specified field that is not null. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1785,7 +1785,7 @@ Creates a **Query** object for a query condition group with a left parenthesis. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1813,7 +1813,7 @@ Creates a **Query** object for a query condition group with a right parenthesis. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1847,7 +1847,7 @@ Creates a **Query** object with a specified key prefix. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1880,7 +1880,7 @@ Creates a **Query** object with an index preferentially used for query. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1914,7 +1914,7 @@ Creates a **Query** object with the device ID as the key prefix. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object created.| +| [Query](#query8) |**Query** object created.| - Example @@ -1939,7 +1939,7 @@ Obtains the query statement of this **Query** object. | Type| Description| | ------ | ------- | -| [Query](#querysup8sup) |**Query** object.| +| [Query](#query8) |**Query** object.| - Example @@ -2122,8 +2122,8 @@ Subscribes to data changes of the specified type. This method uses a synchronous | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | event |'dataChange' | Yes|Type of the events to subscribe to.| -| type |[SubscribeType](#subscribetypea) | Yes|Type of data changes.| -| observer |Callback<[ChangeNotification](#changenotificationa)> | Yes|Callback used to return the result.| +| type |[SubscribeType](#subscribetype) | Yes|Type of data changes.| +| observer |Callback<[ChangeNotification](#changenotification)> | Yes|Callback used to return the result.| - Example @@ -2170,7 +2170,7 @@ Unsubscribes from data change events. This method uses a synchronouscallback to | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | event |'dataChange' | Yes|Type of the events to unsubscribe from.| -| observer |Callback<[ChangeNotification](#changenotificationa)> |No|Callback used to return the result.| +| observer |Callback<[ChangeNotification](#changenotification)> |No|Callback used to return the result.| - Example @@ -2962,7 +2962,7 @@ Obtains the KV pairs that match the specified **Query** object. This method uses | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| | callback |AsyncCallback<Entry[]> | Yes|Callback used to return the KV pairs obtained.| - Example @@ -3011,7 +3011,7 @@ Obtains the KV pairs that match the specified **Query** object. This method uses | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value @@ -3067,7 +3067,7 @@ Obtains the result set with the specified key prefix from this single KV store. | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | keyPrefix |string | Yes|Key prefix to match.| -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)> | Yes|Callback used to return the result set obtained.| +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)> | Yes|Callback used to return the result set obtained.| - Example @@ -3119,7 +3119,7 @@ Obtains the result set with the specified key prefix from this single KV store. | Type| Description| | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)> |Promise used to return the result set obtained.| +|Promise<[KvStoreResultSet](#kvstoreresultset8)> |Promise used to return the result set obtained.| - Example @@ -3172,7 +3172,7 @@ Obtains the **KvStoreResultSet** object that matches the specified **Query** obj | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | query |Query | Yes|**Query** object to match.| -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| - Example @@ -3217,13 +3217,13 @@ Obtains the **KvStoreResultSet** object that matches the specified **Query** obj | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value | Type| Description| | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)> |Promise used to return the **KvStoreResultSet** object obtained.| +|Promise<[KvStoreResultSet](#kvstoreresultset8)> |Promise used to return the **KvStoreResultSet** object obtained.| - Example @@ -3271,7 +3271,7 @@ Closes the **KvStoreResultSet** object obtained by **getResultSet**. This method | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#kvstoreresultsetsup8sup) | Yes|**KvStoreResultSet** object to close.| +| resultSet |[KvStoreResultSet](#kvstoreresultset8) | Yes|**KvStoreResultSet** object to close.| | callback |AsyncCallback<void> | Yes|Callback used to return the execution result.| - Example @@ -3303,7 +3303,7 @@ Closes the **KvStoreResultSet** object obtained by **getResultSet**. This method | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#kvstoreresultsetsup8sup) | Yes|**KvStoreResultSet** object to close.| +| resultSet |[KvStoreResultSet](#kvstoreresultset8) | Yes|**KvStoreResultSet** object to close.| - Return value @@ -3338,7 +3338,7 @@ Obtains the number of results matching the specified **Query** object. This meth | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| | callback |AsyncCallback<number> | Yes|Callback used to return the number of results obtained.| - Example @@ -3382,7 +3382,7 @@ Obtains the number of results matching the specified **Query** object. This meth | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value @@ -3910,7 +3910,7 @@ Obtains the KV pairs matching the specified **Query** object. This method uses a | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| | callback |AsyncCallback<[Entry](#entry)[]> | Yes|Callback used to return the KV pairs obtained.| - Example @@ -3961,7 +3961,7 @@ Obtains the KV pairs matching the specified **Query** object. This method uses a | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value @@ -4018,7 +4018,7 @@ Obtains the KV pairs matching the specified **Query** object for a device. This | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| | callback |AsyncCallback<[Entry](#entry)[]> | Yes|Callback used to return the KV pairs obtained.| - Example @@ -4070,7 +4070,7 @@ Obtains the KV pairs matching the specified **Query** object for a device. This | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value @@ -4129,7 +4129,7 @@ Obtains the **KvStoreResultSet** object that matches the specified key prefix fo | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| | keyPrefix |string | Yes|Key prefix to match.| -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)[]> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| - Example @@ -4167,7 +4167,7 @@ Obtains the **KvStoreResultSet** object that matches the specified key prefix fo | Type| Description| | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise used to return the **KvStoreResultSet** object obtained.| +|Promise<[KvStoreResultSet](#kvstoreresultset8)[]> |Promise used to return the **KvStoreResultSet** object obtained.| - Example @@ -4202,8 +4202,8 @@ Obtains the **KvStoreResultSet** object that matches the specified **Query** obj | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| +| query |[Query](#query8) | Yes|**Query** object to match.| +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)[]> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| - Example @@ -4252,13 +4252,13 @@ Obtains the **KvStoreResultSet** object that matches the specified **Query** obj | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value | Type| Description| | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise used to return the **KvStoreResultSet** object obtained.| +|Promise<[KvStoreResultSet](#kvstoreresultset8)[]> |Promise used to return the **KvStoreResultSet** object obtained.| - Example @@ -4315,8 +4315,8 @@ Obtains the **KvStoreResultSet** object that matches the specified **Query** obj | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| +| query |[Query](#query8) | Yes|**Query** object to match.| +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)[]> | Yes|Callback used to return the **KvStoreResultSet** object obtained.| - Example @@ -4365,13 +4365,13 @@ Obtains the **KvStoreResultSet** object that matches the specified **Query** obj | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value | Type| Description| | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise used to return the **KvStoreResultSet** object obtained.| +|Promise<[KvStoreResultSet](#kvstoreresultset8)[]> |Promise used to return the **KvStoreResultSet** object obtained.| - Example @@ -4428,7 +4428,7 @@ Closes the **KvStoreResultSet** object obtained by **getResultSet**. This method | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#getresultsetsup8sup) | Yes|**KvStoreResultSet** object to close.| +| resultSet |[KvStoreResultSet](#getresultset8) | Yes|**KvStoreResultSet** object to close.| | callback |AsyncCallback<void> | Yes|Callback used to return the result.| - Example @@ -4461,7 +4461,7 @@ Closes the **KvStoreResultSet** object obtained by **getResultSet**. This method | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#getresultsetsup8sup) | Yes|**KvStoreResultSet** object to close.| +| resultSet |[KvStoreResultSet](#getresultset8) | Yes|**KvStoreResultSet** object to close.| - Return value @@ -4497,7 +4497,7 @@ Obtains the number of results that matches the specified **Query** object. This | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| | callback |AsyncCallback<number> | Yes|Callback used to return the number of results obtained.| - Example @@ -4542,7 +4542,7 @@ Obtains the number of results that matches the specified **Query** object. This | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value @@ -4597,7 +4597,7 @@ Obtains the number of results that matches the specified **Query** object for a | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| | callback |AsyncCallback<number> | Yes|Callback used to return the number of results obtained.| - Example @@ -4642,7 +4642,7 @@ Obtains the number of results that matches the specified **Query** object for a | Name| Type| Mandatory| Description| | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes|ID of the target device.| -| query |[Query](#querysup8sup) | Yes|**Query** object to match.| +| query |[Query](#query8) | Yes|**Query** object to match.| - Return value diff --git a/en/application-dev/reference/apis/js-apis-geolocation.md b/en/application-dev/reference/apis/js-apis-geolocation.md new file mode 100644 index 0000000000..2c6fbbdfac --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-geolocation.md @@ -0,0 +1,1119 @@ +# Geolocation - New + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **Note：** +> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. + + +## Modules to Import + + +``` +import geolocation from '@ohos.geolocation'; +``` + + +## Required Permissions + +ohos.permission.LOCATION + +ohos.permission.LOCATION_IN_BACKGROUND + + +## geolocation.on('locationChange') + +on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>) : void + +Registers a listener for location changes with a location request initiated. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **locationChange** indicates a location change event. | + | request | LocationRequest | Yes | Location request. | + | callback | Callback<[Location](#location)> | Yes | Callback used to return the location change event. | + +- Example + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + geolocation.on('locationChange', requestInfo, locationChange); + ``` + + +## geolocation.off('locationChange') + +off(type: 'locationChange', callback?: Callback<Location>) : void + +Unregisters the listener for location changes with the corresponding location request deleted. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **locationChange** indicates a location change event. | + | callback | Callback<[Location](#location)> | No | Callback used to return the location change event. | + +- Example + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + geolocation.on('locationChange', requestInfo, locationChange); + geolocation.off('locationChange', locationChange); + ``` + + +## geolocation.on('locationServiceState') + +on(type: 'locationServiceState', callback: Callback<boolean>) : void + +Registers a listener for location service status change events. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **locationServiceState** indicates a location service status change event. | + | callback | Callback<boolean> | Yes | Callback used to return the location service status change event. | + +- Example + + ``` + var locationServiceState = (state) => { + console.log('locationServiceState: ' + state); + } + geolocation.on('locationServiceState', locationServiceState); + ``` + + +## geolocation.off('locationServiceState') + +off(type: 'locationServiceState', callback?: Callback<boolean>) : void; + +Unregisters the listener for location service status change events. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **locationServiceState** indicates a location service status change event. | + | callback | Callback<boolean> | No | Callback used to return the location service status change event. | + +- Example + + ``` + var locationServiceState = (state) => { + console.log('locationServiceState: state: ' + state); + } + geolocation.on('locationServiceState', locationServiceState); + geolocation.off('locationServiceState', locationServiceState); + ``` + + +## geolocation.on('cachedGnssLocationsReporting') + +on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>) : void; + +Registers a listener for cached GNSS location reports. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **cachedGnssLocationsReporting** indicates reporting of cached GNSS locations. | + | request | CachedGnssLocationsRequest | Yes | Request for reporting cached GNSS location. | + | callback | Callback<boolean> | Yes | Callback used to return cached GNSS locations. | + +- Example + + ``` + var cachedLocationsCb = (locations) => { + console.log('cachedGnssLocationsReporting: locations: ' + locations); + } + var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); + ``` + + +## geolocation.off('cachedGnssLocationsReporting') + +off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>) : void; + +Unregisters the listener for cached GNSS location reports. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **cachedGnssLocationsReporting** indicates reporting of cached GNSS locations. | + | callback | Callback<boolean> | No | Callback used to return cached GNSS locations. | + +- Example + + ``` + var cachedLocationsCb = (locations) => { + console.log('cachedGnssLocationsReporting: locations: ' + locations); + } + var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); + geolocation.off('cachedGnssLocationsReporting'); + ``` + + +## geolocation.on('gnssStatusChange') + +on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : void; + +Registers a listener for GNSS satellite status change events. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **gnssStatusChange** indicates a GNSS satellite status change. | + | callback | Callback<SatelliteStatusInfo> | Yes | Callback used to return GNSS satellite status changes. | + +- Example + + ``` + var gnssStatusCb = (satelliteStatusInfo) => { + console.log('gnssStatusChange: ' + satelliteStatusInfo); + } + geolocation.on('gnssStatusChange', gnssStatusCb); + ``` + + +## geolocation.off('gnssStatusChange') + +off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : void; + +Unregisters the listener for GNSS satellite status change events. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **gnssStatusChange** indicates a GNSS satellite status change. | + | callback | Callback<SatelliteStatusInfo> | No | Callback used to return GNSS satellite status changes. | + +- Example + + ``` + var gnssStatusCb = (satelliteStatusInfo) => { + console.log('gnssStatusChange: ' + satelliteStatusInfo); + } + geolocation.on('gnssStatusChange', gnssStatusCb); + geolocation.off('gnssStatusChange', gnssStatusCb); + ``` + + +## geolocation.on('nmeaMessageChange') + +on(type: 'nmeaMessageChange', callback: Callback<string>) : void; + +Registers a listener for GNSS NMEA message change events. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **nmeaMessageChange** indicates a GNSS NMEA message change. | + | callback | Callback<string> | Yes | Callback used to return GNSS NMEA message changes. | + +- Example + + ``` + var nmeaCb = (str) => { + console.log('nmeaMessageChange: ' + str); + } + geolocation.on('nmeaMessageChange', nmeaCb ); + ``` + + +## geolocation.off('nmeaMessageChange') + +off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; + +Unregisters the listener for GNSS NMEA message change events. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **nmeaMessageChange** indicates a GNSS NMEA message change. | + | callback | Callback<string> | No | Callback used to return GNSS NMEA message changes. | + +- Example + + ``` + var nmeaCb = (str) => { + console.log('nmeaMessageChange: ' + str); + } + geolocation.on('nmeaMessageChange', nmeaCb); + geolocation.off('nmeaMessageChange', nmeaCb); + ``` + + +## geolocation.on('fenceStatusChange') + +on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; + +Registers a listener for status change events of the specified geofence. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **fenceStatusChange** indicates a geofence status change. | + | request | GeofenceRequest | Yes | Geofencing request. | + | want | WantAgent | Yes | **WantAgent** used to return geofence (entrance or exit) events. | + +- Example + + ``` + import WantAgent from '@ohos.wantAgent'; + import { OperationType, WantAgentFlags } from '@ohos.wantagent'; + // WantAgent object + var wantAgent; + // getWantAgent callback + function getWantAgentCallback(err, data) { + console.info("==========================>getWantAgentCallback=======================>"); + if (err.code == 0) { + wantAgent = data; + } else { + console.info('----getWantAgent failed!----'); + } + } + // WantAgentInfo object + var wantAgentInfo = { + wants: [ + { + deviceId: "deviceId", + bundleName: "com.neu.setResultOnAbilityResultTest1", + abilityName: "com.example.test.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true,true,false}", + parameters: + { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "ssssssssssssssssssssssssss", + mykey4: [false, true, false], + mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey6: true, + } + } + ], + operationType: OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] + } + WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) + var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + geolocation.on('fenceStatusChange', requestInfo, wantAgent); + ``` + + +## geolocation.off('fenceStatusChange') + +off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; + +Unregisters the listener for status change events of the specified geofence. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | string | Yes | Event type. The value **fenceStatusChange** indicates a geofence status change. | + | request | GeofenceRequest | Yes | Geofencing request. | + | want | WantAgent | Yes | **WantAgent** used to return geofence (entrance or exit) events. | + +- Example + + ``` + import WantAgent from '@ohos.wantAgent'; + import { OperationType, WantAgentFlags } from '@ohos.wantagent'; + // WantAgent object + var wantAgent; + // getWantAgent callback + function getWantAgentCallback(err, data) { + console.info("==========================>getWantAgentCallback=======================>"); + if (err.code == 0) { + wantAgent = data; + } else { + console.info('----getWantAgent failed!----'); + } + } + // WantAgentInfo object + var wantAgentInfo = { + wants: [ + { + deviceId: "deviceId", + bundleName: "com.neu.setResultOnAbilityResultTest1", + abilityName: "com.example.test.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true,true,false}", + parameters: + { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "ssssssssssssssssssssssssss", + mykey4: [false, true, false], + mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey6: true, + } + } + ], + operationType: OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] + } + WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) + var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + geolocation.on('fenceStatusChange', requestInfo, wantAgent); + geolocation.off('fenceStatusChange', requestInfo, wantAgent); + ``` + + +## geolocation.getCurrentLocation + +getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>) : void + + +Obtains the current location. This method uses an asynchronous callback to return the result. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | request | [CurrentLocationRequest](#currentlocationrequest) | No | Location request. | + | callback | AsyncCallback<[Location](#location)> | Yes | Callback used to return the current location. | + +- Example + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + var locationChange = (err, location) => { + console.log('locationChanger: ' + err + 'data: ' + location); + }; + geolocation.getCurrentLocation(requestInfo, locationChange); + geolocation.getCurrentLocation(locationChange); + ``` + + +## geolocation.getCurrentLocation + +getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> + + +Obtains the current location. This method uses a promise to return the result. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | request | [CurrentLocationRequest](#currentlocationrequest) | No | Location request. | + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<[Location](#location)> | Promise used to return the current location. | + +- Example + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + locationEventListener.getCurrentLocation(requestInfo).then((result) => { + console.log('current location: ' + JSON.stringify(result)); + }); + ``` + + +## geolocation.getLastLocation + +getLastLocation(callback: AsyncCallback<Location>) : void + +Obtains the previous location. This method uses an asynchronous callback to return the result. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[Location](#location)> | Yes | Callback used to return the previous location. | + +- Example + + ``` + geolocation.getLastLocation((err, data) => { + console.log('getLastLocation: ' + err + " data: " + JSON.stringify(data)); + }); + ``` + + +## geolocation.getLastLocation + +getLastLocation() : Promise<Location> + +Obtains the previous location. This method uses a promise to return the result. + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<[Location](#location)> | Promise used to return the previous location. | + +- Example + + ``` + geolocation.getLastLocation().then((result) => { + console.log('getLastLocation: result: ' + JSON.stringify(result)); + }); + ``` + + +## geolocation.isLocationEnabled + +isLocationEnabled(callback: AsyncCallback<boolean>) : void + + +Checks whether the location service is enabled. This method uses an asynchronous callback to return the result. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the location service status. | + +- Example + + ``` + geolocation.isLocationEnabled((err, data) => { + console.log('isLocationEnabled: ' + err + " data: " + data); + }); + ``` + + +## geolocation.isLocationEnabled + +isLocationEnabled() : Promise<boolean> + +Checks whether the location service is enabled. This method uses a promise to return the result. + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Promise used to return the location service status. | + +- Example + + ``` + geolocation.isLocationEnabled().then((result) => { + console.log('promise, isLocationEnabled: ' + result); + }); + ``` + + +## geolocation.requestEnableLocation + +requestEnableLocation(callback: AsyncCallback<boolean>) : void + + +Requests to enable the location service. This method uses an asynchronous callback to return the result. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the location service status. | + +- Example + + ``` + geolocation.requestEnableLocation((err, data) => { + console.log('requestEnableLocation: ' + err + " data: " + data); + }); + ``` + + +## geolocation.requestEnableLocation + +requestEnableLocation() : Promise<boolean> + +Requests to enable the location service. This method uses a promise to return the result. + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Promise used to return the location service status. | + +- Example + + ``` + geolocation.requestEnableLocation().then((result) => { + console.log('promise, requestEnableLocation: ' + result); + }); + ``` + + +## geolocation.isGeoServiceAvailable + +isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void + +Checks whether the (reverse) geocoding service is available. This method uses an asynchronous callback to return the result. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the (reverse) geocoding service status. | + +- Example + + ``` + geolocation.isGeoServiceAvailable((err, data) => { + console.log('isGeoServiceAvailable: ' + err + " data: " + data); + }); + ``` + + +## geolocation.isGeoServiceAvailable + +isGeoServiceAvailable() : Promise<boolean> + +Checks whether the (reverse) geocoding service is available. This method uses a promise to return the result. + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Promise used to return the (reverse) geocoding service status. | + +- Example + + ``` + geolocation.isGeoServiceAvailable().then((result) => { + console.log('promise, isGeoServiceAvailable: ' + result); + }); + ``` + + + +## geolocation.getAddressesFromLocation + +getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void + +Converts coordinates into geographic description through reverse geocoding. This method uses an asynchronous callback to return the result. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | Yes | Reverse geocoding request. | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | Yes | Callback used to return the reverse geocoding result. | + +- Example + + ``` + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { + console.log('getAddressesFromLocation: ' + err + " data: " + JSON.stringify(data)); + }); + ``` + + +## geolocation.getAddressesFromLocation + +getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>>; + +Converts coordinates into geographic description through reverse geocoding. This method uses a promise to return the result. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | Yes | Reverse geocoding request. | + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Promise used to return the reverse geocoding result. | + +- Example + + ``` + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { + console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + }); + ``` + + +## geolocation.getAddressesFromLocationName + +getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void + +Converts geographic description into coordinates through geocoding. This method uses an asynchronous callback to return the result. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | Yes | Geocoding request. | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | Yes | Callback used to return the geocoding result. | + +- Example + + ``` + var geocodeRequest = {"description": "No. xx, xx Road, Pudong District, Shanghai", "maxItems": 1}; + geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { + console.log('getAddressesFromLocationName: ' + err + " data: " + JSON.stringify(data)); + }); + ``` + + +## geolocation.getAddressesFromLocationName + +getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> + +Converts geographic description into coordinates through geocoding. This method uses a promise to return the result. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | Yes | Geocoding request. | + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | Promise used to return the geocoding result. | + +- Example + + ``` + var geocodeRequest = {"description": "No. xx, xx Road, Pudong District, Shanghai", "maxItems": 1}; + geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => { + console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); + }); + ``` + + + +## geolocation.getCachedGnssLocationsSize + +getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; + +Obtains the number of cached GNSS locations. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<number> | Yes | Callback used to return the number of cached GNSS locations. | + +- Example + + ``` + geolocation.getCachedGnssLocationsSize((err, size) => { + console.log('getCachedGnssLocationsSize: err:' + err + " size: " + size); + }); + ``` + + +## geolocation.getCachedGnssLocationsSize + +getCachedGnssLocationsSize() : Promise<number>; + +Obtains the number of cached GNSS locations. + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<number> | Promise used to return the number of cached GNSS locations. | + +- Example + + ``` + geolocation.getCachedGnssLocationsSize().then((result) => { + console.log('promise, getCachedGnssLocationsSize: ' + result); + }); + ``` + + +## geolocation.flushCachedGnssLocations + +flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; + +Obtains all cached GNSS locations and clears the GNSS cache queue. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the operation result. | + +- Example + + ``` + geolocation.flushCachedGnssLocations((err, result) => { + console.log('flushCachedGnssLocations: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.flushCachedGnssLocations + +flushCachedGnssLocations() : Promise<boolean>; + +Obtains all cached GNSS locations and clears the GNSS cache queue. + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Promise used to return the operation result. | + +- Example + + ``` + geolocation.flushCachedGnssLocations().then((result) => { + console.log('promise, flushCachedGnssLocations: ' + result); + }); + ``` + + +## geolocation.sendCommand + +sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : void; + +Sends an extended command to the location subsystem. This function can only be called by system applications. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | command | LocationCommand | Yes | Extended command (string) to be sent. | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the operation result. | + +- Example + + ``` + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + geolocation.sendCommand(requestInfo, (err, result) => { + console.log('sendCommand: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.sendCommand + +sendCommand(command: LocationCommand) : Promise<boolean>; + +Sends extended commands to the location subsystem. This function can only be called by system applications. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | command | LocationCommand | Yes | Extended command (string) to be sent. | + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Callback used to return the operation result. | + +- Example + + ``` + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + geolocation.sendCommand(requestInfo).then((result) => { + console.log('promise, sendCommand: ' + result); + }); + ``` + + +## geolocation.isLocationPrivacyConfirmed + +isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>) : void; + +Checks whether a user agrees with the privacy statement of the location service. This function can only be called by system applications. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | Yes | Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when enabling the location service. | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the result, which indicates whether the user agrees with the privacy statement. | + +- Example + + ``` + geolocation.isLocationPrivacyConfirmed(1, (err, result) => { + console.log('isLocationPrivacyConfirmed: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.isLocationPrivacyConfirmed + +isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean>; + +Checks whether a user agrees with the privacy statement of the location service. This function can only be called by system applications. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | Yes | Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when enabling the location service. | + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Promise used to return the result, which indicates whether the user agrees with the privacy statement. | + +- Example + + ``` + geolocation.isLocationPrivacyConfirmed(1).then((result) => { + console.log('promise, isLocationPrivacyConfirmed: ' + result); + }); + ``` + + +## geolocation.setLocationPrivacyConfirmStatus + +setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback<boolean>) : void; + +Sets the user confirmation status for the privacy statement of the location service. This function can only be called by system applications. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | Yes | Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when enabling the location service. | + | isConfirmed | boolean | Yes | Whether the user agrees with the privacy statement of the location service. | + | callback | AsyncCallback<boolean> | Yes | Callback used to return the operation result. | + +- Example + + ``` + geolocation.setLocationPrivacyConfirmStatus(1, true, (err, result) => { + console.log('isLocationPrivacyConfirmed: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.setLocationPrivacyConfirmStatus + +setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise<boolean>; + +Sets the user confirmation status for the privacy statement of the location service. This function can only be called by system applications. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | Yes | Privacy statement type, for example, privacy statement displayed in the startup wizard or privacy statement displayed when enabling the location service. | + | isConfirmed | boolean | Yes | Whether the user agrees with the privacy statement of the location service. | + +- Return values + | Name | Description | + | -------- | -------- | + | Promise<boolean> | Promise used to return the operation result. | + +- Example + + ``` + geolocation.setLocationPrivacyConfirmStatus(1, true).then((result) => { + console.log('promise, setLocationPrivacyConfirmStatus: ' + result); + }); + ``` + + + +## LocationRequestPriority + +Sets the priority of the location request. + + | Name | Default Value | Description | +| -------- | -------- | -------- | +| UNSET | 0x200 | Priority unspecified. | +| ACCURACY | 0x201 | Location accuracy. | +| LOW_POWER | 0x202 | Power efficiency. | +| FIRST_FIX | 0x203 | Fast location. Use this option if you want to obtain a location as fast as possible. | + + +## LocationRequestScenario + + Sets the scenario of the location request. + | Name | Default Value | Description | +| -------- | -------- | -------- | +| UNSET | 0x300 | Scenario unspecified. | +| NAVIGATION | 0x301 | Navigation. | +| TRAJECTORY_TRACKING | 0x302 | Trajectory tracking. | +| CAR_HAILING | 0x303 | Ride hailing. | +| DAILY_LIFE_SERVICE | 0x304 | Daily life services. | +| NO_POWER | 0x305 | Power efficiency. Your application does not proactively start the location service. When responding to another application requesting the same location service, the system marks a copy of the location result to your application. In this way, your application will not consume extra power for obtaining the user location. | + + +## GeoLocationErrorCode + +Enumerates error codes of the location service. + + | Name | Default Value | Description | +| -------- | -------- | -------- | +| INPUT_PARAMS_ERROR | 101 | Incorrect input parameters. | +| REVERSE_GEOCODE_ERROR | 102 | Failed to call the reverse geocoding API. | +| GEOCODE_ERROR | 103 | Failed to call the geocoding API. | +| LOCATOR_ERROR | 104 | Failed to obtain the location. | +| LOCATION_SWITCH_ERROR | 105 | Failed to change the location service switch. | +| LAST_KNOWN_LOCATION_ERROR | 106 | Failed to obtain the previous location. | +| LOCATION_REQUEST_TIMEOUT_ERROR | 107 | Failed to obtain the location within the specified time. | + + +## ReverseGeoCodeRequest + +Defines a reverse geocoding request. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| locale | string | No | Language used for the location description. **zh** indicates Chinese, and **en** indicates English. | +| latitude | number | Yes | Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. | +| longitude | number | Yes | Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . | +| maxItems | number | No | Maximum number of location records to be returned. | + + +## GeoCodeRequest + +Defines a geocoding request. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| locale | string | No | Language used for the location description. **zh** indicates Chinese, and **en** indicates English. | +| description | number | Yes | Location description, for example, **No. xx, xx Road, Pudong New District, Shanghai**. | +| maxItems | number | No | Maximum number of location records to be returned. | +| minLatitude | number | No | Minimum latitude. This parameter is used with **minLongitude**, **maxLatitude**, and **maxLongitude** to specify the latitude and longitude ranges. | +| minLongitude | number | No | Minimum longitude. | +| maxLatitude | number | No | Maximum latitude. | +| maxLongitude | number | No | Maximum longitude. | + + +## GeoAddress + +Defines a geographic location. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| latitude | number | No | Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. | +| longitude | number | No | Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . | +| locale | string | No | Language used for the location description. **zh** indicates Chinese, and **en** indicates English. | +| placeName | string | No | Landmark of the location. | +| countryCode | string | No | Country code. | +| countryName | string | No | Country name. | +| administrativeArea | string | No | Administrative region name. | +| subAdministrativeArea | string | No | Sub-administrative region name. | +| locality | string | No | Locality information. | +| subLocality | string | No | Sub-locality information. | +| roadName | string | No | Road name. | +| subRoadName | string | No | Auxiliary road information. | +| premises | string | No | House information. | +| postalCode | string | No | Postal code. | +| phoneNumber | string | No | Phone number. | +| addressUrl | string | No | Website URL. | +| descriptions | Array<string> | No | Additional description. | +| descriptionsSize | number | No | Total number of additional descriptions. | + + +## LocationRequest + +Defines a location request. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| priority | [LocationRequestPriority](#locationrequestpriority) | No | Priority of the location request. | +| scenario | [LocationRequestScenario](#locationrequestscenario) | Yes | Scenario of the location request. | +| timeInterval | number | No | Time interval at which location information is reported. | +| distanceInterval | number | No | Distance interval at which location information is reported. | +| maxAccuracy | number | No | Location accuracy. | + + +## CurrentLocationRequest + +Defines the current location request. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| priority | [LocationRequestPriority](#locationrequestpriority) | No | Priority of the location request. | +| scenario | [LocationRequestScenario](#locationrequestscenario) | No | Scenario of the location request. | +| maxAccuracy | number | No | Location accuracy, in meters. | +| timeoutMs | number | No | Timeout duration, in milliseconds. The minimum value is **1000**. | + + +## SatelliteStatusInfo + +Defines the satellite status information. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| satellitesNumber | number | Yes | Number of satellites. | +| satelliteIds | Array<number> | Yes | Array of satellite IDs. | +| carrierToNoiseDensitys | Array<number> | Yes | Carrier-to-noise density ratio, that is, cn0. | +| altitudes | Array<number> | Yes | Altitude information. | +| azimuths | Array<number> | Yes | Azimuth information. | +| carrierFrequencies | Array<number> | Yes | Carrier frequency. | + + +## CachedGnssLocationsRequest + +Represents a request for reporting cached GNSS locations. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| reportingPeriodSec | number | Yes | Interval for reporting the cached GNSS locations, in milliseconds. | +| wakeUpCacheQueueFull | boolean | Yes | **true**: reports the cached GNSS locations to the application when the cache queue is full.
**false**: discards the cached GNSS locations when the cache queue is full. | + + +## Geofence + +Defines a GNSS geofence. Currently, only circular geofences are supported. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| latitude | number | Yes | Latitude information. | +| longitude | number | Yes | Longitude information. | +| radius | number | Yes | Radius of a circular geofence. | +| expiration | number | Yes | Expiration period of a geofence, in milliseconds. | + + +## GeofenceRequest + +Represents a GNSS geofencing request. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| priority | LocationRequestPriority | Yes | Priority of the location information. | +| scenario | LocationRequestScenario | Yes | Location scenario. | +| geofence | Geofence | Yes | Geofence information. | + + +## LocationPrivacyType + +Defines the privacy statement type. + + | Name | Default Value | Description | +| -------- | -------- | -------- | +| OTHERS | 0 | Other scenarios. | +| STARTUP | 1 | Privacy statement displayed in the startup wizard. | +| CORE_LOCATION | 2 | Privacy statement displayed when enabling the location service. | + + +## LocationCommand + +Defines an extended command. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| scenario | LocationRequestScenario | Yes | Location scenario. | +| command | string | Yes | Extended command, in the string format. | + + +## Location + +Defines a location. + + | Name | Type | Mandatory | Description | +| -------- | -------- | -------- | -------- | +| latitude | number | Yes | Latitude information. A positive value indicates north latitude, and a negative value indicates south latitude. | +| longitude | number | Yes | Longitude information. A positive value indicates east longitude , and a negative value indicates west longitude . | +| altitude | number | Yes | Location altitude, in meters. | +| accuracy | number | Yes | Location accuracy, in meters. | +| speed | number | Yes | Speed, in m/s. | +| timeStamp | number | Yes | Location timestamp in the UTC format. | +| direction | number | Yes | Direction information. | +| timeSinceBoot | number | Yes | Location timestamp since boot. | +| additions | Array<string> | No | Additional description. | +| additionSize | number | No | Number of additional descriptions. | diff --git a/en/application-dev/reference/apis/js-apis-rpc.md b/en/application-dev/reference/apis/js-apis-rpc.md new file mode 100644 index 0000000000..8a938bb753 --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-rpc.md @@ -0,0 +1,3818 @@ +# RPC Communication + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **Note：** +> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. + + +## Modules to Import + + +``` +import rpc from '@ohos.rpc'; +``` + + +## Required Permissions + +None + + +## MessageParcel + +Provides methods for reading and writing basic data types and arrays, inter-process communication (IPC) objects, interface tokens, and sequenceable objects. + + +### create + +create(): MessageParcel + +Creates a **MessageParcel** object. This method is a static method. + + +- Return values + | Type | Description | + | -------- | -------- | + | MessageParcel | **MessageParcel** object created. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + console.log("RpcClient: data is " + data); + ``` + + +### reclaim + +reclaim(): void + +Reclaims the **MessageParcel** instance that is no longer used. + + +- Example + + ``` + let reply = rpc.MessageParcel.create(); + reply.reclaim(); + ``` + + +### writeRemoteObject + +writeRemoteObject(object: [IRemoteObject](#iremoteobject)): boolean + + Serializes a remote object and writes it to this **MessageParcel** object. +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | object | [IRemoteObject](#iremoteobject) | Yes | Remote object to serialize and write to the **MessageParcel** object. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let data = rpc.MessageParcel.create(); + let testRemoteObject = new TestRemoteObject("testObject"); + data.writeRemoteObject(testRemoteObject); + ``` + + +### readRemoteObject + +readRemoteObject(): IRemoteObject + +Reads the remote object from this **MessageParcel** object. You can use this method to deserialize the **MessageParcel** object to generate an **IRemoteObject**. The remote objects are read in the order in which they are written to this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | [IRemoteObject](#iremoteobject) | Remote object obtained. | + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let data = rpc.MessageParcel.create(); + let testRemoteObject = new TestRemoteObject("testObject"); + data.writeRemoteObject(testRemoteObject); + let proxy = data.readRemoteObject(); + ``` + + +### writeInterfaceToken + +writeInterfaceToken(token: string): boolean + +Writes an interface token to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | token | string | Yes | Interface token to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeInterfaceToken("aaa"); + console.log("RpcServer: writeInterfaceToken is " + result); + ``` + + +### readInterfaceToken + +readInterfaceToken(): string + +Reads the interface token from this **MessageParcel** object. The interface tokens are read in the order in which they are written into the **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | string | Interface token obtained. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let interfaceToken = data.readInterfaceToken(); + console.log("RpcServer: interfaceToken is " + interfaceToken); + return true; + } + } + ``` + + +### getSize + +getSize(): number + +Obtains the data size of this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Data size obtained, in bytes. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let size = data.getSize(); + console.log("RpcClient: size is " + size); + ``` + + +### getCapacity + +getCapacity(): number + +Obtains the capacity of this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **MessageParcel** capacity obtained, in bytes. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.getCapacity(); + console.log("RpcClient: capacity is " + result); + ``` + + +### setSize + +setSize(size: number): boolean + +Sets the size of data contained in this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | size | number | Yes | Data size to set, in bytes. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let setSize = data.setSize(16); + console.log("RpcClient: setSize is " + setSize); + ``` + + +### setCapacity + +setCapacity(size: number): boolean + +Sets the storage capacity of this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | size | number | Yes | Storage capacity to set, in bytes. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.setCapacity(100); + console.log("RpcClient: setCapacity is " + result); + ``` + + +### getWritableBytes + +getWritableBytes(): number + +Obtains the writable capacity of this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **MessageParcel** writable capacity obtained, in bytes. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let getWritableBytes = data.getWritableBytes(); + console.log("RpcServer: getWritableBytes is " + getWritableBytes); + return true; + } + } + ``` + + +### getReadableBytes + +getReadableBytes(): number + +Obtains the readable capacity of this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **MessageParcel** readable capacity obtained, in bytes. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let result = data.getReadableBytes(); + console.log("RpcServer: getReadableBytes is " + result); + return true; + } + } + ``` + + +### getReadPosition + +getReadPosition(): number + +Obtains the read position of this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Current read position of the **MessageParcel** object. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let readPos = data.getReadPosition(); + console.log("RpcClient: readPos is " + readPos); + ``` + + +### getWritePosition + +getWritePosition(): number + +Obtains the write position of this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Current write position of the **MessageParcel** object. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + data.writeInt(10); + let bwPos = data.getWritePosition(); + console.log("RpcClient: bwPos is " + bwPos); + ``` + + +### rewindRead + +rewindRead(pos: number): boolean + +Moves the read pointer to the specified position. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | pos | number | Yes | Position from which data is to read. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the read position changes; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + data.writeInt(12); + data.writeString("parcel"); + let number = data.readInt(); + console.log("RpcClient: number is " + number); + data.rewindRead(0); + let number2 = data.readInt(); + console.log("RpcClient: rewindRead is " + number2); + ``` + + +### rewindWrite + +rewindWrite(pos: number): boolean + +Moves the write pointer to the specified position. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | pos | number | Yes | Position from which data is to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the write position changes; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + data.writeInt(4); + data.rewindWrite(0); + data.writeInt(5); + let number = data.readInt(); + console.log("RpcClient: rewindWrite is: " + number); + ``` + + +### writeByte + +writeByte(val: number): boolean + +Writes a **Byte** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Byte** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeByte(2); + console.log("RpcClient: writeByte is: " + result); + ``` + + +### readByte + +readByte(): number + +Reads the **Byte** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Byte** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeByte(2); + console.log("RpcClient: writeByte is: " + result); + let ret = data.readByte(); + console.log("RpcClient: readByte is: " + ret); + ``` + + +### writeShort + +writeShort(val: number): boolean + +Writes a **Short int** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Short int** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShort(8); + console.log("RpcClient: writeShort is: " + result); + ``` + + +### readShort + +readShort(): number + +Reads the **Short int** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Short int** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShort(8); + console.log("RpcClient: writeShort is: " + result); + let ret = data.readShort(); + console.log("RpcClient: readShort is: " + ret); + ``` + + +### writeInt + +writeInt(val: number): boolean + +Writes an **Int** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Int** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeInt(10); + console.log("RpcClient: writeInt is " + result); + ``` + + +### readInt + +readInt(): number + +Reads the **Int** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Int** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeInt(10); + console.log("RpcClient: writeInt is " + result); + let ret = data.readInt(); + console.log("RpcClient: readInt is " + ret); + ``` + + +### writeLong + +writeLong(val: number): boolean + +Writes a **Long int** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Long int** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLong(10000); + console.log("RpcClient: writeLong is " + result); + ``` + + +### readLong + +readLong(): number + +Reads the **Long int** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Long int** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLong(10000); + console.log("RpcClient: writeLong is " + result); + let ret = data.readlong(); + console.log("RpcClient: readLong is " + ret); + ``` + + +### writeFloat + +writeFloat(val: number): boolean + +Writes a **Float** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Float** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloat(1.2); + console.log("RpcClient: writeFloat is " + result); + ``` + + +### readFloat + +readFloat(): number + +Reads the **Float** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Float** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloat(1.2); + console.log("RpcClient: writeFloat is " + result); + let ret = data.readFloat(); + console.log("RpcClient: readFloat is " + ret); + ``` + + +### writeDouble + +writeDouble(val: number): boolean + +Writes a **Double** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Double** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDouble(10.2); + console.log("RpcClient: writeDouble is " + result); + ``` + + +### readDouble + +readDouble(): number + +Reads the **Double** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Double** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDouble(10.2); + console.log("RpcClient: writeDouble is " + result); + let ret = data.readDouble(); + console.log("RpcClient: readDouble is " + ret); + ``` + + +### writeBoolean + +writeBoolean(val: boolean): boolean + +Writes a **Boolean** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | boolean | Yes | **Boolean** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBoolean(false); + console.log("RpcClient: writeBoolean is " + result); + ``` + + +### readBoolean + +readBoolean(): boolean + +Reads the **Boolean** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | **Boolean** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBoolean(false); + console.log("RpcClient: writeBoolean is " + result); + let ret = data.readBoolean(); + console.log("RpcClient: readBoolean is " + ret); + ``` + + +### writeChar + +writeChar(val: number): boolean + +Writes a **Char** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | number | Yes | **Char** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeChar('a'); + console.log("RpcClient: writeChar is " + result); + ``` + + +### readChar + +readChar(): number + +Reads the **Char** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | **Char** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeChar('a'); + console.log("RpcClient: writeChar is " + result); + let ret = data.readChar(); + console.log("RpcClient: readChar is " + ret); + ``` + + +### writeString + +writeString(val: string): boolean + +Writes a **String** value to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | string | Yes | **String** value to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeString('abc'); + console.log("RpcClient: writeString is " + result); + ``` + + +### readString + +readString(): string + +Reads the **String** value from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | string | **String** value read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeString('abc'); + console.log("RpcClient: writeString is " + result); + let ret = data.readString(); + console.log("RpcClient: readString is " + ret); + ``` + + +### writeSequenceable + +writeSequenceable(val: Sequenceable): boolean + +Writes a sequenceable object to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | val | [Sequenceable](#sequenceable) | Yes | Sequenceable object to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + ``` + + +### readSequenceable + +readSequenceable(dataIn: Sequenceable) : boolean + +Reads member variables from the **MessageParcel** instance. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | [Sequenceable](#sequenceable) | Yes | Object that reads member variables from the **MessageParcel** instance. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + let ret = new MySequenceable(0, ""); + let result2 = data.readSequenceable(ret); + console.log("RpcClient: writeSequenceable is " + result2); + ``` + + +### writeByteArray + +writeByteArray(byteArray: number[]): boolean + +Writes a **ByteArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | byteArray | number[] | Yes | **ByteArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let result = data.writeByteArray(ByteArrayVar); + console.log("RpcClient: writeByteArray is " + result); + ``` + + +### readByteArray + +readByteArray(dataIn: number[]) : void + +Reads the **ByteArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | Yes | **ByteArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let result = data.writeByteArray(ByteArrayVar); + console.log("RpcClient: writeByteArray is " + result); + let array = new Array(5); + data.readByteArray(array); + ``` + + +### readByteArray + +readByteArray(): number[] + +Reads the **ByteArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | **ByteArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let result = data.writeByteArray(ByteArrayVar); + console.log("RpcClient: writeByteArray is " + result); + let array = data.readByteArray(); + console.log("RpcClient: readByteArray is " + array); + ``` + + +### writeShortArray + +writeShortArray(shortArray: number[]): boolean + +Writes a **ShortArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | shortArray | number[] | Yes | **ShortArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShortArray([11, 12, 13]); + console.log("RpcClient: writeShortArray is " + result); + ``` + + +### readShortArray + +readShortArray(dataIn: number[]) : void + +Reads the **ShortArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | Yes | **ShortArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShortArray([11, 12, 13]); + console.log("RpcClient: writeShortArray is " + result); + let array = new Array(3); + data.readShortArray(array); + ``` + + +### readShortArray + +readShortArray(): number[] + +Reads the **ShortArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | **ShortArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShortArray([11, 12, 13]); + console.log("RpcClient: writeShortArray is " + result); + let array = data.readShortArray(); + console.log("RpcClient: readShortArray is " + array); + ``` + + +### writeIntArray + +writeIntArray(intArray: number[]): boolean + +Writes an **IntArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | intArray | number[] | Yes | **IntArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeIntArray([100, 111, 112]); + console.log("RpcClient: writeIntArray is " + result); + ``` + + +### readIntArray + +readIntArray(dataIn: number[]) : void + +Reads the **IntArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | Yes | **IntArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeIntArray([100, 111, 112]); + console.log("RpcClient: writeIntArray is " + result); + let array = new Array(3); + data.readIntArray(array); + ``` + + +### readIntArray + +readIntArray(): number[] + +Reads the **IntArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | **IntArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeIntArray([100, 111, 112]); + console.log("RpcClient: writeIntArray is " + result); + let array = data.readIntArray(); + console.log("RpcClient: readIntArray is " + array); + ``` + + +### writeLongArray + +writeLongArray(longArray: number[]): boolean + +Writes a **LongArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | longArray | number[] | Yes | **LongArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLongArray([1111, 1112, 1113]); + console.log("RpcClient: writeLongArray is " + result); + ``` + + +### readLongArray + +readLongArray(dataIn: number[]) : void + +Reads the **LongArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | Yes | **LongArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLongArray([1111, 1112, 1113]); + console.log("RpcClient: writeLongArray is " + result); + let array = new Array(3); + data.readLongArray(array); + ``` + + +### readLongArray + +readLongArray(): number[] + +Reads the **LongArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | **LongArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLongArray([1111, 1112, 1113]); + console.log("RpcClient: writeLongArray is " + result); + let array = data.readLongArray(); + console.log("RpcClient: readLongArray is " + array); + ``` + + +### writeFloatArray + +writeFloatArray(floatArray: number[]): boolean + +Writes a **FloatArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | floatArray | number[] | Yes | **FloatArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloatArray([1.2, 1.3, 1.4]); + console.log("RpcClient: writeFloatArray is " + result); + ``` + + +### readFloatArray + +readFloatArray(dataIn: number[]) : void + +Reads the **FloatArray** from this **MessageParcel** object. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | Yes | **FloatArray** to read. | + + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloatArray([1.2, 1.3, 1.4]); + console.log("RpcClient: writeFloatArray is " + result); + let array = new Array(3); + data.readFloatArray(array); + ``` + + +### readFloatArray + +readFloatArray(): number[] + +Reads the **FloatArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | **FloatArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloatArray([1.2, 1.3, 1.4]); + console.log("RpcClient: writeFloatArray is " + result); + let array = data.readFloatArray(); + console.log("RpcClient: readFloatArray is " + array); + ``` + + +### writeDoubleArray + +writeDoubleArray(doubleArray: number[]): boolean + +Writes a **DoubleArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | doubleArray | number[] | Yes | **DoubleArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDoubleArray([11.1, 12.2, 13.3]); + console.log("RpcClient: writeDoubleArray is " + result); + ``` + + +### readDoubleArray + +readDoubleArray(dataIn: number[]) : void + +Reads the **DoubleArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | Yes | **DoubleArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDoubleArray([11.1, 12.2, 13.3]); + console.log("RpcClient: writeDoubleArray is " + result); + let array = new Array(3); + data.readDoubleArray(array); + ``` + + +### readDoubleArray + +readDoubleArray(): number[] + +Reads the **DoubleArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | **DoubleArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDoubleArray([11.1, 12.2, 13.3]); + console.log("RpcClient: writeDoubleArray is " + result); + let array = data.readDoubleArray(); + console.log("RpcClient: readDoubleArray is " + array); + ``` + + +### writeBooleanArray + +writeBooleanArray(booleanArray: boolean[]): boolean + +Writes a **BooleanArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | booleanArray | boolean[] | Yes | **BooleanArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBooleanArray([false, true, false]); + console.log("RpcClient: writeBooleanArray is " + result); + ``` + + +### readBooleanArray + +readBooleanArray(dataIn: boolean[]) : void + +Reads the **BooleanArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | boolean[] | Yes | **BooleanArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBooleanArray([false, true, false]); + console.log("RpcClient: writeBooleanArray is " + result); + let array = new Array(3); + data.readBooleanArray(array); + ``` + + +### readBooleanArray + +readBooleanArray(): boolean[] + +Reads the **BooleanArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean[] | **BooleanArray** read. | + + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBooleanArray([false, true, false]); + console.log("RpcClient: writeBooleanArray is " + result); + let array = data.readBooleanArray(); + console.log("RpcClient: readBooleanArray is " + array); + ``` + + +### writeCharArray + +writeCharArray(charArray: number[]): boolean + +Writes a **CharArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | charArray | number[] | Yes | **CharArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeCharArray(['a', 'b', 'c']); + console.log("RpcClient: writeCharArray is " + result); + ``` + + +### readCharArray + +readCharArray(dataIn: boolean[]) : void + +Reads the **CharArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | boolean[] | Yes | **CharArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeCharArray(['a', 'b', 'c']); + console.log("RpcClient: writeCharArray is " + result); + let array = new Array(3); + data.readCharArray(array); + ``` + + +### readCharArray + +readCharArray(): boolean[] + +Reads the **CharArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean[] | **CharArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeCharArray(['a', 'b', 'c']); + console.log("RpcClient: writeCharArray is " + result); + let array = data.readCharArray(); + console.log("RpcClient: readCharArray is " + array); + ``` + + +### writeStringArray + +writeStringArray(stringArray: string[]): boolean + +Writes a **StringArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | stringArray | string[] | Yes | **StringArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeStringArray(["abc", "def"]); + console.log("RpcClient: writeStringArray is " + result); + ``` + + +### readStringArray + +readStringArray(dataIn: string[]) : void + +Reads the **StringArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | string[] | Yes | **StringArray** to read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeStringArray(["abc", "def"]); + console.log("RpcClient: writeStringArray is " + result); + let array = new Array(2); + data.readStringArray(array); + ``` + + +### readStringArray + +readStringArray(): string[] + +Reads the **StringArray** from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | string[] | **StringArray** read. | + +- Example + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeStringArray(["abc", "def"]); + console.log("RpcClient: writeStringArray is " + result); + let array = data.readStringArray(); + console.log("RpcClient: readStringArray is " + array); + ``` + + +### writeNoException8+ + +writeNoException(): void + +Writes information to this **MessageParcel** object indicating that no exception occurred. + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + onRemoteRequest(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: onRemoteRequest called"); + reply.writeNoException(); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + } + ``` + + +### readException8+ + +readException(): void + +Reads the exception information from this **MessageParcel** object. + + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option) + .then(function(errCode) { + if (errCode === 0) { + console.log("sendRequest got result"); + reply.readException(); + let msg = reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +### writeSequenceableArray + +writeSequenceableArray(sequenceableArray: Sequenceable[]): boolean + +Writes a **SequenceableArray** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | sequenceableArray | Sequenceable[] | Yes | **SequenceableArray** to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let sequenceable2 = new MySequenceable(2, "bbb"); + let sequenceable3 = new MySequenceable(3, "ccc"); + let a = [sequenceable, sequenceable2, sequenceable3]; + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceableArray(a); + console.log("RpcClient: writeSequenceableArray is " + result); + ``` + + +### readSequenceableArray8+ + +readSequenceableArray(sequenceableArray: Sequenceable[]): void + +Reads the specified **SequenceableArray** from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | sequenceableArray | Sequenceable[] | Yes | **SequenceableArray** to read. | + +- Example + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let sequenceable2 = new MySequenceable(2, "bbb"); + let sequenceable3 = new MySequenceable(3, "ccc"); + let a = [sequenceable, sequenceable2, sequenceable3]; + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceableArray(a); + console.log("RpcClient: writeSequenceableArray is " + result); + let b = [new MySequenceable(0, ""), new MySequenceable(0, ""), new MySequenceable(0, "")]; + data.readSequenceableArray(b); + ``` + + +### writeRemoteObjectArray8+ + +writeRemoteObjectArray(objectArray: IRemoteObject[]): boolean + +Writes an array of **IRemoteObject** objects to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | objectArray | IRemoteObject[] | Yes | Array of **IRemoteObject** objects to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the **IRemoteObject** array is successfully written to the **MessageParcel**; returns **false** if the **IRemoteObject** array is null or fails to be written to the **MessageParcel**. | + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")]; + let data = rpc.MessageParcel.create(); + let result = data.writeRemoteObjectArray(a); + console.log("RpcClient: writeRemoteObjectArray is " + result); + ``` + + +### readRemoteObjectArray8+ + +readRemoteObjectArray(objects: IRemoteObject[]): void + +Reads the specified **IRemoteObject** array from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | objects | IRemoteObject[] | Yes | **IRemoteObject** array to read. | + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")]; + let data = rpc.MessageParcel.create(); + let result = data.writeRemoteObjectArray(a); + let b = new Array(3); + data.readRemoteObjectArray(b); + ``` + + +### readRemoteObjectArray8+ + +readRemoteObjectArray(): IRemoteObject[] + +Reads **IRemoteObject** objects from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | IRemoteObject[] | An array of **IRemoteObject** objects obtained. | + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")]; + let data = rpc.MessageParcel.create(); + let result = data.writeRemoteObjectArray(a); + console.log("RpcClient: readRemoteObjectArray is " + result); + let b = data.readRemoteObjectArray(); + console.log("RpcClient: readRemoteObjectArray is " + b); + ``` + + +### closeFileDescriptor8+ + +static closeFileDescriptor(fd: number): void + +Closes the specified file descriptor. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | fd | number | Yes | File descriptor to close. | + +- Example + + ``` + import fileio from '@ohos.fileio'; + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + rpc.MessageParcel.closeFileDescriptor(fd); + ``` + + +### dupFileDescriptor8+ + +static dupFileDescriptor(fd: number) :number + +Duplicates the specified file descriptor. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | fd | number | Yes | File descriptor to duplicate. | + +- Return values + | Type | Description | + | -------- | -------- | + | number | New file descriptor. | + +- Example + + ``` + import fileio from '@ohos.fileio'; + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let newFd = rpc.MessageParcel.dupFileDescriptor(fd); + ``` + + +### containFileDescriptors8+ + +containFileDescriptors(): boolean + +Checks whether this **MessageParcel** object contains a file descriptor. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the **MessageParcel** object contains a file descriptor; returns **false** otherwise. | + +- Example + + ``` + import fileio from '@ohos.fileio'; + let parcel = new rpc.MessageParcel(); + let filePath = "path/to/file"; + let r1 = parcel.containFileDescriptors(); + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let writeResult = parcel.writeFileDescriptor(fd); + console.log("RpcTest: parcel writeFd result is : " + writeResult); + let containFD = parcel.containFileDescriptors(); + console.log("RpcTest: parcel after write fd containFd result is : " + containFD); + ``` + + +### writeFileDescriptor8+ + +writeFileDescriptor(fd: number): boolean + +Writes a file descriptor to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | fd | number | Yes | File descriptor to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + import fileio from '@ohos.fileio'; + let parcel = new rpc.MessageParcel(); + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let writeResult = parcel.writeFileDescriptor(fd); + console.log("RpcTest: parcel writeFd result is : " + writeResult); + ``` + + +### readFileDescriptor8+ + +readFileDescriptor(): number + +Reads a file descriptor from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | File descriptor obtained. | + +- Example + + ``` + import fileio from '@ohos.fileio'; + let parcel = new rpc.MessageParcel(); + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let writeResult = parcel.writeFileDescriptor(fd); + let readFD = parcel.readFileDescriptor(); + console.log("RpcTest: parcel read fd is : " + readFD); + ``` + + +### writeAshmem8+ + +writeAshmem(ashmem: Ashmem): boolean + +Writes an anonymous shared object to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | ashmem | Ashmem | Yes | Anonymous shared object to write. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let parcel = new rpc.MessageParcel(); + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024); + let isWriteSuccess = parcel.writeAshmem(ashmem); + console.log("RpcTest: write ashmem to result is : " + isWriteSuccess); + ``` + + +### readAshmem8+ + +readAshmem(): Ashmem + +Reads the anonymous shared object from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | Ashmem | Anonymous share object obtained. | + +- Example + + ``` + let parcel = new rpc.MessageParcel(); + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024); + let isWriteSuccess = parcel.writeAshmem(ashmem); + console.log("RpcTest: write ashmem to result is : " + isWriteSuccess); + let readAshmem = parcel.readAshmem(); + console.log("RpcTest: read ashmem to result is : " + readAshmem); + ``` + + +### getRawDataCapacity8+ + +getRawDataCapacity(): number + +Obtains the maximum amount of raw data that can be held by this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | 128 MB, which is the maximum amount of raw data that can be held by this **MessageParcel** object. | + +- Example + + ``` + let parcel = new rpc.MessageParcel(); + let result = parcel.getRawDataCapacity(); + console.log("RpcTest: parcel get RawDataCapacity result is : " + result); + ``` + + +### writeRawData8+ + +writeRawData(rawData: number[], size: number): boolean + +Writes raw data to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | rawData | number[] | Yes | Raw data to write. | + | size | number | Yes | Size of the raw data, in bytes. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let parcel = new rpc.MessageParcel(); + let arr = new Int8Array([1, 2, 3, 4, 5]); + let isWriteSuccess = parcel.writeRawData(arr, arr.length); + console.log("RpcTest: parcel write raw data result is : " + isWriteSuccess); + ``` + + +### readRawData8+ + +readRawData(size: number): number[] + +Reads raw data from this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | size | number | Yes | Size of the raw data to read. | + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | Raw data obtained, in bytes. | + +- Example + + ``` + let parcel = new rpc.MessageParcel(); + let arr = new Int8Array([1, 2, 3, 4, 5]); + let isWriteSuccess = parcel.writeRawData(arr, arr.length); + console.log("RpcTest: parcel write raw data result is : " + isWriteSuccess); + let result = parcel.readRawData(5); + console.log("RpcTest: parcel read raw data result is : " + result); + ``` + + +### getDataVersion8+ + +getDataVersion(): number + +Obtains the data format version from this **MessageParcel** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Data format version obtained. | + +- Example + + ``` + let parcel = new rpc.MessageParcel(); + let version = parcel.getDataVersion(); + console.log("RpcTest: parcel get data version is : " + version); + ``` + + +### updateDataVersion8+ + +updateDataVersion(proxy: IRemoteObject): void + +Updates the data format version of the **IRemoteObject** to this **MessageParcel** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | proxy | IRemoteObject | Yes | Remote object that uses this **MessageParcel** object to send the request. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let parcel = new rpc.MessageParcel(); + parcel.updateDataVersion(proxy); + ``` + + +## Sequenceable + +Writes objects of classes to a **MessageParcel** and reads them from the **MessageParcel** during inter-process communication (IPC). + + +### marshalling + +marshalling(dataOut: MessageParcel): boolean + +Marshals this sequenceable object into a **MessageParcel** object. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataOut | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object to which the sequenceable object is to be marshaled. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + let ret = new MySequenceable(0, ""); + let result2 = data.readSequenceable(ret); + console.log("RpcClient: readSequenceable is " + result2); + ``` + + +### unmarshalling + +unmarshalling(dataIn: MessageParcel) : boolean + +Unmarshals this sequenceable object from a **MessageParcel** object. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataIn | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object in which the sequenceable object has been marshaled. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + let ret = new MySequenceable(0, ""); + let result2 = data.readSequenceable(ret); + console.log("RpcClient: readSequenceable is " + result2); + ``` + + +## IRemoteBroker + +Obtains a remote proxy object. + + +### asObject + +asObject(): IRemoteObject + +Obtains a proxy or remote object. This method must be implemented by its derived classes. + +- Return values + | Type | Description | + | -------- | -------- | + | [IRemoteObject](#iremoteobject) | Returns the [RemoteObject](#ashmem8) if the caller is a [RemoteObject](#ashmem8); returns the [IRemoteObject](#iremoteobject), that is, the holder of this **RemoteProxy** object, if the caller is a [RemoteProxy](#remoteproxy) object. | + +- Example + + ``` + class TestAbility extends rpc.RemoteObject { + asObject() { + return this; + } + } + ``` + +- Example + + ``` + class TestProxy { + constructor(remote) { + this.remote = remote; + } + asObject() { + return this.remote; + } + } + ``` + + +## DeathRecipient + +Subscribes to death notifications of a remote object. When the remote object is dead, the local end will receive a notification and [onRemoteDied](#onremotedied) will be called. A remote object is dead when the process holding the object is terminated or the device of the remote object is shut down or restarted. If the local and remote objects belong to different devices, the remote object is dead when the device holding the remote object is detached from the network. + + +### onRemoteDied + +onRemoteDied(): void + +Called to perform subsequent operations when a death notification of the remote object is received. + +- Example + + ``` + class MyDeathRecipient { + onRemoteDied() { + console.log("server is died"); + } + } + ``` + + +## SendRequestResult8+ + +Defines the response to the request. + + | Parameters | Value | Description | +| -------- | -------- | -------- | +| errCode | number | Error code. | +| code | number | Message code. | +| data | MessageParcel | **MessageParcel** object sent to the peer process. | +| reply | MessageParcel | **MessageParcel** object returned by the peer process. | + + +## IRemoteObject + +Provides methods to query or obtain interface descriptors, add or delete death notifications, dump object status to specific files, and send messages. + + +### queryLocalInterface + +queryLocalInterface(descriptor: string): IRemoteBroker + +Obtains the interface. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | descriptor | string | Yes | Interface descriptor. | + +- Return values + | Type | Description | + | -------- | -------- | + | IRemoteBroker | **IRemoteBroker** object bound to the specified interface descriptor. | + + +### sendRequest + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<number>7 + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult>8+ + +Sends a **MessageParcel** message to the peer process in synchronous or asynchronous mode. If **options** indicates the asynchronous mode, a promise will be fulfilled immediately and the **reply** message does not contain any content. If **options** indicates the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Message code called by the request, which is determined by the client and server. If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object holding the data to send. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that receives the response. | + | options | [MessageOption](#messageoption) | Yes | Request sending mode, which can be synchronous (default) or asynchronous. | + +- Return values + | Type | Description | + | -------- | -------- | + | Promise<number>7
Promise<SendRequestResult>8+ | Promise used to return the result. The value **0** will be returned if the request is sent successfully. Otherwise, an error code will be returned. 7
Promise used to return the **sendRequestResult** instance. 8+ | + + +### sendRequest8+ + +sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void + +Sends a **MessageParcel** message to the peer process in synchronous or asynchronous mode. If **options** indicates the asynchronous mode, a callback will be invoked immediately and the **reply** message does not contain any content. If **options** indicates the synchronous mode, a callback will be invoked when the response to **sendRequest** is returned, and the **reply** message contains the returned information. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Message code called by the request, which is determined by the client and server. If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object holding the data to send. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that receives the response. | + | options | [MessageOption](#messageoption) | Yes | Request sending mode, which can be synchronous (default) or asynchronous. | + | callback | AsyncCallback<SendRequestResult> | Yes | Callback for receiving the sending result. | + + +### addDeathrecipient + +addDeathRecipient(recipient: DeathRecipient, flags: number): boolean + +Adds a callback for receiving death notifications of the remote object. This method is called if the remote object process matching the **RemoteProxy** object is killed. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | Yes | Callback to add. | + | flags | number | Yes | Flag of the death notification. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the callback is added successfully; returns **false** otherwise. | + + +### removeDeathRecipient + +removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean + +Removes the callback used to receive death notifications of the remote object. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | Yes | Callback to remove. | + | flags | number | Yes | Flag of the death notification. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the callback is removed successfully; returns **false** otherwise. | + + +### getInterfaceDescriptor + +getInterfaceDescriptor(): string + +Obtains the interface descriptor of the object. The interface descriptor is a string. + +- Return values + | Type | Description | + | -------- | -------- | + | string | Interface descriptor obtained. | + + +### isObjectDead + +isObjectDead(): boolean + +Checks whether the current object is dead. + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the object is dead; returns **false** otherwise. | + + +## RemoteProxy + +Provides methods to implement **IRemoteObject**. + + +### sendRequest + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<number>7 + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult>8+ + +Sends a **MessageParcel** message to the peer process in synchronous or asynchronous mode. If **options** indicates the asynchronous mode, a promise will be fulfilled immediately and the **reply** message does not contain any content. If **options** indicates the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Message code called by the request, which is determined by the client and server. If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object holding the data to send. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that receives the response. | + | options | [MessageOption](#messageoption) | Yes | Request sending mode, which can be synchronous (default) or asynchronous. | + +- Return values + | Type | Description | + | -------- | -------- | + | Promise<number>7
Promise<SendRequestResult>8+ | Promise used to return the result. The value **0** will be returned if the request is sent successfully. Otherwise, an error code will be returned. 7
Promise used to return the **sendRequestResult** instance. 8+ | + +- Example7 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option) + .then(function(errCode) { + if (errCode === 0) { + console.log("sendRequest got result"); + let msg = reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + +- Example8+ + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option) + .then(function(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +### sendRequest8+ + +sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void + +Sends a **MessageParcel** message to the peer process in synchronous or asynchronous mode. If **options** indicates the asynchronous mode, a callback will be invoked immediately and the **reply** message does not contain any content. If **options** indicates the synchronous mode, a callback will be invoked when the response to **sendRequest** is returned, and the **reply** message contains the returned information. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Message code called by the request, which is determined by the client and server. If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object holding the data to send. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that receives the response. | + | options | [MessageOption](#messageoption) | Yes | Request sending mode, which can be synchronous (default) or asynchronous. | + | callback | AsyncCallback<SendRequestResult> | Yes | Callback for receiving the sending result. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + function sendRequestCallback(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + console.log("RPCTest: sendRequest ends, reclaim parcel"); + result.data.reclaim(); + result.reply.reclaim(); + } + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option, sendRequestCallback); + ``` + + +### queryLocalInterface + +queryLocalInterface(interface: string): IRemoteBroker + +Obtains the **LocalInterface** object of an interface descriptor. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | interface | string | Yes | Interface descriptor. | + +- Return values + | Type | Description | + | -------- | -------- | + | IRemoteBroker | Returns **Null** by default, which indicates a proxy interface. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function (elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName":"com.huawei.server", + "abilityName":"com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let broker = proxy.queryLocalInterface("testObject"); + console.log("RpcClient: queryLocalInterface is " + broker); + ``` + + +### addDeathRecippient + +addDeathRecipient(recipient : DeathRecipient, flags : number): boolean + +Adds a callback for receiving the death notifications of the remote object, including the death notifications of the remote proxy. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | Yes | Callback to add. | + | flags | number | Yes | Flag of the death notification. This parameter is reserved. It is set to **0**. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the callback is added successfully; returns **false** otherwise. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + class MyDeathRecipient { + onRemoteDied() { + console.log("server is died"); + } + } + let deathRecipient = new MyDeathRecipient(); + proxy.addDeathRecippient(deathRecipient, 0); + ``` + + +### removeDeathRecipient + +removeDeathRecipient(recipient : DeathRecipient, flags : number): boolean + +Removes the callback used to receive death notifications of the remote object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | Yes | Callback to remove. | + | flags | number | Yes | Flag of the death notification. This parameter is reserved. It is set to **0**. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the callback is removed successfully; returns **false** otherwise. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + class MyDeathRecipient { + onRemoteDied() { + console.log("server is died"); + } + } + let deathRecipient = new MyDeathRecipient(); + proxy.addDeathRecippient(deathRecipient, 0); + proxy.removeDeathRecipient(deathRecipient, 0); + ``` + + +### getInterfaceDescriptor + +getInterfaceDescriptor(): string + +Obtains the interface descriptor of this proxy object. + + +- Return values + | Type | Description | + | -------- | -------- | + | string | Interface descriptor obtained. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let descriptor = proxy.getInterfaceDescriptor(); + console.log("RpcClient: descriptor is " + descriptor); + ``` + + +### isObjectDead + +isObjectDead(): boolean + +Checks whether the **RemoteObject** is dead. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the **RemoteObject** is dead; returns **false** otherwise. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let isDead = proxy.isObjectDead(); + console.log("RpcClient: isObjectDead is " + isDead); + ``` + + +### setDataVersion8+ + +setDataVersion(dataVersion: number): boolean + +Sets the data format version to this **RemoteProxy** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | dataVersion | number | Yes | Data format version to set. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let result = proxy.setDataVersion(1); + console.log("RpcClient: set Data Version is " + result); + ``` + + +## MessageOption + +Provides common message options (flag and wait time). The flag is used to construct the specified **MessageOption** object. + + + | Parameters | Value | Description | +| -------- | -------- | -------- | +| TF_SYNC | 0 | Synchronous call. | +| TF_ASYNC | 1 | Asynchronous call. | +| TF_ACCEPT_FDS | 0x10 | Indication to the [sendRequest](#sendrequest8) API for returning the file descriptor. | +| TF_WAIT_TIME | 8 | Wait time, in seconds. | + + +### constructor + +constructor(syncFlags?: number, waitTime = TF_WAIT_TIME) + +A constructor used to create a **MessageOption** instance. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | syncFlags | number | No | Specifies whether the **SendRequest** is called synchronously (default) or asynchronously. | + | waitTime | number | No | Maximum wait time for an RPC call. The default value is **TF_WAIT_TIME**. | + + +### getFlags + +getFlags(): number + +Obtains the **SendRequest** call flag, which can be synchronous or asynchronous. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Whether the **SendRequest** is called synchronously or asynchronously. | + + +### setFlags + +setFlags(flags: number): void + +Sets the **SendRequest** call flag, which can be synchronous or asynchronous. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | flags | number | Yes | Call flag, which can be synchronous or asynchronous. | + + +### getWaitTime + +getWaitTime(): number + +Obtains the maximum wait time for this RPC call. + +- Return values + | Type | Description | + | -------- | -------- | + | number | Maximum wait time obtained. | + + +### setWaitTime + +setWaitTime(waitTime: number): void + +Sets the maximum wait time for this RPC call. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | waitTime | number | Yes | Maximum wait time to set. | + + +## IPCSkeleton + +Obtains IPC context information, including the UID and PID, local and peer device IDs, and whether the method is invoked on the same device. + + +### getContextObject + +static getContextObject(): IRemoteObject + +Obtains the system capability manager. + + +- Return values + | Type | Description | + | -------- | -------- | + | [IRemoteObject](#iremoteobject) | System capability manager. | + +- Example + + ``` + let samgr = rpc.IPCSkeleton.getContextObject(); + console.log("RpcServer: getContextObject result: " + samgr); + ``` + + +### getCallingPid + +static getCallingPid(): number + +Obtains the PID of the caller. This method is invoked by the **RemoteObject** object in the **onRemoteRequest** method. If this method is not invoked in the IPC context (**onRemoteRequest**), the PID of the process will be returned. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | PID of the caller. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callerPid = rpc.IPCSkeleton.getCallingPid(); + console.log("RpcServer: getCallingPid result: " + callerPid); + return true; + } + } + ``` + + +### getCallingUid + +static getCallingUid(): number + +Obtains the UID of the caller. This method is invoked by the **RemoteObject** object in the **onRemoteRequest** method. If this method is not invoked in the IPC context (**onRemoteRequest**), the UID of the process will be returned. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | UID of the caller. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callerUid = rpc.IPCSkeleton.getCallingUid(); + console.log("RpcServer: getCallingUid result: " + callerUid); + return true; + } + } + ``` + + +### getCalligDeviceID + +static getCallingDeviceID(): string + +Obtains the ID of the device hosting the caller's process. + + +- Return values + | Type | Description | + | -------- | -------- | + | string | Device ID obtained. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callerDeviceID = rpc.IPCSkeleton.getCalligDeviceID(); + console.log("RpcServer: callerDeviceID is: " + callerDeviceID); + return true; + } + } + ``` + + +### getLocalDeviceID + +static getLocalDeviceID(): string + +Obtains the local device ID. + + +- Return values + | Type | Description | + | -------- | -------- | + | string | Local device ID obtained. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let localDeviceID = rpc.IPCSkeleton.getLocalDeviceID(); + console.log("RpcServer: localDeviceID is: " + localDeviceID); + return true; + } + } + ``` + + +### isLocalCalling + +static isLocalCalling(): boolean + +Checks whether the peer process is a process of the local device. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the local and peer processes are on the same device; returns false otherwise. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let isLocalCalling = rpc.IPCSkeleton.isLocalCalling(); + console.log("RpcServer: isLocalCalling is: " + isLocalCalling); + return true; + } + } + ``` + + +### flushCommands + +static flushCommands(object : IRemoteObject): number + +Flushes all suspended commands from the specified **RemoteProxy** to the corresponding **RemoteObject**. It is recommended that this method be called before any time-sensitive operation is performed. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | object | [IRemoteObject](#iremoteobject) | Yes | **RemoteProxy**. | + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Returns **0** if the operation is successful; returns an error code if the input object is null or a **RemoteObject**, or the operation fails. | + +- Example + + ``` + let remoteObject = new rpc.RemoteObject("aaa", 3); + let ret = rpc.IPCSkeleton.flushCommands(remoteObject); + console.log("RpcServer: flushCommands result: " + ret); + ``` + + +### resetCallingIdentity + +static resetCallingIdentity(): string + +Changes the UID and PID of the remote user to the UID and PID of the local user. This method is used in scenarios such as identity authentication. + + +- Return values + | Type | Description | + | -------- | -------- | + | string | String containing the UID and PID of the remote user. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callingIdentity = rpc.IPCSkeleton.resetCallingIdentity(); + console.log("RpcServer: callingIdentity is: " + callingIdentity); + return true; + } + } + ``` + + +### setCallingIdentity + +static setCallingIdentity(identity : string): boolean + +Restores the UID and PID of the remote user. It is usually called when the UID and PID of the remote user are required. The UID and PID of the remote user are returned by **resetCallingIdentity**. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | identity | string | Yes | String containing the remote user UID and PID, which are returned by **resetCallingIdentity**. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callingIdentity = null; + try { + callingIdentity = rpc.IPCSkeleton.resetCallingIdentity(); + console.log("RpcServer: callingIdentity is: " + callingIdentity); + } finally { + let ret = rpc.IPCSkeleton.setCallingIdentity("callingIdentity "); + console.log("RpcServer: setCallingIdentity is: " + ret); + } + return true; + } + } + ``` + + +## RemoteObject + +Provides methods to implement **RemoteObject**. The service provider must inherit from this class. + + +### constructor + +constructor(descriptor: string) + +A constructor used to create a **RemoteObject** instance. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | descriptor | string | Yes | Interface descriptor. | + + +### sendRequest + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<number>7 + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult>8+ + +Sends a **MessageParcel** message to the peer process in synchronous or asynchronous mode. If **options** indicates the asynchronous mode, a promise will be fulfilled immediately and the **reply** message does not contain any content. If **options** indicates the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Message code called by the request, which is determined by the client and server. If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object holding the data to send. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that receives the response. | + | options | [MessageOption](#messageoption) | Yes | Request sending mode, which can be synchronous (default) or asynchronous. | + +- Return values + | Type | Description | + | -------- | -------- | + | Promise<number>7
Promise<SendRequestResult>8+ | Promise used to return the result. The value **0** will be returned if the request is sent successfully. Otherwise, an error code will be returned. 7
Promise used to return the **sendRequestResult** instance. 8+ | + + +- Example7 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + testRemoteObject.sendRequest(1, data, reply, option) + .then(function(errCode) { + if (errCode === 0) { + console.log("sendRequest got result"); + let msg = reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +- Example8+ + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + testRemoteObject.sendRequest(1, data, reply, option) + .then(function(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +### sendRequest8+ + +sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void + +Sends a **MessageParcel** message to the peer process in synchronous or asynchronous mode. If **options** indicates the asynchronous mode, a callback will be invoked immediately and the **reply** message does not contain any content. If **options** indicates the synchronous mode, a callback will be invoked when the response to **sendRequest** is returned, and the **reply** message contains the returned information. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Message code called by the request, which is determined by the client and server. If the method is generated by an IDL tool, the message code is automatically generated by the IDL tool. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object holding the data to send. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that receives the response. | + | options | [MessageOption](#messageoption) | Yes | Request sending mode, which can be synchronous (default) or asynchronous. | + | AsyncCallback | AsyncCallback<SendRequestResult> | Yes | Callback for receiving the sending result. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + function sendRequestCallback(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + console.log("RPCTest: sendRequest ends, reclaim parcel"); + result.data.reclaim(); + result.reply.reclaim(); + } + let testRemoteObject = new TestRemoteObject("testObject"); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + testRemoteObject.sendRequest(1, data, reply, option, sendRequestCallback); + ``` + + +### onRemoteRequest + +onRemoteRequest(code : number, data : MessageParcel, reply: MessageParcel, options : MessageOption): boolean + +Provides a response to **sendRequest()**. The server processes the request and returns a response in this function. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | code | number | Yes | Service request code sent by the peer end. | + | data | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object that holds the parameters called by the client. | + | reply | [MessageParcel](#messageparcel) | Yes | **MessageParcel** object carrying the result. | + | option | [MessageOption](#messageoption) | Yes | Whether the operation is synchronous or asynchronous. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + + onRemoteRequest(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: onRemoteRequest called"); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + } + ``` + + +### getCallingUid + +getCallingUid(): number + +Obtains the UID of the peer process. + +- Return values + | Type | Description | + | -------- | -------- | + | number | UID of the peer process obtained. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + console.log("RpcServer: getCallingUid: " + testRemoteObject.getCallingUid()); + ``` + + +### getCallingPid + +getCallingPid(): number + +Obtains the PID of the peer process. + +- Return values + | Type | Description | + | -------- | -------- | + | number | PID of the peer process obtained. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + console.log("RpcServer: getCallingPid: " + testRemoteObject.getCallingPid()); + ``` + + +### queryLocalInterface + +queryLocalInterface(descriptor: descriptor): IRemoteBroker + +Checks whether the remote object corresponding to the specified interface descriptor exists. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | descriptor | descriptor | Yes | Interface descriptor. | + +- Return values + | Type | Description | + | -------- | -------- | + | IRemoteBroker | Returns the remote object if a match is found; returns **Null** otherwise. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let broker = testRemoteObject.queryLocalInterface("testObject"); + ``` + + +### getInterfaceDescriptor + +getInterfaceDescriptor(): string + +Obtains the interface descriptor. + +- Return values + | Type | Description | + | -------- | -------- | + | string | Interface descriptor obtained. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let descriptor = testRemoteObject.getInterfaceDescriptor(); + console.log("RpcServer: descriptor is: " + descriptor); + ``` + + +### attachLocalInterface + +attachLocalInterface(localInterface: IRemoteBroker, descriptor: string): void + +Binds an interface descriptor to an **IRemoteBroker** object. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | localInterface | IRemoteBroker | Yes | **IRemoteBroker** object. | + | descriptor | string | Yes | Interface descriptor. | + + +- Example + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + ``` + + +## Ashmem8+ + +Provides methods related to anonymous shared memory objects, including creating, closing, mapping, and unmapping an **Ashmem** object, reading data from and writing data to an **Ashmem** object, obtaining the **Ashmem** size, and setting **Ashmem** protection. + +The following table describes the protection types of the mapped memory. + + | Name | Value | Description | +| -------- | -------- | -------- | +| PROT_EXEC | 4 | The mapped memory is executable. | +| PROT_NONE | 0 | The mapped memory is inaccessible. | +| PROT_READ | 1 | The mapped memory is readable. | +| PROT_WRITE | 2 | The mapped memory is writeable. | + + +### createAshmem + +static createAshmem(name: string, size: number): Ashmem + +Creates an **Ashmem** object with the specified name and size. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | name | string | Yes | Name of the **Ashmem** object to create. | + | size | number | Yes | Size (in bytes) of the **Ashmem** object to create. | + +- Return values + | Type | Description | + | -------- | -------- | + | Ashmem | Returns the **Ashmem** object if it is created successfully; returns **null** otherwise. | + + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let size = ashmem.getAshmemSize(); + console.log("RpcTest: get ashemm by createAshmem : " + ashmem + " size is : " + size); + ``` + + +### createAshmemFromExisting + +static createAshmemFromExisting(ashmem: Ashmem): Ashmem + +Creates an **Ashmem** object by copying the file descriptor (FD) of an existing **Ashmem** object. The two **Ashmem** objects point to the same shared memory region. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | ashmem | Ashmem | Yes | Existing **Ashmem** object. | + +- Return values + | Type | Description | + | -------- | -------- | + | Ashmem | **Ashmem** object created. | + + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let ashmem2 = rpc.Ashmem.createAshmemFromExisting(ashmem); + let size = ashmem2.getAshmemSize(); + console.log("RpcTest: get ashemm by createAshmemFromExisting : " + ashmem2 + " size is : " + size); + ``` + + +### closeAshmem + +closeAshmem(): void + +Closes this **Ashmem** object. + + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + ashmem.closeAshmem(); + ``` + + +### unmapAshmem + +unmapAshmem(): void + +Deletes the mappings for the specified address range of this **Ashmem** object. + + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + ashmem.unmapAshmem(); + ``` + + +### getAshmemSize + +getAshmemSize(): number + +Obtains the memory size of this **Ashmem** object. + + +- Return values + | Type | Description | + | -------- | -------- | + | number | Memory size obtained. | + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let size = ashmem.getAshmemSize(); + console.log("RpcTest: get ashmem is " + ashmem + " size is : " + size); + ``` + + +### mapAshmem + +mapAshmem(mapType: number): boolean + +Creates the shared file mapping on the virtual address space of this process. The size of the mapping region is specified by this **Ashmem** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | mapType | number | Yes | Protection level of the memory region to which the shared file is mapped. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let mapReadAndWrite = ashmem.mapAshmem(rpc.Ashmem.PROT_READ | rpc.Ashmem.PROT_WRITE); + console.log("RpcTest: map ashmem result is : " + mapReadAndWrite); + ``` + + +### mapReadAndWriteAshmem + +mapReadAndWriteAshmem(): boolean + +Maps the shared file to the readable and writable virtual address space of the process. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let mapResult = ashmem.mapReadAndWriteAshmem(); + console.log("RpcTest: map ashmem result is : " + mapResult); + ``` + + +### mapReadOnlyAshmem + +mapReadOnlyAshmem(): boolean + +Maps the shared file to the read-only virtual address space of the process. + + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let mapResult = ashmem.mapReadOnlyAshmem(); + console.log("RpcTest: Ashmem mapReadOnlyAshmem result is : " + mapResult); + ``` + + +### setProtection + +setProtection(protectionType: number): boolean + +Sets the protection level of the memory region to which the shared file is mapped. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | protectionType | number | Yes | Protection type to set. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** if the operation is successful; returns **false** otherwise. | + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let result = ashmem.setProtection(rpc.Ashmem.PROT_READ); + console.log("RpcTest: Ashmem setProtection result is : " + result); + ``` + + +### writeToAshmem + +writeToAshmem(buf: number[], size: number, offset: number): boolean + +Writes data to the shared file associated with this **Ashmem** object. + + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | buf | number[] | Yes | Data to write. | + | size | number | Yes | Size of the data to write. | + | offset | number | Yes | Start position of the data to write in the memory region associated with this **Ashmem** object. | + +- Return values + | Type | Description | + | -------- | -------- | + | boolean | Returns **true** is the data is written successfully; returns **false** otherwise. | + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + var ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let writeResult = ashmem.writeToAshmem(ByteArrayVar, 5, 0); + console.log("RpcTest: write to Ashmem result is : " + writeResult); + ``` + + +### readFromAshmem + +readFromAshmem(size: number, offset: number): number[] + +Reads data from the shared file associated with this **Ashmem** object. + +- Parameters + | Name | Type | Mandatory | Description | + | -------- | -------- | -------- | -------- | + | size | number | Yes | Size of the data to read. | + | offset | number | Yes | Start position of the data to read in the memory region associated with this **Ashmem** object. | + +- Return values + | Type | Description | + | -------- | -------- | + | number[] | Data read. | + + +- Example + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + var ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let writeResult = ashmem.writeToAshmem(ByteArrayVar, 5, 0); + console.log("RpcTest: write to Ashmem result is : " + writeResult); + let readResult = ashmem.readFromAshmem(5, 0); + console.log("RpcTest: read to Ashmem result is : " + readResult); + ``` diff --git a/en/application-dev/reference/arkui-js/Readme-EN.md b/en/application-dev/reference/arkui-js/Readme-EN.md index 02a9479f1d..8c0dd7f96e 100644 --- a/en/application-dev/reference/arkui-js/Readme-EN.md +++ b/en/application-dev/reference/arkui-js/Readme-EN.md @@ -7,7 +7,7 @@ - [Universal Events](js-components-common-events.md) - [Universal Methods](js-components-common-methods.md) - [Animation Styles](js-components-common-animation.md) - - [Gradient Styles](reference/arkui-js/js-components-common-gradient.md) + - [Gradient Styles](js-components-common-gradient.md) - [Transition Styles](js-components-common-transition.md) - [Media Query](js-components-common-mediaquery.md) - [Custom Font Styles](js-components-common-customizing-font.md) diff --git a/en/application-dev/reference/arkui-ts/figures/Column.png b/en/application-dev/reference/arkui-ts/figures/Column.png new file mode 100644 index 0000000000000000000000000000000000000000..90bb7a5557e42ccc9b6509f96f54328d7a27eea1 GIT binary patch literal 17074 zcmeIZc{H2d+dmpDEmc)iwbWFEhvKQR6?17(Q`Jy&shLF8)J8=ILun1AXeeqdjff&* ziu9p1$4p2JRW*xQlnB4u^StMr?>g)EuHRZ`t+USiJMZ@o%TDflXW#d=uWRqm=W|^< z*4*?K$0`0(AP|Vd&_K@u1Y$}7fsUbBPXOQijC?5y{9_8VxTOm!>%O!Ad|>v}G0_2m zz9h2myRZPC*&Z6$27*9mnvedNTK$XNKp@>)hI%@dkDaLa-E@b!@SGqYFTM?j*{t41Pd4Q6J+4QQYqX~thc4Go%;jp<(8K(L$M-aM@VL6v ziy)A;cpEbal&1p*fzEO$FoB+VC9#1(dMPp~a6H1dG{qV9Ic26(=4@_xtwbOO&%T|`}-v& ze`tlTj9m|#Nwx6{2wzt1guO+SikjLYi3RkGs$XVoIWLhs zGvi+WaH^^9-t62Q@CyfooP#k{M^wn8}C}U$YP1XdG5EcbZ=yKIZ6{qy zt{@0BqB&*-&SZ;n!m}F!-uENh{W5Uz=F!x?($(M@kNa5*I4<+4ZDYVS$^SC>z^EF+ zYy>tlR#EY+S8I@$;}35ki{Gy8RI!Ri7I1O3NW6o!rN%bWP)_aPJL8@+kC10|4KBA= zbV0P)9@PreDy%zZ!UrlW+8eiKCMyqBu6smWReo?7{3s5%Pxu#oAcc0gyY5Xtc!OGn z?cGu>vsbw`uhEM((6do^vh`&WC#IM}TV8GuEbSuaB2S4%CPA}3XFZmaeBkcg+1a7n z;bpE`7X&K(yxPJ*z}T#{zDaDrUGpM5x~!soI^f8&x_K{+fv43wd2~7UjDl$7S#Ci$ z;HtP<8*tSi=>NM8b9~|{Ehb1ecRISYaoJ5_#(m=hW&JOssI$6lDm??HLW?5mb8Z`W z7MsZ|2gIK$6AzG8pH0CWk}0BewASy>DeZ46M=k+xl%yG}#v0=h)au=xjm)WRuH>aJ z3EWNNSXmRAk2PLI7h(BjJB=XAuM@+EvN2=tV(avJ>Q}gcj?}D|sZYWXb^%$;Hj|0h z{@QW?E0dyEg4_$UoWPSg*%i&Oxw=*we%BkY7)3pz;_;?6X`rm^a5Nc3eLXo2#kuE0E{8=`7%rf0zaTn+gFzXHrqb*MwcU!^M+_17K! zYmPblj+$H3gyx?c+YS4n>(WRL`ACg}Up&_6T6}Gm@_2>X(RexTHdFyvaYy5#+F2PG zY#do=SyvLB-S%zR`a?-ZS-qm4ndUlFbv(IYA2u!oxQE|n4dRu6wWIYuR8p06nBbz) ztB9<*>2UaIk=))P5w@|8vCnV3A3vL1`ToF{TbFfo);1XHq;bv!T^q1%>7d#~3g?pL zftKC0u{WW-b*BwZCsOh#ws_mX;YSd_4J)Vv{hP^k^iPc*Wn+`@Gz+Xo*~;tewt|%d zZzY@M#!|POh-C;3ovIw>;Z1C;tnxFH1$=mPWtX-Q*O@HfT!F!ql1UEX5s!k~J8nSy z>pt?~Y8`Oje70FSqdRB|t&J|niP0R_<2kH|CmbVQ9r=(Mv9PaBS&4%0ui$*sV;^!T z=5!ptfUJ@0v3oFa!lCEa>S4Mh`WOHB9n9z%$}5yRFh+bTVa>K45p!QKwNA0MSwp42LOv`oar`~c8Nz3(_)V|KghXIr zIobCr{75UAa`WwgU7D@O&xoh=gi~cye*IFIFY*`qO5^}y)o;$=vWL55e3vz~(QW|Y z{*+iTUO#4W6rlyE|1HA!pOvLsUK>pG8216@AgzOj#6%25J7&Hd_Jgnrj7y)9$E-r0Yg;y4;g)4$fZ##qg> zVfNd4wLlJv1bzH*xdk4Od7Fa4miGDGQ+Yo+Z5BSTeK!sIrSQP0a}jnG7>b(3!WS%5 zI(6uI8~u4G1EpdPM2t||H)V6jFTA9ODj!BuCgJ^lLqrsI|MJl|S}0rxUbRy;*UQOT z=;5Ic@_a}u)%_=27(E*ocx&9~_)8jE@}PGSCa+8_u?-BU7XzXIKkd_iwH&bdVCazH zYbwGalWL@Da#n^1+W1pVOP0iQu{(M>)9fHuwmwT`ygSRI3RnQzR1)c}p++BcVJ7vt zndzy~usV@O&!6Hm{N8oew{6>nA~x7ax4rA+%x@fx(SNc}i+`~;HfOju{+$sX4q8nz zcz309IaV@zZF;BwPhdOMvYZPG$-FJX1A4Zl{eQzcFM&-^gx~EL2-F8$2faFh1YnWU z{}dMezkch!t{ZpcQ6LcV_M9*zM!ADr7^fEk7bKD5A3>)eCdlLrW&WdC4^ImT@U!i4 z1MrKAy83c{7O>eZ5Kf;y{oBdVEDY?Ur}0)m6*iV}90V%)I1vX63+@CkN%YEh;BCtp zB||>=6vG-~;Y}uxh~QwXx%fL+dny1Av~mApgD5xdl}~IMHeC8bgG-1H)&2x|n}RGz zAEMO7fsKB;Q%Nu_YEI8(bll5XzKW}b31lHs=UGuJHOa1{Hzjb~=f)=7HqxJDJ>n0^ zOmwgO1-ms75M2%51pwLv@mz9j+|1(Q=Pb=|GGCXC)06LqrX6?%EiHdZ(+_LYGBPqM zs;YCXVX`SnB*J8uvcOCnnN^B~sFz;O*?w%cGTuT3Vrs)&5Xfo=iCP zE}kt`WJ{{5CvdKNmtm+!Hia%;8%j&iDJ~}LZ*(qUJl)*Bz1H{2W-g!()%U{H(iRrH zBbNC|je|uAHKRS&9ur?e*COD<1Enyu92>gvVAP}S5F$^qS?%DleeOkIhdV`&v zeMy6d_X$UErV)$fcPC1BcQ^b_v50eh2$AnTRP04$Rl>KA0lcds%#I7F7?Ggwm^^eY z4Q+4XbF05Ez}rE={3@wBS0i^KCc%uw*|qPf$!%S=6KuEW{a==_C9=@`+#-pn*jP3# zxhF>ax^zJS0sF~Bx02}rcpSnb`NQ8HWCNx~{dvyCaU1m>m4w?dRyy6^Xa4=(TQ_kY zUMF4;Y{~WzrMHGWP}2*QWo^ofHOXYXt(h zUph(pRUMfm3wFe!ilb!$cx`fXPgTY>o_Z{mC*3dojr&<#h*VAPt$d+`mZ)DJ^Dr~X zv2MIHj8~(c=oIU=51GB1nVU@dVjz^Es;D@fPw~r@#R^yR@N?q++9C&a`P_27v#O7= z#pqznmJGn;TiSR5K}>Im-AN=!+i2_#SUOrdV^NTmP0#g?i`8G_S9sdBqpXT+K5P4C z!rbzp60EsR7<)T1VK}{Q(7v}aK^dNC~=>vPK4=~%=-#x zGz`PJW4VF%ek4_=W03nPpB7bZRiD8JyMx^^9!z0#HaTx+Q#^lLfo!Vp+&NS|8^!P~ zo`@ap`!fHy8C@%KzTN0WN&S4z~{VVIiu(yk>S+?PGij>86-_YxZMpj zsWFi_ZA7QJ>}D~4v3-MsSc9G+3Veah1@!Cr(Uz0pfUKHy>wmm7OaL)Dh?S5JbE-X$ zLGuX?$kM^3;m@l3bDup-((7z1XNz`U=|og4c5hmDW^I~;uGlwct*$3`Rn1A@u^g-?;VtB6)?4D%7p~cQz&1=Z2J*;7LF!kM1?wHyko1w(i zYrQ@0JHL|$$J+?R;H8&aYuR|~juTg8IPI+YL;k2==N1h=AL_(evpJSCEqA=*8Hb02 zj3?4PQv97o$*;qXTe!iP!4 zvz*jW!lomgGh$1UwtD!xo+fb*TI9JV3kz5fkVE=z^|c}< z6S|Dam6a=t#PGGP=VAq`{os^2SbIT&vB*_`i+%z4ciZ0#7UcFfI|V5mQB`Ju-U7V! z*fZlJ63e6wK4P>W03QSN76fzyxbASV^Dnv2%IqmAdi?w7*Eriz4z`8X<)Eyy;UWqT{oQ!$R0g*oUM8qvoyki;sSeOchjAPE-+8cdKO= zj{l{|WAG}w)6MEoN=`dm7mRakud@~3(eda z=dJ@MozX~*ErvW9Avb6wagaYX?!Kd!*K)qkETk|=sG1rO+`sax3_iROk$_tsP|UX` zZSI^enfyYl^}r}}^r6Pzl+6iThk0XcK$tBu9{ymQ(Z-z20=VPF|FZ7*)w->~y0T95 zULg~m;!Fpo9_zQ0QOjxDX;^4#kW=WgGt{+$srD;&F_q$=kBk+|E>u3dEg}k+=W$FP z^0k)Zph)IC?TQ|2_33r2O?9AL6b*l$3|Tn&!7?bDQyE1=B5zkO7Py+KfJ%DrB5Qh* zWqsVx-kcuw%Zih~KaZ2_sx`1hsaUbllA8vE!ezIL=Gq5|OV72+hsz_bA=-V)LSg97 znj9d*-aus6LR_gG4nG>UTsiq$j56Rg+GtfdzMV$(QDR*{EyI);yHx*xl9MYNC0~52 zOF3WKPxz^@Ei4&a;s`C@!DWhjqX*{YPcYHs|RrfKJU)Sq9f?%cKxv0_^wESHs$ z!?)ejl|$DpE1h$MDp_{!%pXiMmxq^FqnyBb4svvt2IDG*&%k-;(22@q4#e+imEWU1 zqrI4?0`X%wOvSA`S(h>Ntso`?wqebc#W623J_URB?t(Cl*#C)pM{pH8tS)&(*)X%RK+ z@`$NTnm>Zhj@V;|?Xx@oJ|-HTBac{rO`Fe8+#8eG#nl44WF7N=PQ(Ix6xb#qWuzs9 z`hN253lr>AN+fM%CX6_qH@Py{_^uc6JH98W{K^%Apxt?dy``VfF;Ib#C{oJT*OxYI z?{AB?uH2mKp)4*gqLu4BU0nW>bF8bHC?fZkr&sYEcBadRdB2H|AFU0XTW*SCU#f*~ zFYX2W;!2a3m#2LD7U{pUx4nc*1Ag?j3v%9O72p{w?4M74`Sl260G4n3ohQGhsHmu- ztc;bg*;RAG%Eq#`o6+qZ92|Q3lMf$EhmH}*Ty{2>c?SjtoUVXCe+1q_M*b`jYEG50 zdCHaj;ltLZ#Iqw##5bur`E4kzG5dAg@BRG-$A-s!P7#dlZGbmC zXia#+760bVNXgw#!|au(8fHu8^1}Z}wl1_-r=p;_c?V=)%&toC6`$Lbf7lO0$_MgF zxAjj5q<*3-FZdh9pFm{^pe@^Kl}(cr(D|e%vt1VtH+yT$GkqX_oS>x3wF+$C?|k3- z7Rz(s6+3rR&(fMXWOAd4@Y9E6znk<_=1b^EN}4h=O#>$2RlS=RxR z${aU0zo9UVi#T@fv(i7fW6UAa-HYyC8fv+Gcr4_7NAgu8|S8!fw}(Xm;(%rI*V%i3|i_4 z4+ygL-3eE?G|8bd@na zuUC;P7YEk02mCRB1dyQl#pm-X32wQ%rP)m$$ViI4^qTaKMaN4T@WGwab#G(goYG^- zk#6GG4Wt*DA}4ffh!QHD;$x2nu72Jrm>vq@)_ct1;>Z>dSS2q@LQvfENV&Uk6CX2f zw&rKdMT|(&Nl+4hD4rNBKToqrdY*piPK0Kx>Tw0YvAL^jIBL zY=T39ZN4^P-m1?A0uSduab5Hr$lz^u$FK1>aR>u>@71Y>%x`RWvV|^f6^(A+Y8RMbh>w*I4LW@f4P95c%fx{SM%Eam(9&PgECy9%Sfp`^L7jV zxoW;Gi0pvXJtC*)_z3&JKuEd8mm7+aTh7_Y%r7@mZPTxZ!4VT@x~-N^K6v1C@YqTRp43s3JccKahZ2n=a5b$eGzKafhhi4M2YRG?z}TU3e1a zG8@g|Ig^>g?sm)^G}^57r}sVVPrn9Rt$oLxhR-IIimrCH$kCs z77jiV_JJ32)3rFQz%+jqaMTNK$9f+mu^C=%WB%9*IIL?Dn|7iOSp2&P&oiNy#s+bK zXKS25CY=Ll4*WFW;eZ~yb>V-XA4m~PIiVoR_`rdD_rW*>7G*s6irGRswZT{qZN0h4 zwt#Ds2u^3&nW|`c0T~qt>Cf6+wY7gFth6b7O?OXj<*BgGXB*e*PL58ZKK)<^A2w5MZ~4gsxl?Wu#XEFr}U3_iO)RXjx8qB_<2U zC+Ae*e25}c^awF(!=sZlyChBbyEGXaowV3#$>jn0Mn7Rqni&1oAwwRzra|{d{wQLv z6SVBows$nYXuWQ!qT?xMA<%#2jLB@3%Jsn zl!(!+Rg`sby4mnOY}##N&JovPV!h_Clx47Z;DgRhM55I&V}pjTlMY@(2;&kd1O$Iz z^Dufz@>6OU;6==1CyhuxR`I{D?XzUGG;@G-_oQ&9f$^5Xv?Z5%#W$KKcTW9ZB@jo5 z3=Pw)5BIoEject`K+kWI(xDM_5w$ zQ^GnGH(7o6lPRxe3y-Af82^$GUVcZ~5cCZFBSC>JO4@tnk)L3tI9423U2qaN2)X-B4=6dMD6a?Hg0st2x?6>KyOs}0SKI(1N0*c zYy*~loZA+S^4OL-CjGQEQFv!MBVu>M-TA(A__h@xt86%UMjZn21@Z$32V9A1jwUrs zQo2_!U503h!c#iwyNwIRsZ&gQ#4GH?qrO(Jno+Abzjt-Lk+079R1CTeB0JCj;ngVq z@riEhm%6&e*MW4X3{=vkxHpDk19t=@{224hT*;3Q`0UIuj;+#7e}06%w8WyFGJlDP zGovx{_lk;&_Mc)ug)iMB`==YWB!8e`RP?W@U_U!Ri_EwUN_z2cu~M!(2YMmg4xFpY{pcUy}np3w;5o zxUR(kj)pOL63>h0z17bt=6ar%ekEO%%Ni{cfi299YZxX~2|1uzKVFupLeyxSOVF9G zPJ?qN$HK+zz(J_nok6Fks;x#6nZ>Tp*9@7?e~%=6^m0UhdcbQ3{v+D+iimxd@gv)rS^_(Qz~x0#y)<3ujMG+KXiT`5-Ld4eN@Y!@u5yFX**e8vQL189 zX!3vp8WR%KrHipy@+Bmvk_T&s2h3Z+e|=_@ zx~@GB-QvfhP=Qp>`m?axQ4@bb3?G*<1FsiogN$@7q{!fJLKiPKhv;ar8~z&a73l4e zyTl3l3Ly%*11a8Kj(<(;K0mXiE~OsBcBAoX+Icu(o2ZXJoazx<_dBx!$Y^KC!i!6t zTvMyhqU0YWDRDRc;6h-GM9$Ulv@xrhPnq}iI?GC>cUC`WJww6zrVC4YyFGq9QgNly zqQp&$v0%1<)V2}f`7IFHlDf822+HwYmN~xBPy3i1rcM#AU}I;hS3cIT(EPAYA2z@yFXqY<{}>`R*n= z{?>B#Jjena)WSp{!zOe(_%K^*ZA}vrE`-z$72z3)RLU#%v}13wpSDqLr9uA(vV@TV(CICW$TRCPJYUfU_dZXLg#}mnSo6z`_T2Oz*^yBUsZnr`@icI5!Q*=VefFRl@d4%nBe-U1Ul`-SSu-kpLBKPgQR)2EY6^~#UWprO|CJ=8UZA!4#!W$S zK>=z8K{ot3<+gDacrzVvFO!0yVjHvTzgz#Q4gMk~-wBlVCg1;~k{~3E)yi>x#Nyd~ zrate+o??v0`DOY5FbiF8G*q#!J$3A_H0V2&-AYfu+gN~kuvD-^TV)0}<83|6j7`X^ zHS34-aqX+gja`S+8##-z^oXTkRY%+;DuYpPJsyHT3~ytuJAu@e{Cu(OqXBqkBb-KX zs`WW}eirJC_1Pf_6qs#3izYtF*{R8%r}KfY(7)ZHe)FAs`}c6BTfGIfUaw(E94plk zSFgJthdH$uj){j0%$>rwO0(|NX19m&rODFmbFgnK`TpY(x2nEn+^t?LRWO&MXw}oI zWfV*V{Dz=4wqoJPI%?_l*g<=h`ELsI4eMDcwz>PkcosU! zaiT+lPDJ_Jm5i1%;oOq8pwS=nLaIKO@h!?-9{b&lVowX-e-JV|X6ts$@wxHGmuWuH zGMCt4=KL4R4|mDDlZt(^XZu^f6j9CP3;QYr%L4b>Hsaic4}e;g+da&6#{rX+l`Cb) zqUzpe6?P$}$!|E67OktJwQLO{JbE4V-B$4Okdo!ks?@2}I(NcW07UB%Kk$_E>c>Vv zNO2(R@#VjJ^WLYagUXgXWe1m0q?YB)##|G-#>I)u8>h!k+vF;RwH<~=A!R2^-QR;Y5J2HC9b5QIeY}jw) z`h%~I=IRY5QQAj zDUHTN8oF%crEg_*D75cP>EQBl#k*i?|ru|79_zZZ?&_qVP{A78^bIt5?X z*;D!Cm{8yF^HKY@vD2gGn8_U{NNAdWpboG_%>y+K<64WzW#ZVvRGa~7#Y4p*r%-=S zF*xFN<<#VU-D-AO-4_O@=6%ne^{&62Sgz2bosXNPU$kM8PNP-=RriVbFX}<)@op98+a1Qzy^NWUe%*( zuFm|XctpJ4HAL*Fyh-(3P1qknIGH5==nx8pAc&)osI%ko!Z+#fVp(Sla}SM=WnG3?L4+mjE2omw!~}7Fxy2d|By|pdc2I2}Wfw4X!{@UU_@F z;iNTPs15~MuT|1_E|1q*k1_>T+&~) z4tIMPzjrt180JxTDz1erzt6FjpZ>i*P5b#;zRbCO>9hTlO`X!zFP&VPm?1Xwl_K;q}WCGkumwtyH2Nzo$ ziX;_Hq&PW;K|ml%6l7x7B8Wx)4r{ykIS9bsZpiw}S4{ahCbLF}!vML(DU7O2NMQb$ z9Xo3yow~i7@#)3q0IW!jez>VW{SVp2(UP#3q! z<9Hvjv4rEG5g3r1(!U#JdIKnx`}v2G^LLdl5^rN<-c0V!$Dd`{F~e40&fo%cb%vhm z+pO|`mgLG7hyV3!w4)VRsIr=#shm@Vj~V4tC{*_p`Hc@uiiGOE)^(I+v7ISo+fL)(xWG7TmEisX&KJ3XLX!H zwS|iDY@aW4te;I^3XaUB1*;;x?5JJ>x%Mt<=S_SCaswpHz&gpgTJqyS6`4=CpyH7u zWxFeAXi&o>>d>40x8-;9%4Ga_P0*;zD4Fe}a=pm1wdPHBV*0zLYI6GJfD+KsqBE|t z%D6Zt_rc;#Fua@RRDCawX!%W9%M6?$U*$iZc8c=ZGcVh;ey!>1OuJs|=V{VY!N6-y zqB@In0%YKXkLlPt(^IMFsR=~Vi@5x9eIYz>c*L#3LS+KpJ8d-N@P_2(U#2kraRb03^hxZ5`zGBt%yxbY~ZH?nA3t*P2h zzRiICZX{?dIX1ywi(P+O%^DArO}P?T)a*;DhRfyUyr!Xdb#AI@%AN#`Bmnh_x;DS0 z(=Hq2Wf2E-H=B4vAv!`#CNU=msa}*`-&#Q`)VCpgFQhe}QS~W{#u$S=@v^_6u}@OW zd^YPH;dA2#6qRFhfAfnMgGN(ELzUmLs;&xv?$;;Dq?nI1sir8QBaf9FlWN*eqP-{y zzVX-T&884tjnj^AaeO~Q$Ru9sciYaUjXwt;NnCo}Tk)rSDPLM_Im`luGoT=bA zeR`y~H!0OfBH7@?$&*lk?Gp~Q_WBa{cRy~vz@VG6w82TQPrW{HeTK-)Dd1t?Asmy3 z2RoQUVgqe*{aB44!1>=Ai)b{-PpypChce9AM0t)z2fnnlBuCf_@8zr^Rw+1t#_H;S zTmd8kfPk|8BNqI-^>1q&iAMiV{Xos@z04)pz0mfKm&2Bh-gU>O)88WECw>(P_%3Go z5AAP-36VWLyG42C&j85%TEOGLn$vDC1%_^Jx}WdQ3GjdXyC#28+*lgB~5QF zD=lr zJbv1B<~s6HY1b%lcyVDsT~XEdmIv6ei0Unw!UvYd!2^J?MvM9AAKA}N|Z1A&3G2A=j!MMWoYjO3i(@2^Y{KlfM@cAUx=;L;@4;7mD`DyBdRTl$xI5PSup56ECVcP_A22Ka4_$m-Cs9_c zazVj%td>lrWIHwYu0yn%pmIl{ zC0K)qRn9UFA}nc)K4Z+zJfYn29Z5pp8%;BG_W17j=llBm4+H%7wNc)j=$h9tiHN4| zoI=lI;{Z`fN!v82bVtF0ygvFJ-uIg@g28)vGbxjoMHxwW-(X6mM@R(PBWzJQ%*~xx z!FgEWs2+IgAAYNs#U1Ki_p?;NQf^eMR`WqKwkX}OJr*F;3aCBTKSz8<%IhCrEAKB~ z78Ay?ivbcT1TgN;Q$P-5?^53)hkfm_t+n4!@d?mNThkk?6OThwO2gGA~d*Uk^!XagCW0~^E zWkkSjRSLq{i(b+DN_TR@{Qf?Zr7ymMR$ zJvM6VKN@Z-y%@FPoEfT-!b$$F_#didu!G4L{q$(M*#pS!W?B!%3F~5W|7qV<4Tvb? z0`IZ$#f?>LO8avwlH%@s%yLuPMclV69#e4gsiTC4iaGjTV9BuK6I-kwshlz3>*?qJ zV4{Nxtw>WGI22d3LTp`+P*0^?5Bb^NMajfb33+FY8+ | Name| Type| Description| | -------- | -------- | -------- | -| ResourceColor | Color \| number \| string \| [Resource](#ResourceType) | Resource color.| +| ResourceColor | Color \| number \| string \| [Resource](#resourcetype) | Resource color.| ## Custom Builder8+ diff --git a/en/application-dev/usb/Readme-EN.md b/en/application-dev/usb/Readme-EN.md deleted file mode 100644 index 7ff9009a98..0000000000 --- a/en/application-dev/usb/Readme-EN.md +++ /dev/null @@ -1,4 +0,0 @@ -# USB Service - -- [USB Service Overview](usb-overview.md) -- [USB Service Development](usb-guidelines.md) diff --git a/zh-cn/application-dev/Readme-CN.md b/zh-cn/application-dev/Readme-CN.md index 161512be40..81c318bb63 100644 --- a/zh-cn/application-dev/Readme-CN.md +++ b/zh-cn/application-dev/Readme-CN.md @@ -13,15 +13,17 @@ - [Ability开发](ability/Readme-CN.md) - [UI开发](ui/Readme-CN.md) - 基础功能开发 - - [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md) - - [后台任务管理](background-task-management/Readme-CN.md) + - [窗口管理](windowmanager/Readme-CN.md) + - [WebGL](webgl/Readme-CN.md) - [媒体](media/Readme-CN.md) - [安全](security/Readme-CN.md) - [网络与连接](connectivity/Readme-CN.md) - [数据管理](database/Readme-CN.md) - - [USB服务](usb/Readme-CN.md) + - [后台代理提醒](background-agent-scheduled-reminder/Readme-CN.md) + - [后台任务管理](background-task-management/Readme-CN.md) + - [设备管理](device/Readme-CN.md) + - [设备使用信息统计](device-usage-statistics/Readme-CN.md) - [DFX](dfx/Readme-CN.md) - - [窗口管理](windowmanager/Readme-CN.md) - 工具 - [DevEco Studio（OpenHarmony）使用指南](quick-start/deveco-studio-user-guide-for-openharmony.md) - 示例教程 diff --git a/zh-cn/application-dev/background-task-management/background-task-dev-guide.md b/zh-cn/application-dev/background-task-management/background-task-dev-guide.md index 526670f34b..873a675496 100644 --- a/zh-cn/application-dev/background-task-management/background-task-dev-guide.md +++ b/zh-cn/application-dev/background-task-management/background-task-dev-guide.md @@ -36,12 +36,12 @@ import backgroundTaskManager from '@ohos.backgroundTaskManager'; ```js import backgroundTaskManager from '@ohos.backgroundTaskManager'; - + let myReason = 'test requestSuspendDelay'; let delayInfo = backgroundTaskManager.requestSuspendDelay(myReason, () => { console.info("Request suspension delay will time out."); }); - + var id = delayInfo.requestId;console.info("requestId is: " + id); ``` @@ -106,10 +106,10 @@ ohos.permission.KEEP_BACKGROUND_RUNNING | function stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): void;
function stopBackgroundRunning(context: Context): Promise<void>; | 停止后台长时任务的运行 | -其中，wantAgent的信息详见（[WantAgent](../reference/apis/js-apis-notification.md#WantAgent接口) - +其中，wantAgent的信息详见（[WantAgent](../reference/apis/js-apis-notification.md#WantAgent接口)） **表4** 后台模式类型 + | 参数名 | id值 | 描述 | | -------- | -------- | -------- | | DATA_TRANSFER | 1 | 数据传输 | @@ -174,13 +174,13 @@ ohos.permission.KEEP_BACKGROUND_RUNNING ```js import backgroundTaskManager from '@ohos.backgroundTaskManager'; import featureAbility from '@ohos.ability.featureAbility'; - + backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(() => { console.info("Operation succeeded"); }).catch((err) => { console.error("Operation failed Cause: " + err); }); - + ``` ## 开发实例 diff --git a/zh-cn/application-dev/device-usage-statistics/Readme-CN.md b/zh-cn/application-dev/device-usage-statistics/Readme-CN.md index e0c382796b..96a1726aff 100644 --- a/zh-cn/application-dev/device-usage-statistics/Readme-CN.md +++ b/zh-cn/application-dev/device-usage-statistics/Readme-CN.md @@ -1,5 +1,4 @@ # 设备使用信息统计 -- 后台任务 - - [设备使用信息统计概述](device-usage-statistics-overview.md) - - [设备使用信息统计开发指导](device-usage-statistics-dev-guide.md) \ No newline at end of file +- [设备使用信息统计概述](device-usage-statistics-overview.md) +- [设备使用信息统计开发指导](device-usage-statistics-dev-guide.md) \ No newline at end of file diff --git a/zh-cn/application-dev/device/Readme-CN.md b/zh-cn/application-dev/device/Readme-CN.md new file mode 100644 index 0000000000..78cbf49d8d --- /dev/null +++ b/zh-cn/application-dev/device/Readme-CN.md @@ -0,0 +1,9 @@ +# 设备管理 + +- USB服务 + - [USB服务开发概述](usb-overview.md) + - [USB服务开发指导](usb-guidelines.md) +- 位置 + - [位置开发概述](device-location-overview.md) + - [获取设备的位置信息](device-location-info.md) + - [（逆）地理编码转化](device-location-geocoding.md) diff --git a/zh-cn/application-dev/device/device-location-geocoding.md b/zh-cn/application-dev/device/device-location-geocoding.md new file mode 100644 index 0000000000..ef55a0bf81 --- /dev/null +++ b/zh-cn/application-dev/device/device-location-geocoding.md @@ -0,0 +1,60 @@ +# （逆）地理编码转化 + + +## 场景介绍 + +使用坐标描述一个位置，非常准确，但是并不直观，面向用户表达并不友好。 + +系统向开发者提供了地理编码转化能力（将地理描述转化为具体坐标），以及逆地理编码转化能力（将坐标转化为地理描述）。其中地理编码包含多个属性来描述位置，包括国家、行政区划、街道、门牌号、地址描述等等，这样的信息更便于用户理解。 + + +## 接口说明 + +进行坐标和地理编码信息的相互转化，所使用的接口说明如下。 + + **表1** 地理编码转化能力和逆地理编码转化能力的API功能介绍 + +| 接口名 | 功能描述 | +| -------- | -------- | +| isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void | 判断（逆）地理编码服务状态，使用callback回调异步返回结果。 | +| isGeoServiceAvailable() : Promise<boolean> | 判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 | +| getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 | +| getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>>; | 调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 | +| getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void | 调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 | +| getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> | 调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 | + + +## 开发步骤 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> GeoConvert需要访问后端服务，请确保设备联网，以进行信息获取。 + +1. 导入geolocation模块，所有与（逆）地理编码转化能力相关的功能API，都是通过该模块提供的。 + + ``` + import geolocation from '@ohos.geolocation'; + ``` + +2. 获取转化结果。 + - 调用getAddressesFromLocation，坐标转化地理位置信息。 + + ``` + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geolocation.getAddressesFromLocation(reverseGeocodeRequest, (data) => { + console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + }); + ``` + + 参考接口API说明，应用可以获得与此坐标匹配的GeoAddress列表，应用可以根据实际使用需求，读取相应的参数数据。 + - 调用getAddressesFromLocationName位置描述转化坐标。 + + ``` + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + geolocation.getAddressesFromLocationName(geocodeRequest, (data) => { + console.log('getAddressesFromLocationName: ' + JSON.stringify(data)); + }); + ``` + + 参考接口API说明，应用可以获得与位置描述相匹配的GeoAddress列表，其中包含对应的坐标数据，请参考API使用。 + + 如果需要查询的位置描述可能出现多地重名的请求，可以设置GeoCodeRequest，通过设置一个经纬度范围，以高效地获取期望的准确结果。 diff --git a/zh-cn/application-dev/device/device-location-info.md b/zh-cn/application-dev/device/device-location-info.md new file mode 100644 index 0000000000..63b119363d --- /dev/null +++ b/zh-cn/application-dev/device/device-location-info.md @@ -0,0 +1,187 @@ +# 获取设备的位置信息 + + +## 场景介绍 + +开发者可以调用OpenHarmony位置相关接口，获取设备实时位置，或者最近的历史位置。 + +对于位置敏感的应用业务，建议获取设备实时位置信息。如果不需要设备实时位置信息，并且希望尽可能的节省耗电，开发者可以考虑获取最近的历史位置。 + + +## 接口说明 + +获取设备的位置信息，所使用的接口说明如下。 + + **表1** 获取位置信息API功能介绍 + +| 接口名 | 功能描述 | +| -------- | -------- | +| on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>) : void | 开启位置变化订阅，并发起定位请求。 | +| off(type: 'locationChange', callback?: Callback<Location>) : void | 关闭位置变化订阅，并删除对应的定位请求。 | +| on(type: 'locationServiceState', callback: Callback<boolean>) : void | 订阅位置服务状态变化。 | +| off(type: 'locationServiceState', callback: Callback<boolean>) : void | 取消订阅位置服务状态变化。 | +| on(type: 'cachedGnssLocationsReporting', request: CachedGnssLoactionsRequest, callback: Callback<Array<Location>>) : void; | 订阅缓存GNSS位置上报。 | +| off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>) : void; | 取消订阅缓存GNSS位置上报。 | +| on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : void; | 订阅卫星状态信息更新事件。 | +| off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : void; | 取消订阅卫星状态信息更新事件。 | +| on(type: 'nmeaMessageChange', callback: Callback<string>) : void; | 订阅GNSS NMEA信息上报。 | +| off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; | 取消订阅GNSS NMEA信息上报。 | +| on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | 添加围栏，并订阅该围栏事件上报。 | +| off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; | 删除围栏，并取消订阅该围栏事件。 | +| getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>) : void | 获取当前位置，使用callback回调异步返回结果。 | +| getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> | 获取当前位置，使用Promise方式异步返回结果。 | +| getLastLocation(callback: AsyncCallback<Location>) : void | 获取上一次位置，使用callback回调异步返回结果。 | +| getLastLocation() : Promise<Location> | 获取上一次位置，使用Promise方式异步返回结果。 | +| isLocationEnabled(callback: AsyncCallback<boolean>) : void | 判断位置服务是否已经打开，使用callback回调异步返回结果。 | +| isLocationEnabled() : Promise<boolean> | 判断位置服务是否已经开启，使用Promise方式异步返回结果。 | +| requestEnableLocation(callback: AsyncCallback<boolean>) : void | 请求打开位置服务，使用callback回调异步返回结果。 | +| requestEnableLocation() : Promise<boolean> | 请求打开位置服务，使用Promise方式异步返回结果。 | +| enableLocation(callback: AsyncCallback<boolean>) : void | 打开位置服务，使用callback回调异步返回结果。 | +| enableLocation() : Promise<boolean> | 打开位置服务，使用Promise方式异步返回结果。 | +| disableLocation(callback: AsyncCallback<boolean>) : void | 关闭位置服务，使用callback回调异步返回结果。 | +| disableLocation() : Promise<boolean> | 关闭位置服务，使用Promise方式异步返回结果。 | +| getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; | 获取缓存GNSS位置的个数，使用callback回调异步返回结果。 | +| getCachedGnssLocationsSize() : Promise<number>; | 获取缓存GNSS位置的个数，使用Promise方式异步返回结果。 | +| flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; | 获取所有的GNSS缓存位置，并清空GNSS缓存队列，使用callback回调异步返回结果。 | +| flushCachedGnssLocations() : Promise<boolean>; | 获取所有的GNSS缓存位置，并清空GNSS缓存队列，使用Promise方式异步返回结果。 | +| sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : void; | 给位置服务子系统发送扩展命令，使用callback回调异步返回结果。 | +| sendCommand(command: LocationCommand) : Promise<boolean>; | 给位置服务子系统发送扩展命令，使用Promise方式异步返回结果。 | +| isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>) : void; | 查询用户是否同意定位服务的隐私申明，使用callback回调异步返回结果。 | +| isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean>; | 查询用户是否同意定位服务的隐私申明，使用Promise方式异步返回结果。 | +| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean, callback: AsyncCallback<boolean>) : void; | 设置并记录用户是否同意定位服务的隐私申明，使用callback回调异步返回结果。 | +| setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise<boolean>; | 设置并记录用户是否同意定位服务的隐私申明，使用Promise方式异步返回结果。 | + + +## 开发步骤 + +1. 应用在使用系统能力前，需要检查是否已经获取用户授权访问设备位置信息。如未获得授权，可以向用户申请需要的位置权限，申请方式请参考。 + 系统提供的定位权限有： + - ohos.permission.LOCATION + + - ohos.permission.LOCATION_IN_BACKGROUND + + 访问设备的位置信息，必须申请ohos.permission.LOCATION权限，并且获得用户授权。 + + 如果应用在后台运行时也需要访问设备位置，除需要将应用声明为允许后台运行外，还必须申请ohos.permission.LOCATION_IN_BACKGROUND权限，这样应用在切入后台之后，系统可以继续上报位置信息。 + + 开发者可以在应用config.json文件中声明所需要的权限，示例代码如下： + + + ``` + { + "module": { + "reqPermissions": [{ + "name": "ohos.permission.LOCATION", + "reason": "$string:reason_description", + "usedScene": { + "ability": ["com.myapplication.LocationAbility"], + "when": "inuse" + }, { + ... + } + ] + } + } + ``` + + 配置字段详细说明见。 + +2. 导入geolocation模块，所有与基础定位能力相关的功能API，都是通过该模块提供的。 + + ``` + import geolocation from '@ohos.geolocation'; + ``` + +3. 实例化LocationRequest对象，用于告知系统该向应用提供何种类型的位置服务，以及位置结果上报的频率。 + **方式一：** + + 为了面向开发者提供贴近其使用场景的API使用方式，系统定义了几种常见的位置能力使用场景，并针对使用场景做了适当的优化处理，应用可以直接匹配使用，简化开发复杂度。系统当前支持场景如下表所示。 + + + ``` + export enum LocationRequestScenario { + UNSET = 0x300, + NAVIGATION, + TRAJECTORY_TRACKING, + CAR_HAILING, + DAILY_LIFE_SERVICE, + NO_POWER, + } + ``` + + + **表2** 定位场景类型说明 + + | 场景名称 | 常量定义 | 说明 | + | -------- | -------- | -------- | + | 导航场景 | NAVIGATION | 适用于在户外定位设备实时位置的场景，如车载、步行导航。在此场景下，为保证系统提供位置结果精度最优，主要使用GNSS定位技术提供定位服务，结合场景特点，在导航启动之初，用户很可能在室内、车库等遮蔽环境，GNSS技术很难提供位置服务。为解决此问题，我们会在GNSS提供稳定位置结果之前，使用系统网络定位技术，向应用提供位置服务，以在导航初始阶段提升用户体验。
此场景默认以最小1秒间隔上报定位结果，使用此场景的应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 | + | 轨迹跟踪场景 | TRAJECTORY_TRACKING | 适用于记录用户位置轨迹的场景，如运动类应用记录轨迹功能。主要使用GNSS定位技术提供定位服务。
此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 | + | 出行约车场景 | CAR_HAILING | 适用于用户出行打车时定位当前位置的场景，如网约车类应用。
此场景默认以最小1秒间隔上报定位结果，并且应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 | + | 生活服务场景 | DAILY_LIFE_SERVICE | 生活服务场景，适用于不需要定位用户精确位置的使用场景，如新闻资讯、网购、点餐类应用，做推荐、推送时定位用户大致位置即可。
此场景默认以最小1秒间隔上报定位结果，并且应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 | + | 无功耗场景 | NO_POWER | 无功耗场景，适用于不需要主动启动定位业务。系统在响应其他应用启动定位业务并上报位置结果时，会同时向请求此场景的应用程序上报定位结果，当前的应用程序不产生定位功耗。
此场景默认以最小1秒间隔上报定位结果，并且应用需要申请ohos.permission.LOCATION权限，同时获得用户授权。 | + + 以导航场景为例，实例化方式如下： + + ``` + var requestInfo = {'scenario': 0x301, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ``` + + **方式二：** + + 如果定义的现有场景类型不能满足所需的开发场景，系统提供了基本的定位优先级策略类型。 + + + ``` + export enum LocationRequestPriority { + UNSET = 0x200, + ACCURACY, + LOW_POWER, + FIRST_FIX, + } + ``` + + + **表3** 定位优先级策略类型说明： + + | 策略类型 | 常量定义 | 说明 | + | -------- | -------- | -------- | + | 定位精度优先策略 | ACCURACY | 定位精度优先策略主要以GNSS定位技术为主，在开阔场景下可以提供米级的定位精度，具体性能指标依赖用户设备的定位硬件能力，但在室内等强遮蔽定位场景下，无法提供准确的位置服务。
应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 | + | 快速定位优先策略 | FAST_FIRST_FIX | 快速定位优先策略会同时使用GNSS定位、基站定位和WLAN、蓝牙定位技术，以便室内和户外场景下，通过此策略都可以获得位置结果，当各种定位技术都有提供位置结果时，系统会选择其中精度较好的结果返回给应用。因为对各种定位技术同时使用，对设备的硬件资源消耗较大，功耗也较大。
应用必须申请ohos.permission.LOCATION权限，同时获得用户授权。 | + | 低功耗定位优先策略 | LOW_POWER | 低功耗定位优先策略主要使用基站定位和WLAN、蓝牙定位技术，也可以同时提供室内和户外场景下的位置服务，因为其依赖周边基站、可见WLAN、蓝牙设备的分布情况，定位结果的精度波动范围较大，如果对定位结果精度要求不高，或者使用场景多在有基站、可见WLAN、蓝牙设备高密度分布的情况下，推荐使用，可以有效节省设备功耗。
应用至少申请ohos.permission.LOCATION权限，同时获得用户授权。 | + + 以定位精度优先策略为例，实例化方式如下： + + ``` + var requestInfo = {'priority': 0x201, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + ``` + +4. 实例化Callback对象，用于向系统提供位置上报的途径。 + 应用需要自行实现系统定义好的回调接口，并将其实例化。系统在定位成功确定设备的实时位置结果时，会通过该接口上报给应用。应用程序可以在接口的实现中完成自己的业务逻辑。 + + ``` + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + ``` + +5. 启动定位。 + + ``` + geolocation.on('locationChange', requestInfo, locationChange); + ``` + +6. （可选）结束定位。 + + ``` + geolocation.off('locationChange', locationChange); + ``` + + 如果应用使用场景不需要实时的设备位置，可以获取系统缓存的最近一次历史定位结果。 + + ``` + geolocation.getLastLocation((data) => { + console.log('getLastLocation: data: ' + JSON.stringify(data)); + }); + ``` + + 此接口的使用需要应用向用户申请ohos.permission.LOCATION权限。 diff --git a/zh-cn/application-dev/device/device-location-overview.md b/zh-cn/application-dev/device/device-location-overview.md new file mode 100644 index 0000000000..31bab92733 --- /dev/null +++ b/zh-cn/application-dev/device/device-location-overview.md @@ -0,0 +1,39 @@ +# 位置开发概述 + + +移动终端设备已经深入人们日常生活的方方面面，如查看所在城市的天气、新闻轶事、出行打车、旅行导航、运动记录。这些习以为常的活动，都离不开定位用户终端设备的位置。 + + +当用户处于这些丰富的使用场景中时，系统的位置能力可以提供实时准确的位置数据。对于开发者，设计基于位置体验的服务，也可以使应用的使用体验更贴近每个用户。 + + +当应用在实现基于设备位置的功能时，如：驾车导航，记录运动轨迹等，可以调用该模块的API接口，完成位置信息的获取。 + + +## 基本概念 + +位置能力用于确定用户设备在哪里，系统使用位置坐标标示设备的位置，并用多种定位技术提供服务，如GNSS定位、基站定位、WLAN/蓝牙定位（基站定位、WLAN/蓝牙定位后续统称“网络定位技术”）。通过这些定位技术，无论用户设备在室内或是户外，都可以准确地确定设备位置。 + +- **坐标** + 系统以1984年世界大地坐标系统为参考，使用经度、纬度数据描述地球上的一个位置。 + +- **GNSS定位** + 基于全球导航卫星系统，包含：GPS、GLONASS、北斗、Galileo等，通过导航卫星、设备芯片提供的定位算法，来确定设备准确位置。定位过程具体使用哪些定位系统，取决于用户设备的硬件能力。 + +- **基站定位** + 根据设备当前驻网基站和相邻基站的位置，估算设备当前位置。此定位方式的定位结果精度相对较低，并且需要设备可以访问蜂窝网络。 + +- **WLAN、蓝牙定位** + 根据设备可搜索到的周围WLAN、蓝牙设备位置，估算设备当前位置。此定位方式的定位结果精度依赖设备周围可见的固定WLAN、蓝牙设备的分布，密度较高时，精度也相较于基站定位方式更高，同时也需要设备可以访问网络。 + + +## 运作机制 + +位置能力作为系统为应用提供的一种基础服务，需要应用在所使用的业务场景，向系统主动发起请求，并在业务场景结束时，主动结束此请求，在此过程中系统会将实时的定位结果上报给应用。 + + +## 约束与限制 + +使用设备的位置能力，需要用户进行确认并主动开启位置开关。如果位置开关没有开启，系统不会向任何应用提供位置服务。 + +设备位置信息属于用户敏感数据，所以即使用户已经开启位置开关，应用在获取设备位置前仍需向用户申请位置访问权限。在用户确认允许后，系统才会向应用提供位置服务。 diff --git a/zh-cn/application-dev/usb/figures/zh-cn_image_0000001237821727.png b/zh-cn/application-dev/device/figures/zh-cn_image_0000001237821727.png similarity index 100% rename from zh-cn/application-dev/usb/figures/zh-cn_image_0000001237821727.png rename to zh-cn/application-dev/device/figures/zh-cn_image_0000001237821727.png diff --git a/zh-cn/application-dev/usb/public_sys-resources/icon-caution.gif b/zh-cn/application-dev/device/public_sys-resources/icon-caution.gif similarity index 100% rename from zh-cn/application-dev/usb/public_sys-resources/icon-caution.gif rename to zh-cn/application-dev/device/public_sys-resources/icon-caution.gif diff --git a/zh-cn/application-dev/usb/public_sys-resources/icon-danger.gif b/zh-cn/application-dev/device/public_sys-resources/icon-danger.gif similarity index 100% rename from zh-cn/application-dev/usb/public_sys-resources/icon-danger.gif rename to zh-cn/application-dev/device/public_sys-resources/icon-danger.gif diff --git a/zh-cn/application-dev/usb/public_sys-resources/icon-note.gif b/zh-cn/application-dev/device/public_sys-resources/icon-note.gif similarity index 100% rename from zh-cn/application-dev/usb/public_sys-resources/icon-note.gif rename to zh-cn/application-dev/device/public_sys-resources/icon-note.gif diff --git a/zh-cn/application-dev/usb/public_sys-resources/icon-notice.gif b/zh-cn/application-dev/device/public_sys-resources/icon-notice.gif similarity index 100% rename from zh-cn/application-dev/usb/public_sys-resources/icon-notice.gif rename to zh-cn/application-dev/device/public_sys-resources/icon-notice.gif diff --git a/zh-cn/application-dev/usb/public_sys-resources/icon-tip.gif b/zh-cn/application-dev/device/public_sys-resources/icon-tip.gif similarity index 100% rename from zh-cn/application-dev/usb/public_sys-resources/icon-tip.gif rename to zh-cn/application-dev/device/public_sys-resources/icon-tip.gif diff --git a/zh-cn/application-dev/usb/public_sys-resources/icon-warning.gif b/zh-cn/application-dev/device/public_sys-resources/icon-warning.gif similarity index 100% rename from zh-cn/application-dev/usb/public_sys-resources/icon-warning.gif rename to zh-cn/application-dev/device/public_sys-resources/icon-warning.gif diff --git a/zh-cn/application-dev/usb/usb-guidelines.md b/zh-cn/application-dev/device/usb-guidelines.md similarity index 100% rename from zh-cn/application-dev/usb/usb-guidelines.md rename to zh-cn/application-dev/device/usb-guidelines.md diff --git a/zh-cn/application-dev/usb/usb-overview.md b/zh-cn/application-dev/device/usb-overview.md similarity index 100% rename from zh-cn/application-dev/usb/usb-overview.md rename to zh-cn/application-dev/device/usb-overview.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index e29e518a06..8065062ead 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -54,6 +54,7 @@ - 通信与连接 - [WLAN](js-apis-wifi.md) - [Bluetooth](js-apis-bluetooth.md) + - [RPC通信](js-apis-rpc.md) - 设备管理 - [传感器](js-apis-sensor.md) - [振动](js-apis-vibrator.md) @@ -69,6 +70,7 @@ - [显示设备属性](js-apis-display.md) - [升级](js-apis-update.md) - [USB管理](js-apis-usb.md) + - [位置服务](js-apis-geolocation.md) - 基本功能 - [应用上下文](js-apis-basic-features-app-context.md) - [日志打印](js-apis-basic-features-logs.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md index 28f6239ce3..c64cd5e60c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md @@ -13,7 +13,7 @@ Ability运行相关信息。 通过abilityManager中getAbilityRunningInfos方法获取。 - + ```js import abilitymanager from '@ohos.application.abilityManager'; abilitymanager.getAbilityRunningInfos((err,data) => { @@ -23,14 +23,14 @@ abilitymanager.getAbilityRunningInfos((err,data) => { ## 属性 -| 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| ability | ElementName | 是 | 否 | Ability匹配信息。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | -| pid | number | 是 | 否 | 进程ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | -| uid | number | 是 | 否 | 用户ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | -| processName | string | 是 | 否 | 进程名称。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | -| startTime | number | 是 | 否 | Ability启动时间。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | -| abilityState | [abilityManager.AbilityState](#abilitymanager-abilitystate) | 是 | 否 | Ability状态。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | +| ability | ElementName | 是 | 否 | Ability匹配信息。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | +| pid | number | 是 | 否 | 进程ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | +| uid | number | 是 | 否 | 用户ID。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | +| processName | string | 是 | 否 | 进程名称。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | +| startTime | number | 是 | 否 | Ability启动时间。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | +| abilityState | [abilityManager.AbilityState](#abilitymanagerabilitystate) | 是 | 否 | Ability状态。
**系统能力**：SystemCapability.Ability.AbilityRuntime.Core | ## abilityManager.AbilityState diff --git a/zh-cn/application-dev/reference/apis/js-apis-camera.md b/zh-cn/application-dev/reference/apis/js-apis-camera.md index ed5e53a56e..66bf11d330 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-camera.md +++ b/zh-cn/application-dev/reference/apis/js-apis-camera.md @@ -2531,7 +2531,7 @@ createVideoOutput(surfaceId: string, callback: AsyncCallback): voi | 名称 | 类型 | 必填 | 说明 | |------------|-------------------------------|-----------|----------------------------------------------------| | surfaceId | string | 是 | 从VideoRecorder获取的Surface ID。 | -| callback | AsyncCallback<[VideoOutput](#videootput)\> | 是 | 回调函数，用于获取VideoOutput实例。 | +| callback | AsyncCallback<[VideoOutput](#videooutput)\> | 是 | 回调函数，用于获取VideoOutput实例。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md index ceb547322d..0e9a71b9eb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md +++ b/zh-cn/application-dev/reference/apis/js-apis-distributed-data.md @@ -61,17 +61,17 @@ createKVManager(config: KVManagerConfig): Promise<KVManager> 创建一个KVManager对象实例，用于管理数据库对象，并通过Promise方式返回，此方法为异步方法。 - 参数： - + | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ------ | ------ | | config |[KVManagerConfig](#kvmanager) | 是 | 提供KVManager实例的配置信息，包括调用方的包名和用户信息。 | - + - 返回值： | 类型 | 说明 | | -------- | -------- | | Promise<[KVManager](#kvmanager)> | 指定的Promise回调方法，返回创建的KVManager对象实例。 | - + - 示例： ``` @@ -363,7 +363,7 @@ deleteKVStore(appId: string, storeId: string): Promise<void>; 通过storeId的值删除指定的kvStore数据库，并通过Promise方式返回，此方法为异步方法。 - 参数： - + | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | appId | string | 是 | 所调用数据库方的包名。 | @@ -450,7 +450,7 @@ getAllKVStoreId(appId: string): Promise<string[]>; - 返回值： - + | 类型 | 说明 | | ------------- | -------------- | | Promise<string[]>| Promise实例，返回所有创建的 KvStore 数据库的 storeId。 | @@ -517,7 +517,7 @@ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): v | ----- | ------ | ---- | ----------------------- | | event | 'distributedDataServiceDie' | 是 | 服务状态改变时触发的事件名。 | | deathCallback | Callback<void> | 否 | 回调函数，取消设备状态改变时获取通知。 | - + - 示例 @@ -633,7 +633,7 @@ appendChild(child: FieldNode): boolean; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | child | [FieldNode](#FieldNode) | 是 | 要附加的域节点。 | - + - 返回值： @@ -1138,7 +1138,7 @@ reset(): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回重置的 Query 对象。| +| [Query](#query8) |返回重置的 Query 对象。| - 示例 @@ -1173,7 +1173,7 @@ equalTo(field: string, value: number|string|boolean): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回重置的 Query 对象。| +| [Query](#query8) |返回重置的 Query 对象。| - 示例 @@ -1206,7 +1206,7 @@ notEqualTo(field: string, value: number|string|boolean): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回重置的 Query 对象。| +| [Query](#query8) |返回重置的 Query 对象。| - 示例 @@ -1239,7 +1239,7 @@ greaterThan(field: string, value: number|string|boolean): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1272,7 +1272,7 @@ lessThan(field: string, value: number|string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1305,7 +1305,7 @@ greaterThanOrEqualTo(field: string, value: number|string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1338,7 +1338,7 @@ lessThanOrEqualTo(field: string, value: number|string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1370,7 +1370,7 @@ isNull(field: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1403,7 +1403,7 @@ inNumber(field: string, valueList: number[]): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1437,7 +1437,7 @@ inString(field: string, valueList: string[]): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1470,7 +1470,7 @@ notInNumber(field: string, valueList: number[]): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1503,7 +1503,7 @@ notInString(field: string, valueList: string[]): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1536,7 +1536,7 @@ like(field: string, value: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1569,7 +1569,7 @@ unlike(field: string, value: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1595,7 +1595,7 @@ and(): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1623,7 +1623,7 @@ or(): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1657,7 +1657,7 @@ orderByAsc(field: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1690,7 +1690,7 @@ orderByDesc(field: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1725,7 +1725,7 @@ limit(total: number, offset: number): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1758,7 +1758,7 @@ isNotNull(field: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1784,7 +1784,7 @@ beginGroup(): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1812,7 +1812,7 @@ endGroup(): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1846,7 +1846,7 @@ prefixKey(prefix: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1879,7 +1879,7 @@ setSuggestIndex(index: string): Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1913,7 +1913,7 @@ deviceId(deviceId:string):Query; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -1938,7 +1938,7 @@ getSqlLike():string; | 类型 | 说明 | | ------ | ------- | -| [Query](#querysup8sup) |返回查询对象。| +| [Query](#query8) |返回查询对象。| - 示例 @@ -2121,8 +2121,8 @@ on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotific | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | event |'dataChange' | 是 |回调函数名称。 | -| type |[SubscribeType](#subscribetypea) | 是 |表示订阅的类型。 | -| observer |Callback<[ChangeNotification](#changenotificationa)> | 是 |回调函数。 | +| type |[SubscribeType](#subscribetype) | 是 |表示订阅的类型。 | +| observer |Callback<[ChangeNotification](#changenotification)> | 是 |回调函数。 | - 示例 @@ -2169,7 +2169,7 @@ off(event:'dataChange', observer?: Callback<ChangeNotification>): void; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | event |'dataChange' | 是 |回调函数名称。 | -| observer |Callback<[ChangeNotification](#changenotificationa)> |否 |回调函数。 | +| observer |Callback<[ChangeNotification](#changenotification)> |否 |回调函数。 | - 示例 @@ -2961,7 +2961,7 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示要匹配的键前缀。 | +| query |[Query](#query8) | 是 |表示要匹配的键前缀。 | | callback |AsyncCallback<Entry[]> | 是 |回调函数，获取指定前缀的键值对列表。 | - 示例 @@ -3010,7 +3010,7 @@ getEntries(query: Query): Promise<Entry[]>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： @@ -3066,7 +3066,7 @@ getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>) | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)> | 是 |表示要匹配的键前缀。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)> | 是 |表示要匹配的键前缀。 | - 示例 @@ -3118,7 +3118,7 @@ getResultSet(keyPrefix: string): Promise<KvStoreResultSet>; | 类型 | 说明 | | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)> |Promise实例，用于获取异步返回结果。| +|Promise<[KvStoreResultSet](#kvstoreresultset8)> |Promise实例，用于获取异步返回结果。| - 示例 @@ -3171,7 +3171,7 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | query |Query | 是 |表示查询对象。 | -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)> | 是 |回调函数，获取与指定 Query 对象匹配的 KvStoreResultSet 对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)> | 是 |回调函数，获取与指定 Query 对象匹配的 KvStoreResultSet 对象。 | - 示例 @@ -3216,13 +3216,13 @@ getResultSet(query: Query): Promise<KvStoreResultSet>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： | 类型 | 说明 | | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)> |Promise实例，用于获取异步返回结果。| +|Promise<[KvStoreResultSet](#kvstoreresultset8)> |Promise实例，用于获取异步返回结果。| - 示例 @@ -3270,7 +3270,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#kvstoreresultsetsup8sup) | 是 |表示要关闭的 KvStoreResultSet 对象。 | +| resultSet |[KvStoreResultSet](#kvstoreresultset8) | 是 |表示要关闭的 KvStoreResultSet 对象。 | | callback |AsyncCallback<void> | 是 |回调函数，获取由 getResultSet 返回的 KvStoreResultSet 对象。 | - 示例 @@ -3302,7 +3302,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#kvstoreresultsetsup8sup) | 是 |表示要关闭的 KvStoreResultSet 对象。 | +| resultSet |[KvStoreResultSet](#kvstoreresultset8) | 是 |表示要关闭的 KvStoreResultSet 对象。 | - 返回值： @@ -3337,7 +3337,7 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | | callback |AsyncCallback<number> | 是 |回调函数，获取与指定 Query 对象匹配的结果数。 | - 示例 @@ -3381,7 +3381,7 @@ getResultSize(query: Query): Promise<number>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： @@ -3909,7 +3909,7 @@ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | | callback |AsyncCallback<[Entry](#entry)[]> | 是 |回调函数，返回与指定 Query 对象匹配的键值对列表。 | - 示例 @@ -3960,7 +3960,7 @@ getEntries(query: Query): Promise<Entry[]>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： @@ -4017,7 +4017,7 @@ getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]> | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |键值对所属的设备ID。 | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | | callback |AsyncCallback<[Entry](#entry)[]> | 是 |回调函数，返回与指定 Query 对象匹配的键值对列表。 | - 示例 @@ -4069,7 +4069,7 @@ getEntries(deviceId: string, query: Query): Promise<Entry[]>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |键值对所属的设备ID。 | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： @@ -4128,7 +4128,7 @@ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvS | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |标识要查询其数据的设备。 | | keyPrefix |string | 是 |表示要匹配的键前缀。 | -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | 是 |回调函数，返回 KvStoreResultSet 对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)[]> | 是 |回调函数，返回 KvStoreResultSet 对象。 | - 示例 @@ -4166,7 +4166,7 @@ getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet&g | 类型 | 说明 | | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise实例，用于获取异步返回结果。| +|Promise<[KvStoreResultSet](#kvstoreresultset8)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -4201,8 +4201,8 @@ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): voi | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | 是 |回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)[]> | 是 |回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。 | - 示例 @@ -4251,13 +4251,13 @@ getResultSet(query: Query): Promise<KvStoreResultSet>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： | 类型 | 说明 | | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise实例，用于获取异步返回结果。| +|Promise<[KvStoreResultSet](#kvstoreresultset8)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -4314,8 +4314,8 @@ getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreR | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | -| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> | 是 |回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | +| callback |AsyncCallback<[KvStoreResultSet](#kvstoreresultset8)[]> | 是 |回调函数，返回与指定 Query 对象匹配的 KvStoreResultSet 对象。 | - 示例 @@ -4364,13 +4364,13 @@ getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： | 类型 | 说明 | | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultsetsup8sup)[]> |Promise实例，用于获取异步返回结果。| +|Promise<[KvStoreResultSet](#kvstoreresultset8)[]> |Promise实例，用于获取异步返回结果。| - 示例 @@ -4427,7 +4427,7 @@ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>) | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#getresultsetsup8sup) | 是 |指示要关闭的 KvStoreResultSet 对象。 | +| resultSet |[KvStoreResultSet](#getresultset8) | 是 |指示要关闭的 KvStoreResultSet 对象。 | | callback |AsyncCallback<void> | 是 |回调函数。 | - 示例 @@ -4460,7 +4460,7 @@ closeResultSet(resultSet: KvStoreResultSet): Promise<void>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| resultSet |[KvStoreResultSet](#getresultsetsup8sup) | 是 |指示要关闭的 KvStoreResultSet 对象。 | +| resultSet |[KvStoreResultSet](#getresultset8) | 是 |指示要关闭的 KvStoreResultSet 对象。 | - 返回值： @@ -4496,7 +4496,7 @@ getResultSize(query: Query, callback: AsyncCallback<number>): void; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | | callback |AsyncCallback<number> | 是 |回调函数，返回与指定 Query 对象匹配的结果数。 | - 示例 @@ -4541,7 +4541,7 @@ getResultSize(query: Query): Promise<number>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： @@ -4596,7 +4596,7 @@ getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number& | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | | callback |AsyncCallback<number> | 是 |回调函数，返回与指定 Query 对象匹配的结果数。 | - 示例 @@ -4641,7 +4641,7 @@ getResultSize(deviceId: string, query: Query): Promise<number>; | 参数名 | 参数类型 | 必填 | 说明 | | ----- | ------ | ---- | ----------------------- | | deviceId |string | 是 |KvStoreResultSet对象所属的设备ID。 | -| query |[Query](#querysup8sup) | 是 |表示查询对象。 | +| query |[Query](#query8) | 是 |表示查询对象。 | - 返回值： diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md index 19ed0e0bc2..c710249cdb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md @@ -13,7 +13,7 @@ Extension运行相关信息。 通过abilityManager中方法获取。 - + ``` import abilitymanager from '@ohos.application.abilityManager'; abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { @@ -24,15 +24,15 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { ### 属性 - | 名称 | 参数类型 | 可读 | 可写 | 说明 | +| 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| extension | ElementName | 是 | 否 | Extension匹配信息。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | -| pid | number | 是 | 否 | 进程ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | -| uid | number | 是 | 否 | 用户ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | -| processName | string | 是 | 否 | 进程名称。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | -| startTime | number | 是 | 否 | Extension启动时间。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | -| clientPackage | Array<String> | 是 | 否 | 表示当期进程下的所有包名。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | -| type | [bundle.ExtensionAbilityType](#bundle-extensionabilitytype) | 是 | 否 | Extension类型。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| extension | ElementName | 是 | 否 | Extension匹配信息。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| pid | number | 是 | 否 | 进程ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| uid | number | 是 | 否 | 用户ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| processName | string | 是 | 否 | 进程名称。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| startTime | number | 是 | 否 | Extension启动时间。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| clientPackage | Array<String> | 是 | 否 | 表示当期进程下的所有包名。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| type | [bundle.ExtensionAbilityType](#bundleextensionabilitytype) | 是 | 否 | Extension类型。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | ## bundle.ExtensionAbilityType diff --git a/zh-cn/application-dev/reference/apis/js-apis-geolocation.md b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md new file mode 100644 index 0000000000..6dd2b097b5 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-geolocation.md @@ -0,0 +1,1119 @@ +# 位置服务(新) + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + + +``` +import geolocation from '@ohos.geolocation'; +``` + + +## 权限 + +ohos.permission.LOCATION + +ohos.permission.LOCATION_IN_BACKGROUND + + +## geolocation.on('locationChange') + +on(type: 'locationChange', request: LocationRequest, callback: Callback<Location>) : void + +开启位置变化订阅，并发起定位请求。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | request | LocationRequest | 是 | 设置位置请求参数。 | + | callback | Callback<[Location](#location)> | 是 | 接收位置变化状态变化监听。 | + +- 示例： + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + geolocation.on('locationChange', requestInfo, locationChange); + ``` + + +## geolocation.off('locationChange') + +off(type: 'locationChange', callback?: Callback<Location>) : void + +关闭位置变化订阅，并删除对应的定位请求。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationChange”，表示位置变化。 | + | callback | Callback<[Location](#location)> | 否 | 接收位置变化状态变化监听。 | + +- 示例： + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300, 'timeInterval': 0, 'distanceInterval': 0, 'maxAccuracy': 0}; + var locationChange = (location) => { + console.log('locationChanger: data: ' + JSON.stringify(location)); + }; + geolocation.on('locationChange', requestInfo, locationChange); + geolocation.off('locationChange', locationChange); + ``` + + +## geolocation.on('locationServiceState') + +on(type: 'locationServiceState', callback: Callback<boolean>) : void + +订阅位置服务状态变化。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | + | callback | Callback<boolean> | 是 | 接收位置服务状态变化监听。 | + +- 示例： + + ``` + var locationServiceState = (state) => { + console.log('locationServiceState: ' + state); + } + geolocation.on('locationServiceState', locationServiceState); + ``` + + +## geolocation.off('locationServiceState') + +off(type: 'locationServiceState', callback?: Callback<boolean>) : void; + +取消订阅位置服务状态变化。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“locationServiceState”，表示位置服务状态。 | + | callback | Callback<boolean> | 否 | 接收位置服务状态变化监听。 | + +- 示例： + + ``` + var locationServiceState = (state) => { + console.log('locationServiceState: state: ' + state); + } + geolocation.on('locationServiceState', locationServiceState); + geolocation.off('locationServiceState', locationServiceState); + ``` + + +## geolocation.on('cachedGnssLocationsReporting') + +on(type: 'cachedGnssLocationsReporting', request: CachedGnssLocationsRequest, callback: Callback<Array<Location>>) : void; + +订阅缓存GNSS定位结果上报事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | + | request | CachedGnssLocationsRequest | 是 | GNSS缓存功能配置参数 | + | callback | Callback<boolean> | 是 | 接收GNSS缓存位置上报。 | + +- 示例： + + ``` + var cachedLocationsCb = (locations) => { + console.log('cachedGnssLocationsReporting: locations: ' + locations); + } + var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); + ``` + + +## geolocation.off('cachedGnssLocationsReporting') + +off(type: 'cachedGnssLocationsReporting', callback?: Callback<Array<Location>>) : void; + +取消订阅缓存GNSS定位结果上报事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“cachedGnssLocationsReporting”，表示GNSS缓存定位结果上报。 | + | callback | Callback<boolean> | 否 | 接收GNSS缓存位置上报。 | + +- 示例： + + ``` + var cachedLocationsCb = (locations) => { + console.log('cachedGnssLocationsReporting: locations: ' + locations); + } + var requestInfo = {'reportingPeriodSec': 10, 'wakeUpCacheQueueFull': true}; + geolocation.on('cachedGnssLocationsReporting', requestInfo, cachedLocationsCb); + geolocation.off('cachedGnssLocationsReporting'); + ``` + + +## geolocation.on('gnssStatusChange') + +on(type: 'gnssStatusChange', callback: Callback<SatelliteStatusInfo>) : void; + +订阅GNSS卫星状态信息上报事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<SatelliteStatusInfo> | 是 | 接收GNSS卫星状态信息上报。 | + +- 示例： + + ``` + var gnssStatusCb = (satelliteStatusInfo) => { + console.log('gnssStatusChange: ' + satelliteStatusInfo); + } + geolocation.on('gnssStatusChange', gnssStatusCb); + ``` + + +## geolocation.off('gnssStatusChange') + +off(type: 'gnssStatusChange', callback?: Callback<SatelliteStatusInfo>) : void; + +取消订阅GNSS卫星状态信息上报事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“gnssStatusChange”，表示订阅GNSS卫星状态信息上报。 | + | callback | Callback<SatelliteStatusInfo> | 否 | 接收GNSS卫星状态信息上报。 | + +- 示例： + + ``` + var gnssStatusCb = (satelliteStatusInfo) => { + console.log('gnssStatusChange: ' + satelliteStatusInfo); + } + geolocation.on('gnssStatusChange', gnssStatusCb); + geolocation.off('gnssStatusChange', gnssStatusCb); + ``` + + +## geolocation.on('nmeaMessageChange') + +on(type: 'nmeaMessageChange', callback: Callback<string>) : void; + +订阅GNSS NMEA信息上报事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 是 | 接收GNSS NMEA信息上报。 | + +- 示例： + + ``` + var nmeaCb = (str) => { + console.log('nmeaMessageChange: ' + str); + } + geolocation.on('nmeaMessageChange', nmeaCb ); + ``` + + +## geolocation.off('nmeaMessageChange') + +off(type: 'nmeaMessageChange', callback?: Callback<string>) : void; + +取消订阅GNSS NMEA信息上报事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“nmeaMessageChange”，表示订阅GNSS NMEA信息上报。 | + | callback | Callback<string> | 否 | 接收GNSS NMEA信息上报。 | + +- 示例： + + ``` + var nmeaCb = (str) => { + console.log('nmeaMessageChange: ' + str); + } + geolocation.on('nmeaMessageChange', nmeaCb); + geolocation.off('nmeaMessageChange', nmeaCb); + ``` + + +## geolocation.on('fenceStatusChange') + +on(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; + +添加一个围栏，并订阅地理围栏事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | + | request | GeofenceRequest | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | + +- 示例： + + ``` + import WantAgent from '@ohos.wantAgent'; + import { OperationType, WantAgentFlags } from '@ohos.wantagent'; + //wantAgent对象 + var wantAgent; + //getWantAgent回调 + function getWantAgentCallback(err, data) { + console.info("==========================>getWantAgentCallback=======================>"); + if (err.code == 0) { + wantAgent = data; + } else { + console.info('----getWantAgent failed!----'); + } + } + //WantAgentInfo对象 + var wantAgentInfo = { + wants: [ + { + deviceId: "deviceId", + bundleName: "com.neu.setResultOnAbilityResultTest1", + abilityName: "com.example.test.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true,true,false}", + parameters: + { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "ssssssssssssssssssssssssss", + mykey4: [false, true, false], + mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey6: true, + } + } + ], + operationType: OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] + } + WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) + var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + geolocation.on('fenceStatusChange', requestInfo, wantAgent); + ``` + + +## geolocation.off('fenceStatusChange') + +off(type: 'fenceStatusChange', request: GeofenceRequest, want: WantAgent) : void; + +删除一个围栏，并取消订阅该围栏事件。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 设置事件类型。type为“fenceStatusChange”，表示订阅围栏事件上报。 | + | request | GeofenceRequest | 是 | 围栏的配置参数。 | + | want | WantAgent | 是 | 用于接收地理围栏事件上报（进出围栏）。 | + +- 示例： + + ``` + import WantAgent from '@ohos.wantAgent'; + import { OperationType, WantAgentFlags } from '@ohos.wantagent'; + //wantAgent对象 + var wantAgent; + //getWantAgent回调 + function getWantAgentCallback(err, data) { + console.info("==========================>getWantAgentCallback=======================>"); + if (err.code == 0) { + wantAgent = data; + } else { + console.info('----getWantAgent failed!----'); + } + } + //WantAgentInfo对象 + var wantAgentInfo = { + wants: [ + { + deviceId: "deviceId", + bundleName: "com.neu.setResultOnAbilityResultTest1", + abilityName: "com.example.test.MainAbility", + action: "action1", + entities: ["entity1"], + type: "MIMETYPE", + uri: "key={true,true,false}", + parameters: + { + mykey0: 2222, + mykey1: [1, 2, 3], + mykey2: "[1, 2, 3]", + mykey3: "ssssssssssssssssssssssssss", + mykey4: [false, true, false], + mykey5: ["qqqqq", "wwwwww", "aaaaaaaaaaaaaaaaa"], + mykey6: true, + } + } + ], + operationType: OperationType.START_ABILITIES, + requestCode: 0, + wantAgentFlags:[WantAgentFlags.UPDATE_PRESENT_FLAG] + } + WantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback) + var requestInfo = {'priority': 0x201, 'scenario': 0x301, "geofence": {"latitude": 121, "longitude": 26, "radius": 100, "expiration": 10000}}; + geolocation.on('fenceStatusChange', requestInfo, wantAgent); + geolocation.off('fenceStatusChange', requestInfo, wantAgent); + ``` + + +## geolocation.getCurrentLocation + +getCurrentLocation(request: CurrentLocationRequest, callback: AsyncCallback<Location>) : void + + +获取当前位置，使用callback回调异步返回结果。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收位置信息的回调。 | + +- 示例： + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + var locationChange = (err, location) => { + console.log('locationChanger: ' + err + 'data: ' + location); + }; + geolocation.getCurrentLocation(requestInfo, locationChange); + geolocation.getCurrentLocation(locationChange); + ``` + + +## geolocation.getCurrentLocation + +getCurrentLocation(request?: CurrentLocationRequest) : Promise<Location> + + +获取当前位置，使用Promise方式异步返回结果。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [CurrentLocationRequest](#currentlocationrequest) | 否 | 设置位置请求参数。 | + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<[Location](#location)> | 返回位置信息。 | + +- 示例： + + ``` + var requestInfo = {'priority': 0x203, 'scenario': 0x300,'maxAccuracy': 0}; + locationEventListener.getCurrentLocation(requestInfo).then((result) => { + console.log('current location: ' + JSON.stringify(result)); + }); + ``` + + +## geolocation.getLastLocation + +getLastLocation(callback: AsyncCallback<Location>) : void + +获取上一次位置，使用callback回调异步返回结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<[Location](#location)> | 是 | 用来接收上次位置的回调。 | + +- 示例： + + ``` + geolocation.getLastLocation((err, data) => { + console.log('getLastLocation: ' + err + " data: " + JSON.stringify(data)); + }); + ``` + + +## geolocation.getLastLocation + +getLastLocation() : Promise<Location> + +获取上一次位置，使用Promise方式异步返回结果。 + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<[Location](#location)> | 返回上次位置信息。 | + +- 示例： + + ``` + geolocation.getLastLocation().then((result) => { + console.log('getLastLocation: result: ' + JSON.stringify(result)); + }); + ``` + + +## geolocation.isLocationEnabled + +isLocationEnabled(callback: AsyncCallback<boolean>) : void + + +判断位置服务是否已经打开，使用callback回调异步返回结果。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | + +- 示例： + + ``` + geolocation.isLocationEnabled((err, data) => { + console.log('isLocationEnabled: ' + err + " data: " + data); + }); + ``` + + +## geolocation.isLocationEnabled + +isLocationEnabled() : Promise<boolean> + +判断位置服务是否已经开启，使用Promise方式异步返回结果。 + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 返回位置服务是否可用的状态。 | + +- 示例： + + ``` + geolocation.isLocationEnabled().then((result) => { + console.log('promise, isLocationEnabled: ' + result); + }); + ``` + + +## geolocation.requestEnableLocation + +requestEnableLocation(callback: AsyncCallback<boolean>) : void + + +请求打开位置服务，使用callback回调异步返回结果。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 用来接收位置服务状态的回调。 | + +- 示例： + + ``` + geolocation.requestEnableLocation((err, data) => { + console.log('requestEnableLocation: ' + err + " data: " + data); + }); + ``` + + +## geolocation.requestEnableLocation + +requestEnableLocation() : Promise<boolean> + +请求打开位置服务，使用Promise方式异步返回结果。 + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 返回位置服务是否可用。 | + +- 示例： + + ``` + geolocation.requestEnableLocation().then((result) => { + console.log('promise, requestEnableLocation: ' + result); + }); + ``` + + +## geolocation.isGeoServiceAvailable + +isGeoServiceAvailable(callback: AsyncCallback<boolean>) : void + +判断（逆）地理编码服务状态，使用callback回调异步返回结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 用来接收地理编码服务状态的回调。 | + +- 示例： + + ``` + geolocation.isGeoServiceAvailable((err, data) => { + console.log('isGeoServiceAvailable: ' + err + " data: " + data); + }); + ``` + + +## geolocation.isGeoServiceAvailable + +isGeoServiceAvailable() : Promise<boolean> + +判断（逆）地理编码服务状态，使用Promise方式异步返回结果。 + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 返回地理编码服务是否可用的状态。 | + +- 示例： + + ``` + geolocation.isGeoServiceAvailable().then((result) => { + console.log('promise, isGeoServiceAvailable: ' + result); + }); + ``` + + + +## geolocation.getAddressesFromLocation + +getAddressesFromLocation(request: ReverseGeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void + +调用逆地理编码服务，将坐标转换为地理描述，使用callback回调异步返回结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收逆地理编码请求的回调参数。 | + +- 示例： + + ``` + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geolocation.getAddressesFromLocation(reverseGeocodeRequest, (err, data) => { + console.log('getAddressesFromLocation: ' + err + " data: " + JSON.stringify(data)); + }); + ``` + + +## geolocation.getAddressesFromLocation + +getAddressesFromLocation(request: ReverseGeoCodeRequest) : Promise<Array<GeoAddress>>; + +调用逆地理编码服务，将坐标转换为地理描述，使用Promise方式异步返回结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [ReverseGeoCodeRequest](#reversegeocoderequest) | 是 | 设置逆地理编码请求的相关参数。 | + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | 返回地理描述信息。 | + +- 示例： + + ``` + var reverseGeocodeRequest = {"latitude": 31.12, "longitude": 121.11, "maxItems": 1}; + geolocation.getAddressesFromLocation(reverseGeocodeRequest).then((data) => { + console.log('getAddressesFromLocation: ' + JSON.stringify(data)); + }); + ``` + + +## geolocation.getAddressesFromLocationName + +getAddressesFromLocationName(request: GeoCodeRequest, callback: AsyncCallback<Array<GeoAddress>>) : void + +调用地理编码服务，将地理描述转换为具体坐标，使用callback回调异步返回结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + | callback | AsyncCallback<Array<[GeoAddress](#geoaddress)>> | 是 | 设置接收地理编码请求的回调参数。 | + +- 示例： + + ``` + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + geolocation.getAddressesFromLocationName(geocodeRequest, (err, data) => { + console.log('getAddressesFromLocationName: ' + err + " data: " + JSON.stringify(data)); + }); + ``` + + +## geolocation.getAddressesFromLocationName + +getAddressesFromLocationName(request: GeoCodeRequest) : Promise<Array<GeoAddress>> + +调用地理编码服务，将地理描述转换为具体坐标，使用Promise方式异步返回结果。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | request | [GeoCodeRequest](#geocoderequest) | 是 | 设置地理编码请求的相关参数。 | + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<Array<[GeoAddress](#geoaddress)>> | 设置接收地理编码请求的回调参数。 | + +- 示例： + + ``` + var geocodeRequest = {"description": "上海市浦东新区xx路xx号", "maxItems": 1}; + geolocation.getAddressesFromLocationName(geocodeRequest).then((result) => { + console.log('getAddressesFromLocationName: ' + JSON.stringify(result)); + }); + ``` + + + +## geolocation.getCachedGnssLocationsSize + +getCachedGnssLocationsSize(callback: AsyncCallback<number>) : void; + +获取GNSS芯片缓存位置的个数。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<number> | 是 | 用来接收GNSS芯片缓存位置个数的回调。 | + +- 示例： + + ``` + geolocation.getCachedGnssLocationsSize((err, size) => { + console.log('getCachedGnssLocationsSize: err:' + err + " size: " + size); + }); + ``` + + +## geolocation.getCachedGnssLocationsSize + +getCachedGnssLocationsSize() : Promise<number>; + +获取GNSS芯片缓存位置的个数。 + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<number> | 返回GNSS缓存位置的个数。 | + +- 示例： + + ``` + geolocation.getCachedGnssLocationsSize().then((result) => { + console.log('promise, getCachedGnssLocationsSize: ' + result); + }); + ``` + + +## geolocation.flushCachedGnssLocations + +flushCachedGnssLocations(callback: AsyncCallback<boolean>) : void; + +读取并清空GNSS芯片所有缓存位置。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | 是 | 用来接收清空GNSS芯片缓存位置操作的结果。 | + +- 示例： + + ``` + geolocation.flushCachedGnssLocations((err, result) => { + console.log('flushCachedGnssLocations: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.flushCachedGnssLocations + +flushCachedGnssLocations() : Promise<boolean>; + +读取并清空GNSS芯片所有缓存位置。 + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 清空所有GNSS缓存位置是否成功。 | + +- 示例： + + ``` + geolocation.flushCachedGnssLocations().then((result) => { + console.log('promise, flushCachedGnssLocations: ' + result); + }); + ``` + + +## geolocation.sendCommand + +sendCommand(command: LocationCommand, callback: AsyncCallback<boolean>) : void; + +给位置服务子系统的各个部件发送扩展命令。只有系统应用才能调用。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | command | LocationCommand | 是 | 指定目标场景，和将要发送的命令（字符串）。 | + | callback | AsyncCallback<boolean> | 是 | 用来接收命令发送的结果。 | + +- 示例： + + ``` + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + geolocation.sendCommand(requestInfo, (err, result) => { + console.log('sendCommand: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.sendCommand + +sendCommand(command: LocationCommand) : Promise<boolean>; + +给位置服务子系统的各个部件发送扩展命令。只有系统应用才能调用。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | command | LocationCommand | 是 | 指定目标场景，和将要发送的命令（字符串）。 | + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 表示命令发送成功或失败。 | + +- 示例： + + ``` + var requestInfo = {'scenario': 0x301, 'command': "command_1"}; + geolocation.sendCommand(requestInfo).then((result) => { + console.log('promise, sendCommand: ' + result); + }); + ``` + + +## geolocation.isLocationPrivacyConfirmed + +isLocationPrivacyConfirmed(type : LocationPrivacyType, callback: AsyncCallback<boolean>) : void; + +查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | callback | AsyncCallback<boolean> | 是 | 表示用户是否同意定位服务隐私申明。 | + +- 示例： + + ``` + geolocation.isLocationPrivacyConfirmed(1, (err, result) => { + console.log('isLocationPrivacyConfirmed: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.isLocationPrivacyConfirmed + +isLocationPrivacyConfirmed(type : LocationPrivacyType,) : Promise<boolean>; + +查询用户是否同意定位服务隐私申明，是否同意启用定位服务。只有系统应用才能调用。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 表示用户是否同意定位服务隐私申明。 | + +- 示例： + + ``` + geolocation.isLocationPrivacyConfirmed(1).then((result) => { + console.log('promise, isLocationPrivacyConfirmed: ' + result); + }); + ``` + + +## geolocation.setLocationPrivacyConfirmStatus + +setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed: boolean, callback: AsyncCallback<boolean>) : void; + +设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + | callback | AsyncCallback<boolean> | 是 | 表示操作是否成功。 | + +- 示例： + + ``` + geolocation.setLocationPrivacyConfirmStatus(1, true, (err, result) => { + console.log('isLocationPrivacyConfirmed: err:' + err + " result: " + result); + }); + ``` + + +## geolocation.setLocationPrivacyConfirmStatus + +setLocationPrivacyConfirmStatus(type : LocationPrivacyType, isConfirmed : boolean) : Promise<boolean>; + +设置用户勾选定位服务隐私申明的状态，记录用户是否同意启用定位服务。只有系统应用才能调用。 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | LocationPrivacyType | 是 | 指定隐私申明场景，例如开机向导中的隐私申明、开启网络定位功能时弹出的隐私申明等。 | + | isConfirmed | boolean | 是 | 表示用户是否同意定位服务隐私申明。 | + +- 返回值： + | 参数名 | 说明 | + | -------- | -------- | + | Promise<boolean> | 表示操作是否成功。 | + +- 示例： + + ``` + geolocation.setLocationPrivacyConfirmStatus(1, true).then((result) => { + console.log('promise, setLocationPrivacyConfirmStatus: ' + result); + }); + ``` + + + +## LocationRequestPriority + +位置请求中位置信息优先级设置。 + + | 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| UNSET | 0x200 | 表示未设置优先级。 | +| ACCURACY | 0x201 | 表示精度优先。 | +| LOW_POWER | 0x202 | 表示低功耗优先。 | +| FIRST_FIX | 0x203 | 表示快速获取位置优先，如果应用希望快速拿到1个位置，可以将优先级设置为该字段。 | + + +## LocationRequestScenario + + 位置请求中定位场景设置。 + | 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| UNSET | 0x300 | 表示未设置场景信息。 | +| NAVIGATION | 0x301 | 表示导航场景。 | +| TRAJECTORY_TRACKING | 0x302 | 表示运动轨迹记录场景。 | +| CAR_HAILING | 0x303 | 表示打车场景。 | +| DAILY_LIFE_SERVICE | 0x304 | 表示日常服务使用场景。 | +| NO_POWER | 0x305 | 表示无功耗功场景，这种场景下不会主动触发定位，会在其他应用定位时，才给当前应用返回位置。 | + + +## GeoLocationErrorCode + +位置服务中的错误码信息。 + + | 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| INPUT_PARAMS_ERROR | 101 | 表示输入参数错误。 | +| REVERSE_GEOCODE_ERROR | 102 | 表示逆地理编码接口调用失败。 | +| GEOCODE_ERROR | 103 | 表示地理编码接口调用失败。 | +| LOCATOR_ERROR | 104 | 表示定位失败。 | +| LOCATION_SWITCH_ERROR | 105 | 表示定位开关。 | +| LAST_KNOWN_LOCATION_ERROR | 106 | 表示获取上次位置失败。 | +| LOCATION_REQUEST_TIMEOUT_ERROR | 107 | 表示单次定位，没有在指定时间内返回位置。 | + + +## ReverseGeoCodeRequest + +逆地理编码请求接口。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| locale | string | 否 | 指定位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 表示经度信息，正值表示东经，负值表示西经。 | +| maxItems | number | 否 | 指定返回位置信息的最大个数。 | + + +## GeoCodeRequest + +地理编码请求接口。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| description | number | 是 | 表示位置信息描述，如“上海市浦东新区xx路xx号”。 | +| maxItems | number | 否 | 表示返回位置信息的最大个数。 | +| minLatitude | number | 否 | 表示最小纬度信息，与下面三个参数一起，表示一个经纬度范围。 | +| minLongitude | number | 否 | 表示最小经度信息。 | +| maxLatitude | number | 否 | 表示最大纬度信息。 | +| maxLongitude | number | 否 | 表示最大经度信息。 | + + +## GeoAddress + +地理编码类型。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| latitude | number | 否 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 否 | 表示经度信息，正值表示东经，负值表是西经。 | +| locale | string | 否 | 表示位置描述信息的语言，“zh”代表中文，“en”代表英文。 | +| placeName | string | 否 | 表示地区信息。 | +| countryCode | string | 否 | 表示国家码信息。 | +| countryName | string | 否 | 表示国家信息。 | +| administrativeArea | string | 否 | 表示省份区域信息。 | +| subAdministrativeArea | string | 否 | 表示表示子区域信息。 | +| locality | string | 否 | 表示城市信息。 | +| subLocality | string | 否 | 表示子城市信息。 | +| roadName | string | 否 | 表示路名信息。 | +| subRoadName | string | 否 | 表示子路名信息。 | +| premises | string | 否 | 表示门牌号信息。 | +| postalCode | string | 否 | 表示邮政编码信息。 | +| phoneNumber | string | 否 | 表示联系方式信息。 | +| addressUrl | string | 否 | 表示位置信息附件的网址信息。 | +| descriptions | Array<string> | 否 | 表示附加的描述信息。 | +| descriptionsSize | number | 否 | 表示附加的描述信息数量。 | + + +## LocationRequest + +位置信息请求类型。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 是 | 表示场景信息。 | +| timeInterval | number | 否 | 表示上报位置信息的时间间隔。 | +| distanceInterval | number | 否 | 表示上报位置信息的距离间隔。 | +| maxAccuracy | number | 否 | 表示精度信息。 | + + +## CurrentLocationRequest + +当前位置信息请求类型。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| priority | [LocationRequestPriority](#locationrequestpriority) | 否 | 表示优先级信息。 | +| scenario | [LocationRequestScenario](#locationrequestscenario) | 否 | 表示场景信息。 | +| maxAccuracy | number | 否 | 表示精度信息，单位是米。 | +| timeoutMs | number | 否 | 表示超时时间，单位是毫秒，最小为1000毫秒。 | + + +## SatelliteStatusInfo + +卫星状态信息。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| satellitesNumber | number | 是 | 表示卫星个数。 | +| satelliteIds | Array<number> | 是 | 表示每个卫星的ID，数组类型。 | +| carrierToNoiseDensitys | Array<number> | 是 | 表示载波噪声功率谱密度比，即cn0。 | +| altitudes | Array<number> | 是 | 表示高程信息。 | +| azimuths | Array<number> | 是 | 表示方位角。 | +| carrierFrequencies | Array<number> | 是 | 表示载波频率。 | + + +## CachedGnssLocationsRequest + +请求订阅GNSS缓存位置上报功能接口的配置参数。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| reportingPeriodSec | number | 是 | 表示GNSS缓存位置上报的周期，单位是毫秒。 | +| wakeUpCacheQueueFull | boolean | 是 | true表示GNSS芯片底层缓存队列满之后会主动唤醒AP芯片，并把缓存位置上报给应用。
false表示GNSS芯片底层缓存队列满之后不会主动唤醒AP芯片，会把缓存位置直接丢弃。 | + + +## Geofence + +GNSS围栏的配置参数。目前只支持圆形围栏。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| latitude | number | 是 | 表示纬度。 | +| longitude | number | 是 | 表示经度。 | +| radius | number | 是 | 表示圆形围栏的半径。 | +| expiration | number | 是 | 围栏存活的时间，单位是毫秒。 | + + +## GeofenceRequest + +请求添加GNSS围栏消息中携带的参数，包括定位优先级、定位场景和围栏信息。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| priority | LocationRequestPriority | 是 | 表示位置信息优先级。 | +| scenario | LocationRequestScenario | 是 | 表示定位场景。 | +| geofence | Geofence | 是 | 表示围栏信息。 | + + +## LocationPrivacyType + +定位服务隐私协议类型。 + + | 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| OTHERS | 0 | 其他场景。 | +| STARTUP | 1 | 开机向导场景下的隐私协议。 | +| CORE_LOCATION | 2 | 开启网络定位时弹出的隐私协议。 | + + +## LocationCommand + +扩展命令结构体。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| scenario | LocationRequestScenario | 是 | 表示定位场景。 | +| command | string | 是 | 扩展命令字符串。 | + + +## Location + +位置信息类型。 + + | 名称 | 参数类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| latitude | number | 是 | 表示纬度信息，正值表示北纬，负值表示南纬。 | +| longitude | number | 是 | 表示经度信息，正值表示东经，负值表是西经。 | +| altitude | number | 是 | 表示高度信息，单位米。 | +| accuracy | number | 是 | 表示精度信息，单位米。 | +| speed | number | 是 | 表示速度信息，单位米每秒。 | +| timeStamp | number | 是 | 表示位置时间戳，UTC格式。 | +| direction | number | 是 | 表示航向信息。 | +| timeSinceBoot | number | 是 | 表示位置时间戳，开机时间格式。 | +| additions | Array<string> | 否 | 附加信息。 | +| additionSize | number | 否 | 附加信息数量。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-media.md b/zh-cn/application-dev/reference/apis/js-apis-media.md index bc8c7da071..7aec07780e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-media.md +++ b/zh-cn/application-dev/reference/apis/js-apis-media.md @@ -259,7 +259,7 @@ Codec MIME类型枚举。 ## AudioPlayer -音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过[createAudioPlayer()](#media.createaudioplayer)构建一个[AudioPlayer](#audioplayer)实例。 +音频播放管理类，用于管理和播放音频媒体。在调用AudioPlayer的方法前，需要先通过[createAudioPlayer()](#mediacreateaudioplayer)构建一个[AudioPlayer](#audioplayer)实例。 音频播放demo可参考：[音频播放开发指导](../../media/audio-playback.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-rpc.md b/zh-cn/application-dev/reference/apis/js-apis-rpc.md new file mode 100644 index 0000000000..87c36cf542 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-rpc.md @@ -0,0 +1,3818 @@ +# RPC通信 + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + + +``` +import rpc from '@ohos.rpc'; +``` + + +## 权限列表 + +无 + + +## MessageParcel + +该类提供读写基础类型及数组、IPC对象、接口描述符和自定义序列化对象的方法。 + + +### create + +create(): MessageParcel + +静态方法，创建MessageParcel对象。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | MessageParcel | 返回创建的MessageParcel对象。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + console.log("RpcClient: data is " + data); + ``` + + +### reclaim + +reclaim(): void + +释放不再使用的MessageParcel对象。 + + +- 示例 + + ``` + let reply = rpc.MessageParcel.create(); + reply.reclaim(); + ``` + + +### writeRemoteObject + +writeRemoteObject(object: [IRemoteObject](#iremoteobject)): boolean + + 序列化远程对象并将其写入MessageParcel对象。 +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | object | [IRemoteObject](#iremoteobject) | 是 | 要序列化并写入MessageParcel的远程对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果操作成功，则返回true；否则返回false。 | + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let data = rpc.MessageParcel.create(); + let testRemoteObject = new TestRemoteObject("testObject"); + data.writeRemoteObject(testRemoteObject); + ``` + + +### readRemoteObject + +readRemoteObject(): IRemoteObject + +从MessageParcel读取远程对象。此方法用于反序列化MessageParcel对象以生成IRemoteObject。远程对象按写入MessageParcel的顺序读取。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | [IRemoteObject](#iremoteobject) | 读取到的远程对象。 | + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let data = rpc.MessageParcel.create(); + let testRemoteObject = new TestRemoteObject("testObject"); + data.writeRemoteObject(testRemoteObject); + let proxy = data.readRemoteObject(); + ``` + + +### writeInterfaceToken + +writeInterfaceToken(token: string): boolean + +将接口描述符写入MessageParcel对象。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | token | string | 是 | 字符串类型描述符。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果操作成功，则返回true；否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeInterfaceToken("aaa"); + console.log("RpcServer: writeInterfaceToken is " + result); + ``` + + +### readInterfaceToken + +readInterfaceToken(): string + +从MessageParcel中读取接口描述符。接口描述符按写入MessageParcel的顺序读取。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回读取到的接口描述符。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let interfaceToken = data.readInterfaceToken(); + console.log("RpcServer: interfaceToken is " + interfaceToken); + return true; + } + } + ``` + + +### getSize + +getSize(): number + +获取当前MessageParcel的数据大小。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 获取的MessageParcel的数据大小。以字节为单位。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let size = data.getSize(); + console.log("RpcClient: size is " + size); + ``` + + +### getCapacity + +getCapacity(): number + +获取当前MessageParcel的容量。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 获取的MessageParcel的容量大小。以字节为单位。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.getCapacity(); + console.log("RpcClient: capacity is " + result); + ``` + + +### setSize + +setSize(size: number): boolean + +设置MessageParcel实例中包含的数据大小。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | size | number | 是 | MessageParcel实例的数据大小。以字节为单位。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 设置成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let setSize = data.setSize(16); + console.log("RpcClient: setSize is " + setSize); + ``` + + +### setCapacity + +setCapacity(size: number): boolean + +设置MessageParcel实例的存储容量。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | size | number | 是 | MessageParcel实例的存储容量。以字节为单位。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 设置成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.setCapacity(100); + console.log("RpcClient: setCapacity is " + result); + ``` + + +### getWritableBytes + +getWritableBytes(): number + +获取MessageParcel的可写字节空间。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 获取到的MessageParcel的可写字节空间。以字节为单位。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let getWritableBytes = data.getWritableBytes(); + console.log("RpcServer: getWritableBytes is " + getWritableBytes); + return true; + } + } + ``` + + +### getReadableBytes + +getReadableBytes(): number + +获取MessageParcel的可读字节空间。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 获取到的MessageParcel的可读字节空间。以字节为单位。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let result = data.getReadableBytes(); + console.log("RpcServer: getReadableBytes is " + result); + return true; + } + } + ``` + + +### getReadPosition + +getReadPosition(): number + +获取MessageParcel的读位置。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回MessageParcel实例中的当前读取位置。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let readPos = data.getReadPosition(); + console.log("RpcClient: readPos is " + readPos); + ``` + + +### getWritePosition + +getWritePosition(): number + +获取MessageParcel的写位置。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回MessageParcel实例中的当前写入位置。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + data.writeInt(10); + let bwPos = data.getWritePosition(); + console.log("RpcClient: bwPos is " + bwPos); + ``` + + +### rewindRead + +rewindRead(pos: number): boolean + +重新偏移读取位置到指定的位置。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | pos | number | 是 | 开始读取数据的目标位置。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果读取位置发生更改，则返回true；否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + data.writeInt(12); + data.writeString("parcel"); + let number = data.readInt(); + console.log("RpcClient: number is " + number); + data.rewindRead(0); + let number2 = data.readInt(); + console.log("RpcClient: rewindRead is " + number2); + ``` + + +### rewindWrite + +rewindWrite(pos: number): boolean + +重新偏移写位置到指定的位置。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | pos | number | 是 | 开始写入数据的目标位置。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果写入位置更改，则返回true；否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + data.writeInt(4); + data.rewindWrite(0); + data.writeInt(5); + let number = data.readInt(); + console.log("RpcClient: rewindWrite is: " + number); + ``` + + +### writeByte + +writeByte(val: number): boolean + +将字节值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的字节值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回成功，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeByte(2); + console.log("RpcClient: writeByte is: " + result); + ``` + + +### readByte + +readByte(): number + +从MessageParcel实例读取字节值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回字节值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeByte(2); + console.log("RpcClient: writeByte is: " + result); + let ret = data.readByte(); + console.log("RpcClient: readByte is: " + ret); + ``` + + +### writeShort + +writeShort(val: number): boolean + +将短整数值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的短整数值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShort(8); + console.log("RpcClient: writeShort is: " + result); + ``` + + +### readShort + +readShort(): number + +从MessageParcel实例读取短整数值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回短整数值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShort(8); + console.log("RpcClient: writeShort is: " + result); + let ret = data.readShort(); + console.log("RpcClient: readShort is: " + ret); + ``` + + +### writeInt + +writeInt(val: number): boolean + +将整数值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的整数值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回成功，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeInt(10); + console.log("RpcClient: writeInt is " + result); + ``` + + +### readInt + +readInt(): number + +从MessageParcel实例读取整数值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回整数值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeInt(10); + console.log("RpcClient: writeInt is " + result); + let ret = data.readInt(); + console.log("RpcClient: readInt is " + ret); + ``` + + +### writeLong + +writeLong(val: number): boolean + +将长整数值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的长整数值 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLong(10000); + console.log("RpcClient: writeLong is " + result); + ``` + + +### readLong + +readLong(): number + +从MessageParcel实例中读取长整数值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回长整数值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLong(10000); + console.log("RpcClient: writeLong is " + result); + let ret = data.readlong(); + console.log("RpcClient: readLong is " + ret); + ``` + + +### writeFloat + +writeFloat(val: number): boolean + +将浮点值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的浮点值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloat(1.2); + console.log("RpcClient: writeFloat is " + result); + ``` + + +### readFloat + +readFloat(): number + +从MessageParcel实例中读取浮点值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回浮点值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloat(1.2); + console.log("RpcClient: writeFloat is " + result); + let ret = data.readFloat(); + console.log("RpcClient: readFloat is " + ret); + ``` + + +### writeDouble + +writeDouble(val: number): boolean + +将双精度浮点值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的双精度浮点值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDouble(10.2); + console.log("RpcClient: writeDouble is " + result); + ``` + + +### readDouble + +readDouble(): number + +从MessageParcel实例读取双精度浮点值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回双精度浮点值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDouble(10.2); + console.log("RpcClient: writeDouble is " + result); + let ret = data.readDouble(); + console.log("RpcClient: readDouble is " + ret); + ``` + + +### writeBoolean + +writeBoolean(val: boolean): boolean + +将布尔值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | boolean | 是 | 要写入的布尔值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBoolean(false); + console.log("RpcClient: writeBoolean is " + result); + ``` + + +### readBoolean + +readBoolean(): boolean + +从MessageParcel实例读取布尔值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 返回读取到的布尔值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBoolean(false); + console.log("RpcClient: writeBoolean is " + result); + let ret = data.readBoolean(); + console.log("RpcClient: readBoolean is " + ret); + ``` + + +### writeChar + +writeChar(val: number): boolean + +将单个字符值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | number | 是 | 要写入的单个字符值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeChar('a'); + console.log("RpcClient: writeChar is " + result); + ``` + + +### readChar + +readChar(): number + +从MessageParcel实例中读取单个字符值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回单个字符值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeChar('a'); + console.log("RpcClient: writeChar is " + result); + let ret = data.readChar(); + console.log("RpcClient: readChar is " + ret); + ``` + + +### writeString + +writeString(val: string): boolean + +将字符串值写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | string | 是 | 要写入的字符串值。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeString('abc'); + console.log("RpcClient: writeString is " + result); + ``` + + +### readString + +readString(): string + +从MessageParcel实例读取字符串值。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回字符串值。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeString('abc'); + console.log("RpcClient: writeString is " + result); + let ret = data.readString(); + console.log("RpcClient: readString is " + ret); + ``` + + +### writeSequenceable + +writeSequenceable(val: Sequenceable): boolean + +将自定义序列化对象写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | val | [Sequenceable](#sequenceable) | 是 | 要写入的可序列对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + ``` + + +### readSequenceable + +readSequenceable(dataIn: Sequenceable) : boolean + +从MessageParcel实例中读取成员变量到指定的对象（dataIn）。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | [Sequenceable](#sequenceable) | 是 | 需要从MessageParcel读取成员变量的对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果反序列成功，则返回true；否则返回false。 | + +- 示例 + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + let ret = new MySequenceable(0, ""); + let result2 = data.readSequenceable(ret); + console.log("RpcClient: writeSequenceable is " + result2); + ``` + + +### writeByteArray + +writeByteArray(byteArray: number[]): boolean + +将字节数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | byteArray | number[] | 是 | 要写入的字节数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let result = data.writeByteArray(ByteArrayVar); + console.log("RpcClient: writeByteArray is " + result); + ``` + + +### readByteArray + +readByteArray(dataIn: number[]) : void + +从MessageParcel实例读取字节数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | 是 | 要读取的字节数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let result = data.writeByteArray(ByteArrayVar); + console.log("RpcClient: writeByteArray is " + result); + let array = new Array(5); + data.readByteArray(array); + ``` + + +### readByteArray + +readByteArray(): number[] + +从MessageParcel实例中读取字节数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回字节数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let result = data.writeByteArray(ByteArrayVar); + console.log("RpcClient: writeByteArray is " + result); + let array = data.readByteArray(); + console.log("RpcClient: readByteArray is " + array); + ``` + + +### writeShortArray + +writeShortArray(shortArray: number[]): boolean + +将短整数数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | shortArray | number[] | 是 | 要写入的短整数数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShortArray([11, 12, 13]); + console.log("RpcClient: writeShortArray is " + result); + ``` + + +### readShortArray + +readShortArray(dataIn: number[]) : void + +从MessageParcel实例中读取短整数数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | 是 | 要读取的短整数数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShortArray([11, 12, 13]); + console.log("RpcClient: writeShortArray is " + result); + let array = new Array(3); + data.readShortArray(array); + ``` + + +### readShortArray + +readShortArray(): number[] + +从MessageParcel实例中读取短整数数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回短整数数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeShortArray([11, 12, 13]); + console.log("RpcClient: writeShortArray is " + result); + let array = data.readShortArray(); + console.log("RpcClient: readShortArray is " + array); + ``` + + +### writeIntArray + +writeIntArray(intArray: number[]): boolean + +将整数数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | intArray | number[] | 是 | 要写入的整数数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeIntArray([100, 111, 112]); + console.log("RpcClient: writeIntArray is " + result); + ``` + + +### readIntArray + +readIntArray(dataIn: number[]) : void + +从MessageParcel实例中读取整数数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | 是 | 要读取的整数数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeIntArray([100, 111, 112]); + console.log("RpcClient: writeIntArray is " + result); + let array = new Array(3); + data.readIntArray(array); + ``` + + +### readIntArray + +readIntArray(): number[] + +从MessageParcel实例中读取整数数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回整数数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeIntArray([100, 111, 112]); + console.log("RpcClient: writeIntArray is " + result); + let array = data.readIntArray(); + console.log("RpcClient: readIntArray is " + array); + ``` + + +### writeLongArray + +writeLongArray(longArray: number[]): boolean + +将长整数数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | longArray | number[] | 是 | 要写入的长整数数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLongArray([1111, 1112, 1113]); + console.log("RpcClient: writeLongArray is " + result); + ``` + + +### readLongArray + +readLongArray(dataIn: number[]) : void + +从MessageParcel实例读取长整数数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | 是 | 要读取的长整数数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLongArray([1111, 1112, 1113]); + console.log("RpcClient: writeLongArray is " + result); + let array = new Array(3); + data.readLongArray(array); + ``` + + +### readLongArray + +readLongArray(): number[] + +从MessageParcel实例中读取长整数数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回长整数数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeLongArray([1111, 1112, 1113]); + console.log("RpcClient: writeLongArray is " + result); + let array = data.readLongArray(); + console.log("RpcClient: readLongArray is " + array); + ``` + + +### writeFloatArray + +writeFloatArray(floatArray: number[]): boolean + +将浮点数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | floatArray | number[] | 是 | 要写入的浮点数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloatArray([1.2, 1.3, 1.4]); + console.log("RpcClient: writeFloatArray is " + result); + ``` + + +### readFloatArray + +readFloatArray(dataIn: number[]) : void + +从MessageParcel实例中读取浮点数组。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | 是 | 要读取的浮点数组。 | + + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloatArray([1.2, 1.3, 1.4]); + console.log("RpcClient: writeFloatArray is " + result); + let array = new Array(3); + data.readFloatArray(array); + ``` + + +### readFloatArray + +readFloatArray(): number[] + +从MessageParcel实例中读取浮点数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回浮点数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeFloatArray([1.2, 1.3, 1.4]); + console.log("RpcClient: writeFloatArray is " + result); + let array = data.readFloatArray(); + console.log("RpcClient: readFloatArray is " + array); + ``` + + +### writeDoubleArray + +writeDoubleArray(doubleArray: number[]): boolean + +将双精度浮点数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | doubleArray | number[] | 是 | 要写入的双精度浮点数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDoubleArray([11.1, 12.2, 13.3]); + console.log("RpcClient: writeDoubleArray is " + result); + ``` + + +### readDoubleArray + +readDoubleArray(dataIn: number[]) : void + +从MessageParcel实例中读取双精度浮点数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | number[] | 是 | 要读取的双精度浮点数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDoubleArray([11.1, 12.2, 13.3]); + console.log("RpcClient: writeDoubleArray is " + result); + let array = new Array(3); + data.readDoubleArray(array); + ``` + + +### readDoubleArray + +readDoubleArray(): number[] + +从MessageParcel实例读取双精度浮点数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回双精度浮点数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeDoubleArray([11.1, 12.2, 13.3]); + console.log("RpcClient: writeDoubleArray is " + result); + let array = data.readDoubleArray(); + console.log("RpcClient: readDoubleArray is " + array); + ``` + + +### writeBooleanArray + +writeBooleanArray(booleanArray: boolean[]): boolean + +将布尔数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | booleanArray | boolean[] | 是 | 要写入的布尔数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBooleanArray([false, true, false]); + console.log("RpcClient: writeBooleanArray is " + result); + ``` + + +### readBooleanArray + +readBooleanArray(dataIn: boolean[]) : void + +从MessageParcel实例中读取布尔数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | boolean[] | 是 | 要读取的布尔数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBooleanArray([false, true, false]); + console.log("RpcClient: writeBooleanArray is " + result); + let array = new Array(3); + data.readBooleanArray(array); + ``` + + +### readBooleanArray + +readBooleanArray(): boolean[] + +从MessageParcel实例中读取布尔数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean[] | 返回布尔数组。 | + + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeBooleanArray([false, true, false]); + console.log("RpcClient: writeBooleanArray is " + result); + let array = data.readBooleanArray(); + console.log("RpcClient: readBooleanArray is " + array); + ``` + + +### writeCharArray + +writeCharArray(charArray: number[]): boolean + +将单个字符数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | charArray | number[] | 是 | 要写入的单个字符数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeCharArray(['a', 'b', 'c']); + console.log("RpcClient: writeCharArray is " + result); + ``` + + +### readCharArray + +readCharArray(dataIn: boolean[]) : void + +从MessageParcel实例中读取单个字符数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | boolean[] | 是 | 要读取的单个字符数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeCharArray(['a', 'b', 'c']); + console.log("RpcClient: writeCharArray is " + result); + let array = new Array(3); + data.readCharArray(array); + ``` + + +### readCharArray + +readCharArray(): boolean[] + +从MessageParcel实例读取单个字符数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean[] | 返回单个字符数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeCharArray(['a', 'b', 'c']); + console.log("RpcClient: writeCharArray is " + result); + let array = data.readCharArray(); + console.log("RpcClient: readCharArray is " + array); + ``` + + +### writeStringArray + +writeStringArray(stringArray: string[]): boolean + +将字符串数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | stringArray | string[] | 是 | 要写入的字符串数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeStringArray(["abc", "def"]); + console.log("RpcClient: writeStringArray is " + result); + ``` + + +### readStringArray + +readStringArray(dataIn: string[]) : void + +从MessageParcel实例读取字符串数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | string[] | 是 | 要读取的字符串数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeStringArray(["abc", "def"]); + console.log("RpcClient: writeStringArray is " + result); + let array = new Array(2); + data.readStringArray(array); + ``` + + +### readStringArray + +readStringArray(): string[] + +从MessageParcel实例读取字符串数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string[] | 返回字符串数组。 | + +- 示例 + + ``` + let data = rpc.MessageParcel.create(); + let result = data.writeStringArray(["abc", "def"]); + console.log("RpcClient: writeStringArray is " + result); + let array = data.readStringArray(); + console.log("RpcClient: readStringArray is " + array); + ``` + + +### writeNoException8+ + +writeNoException(): void + +向MessageParcel写入“指示未发生异常”的信息。 + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + onRemoteRequest(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: onRemoteRequest called"); + reply.writeNoException(); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + } + ``` + + +### readException8+ + +readException(): void + +从MessageParcel中读取异常。 + + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option) + .then(function(errCode) { + if (errCode === 0) { + console.log("sendRequest got result"); + reply.readException(); + let msg = reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +### writeSequenceableArray + +writeSequenceableArray(sequenceableArray: Sequenceable[]): boolean + +将可序列化对象数组写入MessageParcel实例。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | sequenceableArray | Sequenceable[] | 是 | 要写入的可序列化对象数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 写入成功返回true，否则返回false。 | + +- 示例 + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let sequenceable2 = new MySequenceable(2, "bbb"); + let sequenceable3 = new MySequenceable(3, "ccc"); + let a = [sequenceable, sequenceable2, sequenceable3]; + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceableArray(a); + console.log("RpcClient: writeSequenceableArray is " + result); + ``` + + +### readSequenceableArray8+ + +readSequenceableArray(sequenceableArray: Sequenceable[]): void + +从MessageParcel实例读取可序列化对象数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | sequenceableArray | Sequenceable[] | 是 | 要读取的可序列化对象数组。 | + +- 示例 + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let sequenceable2 = new MySequenceable(2, "bbb"); + let sequenceable3 = new MySequenceable(3, "ccc"); + let a = [sequenceable, sequenceable2, sequenceable3]; + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceableArray(a); + console.log("RpcClient: writeSequenceableArray is " + result); + let b = [new MySequenceable(0, ""), new MySequenceable(0, ""), new MySequenceable(0, "")]; + data.readSequenceableArray(b); + ``` + + +### writeRemoteObjectArray8+ + +writeRemoteObjectArray(objectArray: IRemoteObject[]): boolean + +将IRemoteObject对象数组写入MessageParcel。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | objectArray | IRemoteObject[] | 是 | 要写入MessageParcel的IRemoteObject对象数组。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果IRemoteObject对象数组成功写入MessageParcel，则返回true；如果对象为null或数组写入MessageParcel失败，则返回false。 | + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")]; + let data = rpc.MessageParcel.create(); + let result = data.writeRemoteObjectArray(a); + console.log("RpcClient: writeRemoteObjectArray is " + result); + ``` + + +### readRemoteObjectArray8+ + +readRemoteObjectArray(objects: IRemoteObject[]): void + +从MessageParcel读取IRemoteObject对象数组。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | objects | IRemoteObject[] | 是 | 从MessageParcel读取的IRemoteObject对象数组。 | + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")]; + let data = rpc.MessageParcel.create(); + let result = data.writeRemoteObjectArray(a); + let b = new Array(3); + data.readRemoteObjectArray(b); + ``` + + +### readRemoteObjectArray8+ + +readRemoteObjectArray(): IRemoteObject[] + +从MessageParcel读取IRemoteObject对象数组。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | IRemoteObject[] | 返回IRemoteObject对象数组。 | + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let a = [new TestRemoteObject("testObject1"), new TestRemoteObject("testObject2"), new TestRemoteObject("testObject3")]; + let data = rpc.MessageParcel.create(); + let result = data.writeRemoteObjectArray(a); + console.log("RpcClient: readRemoteObjectArray is " + result); + let b = data.readRemoteObjectArray(); + console.log("RpcClient: readRemoteObjectArray is " + b); + ``` + + +### closeFileDescriptor8+ + +static closeFileDescriptor(fd: number): void + +关闭给定的文件描述符。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | fd | number | 是 | 要关闭的文件描述符。 | + +- 示例 + + ``` + import fileio from '@ohos.fileio'; + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + rpc.MessageParcel.closeFileDescriptor(fd); + ``` + + +### dupFileDescriptor8+ + +static dupFileDescriptor(fd: number) :number + +复制给定的文件描述符。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | fd | number | 是 | 表示已存在的文件描述符。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回新的文件描述符。 | + +- 示例 + + ``` + import fileio from '@ohos.fileio'; + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let newFd = rpc.MessageParcel.dupFileDescriptor(fd); + ``` + + +### containFileDescriptors8+ + +containFileDescriptors(): boolean + +检查此MessageParcel对象是否包含文件描述符。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果此MessageParcel对象包含文件描述符，则返回true；否则返回false。 | + +- 示例 + + ``` + import fileio from '@ohos.fileio'; + let parcel = new rpc.MessageParcel(); + let filePath = "path/to/file"; + let r1 = parcel.containFileDescriptors(); + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let writeResult = parcel.writeFileDescriptor(fd); + console.log("RpcTest: parcel writeFd result is : " + writeResult); + let containFD = parcel.containFileDescriptors(); + console.log("RpcTest: parcel after write fd containFd result is : " + containFD); + ``` + + +### writeFileDescriptor8+ + +writeFileDescriptor(fd: number): boolean + +写入文件描述符到MessageParcel。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | fd | number | 是 | 文件描述符。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果操作成功，则返回true；否则返回false。 | + +- 示例 + + ``` + import fileio from '@ohos.fileio'; + let parcel = new rpc.MessageParcel(); + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let writeResult = parcel.writeFileDescriptor(fd); + console.log("RpcTest: parcel writeFd result is : " + writeResult); + ``` + + +### readFileDescriptor8+ + +readFileDescriptor(): number + +从MessageParcel中读取文件描述符。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回文件描述符。 | + +- 示例 + + ``` + import fileio from '@ohos.fileio'; + let parcel = new rpc.MessageParcel(); + let filePath = "path/to/file"; + let fd = fileio.openSync(filePath, 0o2| 0o100, 0o666); + let writeResult = parcel.writeFileDescriptor(fd); + let readFD = parcel.readFileDescriptor(); + console.log("RpcTest: parcel read fd is : " + readFD); + ``` + + +### writeAshmem8+ + +writeAshmem(ashmem: Ashmem): boolean + +将指定的匿名共享对象写入此MessageParcel。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | ashmem | Ashmem | 是 | 要写入MessageParcel的匿名共享对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果匿名共享对象成功写入此MessageParcel，则返回true；否则返回false。 | + +- 示例 + + ``` + let parcel = new rpc.MessageParcel(); + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024); + let isWriteSuccess = parcel.writeAshmem(ashmem); + console.log("RpcTest: write ashmem to result is : " + isWriteSuccess); + ``` + + +### readAshmem8+ + +readAshmem(): Ashmem + +从MessageParcel读取匿名共享对象。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Ashmem | 返回匿名共享对象。 | + +- 示例 + + ``` + let parcel = new rpc.MessageParcel(); + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024); + let isWriteSuccess = parcel.writeAshmem(ashmem); + console.log("RpcTest: write ashmem to result is : " + isWriteSuccess); + let readAshmem = parcel.readAshmem(); + console.log("RpcTest: read ashmem to result is : " + readAshmem); + ``` + + +### getRawDataCapacity8+ + +getRawDataCapacity(): number + +获取MessageParcel可以容纳的最大原始数据量。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回MessageParcel可以容纳的最大原始数据量，即128 Mb。 | + +- 示例 + + ``` + let parcel = new rpc.MessageParcel(); + let result = parcel.getRawDataCapacity(); + console.log("RpcTest: parcel get RawDataCapacity result is : " + result); + ``` + + +### writeRawData8+ + +writeRawData(rawData: number[], size: number): boolean + +将原始数据写入MessageParcel对象。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | rawData | number[] | 是 | 要写入的原始数据。 | + | size | number | 是 | 发送的原始数据大小，以字节为单位。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果操作成功，则返回true；否则返回false。 | + +- 示例 + + ``` + let parcel = new rpc.MessageParcel(); + let arr = new Int8Array([1, 2, 3, 4, 5]); + let isWriteSuccess = parcel.writeRawData(arr, arr.length); + console.log("RpcTest: parcel write raw data result is : " + isWriteSuccess); + ``` + + +### readRawData8+ + +readRawData(size: number): number[] + +从MessageParcel读取原始数据。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | size | number | 是 | 要读取的原始数据的大小。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回原始数据（以字节为单位）。 | + +- 示例 + + ``` + let parcel = new rpc.MessageParcel(); + let arr = new Int8Array([1, 2, 3, 4, 5]); + let isWriteSuccess = parcel.writeRawData(arr, arr.length); + console.log("RpcTest: parcel write raw data result is : " + isWriteSuccess); + let result = parcel.readRawData(5); + console.log("RpcTest: parcel read raw data result is : " + result); + ``` + + +### getDataVersion8+ + +getDataVersion(): number + +从MessageParcel对象返回数据格式版本。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 从MessageParcel返回数据格式版本。 | + +- 示例 + + ``` + let parcel = new rpc.MessageParcel(); + let version = parcel.getDataVersion(); + console.log("RpcTest: parcel get data version is : " + version); + ``` + + +### updateDataVersion8+ + +updateDataVersion(proxy: IRemoteObject): void + +将远程对象数据格式版本更新到MessageParcel对象。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | proxy | IRemoteObject | 是 | 使用该MessageParcel对象发送请求的远程对象。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let parcel = new rpc.MessageParcel(); + parcel.updateDataVersion(proxy); + ``` + + +## Sequenceable + +在进程间通信（IPC）期间，将类的对象写入MessageParcel并从MessageParcel中恢复它们。 + + +### marshalling + +marshalling(dataOut: MessageParcel): boolean + +将此可序列对象封送到MessageParcel中。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataOut | [MessageParcel](#messageparcel) | 是 | 可序列对象将被封送到的MessageParcel对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果封送成功，则返回true；否则返回false。 | + +- 示例 + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + let ret = new MySequenceable(0, ""); + let result2 = data.readSequenceable(ret); + console.log("RpcClient: readSequenceable is " + result2); + ``` + + +### unmarshalling + +unmarshalling(dataIn: MessageParcel) : boolean + +从MessageParcel中解封此可序列对象。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataIn | [MessageParcel](#messageparcel) | 是 | 已将可序列对象封送到其中的MessageParcel对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果可序列化成功，则返回true；否则返回false。 | + +- 示例 + + ``` + class MySequenceable { + constructor(num, string) { + this.num = num; + this.str = string; + } + marshalling(messageParcel) { + messageParcel.writeInt(this.num); + messageParcel.writeString(this.str); + return true; + } + unmarshalling(messageParcel) { + this.num = messageParcel.readInt(); + this.str = messageParcel.readString(); + return true; + } + } + let sequenceable = new MySequenceable(1, "aaa"); + let data = rpc.MessageParcel.create(); + let result = data.writeSequenceable(sequenceable); + console.log("RpcClient: writeSequenceable is " + result); + let ret = new MySequenceable(0, ""); + let result2 = data.readSequenceable(ret); + console.log("RpcClient: readSequenceable is " + result2); + ``` + + +## IRemoteBroker + +远端对象的代理持有者。用于获取代理对象。 + + +### asObject + +asObject(): IRemoteObject + +需派生类实现，获取代理或远端对象。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | [IRemoteObject](#iremoteobject) | 如果调用者是[RemoteObject](#ashmem8)对象，则直接返回本身；如果调用者是[RemoteProxy](#remoteproxy)对象，则返回它的持有者[IRemoteObject](#iremoteobject)。 | + +- 示例 + + ``` + class TestAbility extends rpc.RemoteObject { + asObject() { + return this; + } + } + ``` + +- 示例 + + ``` + class TestProxy { + constructor(remote) { + this.remote = remote; + } + asObject() { + return this.remote; + } + } + ``` + + +## DeathRecipient + +用于订阅远端对象的死亡通知。当被订阅该通知的远端对象死亡时，本端可收到消息，调用[onRemoteDied](#onremotedied)接口。远端对象死亡可以为远端对象所在进程死亡，远端对象所在设备关机或重启，当远端对象与本端对象属于不同设备时，也可为远端对象离开组网时。 + + +### onRemoteDied + +onRemoteDied(): void + +在成功添加死亡通知订阅后，当远端对象死亡时，将自动调用本方法。 + +- 示例 + + ``` + class MyDeathRecipient { + onRemoteDied() { + console.log("server is died"); + } + } + ``` + + +## SendRequestResult8+ + +发送请求的响应结果。 + + | 参数 | 值 | 说明 | +| -------- | -------- | -------- | +| errCode | number | 错误码。 | +| code | number | 消息代码。 | +| data | MessageParcel | 发送给对端进程的MessageParcel对象。 | +| reply | MessageParcel | 对端进程返回的MessageParcel对象。 | + + +## IRemoteObject + +该接口可用于查询或获取接口描述符、添加或删除死亡通知、转储对象状态到特定文件、发送消息。 + + +### queryLocalInterface + +queryLocalInterface(descriptor: string): IRemoteBroker + +查询接口。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | descriptor | string | 是 | 接口描述符的字符串。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | IRemoteBroker | 返回绑定到指定接口描述符的IRemoteBroker对象。 | + + +### sendRequest + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<number>7 + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult>8+ + +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | + | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Promise<number>7
Promise<SendRequestResult>8+ | 返回一个期约，兑现值是sendRequest错误码。0表示成功，其他情况表示失败。7
返回一个期约，兑现值是sendRequestResult实例。8+ | + + +### sendRequest8+ + +sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void + +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | + | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | + | callback | AsyncCallback<SendRequestResult> | 是 | 接收发送结果的回调。 | + + +### addDeathrecipient + +addDeathRecipient(recipient: DeathRecipient, flags: number): boolean + +注册用于接收远程对象死亡通知的回调。如果与RemoteProxy对象匹配的远程对象进程死亡，则调用此方法。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | 是 | 要注册的回调。 | + | flags | number | 是 | 死亡通知标志。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果回调注册成功，则返回true；否则返回false。 | + + +### removeDeathRecipient + +removeDeathRecipient(recipient: DeathRecipient, flags: number): boolean + +注销用于接收远程对象死亡通知的回调。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | 是 | 要注销的回调。 | + | flags | number | 是 | 死亡通知标志。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果回调成功注销，则返回true；否则返回false。 | + + +### getInterfaceDescriptor + +getInterfaceDescriptor(): string + +获取对象的接口描述符。接口描述符为字符串。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回接口描述符。 | + + +### isObjectDead + +isObjectDead(): boolean + +检查当前对象是否死亡。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果对象已死亡，则返回true；否则返回false。 | + + +## RemoteProxy + +实现IRemoteObject代理对象。 + + +### sendRequest + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<number>7 + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult>8+ + +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | + | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Promise<number>7
Promise<SendRequestResult>8+ | 返回一个期约，兑现值是sendRequest错误码。0表示成功，其他情况表示失败。7
返回一个期约，兑现值是sendRequestResult实例。8+ | + +- 示例7 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option) + .then(function(errCode) { + if (errCode === 0) { + console.log("sendRequest got result"); + let msg = reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + +- 示例8+ + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option) + .then(function(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +### sendRequest8+ + +sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void + +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | + | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | + | callback | AsyncCallback<SendRequestResult> | 是 | 接收发送结果的回调。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + function sendRequestCallback(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + console.log("RPCTest: sendRequest ends, reclaim parcel"); + result.data.reclaim(); + result.reply.reclaim(); + } + FA.connectAbility(want, connect); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + proxy.sendRequest(1, data, reply, option, sendRequestCallback); + ``` + + +### queryLocalInterface + +queryLocalInterface(interface: string): IRemoteBroker + +查询并获取当前接口描述符对应的本地接口对象。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | interface | string | 是 | 需要查询的接口描述符。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | IRemoteBroker | 默认返回Null，标识该接口是一个代理侧接口。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function (elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName":"com.huawei.server", + "abilityName":"com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let broker = proxy.queryLocalInterface("testObject"); + console.log("RpcClient: queryLocalInterface is " + broker); + ``` + + +### addDeathRecippient + +addDeathRecipient(recipient : DeathRecipient, flags : number): boolean + +注册用于接收远程对象死亡通知的回调，增加proxy对象上的死亡通知。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | 是 | 收件人表示要注册的回调。 | + | flags | number | 是 | 死亡通知标志。保留参数。设置为0。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果回调注册成功，则返回true；否则返回false。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + class MyDeathRecipient { + onRemoteDied() { + console.log("server is died"); + } + } + let deathRecipient = new MyDeathRecipient(); + proxy.addDeathRecippient(deathRecipient, 0); + ``` + + +### removeDeathRecipient + +removeDeathRecipient(recipient : DeathRecipient, flags : number): boolean + +注销用于接收远程对象死亡通知的回调。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | recipient | [DeathRecipient](#deathrecipient) | 是 | 要注销的死亡回调。 | + | flags | number | 是 | 死亡通知标志。保留参数。设置为0。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果回调成功注销，则返回true；否则返回false。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + class MyDeathRecipient { + onRemoteDied() { + console.log("server is died"); + } + } + let deathRecipient = new MyDeathRecipient(); + proxy.addDeathRecippient(deathRecipient, 0); + proxy.removeDeathRecipient(deathRecipient, 0); + ``` + + +### getInterfaceDescriptor + +getInterfaceDescriptor(): string + +查询当前代理对象接口的描述符。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 当前的接口描述符。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let descriptor = proxy.getInterfaceDescriptor(); + console.log("RpcClient: descriptor is " + descriptor); + ``` + + +### isObjectDead + +isObjectDead(): boolean + +指示对应的RemoteObject是否死亡。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果对应的RemoteObject已经死亡，返回true，否则返回false。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let isDead = proxy.isObjectDead(); + console.log("RpcClient: isObjectDead is " + isDead); + ``` + + +### setDataVersion8+ + +setDataVersion(dataVersion: number): boolean + +将数据格式版本设置到RemoteProxy对象。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | dataVersion | number | 是 | 数据格式版本。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果设置数据格式版本成功，则返回true；否则返回false。 | + +- 示例 + + ``` + import FA from "@ohos.ability.featureAbility"; + let proxy; + let connect = { + onConnect: function(elementName, remoteProxy) { + console.log("RpcClient: js onConnect called."); + proxy = remoteProxy; + }, + onDisconnect: function(elementName) { + console.log("RpcClient: onDisconnect"); + }, + onFailed: function() { + console.log("RpcClient: onFailed"); + } + }; + let want = { + "bundleName": "com.huawei.server", + "abilityName": "com.huawei.server.MainAbility", + }; + FA.connectAbility(want, connect); + let result = proxy.setDataVersion(1); + console.log("RpcClient: set Data Version is " + result); + ``` + + +## MessageOption + +公共消息选项（int标志，int等待时间），使用标志中指定的标志构造指定的MessageOption对象。 + + + | 参数 | 值 | 说明 | +| -------- | -------- | -------- | +| TF_SYNC | 0 | 同步调用。 | +| TF_ASYNC | 1 | 异步调用。 | +| TF_ACCEPT_FDS | 0x10 | 指示[sendRequest](#sendrequest8)接口可以返回文件描述符。 | +| TF_WAIT_TIME | 8 | 等待时间。单位秒。 | + + +### constructor + +constructor(syncFlags?: number, waitTime = TF_WAIT_TIME) + +MessageOption构造函数。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | syncFlags | number | 否 | 同步调用或异步调用标志。默认同步调用。 | + | waitTime | number | 否 | 调用rpc最长等待时间。默认 TF_WAIT_TIME。 | + + +### getFlags + +getFlags(): number + +获取同步调用或异步调用标志。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 调用成功返回同步调用或异步调用标志。 | + + +### setFlags + +setFlags(flags: number): void + +设置同步调用或异步调用标志。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | flags | number | 是 | 同步调用或异步调用标志。 | + + +### getWaitTime + +getWaitTime(): number + +获取rpc调用的最长等待时间。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | rpc最长等待时间。 | + + +### setWaitTime + +setWaitTime(waitTime: number): void + +设置rpc调用最长等待时间。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | waitTime | number | 是 | rpc调用最长等待时间。 | + + +## IPCSkeleton + +用于获取IPC上下文信息，包括获取UID和PID、获取本端和对端设备ID、检查接口调用是否在同一设备上。 + + +### getContextObject + +static getContextObject(): IRemoteObject + +获取系统能力的管理者。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | [IRemoteObject](#iremoteobject) | 返回系统能力管理者。 | + +- 示例 + + ``` + let samgr = rpc.IPCSkeleton.getContextObject(); + console.log("RpcServer: getContextObject result: " + samgr); + ``` + + +### getCallingPid + +static getCallingPid(): number + +获取调用者的PID。此方法由RemoteObject对象在onRemoteRequest方法中调用，不在IPC上下文环境（onRemoteRequest）中调用则返回本进程的PID。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回调用者的PID。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callerPid = rpc.IPCSkeleton.getCallingPid(); + console.log("RpcServer: getCallingPid result: " + callerPid); + return true; + } + } + ``` + + +### getCallingUid + +static getCallingUid(): number + +获取调用者的UID。此方法由RemoteObject对象在onRemoteRequest方法中调用，不在IPC上下文环境（onRemoteRequest）中调用则返回本进程的UID。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回调用者的UID。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callerUid = rpc.IPCSkeleton.getCallingUid(); + console.log("RpcServer: getCallingUid result: " + callerUid); + return true; + } + } + ``` + + +### getCalligDeviceID + +static getCallingDeviceID(): string + +获取调用者进程所在的设备ID。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回调用者进程所在的设备ID。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callerDeviceID = rpc.IPCSkeleton.getCalligDeviceID(); + console.log("RpcServer: callerDeviceID is: " + callerDeviceID); + return true; + } + } + ``` + + +### getLocalDeviceID + +static getLocalDeviceID(): string + +获取本端设备ID。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回本地设备的ID。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let localDeviceID = rpc.IPCSkeleton.getLocalDeviceID(); + console.log("RpcServer: localDeviceID is: " + localDeviceID); + return true; + } + } + ``` + + +### isLocalCalling + +static isLocalCalling(): boolean + +检查当前通信对端是否是本设备的进程。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果调用是在同一设备上进行的，则返回true，否则返回false。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let isLocalCalling = rpc.IPCSkeleton.isLocalCalling(); + console.log("RpcServer: isLocalCalling is: " + isLocalCalling); + return true; + } + } + ``` + + +### flushCommands + +static flushCommands(object : IRemoteObject): number + +将所有挂起的命令从指定的RemoteProxy刷新到相应的RemoteObject。建议在执行任何时间敏感操作之前调用此方法。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | object | [IRemoteObject](#iremoteobject) | 是 | 指定的RemoteProxy。 | + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 如果操作成功，返回0；如果输入对象为空或RemoteObject，或者操作失败，返回错误代码。 | + +- 示例 + + ``` + let remoteObject = new rpc.RemoteObject("aaa", 3); + let ret = rpc.IPCSkeleton.flushCommands(remoteObject); + console.log("RpcServer: flushCommands result: " + ret); + ``` + + +### resetCallingIdentity + +static resetCallingIdentity(): string + +将远程用户的UID和PID替换为本地用户的UID和PID。它可以用于身份验证等场景。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回包含远程用户的UID和PID的字符串。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callingIdentity = rpc.IPCSkeleton.resetCallingIdentity(); + console.log("RpcServer: callingIdentity is: " + callingIdentity); + return true; + } + } + ``` + + +### setCallingIdentity + +static setCallingIdentity(identity : string): boolean + +将UID和PID恢复为远程用户的UID和PID。它通常在使用resetCallingIdentity后调用，需要resetCallingIdentity返回的远程用户的UID和PID。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | identity | string | 是 | 标识表示包含远程用户UID和PID的字符串。由resetCallingIdentity返回。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果操作成功，则返回true；否则返回false。 | + +- 示例 + + ``` + class Stub extends rpc.RemoteObject { + onRemoteRequest(code, data, reply, option) { + let callingIdentity = null; + try { + callingIdentity = rpc.IPCSkeleton.resetCallingIdentity(); + console.log("RpcServer: callingIdentity is: " + callingIdentity); + } finally { + let ret = rpc.IPCSkeleton.setCallingIdentity("callingIdentity "); + console.log("RpcServer: setCallingIdentity is: " + ret); + } + return true; + } + } + ``` + + +## RemoteObject + +实现远程对象。服务提供者必须继承此类。 + + +### constructor + +constructor(descriptor: string) + +RemoteObject构造函数。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | descriptor | string | 是 | 接口描述符。 | + + +### sendRequest + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<number>7 + +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult>8+ + +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则期约立即兑现，reply报文里没有内容。如果为选项设置了同步模式，则期约将在sendRequest返回时兑现，回复内容在reply报文里。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | + | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Promise<number>7
Promise<SendRequestResult>8+ | 返回一个期约，兑现值是sendRequest错误码。0表示成功，其他情况表示失败。7
返回一个期约，兑现值是sendRequestResult实例。8+ | + + +- 示例7 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + testRemoteObject.sendRequest(1, data, reply, option) + .then(function(errCode) { + if (errCode === 0) { + console.log("sendRequest got result"); + let msg = reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +- 示例8+ + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + testRemoteObject.sendRequest(1, data, reply, option) + .then(function(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + }).catch(function(e) { + console.log("RPCTest: sendRequest got exception: " + e.message); + }).finally (() => { + console.log("RPCTest: sendRequest ends, reclaim parcel"); + data.reclaim(); + reply.reclaim(); + }); + ``` + + +### sendRequest8+ + +sendRequest(code: number, data: MessageParcel, reply: MessageParcel, options: MessageOption, callback: AsyncCallback<SendRequestResult>): void + +以同步或异步方式向对端进程发送MessageParcel消息。如果为选项设置了异步模式，则立即收到回调，reply报文里没有内容。如果为选项设置了同步模式，则将在sendRequest返回时收到回调，回复内容在reply报文里。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 本次请求调用的消息码，由通信双方确定。如果接口由IDL工具生成，则消息代码由IDL自动生成。 | + | data | [MessageParcel](#messageparcel) | 是 | 保存待发送数据的 MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 接收应答数据的MessageParcel对象。 | + | options | [MessageOption](#messageoption) | 是 | 本次请求的同异步模式，默认同步调用。 | + | AsyncCallback | AsyncCallback<SendRequestResult> | 是 | 接收发送结果的回调。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + function sendRequestCallback(result) { + if (result.errCode === 0) { + console.log("sendRequest got result"); + result.reply.readException(); + let msg = result.reply.readString(); + console.log("RPCTest: reply msg: " + msg); + } else { + console.log("RPCTest: sendRequest failed, errCode: " + result.errCode); + } + console.log("RPCTest: sendRequest ends, reclaim parcel"); + result.data.reclaim(); + result.reply.reclaim(); + } + let testRemoteObject = new TestRemoteObject("testObject"); + let option = new rpc.MessageOption(); + let data = rpc.MessageParcel.create(); + let reply = rpc.MessageParcel.create(); + data.writeInt(1); + data.writeString("hello"); + testRemoteObject.sendRequest(1, data, reply, option, sendRequestCallback); + ``` + + +### onRemoteRequest + +onRemoteRequest(code : number, data : MessageParcel, reply: MessageParcel, options : MessageOption): boolean + +sendRequest请求的响应处理函数，服务端在该函数里处理请求，回复结果。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | code | number | 是 | 对端发送的服务请求码。 | + | data | [MessageParcel](#messageparcel) | 是 | 携带客户端调用参数的MessageParcel对象。 | + | reply | [MessageParcel](#messageparcel) | 是 | 写入结果的MessageParcel对象。 | + | option | [MessageOption](#messageoption) | 是 | 指示操作是同步还是异步。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果操作成功，则返回true；否则返回false。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + + onRemoteRequest(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: onRemoteRequest called"); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + } + ``` + + +### getCallingUid + +getCallingUid(): number + +获取通信对端的进程Uid。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回通信对端的进程Uid。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + console.log("RpcServer: getCallingUid: " + testRemoteObject.getCallingUid()); + ``` + + +### getCallingPid + +getCallingPid(): number + +获取通信对端的进程Pid。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回通信对端的进程Pid。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + console.log("RpcServer: getCallingPid: " + testRemoteObject.getCallingPid()); + ``` + + +### queryLocalInterface + +queryLocalInterface(descriptor: descriptor): IRemoteBroker + +查询并获取当前接口描述符对应的远端对象是否已经存在。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | descriptor | descriptor | 是 | 需要查询的接口描述符。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | IRemoteBroker | 如果接口描述符对应的远端对象存在，则返回该远端对象，否则返回Null。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let broker = testRemoteObject.queryLocalInterface("testObject"); + ``` + + +### getInterfaceDescriptor + +getInterfaceDescriptor(): string + +查询接口描述符。 + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | string | 返回接口描述符。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + let descriptor = testRemoteObject.getInterfaceDescriptor(); + console.log("RpcServer: descriptor is: " + descriptor); + ``` + + +### attachLocalInterface + +attachLocalInterface(localInterface: IRemoteBroker, descriptor: string): void + +此接口用于把接口描述符和IRemoteBroker对象绑定。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | localInterface | IRemoteBroker | 是 | 将与描述符绑定的IRemoteBroker对象。 | + | descriptor | string | 是 | 用于与IRemoteBroker对象绑定的描述符。 | + + +- 示例 + + ``` + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + this.attachLocalInterface(this, descriptor); + } + } + let testRemoteObject = new TestRemoteObject("testObject"); + ``` + + +## Ashmem8+ + +提供与匿名共享内存对象相关的方法，包括创建、关闭、映射和取消映射Ashmem、从Ashmem读取数据和写入数据、获取Ashmem大小、设置Ashmem保护。 + +映射内存保护类型： + + | 参数名 | 值 | 说明 | +| -------- | -------- | -------- | +| PROT_EXEC | 4 | 映射的内存可执行 | +| PROT_NONE | 0 | 映射的内存不可访问 | +| PROT_READ | 1 | 映射的内存可读 | +| PROT_WRITE | 2 | 映射的内存可写 | + + +### createAshmem + +static createAshmem(name: string, size: number): Ashmem + +根据指定的名称和大小创建Ashmem对象。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | name | string | 是 | 名称，用于查询Ashmem信息。 | + | size | number | 是 | Ashmem的大小，以字节为单位。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Ashmem | 返回创建的Ashmem对象；如果创建失败，返回null。 | + + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let size = ashmem.getAshmemSize(); + console.log("RpcTest: get ashemm by createAshmem : " + ashmem + " size is : " + size); + ``` + + +### createAshmemFromExisting + +static createAshmemFromExisting(ashmem: Ashmem): Ashmem + +通过复制现有Ashmem对象的文件描述符(fd)来创建Ashmem对象。两个Ashmem对象指向同一个共享内存区域。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | ashmem | Ashmem | 是 | 已存在的Ashmem对象。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | Ashmem | 返回创建的Ashmem对象。 | + + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let ashmem2 = rpc.Ashmem.createAshmemFromExisting(ashmem); + let size = ashmem2.getAshmemSize(); + console.log("RpcTest: get ashemm by createAshmemFromExisting : " + ashmem2 + " size is : " + size); + ``` + + +### closeAshmem + +closeAshmem(): void + +关闭这个Ashmem。 + + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + ashmem.closeAshmem(); + ``` + + +### unmapAshmem + +unmapAshmem(): void + +删除该Ashmem对象的地址映射。 + + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + ashmem.unmapAshmem(); + ``` + + +### getAshmemSize + +getAshmemSize(): number + +获取Ashmem对象的内存大小。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number | 返回Ashmem对象的内存大小。 | + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let size = ashmem.getAshmemSize(); + console.log("RpcTest: get ashmem is " + ashmem + " size is : " + size); + ``` + + +### mapAshmem + +mapAshmem(mapType: number): boolean + +在此进程的虚拟地址空间上创建共享文件映射，映射区域大小由此Ashmem对象指定。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | mapType | number | 是 | 指定映射的内存区域的保护等级。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果映射成功，则返回true；否则返回false。 | + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let mapReadAndWrite = ashmem.mapAshmem(rpc.Ashmem.PROT_READ | rpc.Ashmem.PROT_WRITE); + console.log("RpcTest: map ashmem result is : " + mapReadAndWrite); + ``` + + +### mapReadAndWriteAshmem + +mapReadAndWriteAshmem(): boolean + +在此进程虚拟地址空间上创建可读写的共享文件映射。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果映射成功，则返回true；否则返回false。 | + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let mapResult = ashmem.mapReadAndWriteAshmem(); + console.log("RpcTest: map ashmem result is : " + mapResult); + ``` + + +### mapReadOnlyAshmem + +mapReadOnlyAshmem(): boolean + +在此进程虚拟地址空间上创建只读的共享文件映射。 + + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果映射成功，则返回true；否则返回false。 | + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let mapResult = ashmem.mapReadOnlyAshmem(); + console.log("RpcTest: Ashmem mapReadOnlyAshmem result is : " + mapResult); + ``` + + +### setProtection + +setProtection(protectionType: number): boolean + +设置映射内存区域的保护等级。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | protectionType | number | 是 | 要设置的保护类型。 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果设置成功，则返回true；否则返回false。 | + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + let result = ashmem.setProtection(rpc.Ashmem.PROT_READ); + console.log("RpcTest: Ashmem setProtection result is : " + result); + ``` + + +### writeToAshmem + +writeToAshmem(buf: number[], size: number, offset: number): boolean + +将数据写入此Ashmem对象关联的共享文件。 + + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | buf | number[] | 是 | 写入Ashmem对象的数据。 | + | size | number | 是 | 要写入的数据大小。 | + | offset | number | 是 | 要写入的数据在此Ashmem对象关联的内存区间的起始位置 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果数据写入成功，则返回true；在其他情况下，如数据写入越界或未获得写入权限，则返回false。 | + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + var ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let writeResult = ashmem.writeToAshmem(ByteArrayVar, 5, 0); + console.log("RpcTest: write to Ashmem result is : " + writeResult); + ``` + + +### readFromAshmem + +readFromAshmem(size: number, offset: number): number[] + +从此Ashmem对象关联的共享文件中读取数据。 + +- 参数 + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | size | number | 是 | 要读取的数据的大小。 | + | offset | number | 是 | 要读取的数据在此Ashmem对象关联的内存区间的起始位置 | + +- 返回值 + | 类型 | 说明 | + | -------- | -------- | + | number[] | 返回读取的数据。 | + + +- 示例 + + ``` + let ashmem = rpc.Ashmem.createAshmem("ashmem", 1024*1024); + var ByteArrayVar = new Int8Array([1, 2, 3, 4, 5]); + let writeResult = ashmem.writeToAshmem(ByteArrayVar, 5, 0); + console.log("RpcTest: write to Ashmem result is : " + writeResult); + let readResult = ashmem.readFromAshmem(5, 0); + console.log("RpcTest: read to Ashmem result is : " + readResult); + ``` diff --git a/zh-cn/application-dev/reference/arkui-js/figures/zh-cn_image_0000001188551432.png b/zh-cn/application-dev/reference/arkui-js/figures/zh-cn_image_0000001188551432.png deleted file mode 100644 index 7933730b5753d05a6f5734cb3d7ebb39aeb5f173..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 11318 zcmeI2_fwPIxAy6v0YVXo(m_B30zn@LU7F=V#R@@sVgRKEr1u^qf{Fr4i6AN}9Sk5y z4FL%PqSAYn4xxqqZqE1o2k*>#=AAh|WHNUqcXIE&*Iw(oK5NI_xPFQ2_^IOz3=CXX zE*srqU|__6mkb9R_yo}y`4qe{dfmEYz);XGG7BzP9QCj1GcXhirM%#vL%anic zkqDLiH;#-tO*Mq-oDlP$e5T?#*^*t4LmceP7aC4bo;0S|hP)ambsH(NZ*0i$9X=Vu zE&7n?JBW)7t~or|9ZPesId;ymowL;8$8oReHhF%Bj!f6xgN?$_D^HEDJcGsGf6$$0 z;nZ7{73ZAQnRA8TWUJq~F#6lp@BrDb>9GJwS%Ko(Uv})0sP`S@OuAPCcsS9W%|+pR zWlp?HRm(Li3#A<~@2{oZ3lSN}y(tZ`;ogvN|Ib51(AyoM2j|M~CVx+on`!c!`~5M? ze{EX!YqTOJs_gD(Gy6UIs{j1v3^A01S*o1L+#^M*=;`$QX`a)jz>y49$i@n7jmgR1uqye|8&X2d{b`xL|j+y5l-11wgXK&s!QPDQv0xWEDgtC8MCK#7UQ0R|vCkZFd$sTI>ETAAuKDl`? z%syo_@gkuwkKb~qe zEPL?l{i|pb5y1th-rfy)Dh!z!G|m$Vv&A(DY<}~aX}2fic{i=migU-0{&SFHBzP<1 z*tkQQt3wDnIajhehz}|dw<`Z3o$tE#DmjADc6G4Q>l%Tb>(u>OEuRG^=XCx5zBzek zV?J#ozVl%Hm#J(UilSg%z!@*7RI+>{6NX{*T^=41Yd@OL&A6w&e>)`?ikroM7JO1{T&2)E;6EB1dV=r-ZNXmYB+37vrTBK1WNOAp1_qOx#R z3k-o{LYngL#TUElvzXoQX%a>spTgo#KNujnA{Wbkwc-)fK^{}9V|WBQE{##r_(go& z>T?+rMWq@$D*-ST+lr;H^9wLDtoCLvW;%45QStyYGvqt+rJ7rNrOt}L^Ue^2I&(2r zpfTzg|5e59gwd}MCdtLFckwz_URz8n!LwcO9ENDKqvF#QC(k)dDve7T#`NkA3Vt@r zFR=}KtJtjc$cVUK^4Rzz*wT{~yGvC+M8g@Rk|Wunq-8v!p>6&<#{$R&4`zAW%x(Oe zLb#LIz47M@IN5R2>awHx<-;ZWEXk!C^F1BpVEW3~v|c6>m(3dT{fYV>YW$*ww#td@ z7hn%Or>FU%KDfQ4RW;(z6vV--PU6oCDiia>ecqcA-QXNne53x~*1JryK!j{!^egmv zT;L3uP)3E<7hW}m=v>G58-S6@%%8fDYF=pLx(e^gloecT9dC9_{On|jzXcNa;j@Yh zX69#PilqMeA1Y^7XtVr#0ycq*UsSy3e(#NRIF5B7Lbs<myiwu4eh% zjqcFhRjgiVfY@&?^lhr|3+Vfo1uph~sZ8yUUY7g>mWh$5C4^zGU`!n=E=C)j5 z#}t}{wxy|ewC}Ia{&KDA^_R;mOOi9?77t#3_R`p@cs<%K@7gQXCMJxMt$ zy+@;}O`qJoD?bw|8izZ!y}ukP{#woT)N6Hjx2&6QFOHdp?%Z~Bw>UW1s*NSN4#eb> z`p<$SBkMxya~PZZTsUl}BJB_>7U1O6l@mABmu(E$ye?GmOGVTK@pmbS0gl-Qv zw#a3V=*%)?H&GASqYq|wsXY9BMoY-jt#XQOrfzo+lpu(bC8=!fsxVAE-E=cW&U0Zc z-gc%v!>}=iE8lj$r%?Qqx|@igvW?3ulCq}%7yR4q9!gSY|C09oc@*Bc@SB=T)gsA9 zY}SzSccaJFeHW?QKJnVQpg7>CY-^5og3wDtw3QSOnr*r+oY|F0$*MwSZ#6NrOh32} zn=*APe*&yr`S-5R=E|jLo($;(q||xm?zYV)5l~;%vI?qctt;SXE$<~@3<7FaSt>z7 zF`Vztzs8Vy8h^oiMf=ry;PSWfFRs6?sekFn^L`8)^zN}HEw@M~mT972+WHQ8%f10o zW)8d`FP^(~P%Kkr68kN^+7hwNiT8+Mm##RZk_ooLsbSJdh-x563gQ-_p`>So|o3+Ndf z*x23ELbgFaDTW`eXSC)->TC`EqD@QH8y}lb)phA9$XM*?R<3#?)5f}4>!+=}Bv*YpeNkW2wInjV{5o{D zP`bL;@e|x(HNMWjc3*BH%rb*$R|eQ95;JpPW4ATs&4&)MuS+v=O_JuTLW-#|QT8F>cH^MOR*O=+m&Es^OYbTp=&P~U5xf$oa609J*W2XQ6cZNG*mh+Gt54Jo zR$Q(q$X4N-;Cn8bsy#TW24!6HGlC$-1XZt7FI?(8*#a~vwW%PjIvTlB$NWRn;KX=AJyok4e!dX~of8QpyH@R^5FP3)bZWm7k&wKacnnm+%GxoPe zM%tfDY)FsFX6ZeCB4gKvuz{tlI|gYlLFVeMk7@5Nl$!ZSs`Efk7AH)7I*MG;hTD(w zgk)bf8p37S3^K6o=^DvmH{ona%!vDS%Rtj?BMp-KPhjd=r1#l%>I7f2X=YQD}n83+u8 zO|Ynn1d?L172!+_xgx>tDOyKGrBdk;{OeyS;g;xRJZ`rcp*|Ai1$Qtky0`KNyQai4 zRpDNuHY$nsPsRxb_5RL!Z`K9Gx|@)^Q6W&y0y{)r%uX?!oa)KJ6OSEkv+^s?Yv6{Ge4SyYtIXD44&>QK|QH&wDjdd z=xP)eYyGg-klTe zaDpGxO&qtSxG!df9v;}&g)!Q}QOmeN&3&gKJB51TWO01{`iKE+&3nbe}?UfG)e13-&FcvH) zV2CwGo0_|B2U|pAU>gsA(vfuKL_A`*BHHM*MgsP##pOtpRFU>yjF#5-QZSUvqEZ^8 z!Y}4-IpXRsy5dV-OkMe9EuSIp9;>#1Ty>M7@se*rzExzuTE<1Jzj#B#VqmqhEGuGK zQmTA2dhmo|qhXO><_)n5F;wzJtlgNK4OOGX<{3>-cRe+BBt+-NT7U`2o zrg>Z}$`I!i(x|LdXqPGpR%n5;Z>Ry;Ur$K-u_OYH04n+e*Te3I4(z%fkSD1{HoqlB zBlqIuGK<37l-vYm|7qS>8qy-VXYFAg$Kkv`5@497TX3^`o14{|ofH=>UiqzGf>Nvq zALr-qf-U^Cp6+l#kl2pf4EB$WU?g+q$Wv{AoD?~=^#b=1#f3ky4Q)Hrq)L?j2fUbNgPX`$}7RB$0 zn6HPnM78V~eHSu0M-nMbdc)(bMA80RUv6^B=578l6z1xJfy50sJo>UeVLJio={x$F zKWzW^e0lA@tIc2-qEREkJi{tzwW&L$I!HexlU>NI`%bei+C~k%P!#o4Ra;3a@hQy% zil2!V8UJfoo>S?^)6AzYA-W-}JSbAex^;YX?R~+A%z%fld{#43QmXZgwl5P*SjyjV z-bfZfs02S1iim4IbtlL#M_NbaBq&>QyGtteug*`-tNfj~LAZrSB&jM;e%J56K`nn- z4TRy@v(vs5;BI$zDE6GacpS~CjeN`1hYc2XuP(OOT7}sM(`$B@oc)og0>uex&8?14 zf)r@&pRuW*Gu1k=yA6`cHWm(h6(;q~kong{|LIq%8%-OHsf=Aew+J_lbgMjLwZz@a zKVYqR%7G2Gs6Hbehf`|2KsJqGZM-mD4>Nu5AI8gG>ngp!x4ovM6yXKD;4A0IEAcJ# zE~%BEI5}G}I|MJUF;qNgMIXKqbK{~b-1V(CSxtd*HNY)eKJkiJPvV6P|ECrff29>M zJ5e;hzi~x0;bZhGv;1OD1txmH>5GIS2x8Vh5H2{3PRCJBb{AHB z5DQ#D2(w$2trjzTzquMw`{iVJX9mgi0Jc*6ZhV`s zC8f@2`qu<8VD6*U9G7G$S)#pE)-SlE`z$m#SID*Qv1d5#LU8=P-7SBQ_-||NS~I&z zn|8qy6#2qycmy{29)VXxPkFQf))?SPesbRGvJPk(M%SNRORxgNc;f$>#baEIQ)w>H`%|-^aX#4t<9^|np?k>AlMt_23X$a z#gI)Yvy)`be_B+oiZYeXpP!}_{I88Y;eBp^E^J@!6 z^q)?1#8M?hT?-ZL@l=I7&1hWoIAm-w*JbB5U&?KB?18cr;y^r`B*(Y?z%#jN_cXV` z9X7xeWq>356!HHCD?We!^>FKbXdlnvgUf`bP#KO@P`7TEgnkmtCIREB8Cy%ZbhO2)tmples%cnd) zrOx4x48B2v77Dkcb2<4iHytYu zg{Zyx|2hH-lm)ob*pa~jo6`E`O)4dHEYqyAgAm zXq2ah(S>f-CzWET&zTViFBqB3iePplfDj^U9+E5*?U zi1PXPbOEs%=;{=IMXCh3!ki-n$NQi4i`a;hskWZN>ezLvLC~wYqV3PbriHJkWaavZN*2jla{NNb@^?qPUAhw z-G*pF92S)9uSd}lexs?JzBbdL9zHoX09-Rk-w%Z2wbQGJwb48tx0BM7lku1N{BmP* zce+ThsLconyd}Ok)QnY3bB9(nMNP3xk3#)s0n>5L3LkD71vBBdRcv_0h5ESA{9Hz< z`F`}d&6CZe_avZu6&5~&xJ#vkp|5N-<2qgxjmoCzI(W9Iky|Sj5+&nh@LLdUl@Ag* zA%Tg3Oj%R*!Uas_4|ODxgQNlgA}O7)Zp-ldht=PUa}1~*b;jl$pH&}3^H5#9Xiogr zO~Gsv8#;bpUs`G(I5|{EQ1hP%sHOwZm07@FR4Pe+N&t}|Pmkd>RJ>u780%9Z@AoDa z>Bzjwp$0vWAU$S8$XYM-$heezm-Qbhp5cw9!mC^&s~PNP{#gLlJPH^n%A6Je6<#KG z51OSGp&KZ+OB%p{`@@C)`^WJrwd(bnqk!G~j{1qC{)vp2k&0DdE@67C6=D9O*lMDV z?|e|BsqS{pV#j;?Xx63UHfr@!vbKuYK_PmQzkC$Cmo{A(>0wtf_vv%nYgr|4<{D-N zc+q1W8~hyLW8TLLb*h}UzuMTA2<|%RNHi>&$K=6;O57OLS(}U7Q)xvG7Rl2EaR9PN zx|IG<+kAc{on7zNWXLqH^uux=;fis^sqn!?f|1fZzzbl=i& z84tOPN4IVw;A}P4Wcm>sbWJe4%!?TT;IbAoMsKXcO;GyO&;)m3`aVPvs~ozsJ}Wzo zUu}JcziM&A)Hz+iPG~yw2=gx* z9}hW~x{S(UseuZsDX!1`p@yV3TXVi-L`>HUC&Oznd3H5xZ@BdS8QK2w&xN2>`w9MO zWZuJ2`b=#LTZMdP@TNulO!*TmSA4$_S~27wo^tuy?|Xfty7!Cmwu+DNo0H#@76b2+ zVV8+ttmN5=I4i+{8tC}W{d#dFBUfp_DR15}BYZabxF(bh`ycAK!Fl(JWk9t=Rr}#k zCHLd@g;h`NG>-w?)_3qEHPpZcaG7A`&6!kkA?Qm40fH%rB&m9EZhV|2x_MR~mX;iT z_7qf(47GT#0}+CADwyRJRlL4XvzM>C9Skx#>#izgUcZVu|LZkh`L9EruQ!Iy5dFGT z;h<%dG;rI$Wn#d+_RB>X>o7p#A53(s58MxvsrFe+&@A)IFMGg$@5@7hQ|Fy{ z#DZ4p2ZuLQiaNBGt2+Uu>@2}jJ1cM)>h5zB`1g1na?*1T!0Rk(fDU%mE%@rO01##a zx7LE4E4rjv;_B5&P#t0cnS>t|`jLZ7oxo{1|GWBiAU=JmvDyy;LAh&?BL+P;DVF4z z$chzvI4gJU^^5p?9Vf_4T+LL_dH3PL{{AXo_xV^wU_=u#w3ZWrN{A_K*Q9RVolci% zh!yooeK~_&1jxW1)OV7eZaJY86!|{b`oVa5FyO-?W~{`O6d4x^3g!Td_H-(y?Vi0}5{{}=&RIU>W2u{O`u?c= z%;{H7&Y-RC?!o#!C!bxqXJe&8SG+H(cR-&|+dk_1sbDAs75Cw44^XpbCO#cE6J+}R z)qCCpK(o|0NAOZ@dlsr_yAt4O{}pr~^R-zLJC2BDO@EZ`r8k=(8dd-(i{4(F8PJ#s z$_&|=t-Lco+EC{|8nN4|P}pnDGxKa`2;ds_`-N;?QHHYi|3Ewaj!)YgLppUfVYmc>zIF!?Kb2c|G`PiT%Q0Oc^ z0=ecg*M6Un?~R;%YIv20XXDcaOP-A0Kl)mk0dw-7nH%Oiean*Q0OR&VC8|1G5-K@< zwnuVnw#-GOR=%;{2V`)hM(e1{w4Ux*t2K`7k{S-t9-I9@Bvpl_R(j3c(}GuwMp#`{ zQEy)B&~pzy=QfC>CWhVkbr7<@V-cbYzic9U8IltX$dkGiz{qN1Itf(?1{2RAmOv=E zq?Ju}z^36X%WU|G!E-jBoEi2C0Tp26G#X^OYPMDEKT3M`eKaYujAIM5b6p3xBM*S~ zEUG6w)dbBU?6BO)wOGBqdf8+Ab#j+SYJ%62xKoS%2w-S$#f}{Eu#n%6e|l2!Cx8QF zaYj;szH$rOM1`B8@DIBiE9@$URAJx?D62Mr2Jid(Szn>94stnY0GQxHJVJYMc%?hyWuw{O zbHYGkk8&mT$yU?H<4KDWpXgR6TUK?6K^8pX#H-iUT(6Olx|G_9!;2h{IGiNXZL}_2 zRuv+s*wSQ{Y2X?Py0Q)L)7%~suakn`@nK?V9O<{2Mh-X2Yx|6QlqvYLix)#*ben%rl6m4&G9A8ron0lsAm4 z+dzS9rO*D_v-hycYc-QU^DWD*TEFI(q zYCwOYqu=IVMEhgu8Rn6q5mLvibIouo!&q)5uPipPFsX#v-JxXwW8wxPI?{^`)7fW0 zYUzL|W zLnLF|X^Qt{&}DEjC^=1KS6Jdy!~zP4N?fR#eV^uu5C-H`QG({}Tm`Eo!H!H>atM%V zSXr05V~i5~B1D(1rJ*06sK>3Yer$p{#m6Jya^wdKy~QLh_nPhZ$JSTI8rPT>JwzHT zTB66E>bd$L+9P&bSd;hY3D9z$Oj7ll4>$_Y+pF-1y^&9SZoVMv$p6s1QZ8HR~)-cCU`}Db>Bs{~Kxi!oOQL{ar=2eW<$6HLtG#S-Q&K?XJsK_6W zLzr%?2BX89!;#5F*wqOIX$qWsutDl##e=$m4&CGp|5tc{aHK9Iyyd4H{`kJ(ZgFeL zqUYSd1jZgd@A1A1R^o1pagHC&%?Pu4R!ml?$Mp!24#O`7qs>$HX(?BTD>w3Q5Ys(d z<-5hB&FYc#%`1&_PZja-8CtTXTd`}N4G9v5X!ucMqWtare}TRN<`~YC=!ifv@1;p} zcO+|r5kdSn^2i!rt3zj#OU~xKi-hVTg>L&u-Itf8&^K0$(bj=>=(V^+^>}ex3u>>N za`|H2Y9>4SYR0&yPDSW>*#fO*sfP8D>spI1;)kBzdW^FY-^->KPGB9lO?ZlvAwyFh zH?g+HCI>vdy~-kuCHgxZTVwC*g86&uSKq}w{Xs3S>_u!IuaxI;YTpH?Qe4tjzi(sx zg~|S3(;{LE{|f-de97Qoq`p3$A2F(bj2{CIhE%3*6p6jUKy>!%n09}-hhUN&utO|O zR(sgT{yNU1)aVzL)4k-d_tDeA{DiFN6;YBBpFVF(&e$ zXtH$b8)%rCK`AmDlh{)`JwvLvj4M>#!SnxNmQ$8jIm&O0>(AKW^BP*q(l?+^Kms(c|XZ!q=cVn=@fKe0RW>I=N z&CShroAtBgf$Hqm`{-=C317ASMUh<*SpkDKBRl_FYNlsS%=}Jhp|F65dE>oab*P9fbk`ZIr}UsQ{${mUHBZII3MaCHBacIZV_v6TogDS# ztX^#=ZV89I$!%bAD&bv_nNz23x4af!rJ$J3$}6FyAcrmc26WP52QE;gE@ zEM8-^M(WJK$RKaU-{;)9;zHwooJZNtgdsWJ^hW0S(f|fuR`+w9Aa@YOHnBOsAU|Qc`PV&{pTfW z1(8Q?Cw~1mtGL1v3yV8ATEp5A4-sAw{W-~mf7zD71huGyN&2luKQ8fjQk>{j2b;(` z)9f?bC39#gXfdv-vKiDi>QLt$UKLjXsEd}ZI{CG(L$#++i!SLSzw6W=r<(}SNUQr? zc~z55DY^5au6f`hF8Xw(N%_d^mk*Ydp#y zS{raz^ZX)uScEWn<$ipn+%K<~TJxIDeOEdct}C%p_p!upSi6&aPui4)K>GFmv236s z#ck>j+umPj@O5isN6-fmCf6B}Cg_wCyK{4}%hQ;e(JY(0?Z*Vwu#zF`N`)C!#Qx@_ ztv-Oiu=`|dR^s4IY-sOC?TR|D;amkQZC0p;p5A!Ws)ll3X$IXwT*fuI4Y7*8Zj|@b2^3sV}@|`)%)5i*n?Z%ZQzO8IJkX&u$}lX9IQ9|1{+bXXGEb zSm+)a*LTAy)b-YJ_uL Rg0sF1SB$S46&Tn>{2yZ8SJMCh diff --git a/zh-cn/application-dev/reference/arkui-js/figures/zh-cn_image_0000001188711340.png b/zh-cn/application-dev/reference/arkui-js/figures/zh-cn_image_0000001188711340.png deleted file mode 100644 index 994f8510b56d1f66d8a40dbd0349ca61baf242cb..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 25553 zcmb@tWn9x?8#cVbfYA&_O6Le^1nI%(oS+~gEiEk|-7x`436U5`h?IbIr*sQSN_Usk zJMZVd-{0@~{(RVn{jZKQj^jM9XkBd;Vgfn>002O&riyq1002>#pBfk!^CcY19#g;! zP(#4=y@9*_cxm+A>E}UhIYT8WU;?lpjb=~gh%6d-O@A=l>fhondF^O=jB`DF@BDym zPjdto-yX#tZAC=?{Rb_A42wM(`Qh0|_l!@Y=EsBAa;8r&c6aR!cE4JC`dYVykLPc1 zf2nO~t!>p`14ni)b^KA~kUs|aufo5N zZQehF*izJk2`&HI>QGE@L2L^W zL+HW#m08xS>+vc*>Vv1lYy*^7n$UWMZ-8GcZI5WxV8&h z895H2_cXzkWM*g@!W7o)IE4jOGAnZIRwhoh9t#>mR$}!Ab=+kz^oe$_Eug_v;>Pv+qD>vEJOP4>-!6w?-9Hjq ze*Q%Q`JMkh91N)q>)M0}U-TJ}~AtF7ah*`rn07lg%y)CAR5GuXeLE9B}X%srHj zafFzm`>2FIPIIBbxS@^~7J&$pa^UgX=cF8unknmEyp<1%W+lzhR!O3t>dFW^Tg^T& zK%xG$jw@ig1g}exN7E-#Cpeq8@1^n!CA>{iD7z~6z^oN^SYPnqL%8P_!QNJeFDv04 zF9RqIM&MWWSSLiyqMWWIIL^5d?64NA~~5u@DP^$g=_Me5n;MdyEW+P*VjbLr%HG(3tIl0 z#J~o!!PyIr96OqEw1o2*=U};WXBC6I?ohBY3mC2>NFy((8b&46L z=o6dl-5{f%$DFJ7DnD997PujwqaEUMniE$`XPKtA_-?{!YK$VJnB|p#z1&A{h(LLUN1g&sMm9NYpxh}n zEyXN%>AjGaLNrCO4p!~p-K&!9UqAwU%vUwOlpg3G6(7U;Uw_I z7|7@GeMzMD&649!*}*dp^kDIF)kWB78CHa;qI@i~>W<2oUIkqUBbWsWZUcwqe!*4M z)k`Sgc{#}eFD#Kgv77sLk@QwWQGNn4s(;%7Ap`eY#}9djz&xI)d04fb5DxVFI)LX9MS_qI#v~5>n13q_bgB4Nt6c2 z@yzqwO{x{}%|;a9hJE1BQvUE=DNJpJW;RZg%MMJVm~-;?jQPHI3iLsIu*6r;*}ND2-M3VinTz|h@c3v(Q+>HctJw-<&_Cb+tJ_xm|#wK zm!7*KjV&Q|s1cEZV3G?}IOr1!$Y2`>)Pm#;0C3NWxL5n=Epuc*Ec(80wpS|R9Ylg6 zz-REkWDAa(=AQm?R14%uh+JA-Vr=*np{YcS)64Jff>=ahtl*3exsxBCex)KH35d$B zHa&((t{e^`(eU8Ac=p^Nb*$%|%x7!_)nR~Ec7~RL%-WXy77bzXuG60m|O1BB3R&9r%(pyK(1WN zk9Q(e2OXK+pCl?jNhV%Sk~FRDr2s53pHJ+&%p zXGQ5b#pe8mt}C`PONOZ3tnD?rpc*OMsoz+XRT2Iyqlbnm_m1gZ2|i+rMt7`*I&isU zxl?Pqd9HwL@P=D*8GJ=q3AZ)_51aW1&%KY-US)5Jrw3sL1F~i&-@P4vX6)ug7Axs; z^yc6XJ4aAI2akQ~w#4jOx2eohx45$(se5K~(J2VIKQ1`%I0!R+iaLjOK_gtfy7Pi& z!_ECJ{9&g| zeXowJY~%uE7v%mfUzz*coVF6PLLshln6!~tx9Q2mBSWWcMAt6M`any`hNcMV2fNrT zGD0t-Unoj!Pzl&W<@!^Y@BZ4E>BbVa-;ECgzCh)^7{mQebTFzAWs%j$w8qb{c&7*o z7;4MO>U#UG7Cpz%!Q`Vt-d+E0Iv}ZL?P1sU+WCBmt6VYW)&4khnJ=l~nK}9UmPM3l z3-%=6zDi1OTVN9&-&?MzU|sTNBj`q>XWn?Rc{@2%*qO8TjDyGE0Ln!LhL& zJ)zbX!l^PcYk@e69D%NM;@)vy+q6HoK?%O7;Y?{q~|XtV6dantKzqH-n+qd__Xi|+*% zr%;c+mEv`5js_FT__{W6MX6j1M|G?zru4p-^GJwBsK^tq9FYiJI!<;v?q*dH5%)AyN& z4P~R0S*wDm8_LjAc$p1#K+0j}?+{rlsuPFH^6Of(_L$3XEPiXn3*a*N;qk3tL z?!)41)E|1)H4#tMn1is9%e6?jpkA}&Yx?TzWo(=bhd`n3(6CPE`2>$lqX&G4-4SSUqc(Klo!CnS# z{7s?vTw;_#y}g`nlL*Lw+)j;y6W5s?QR%~Q@4TawkAOX_s0rsdR1sG;9d$3`0l^X} z(#!xl1HtxG2@3S(N72=yn3_SCx1DjjV+iCreTUxs6PF}`h-2P>CVO$76y}y=3BepL z(lJ;>v;|p}CVErkmiK|LYTn_>>6%POIb^h0iz(yjlIUlkSXq&ab&{oY4(`#9zpsn* z^`#fFFK-$~6a9PuOsBvUeg?v1*?3ahwi0u5e-Z0?eMe$!BNx?6oxW_*@)qK%Ot@oQ zQj)Y6qTNAmR!MTTkVzAI)hRshCtZAmifSqIgVe)z4bE zn*-^k9FXnO^nwm}s@k}`7;UQ`IM3;)gb$5_zkDEFYSh7Y_!YdM3r&y*VEYhI^DUs% zIoL%Bgm(%R;5tGjY;{sC?A zK|`@drPm;vz0}OxMxL&bk*K|-H!S;ef8L*B{^RydLD&eK*kX(DQ_-6eiJkB9E-j0# z=47wb!6zvs)k*Q3OyOTv60}U*q^ zo##c4d0u^y^~3%}o>!GZ^1q;V{;L~fV+Fvfm)J!mOl^@YtSDwGzI{Zg21T4JdwTKycy3Bi;pv68#rZ1i6eotjN=bf( z-VV=)(IE=FUT<)Y`WL{{yW%;xY%?-FAZ>IWJRUtMTLmIS9wH?kFHzFN-k1C zRDPD?&+MxUHhI!}NFj&WBf91$qI|~;FX&WG2*Fsta z6|kQVol(S+35E4N_BkW|sJlY6RL+P`aNizyA5beeb#sZ6qk?x6fdVS_*3>$xq)5fQ zI8QiCMIei9i}cu$x|`f~P=6z$jRsGAig6JhnLVzG@08wElz;4gGl_QXg#H%IT-|P` ze{XuJfO{sv|81S}#kA=~^_iVvR5V7pKfOk<*SHJRDs+EI-%FJ~Mmq~p)Bz|bErwA^96RTcy2g)9^ ze8Fh0Q!{!QRwQ4r43D7KSb+XyNu9Ysx{HE>d{TPh6a1xsabbPo9b50yPBLvz(%f-| zt^kIP4c7(q>mv8-BQ(>dILxbqte$|YK0~)^hAXR%+jOaa?E!M1;7{v9MBhNpYE5kh zH(?{`nmYZ1zPoaqBWpc!uE`6__EJ}fKO%1ZV7`&^l@kNk!>w*>pOC_Q`G+y$FM{5^ ze9?U+oU{k#HTv6G((Ag8_AffUJW5fq?10OpY`lnS{0iJ3Q-wfHO zzm&GRtUR4^nw0b}GAXcJc*w$6#}edb02a#<RmGqYnAeVCn zy6q1|Ft2de^*!8QN`_@97Pjbcb&CFZSN%rf%(uRXYMl)E&l;UdUR^ZR`)%UP`X;=W5HM3`cv)%D;bzerE|)PByS2br zINNpdD@X#iVoQ=qHoqTFiiY0|yMi^o9ObPMIU$vJZpTV*k3?x;%7etEX72wBD2~J2 zs?Lhp@r4BvX2XTQwR&!tWNtZiDA-6*Nq%%4i)HZk5D-LUgi=A%f5OF38=k$c2{z)| z?lmipI@B#!hh!~h^5W~fLzg|BG97%1oK&nRp3h9R``E)Tzu}!^#!7gpi3FS*(KjQ< zr9(!ssxjbh(RuvPM#Ia}-2Z{LSIx@TwTG9p?;r`cTK=Mwa3Wfvo5ez@Lp2O2c(RD9 znk#iF!{e_HV9@?@&_;DsUH0cw0kd}LJ=w9RNS#S#97?4bLj zl~pA?*Y4Lt9U}@QtJca`3A0g&hqn0dPpC?Ji+?h8odB1r20YEPN|a8Iwtamo6!Toe z%!_0c2QS7-Bt1Q!Qfo&g$S*oSY1tTT5VsmyMj$#QF_i z^=)a%`xOd5YedE1%W>!1JwK}GE6G{xi$Ux>-?9e)=YtHAG@Nx8A~XZo2dxAFu^)SM zTF17(2e?1vsw_y#4ee33WSU$fi8}Rf14o~TkB`Hu`&NnsH-FfEPS))E;fce8__q0o zLW#<3w%DHk7McVhin|kceTJO{<7#uT*l<<3?a+g1_x51?Niz56U#e~8B zSXnD`Y1zjdnrSfg;3Czkwbnl>7^X64V`kV0=dq5RR$f*4J(-PZ>vKLNi{<@^lIGmL z2bmslQFiX^zqUr|+0fJDmrmhCvu9%7*bRomAN`0;9SaiiIz5)vTJWbicVUp@ z39f%!gXHJZbvI{}F+St62PKJvgMh73uWE$duOl&o75)^@zTF>zpF;r@N|3>tJx$#Z zGAk(ALoC(CuRlIb8Dhh5S(lrlS;^?0lLSYzYP9Vd$rvnu>t^orCc5IVGI=sr_Jld` z)&kwf^j&X3cu&tu)L@LWUl>hao5TN)Xx)2FChT-}tPP@7=QHx-y zMnaDLZ2!I?pHXmRXSm0#yXi?7X6ji%H5yf`-ql{Xwf(Jf~j%_xDdrdKHtm<)#FR(BrOu;>y3&;^+Q<^c;^ zSRYztg981l@l6~3@nm1#^Ya^>lE~IvzPt&yp|~4q#ydI)-0gA}@2PAj^)=01LZV0k^0KfyIdkkxXBg#Ht5x zP)tvquqn}Dy18M<;xH@M2?v^#eK60QIR*#v%(G1L05Kd}JC_XJ(NN@dr5|?1L##^x zJA!(1@Kk%7^{YorCiR`Z@jpxd(~oM|Rux40F;?DzJbiI=N0;8afw*op0ylGax6AP- z8O9Ope~H_lLe@{|lk&NPp(7#L-T=VW;B%C+*jxE5=~o0hF@>k~JJzNtT}t;Hr7x%~CNq!%{x%tDYwGQR{~~-z3a^u=v(@~_Eo%GOnb z*u_&>d1ldC*_TnuYApQoI3HBc9p*zS`hrdL0GJ6|_|w?<(&?_yA;P)R9&jhG}_Lj`~}J9Pg{^{%MG^E54aA z!yZ~Ug8ThWu=Y#8Q4f03Bm_Us?PRqQ$*G|1+Y{ym5><+fG-ij2X@~YU*0L#X(;26cuBVkx_U*M?s!IfAz!)N|ipydO1$PO*EEoglK0Hf=nLN|Lu^&-Cv>2ak!dAwq9>E*o5b%IU!63fkTt?bR7{a zY~K|mR&WK3cEvd69w?g`V}!aVJR-1994qjbP!vV7lRh8*$|Z-|phqtVsas^1E@f@~ zWaE*Y(-$%P9lsCCEP0;?2c2x>Jf9?jG2z8W7z5O?PNDBO&t|Dd-+32wSS@4CFLxWcQ;3>8uWAjKZtfC};M)w^yVm%p4kb-Qy;SH5bm; zhg%vb7;bL$F67tnyoPIYdo}c7bS3N<|NFopU-oNvGQ&-K=soHVI}mT{HJP_t2d^E=@4G$WXsRAsYP* zdGswc8hu!H{%2o^LdkXH;52sF*!&}7>;qym6MsUUA$CdfuU2l4Er2iBU-$Wo*b2eb z`v@`Alk6!lijDix3l4ORs@Gr6?+np zg2SeePy;|ekJ9>^?t?-`Oq1f?CiY=f&$ENM8itg80FQAsGvl6(melyHlAvB!N{wQc zOkR1vv}6{ou-6aX=#mILI|IyN?MjN^ER^2{n8E!;`sW%9#ike$EM7TDR-g0c@_w*_ zJNZG6=17gG?aK-uH18I`4jXe18%GexOLyBwh_2hboJ<|*loRC|WBpZp)TYoydK!Nz zT4A?_L1}NCjK4u3u7qja^#_V2v(8v4T;bZ}g?VFVhfl*_p5YRN?%MRByoi!~g3d?r z@{0Lx6IKQbG%O)HE5p115f+ELgaMgDQ>L$3J-P$P%u$~p`v1!XsO&vg@=|db;a{3} zGMkbVC~IkCn%WN%R2tK}sZLakuq%rZWvmT$PbHNv#Mcx;Y7V^_w4sf~oP{mo@+6-u z=cx|GY1c~6lLrEGALt=|eih*W2+l3F4%UX0SI)TB9pIO@>VC5s zH9F_c@8Y>xIj#q;rR@>+JJa*LVKLYv9agt071PhwY_;KHE?b{M!7t2Cc-aKIF}-OD zEp_`hu*=%U=1s4OM|a3t(`#H#M5r#l)h1UmV2*plilW978h8xL+($S)o8JnoL4Whm z_th6oSI5B{pt^Wz)jKAHoN;|dP^puwkg2)+(Q8ks-i7YBdvIRxnLB!-*PGI z(LxoP%sJL#Q-nfEXb{cN6Q9W2HT+^Oiif&1%-#SUMG$L|jSG(Lz~l4zQAUSjCk~BP zDo6U+E71gyq||gynYj65^g=!N$YRjXM@h5XFzVVW$qK zb&fsXnm!9cz-NYxEpmQQ_FQDgL~G@!--TEL3jWCzcX*?>&NLJDaFHDBn6qpD%~#~A zgbzOO?xA z3W8}r!5!l$BiC-?o%#3~AT^9Y1|?bd^2?o@q^cURiQw-6hY$&hXflmzJzsPE#*i6p zDZ1$Sm?*w9!Ch}T=!@($80xihp^J2Kv{ncTF(p?%XCLAE z4vCerOtW;*bAIQD;=X_coh>04OVd|1ALi9Hdd=nhlVWvp%(@aY&y7ip_ILcQ%1voG z2}nzelN-6VtK$a^1)aYwQc5D@pC5de5k8JqV@>@jRQpB(Bl#qeB=?ViAX_2%rI9jU zfl!#bPF|Y2#ZB+VTEH)gH2Sg*@an&Gk<2#3j@Z$K8NjefHAD3xw#*jch6AH0flo%6 zN3ZU39I8~oPVJCDDYcuDTxx5~$!8@M)-MhByQWE)LWJP`O#&WT~ zW!&nbg6LeiT2JWt&X0p-U2W*8=W_pqEN<5wYGYHEjk+!qyv7RO-nzWv<)#;nMo(p9 zB4KZj(xq@+#y(A&fT_O% zP#V#VFfZAHwGHP#vAC!S9}a!Xh2p6V)|qE$|MWYU`eTr|Q5CQAcYuRY@WbZnF7GE_ z&n9W3mOHaR)8B#RUH}KlRo>>p;~w+=j7Li;)=MpCLdNdd)HVCSWZ&ZhaQ4BjJi8VY z$9u>nm5>Cpxgj5guRRQ<2Quiov25N6O8tmM9Ve+EcaTR_wL$an93_n$Ub2BN9+>DD zxM!3$$CAxLj^I~PNK4-LhTE~z1AUe0yar23R=VeOc;t0kdt~d6e{0EU1&F;%+L6LR z8cK%ymx1@yDlzy1`Bg*;XXP8(sZXV{Z8n1w{fC)`=HHYER-ef+aJc6QG^v#+Cxl^bEbISety%WLPnWC;aYd z0$U(Kltr1IWEIEp?jYk^t>Z#JX3U7B`WgjV#d`5Yl9ppxO%&Z$*=?mOu*?t7-ru&L z1kKe&o#*AmzKakX5Q}o_{co8ViFX5xI$z@!FF>-d7i({>a4_##((=#O_K#aGMQXQOoCfkCZ;anO5>*I0|yacmUxT z_yUl$A;&4T{u}<=Gj}d8S0VZr|DWhE4;BY#H8Bsz$;(rOLSJI!cI<{{XH~PT(*z_Q&|k=$se=qi27r|Gu;+tP{#c zoiNK+J=Q7M+6uz;z*Dd#&ab%q4E();)aMgB-1`YoY|Db{6AJ~-<8O=S1I$$kb*XLPJ&Kv0m~F)*N)Xgyv*A#^<$khx zm~d76dwO{Hz(~Uz#AZtZXnos$N7v0QP76*;?N^;6y!gAEMNNV+wBaHK-*>hQv3L`( z%8b5`O(Tvz*#vzG$mwS4mUSj*^($NKDc~|%0og!-UV$T1ep{Pp5_?Z-mfG9Hc? zqwaUa=I@yJUWdf$JU2-*z6E38k%R)^>aY?5j^>c@%n8xd`7R=-CNi@rBcdFb<{iRrEp%=9FS%!kPRJ~7~d?+UAR zjI*qkoE5JMh~S!`Fd!+7HAiDll)c~fwooJW0OA0B#minF0KRX+1%E^cjc;}#koFf7 z9`945EgEccR7aenzsc+c48D1jJFe7NHOq1QWB3-F*H7CMefDw-!wEJcybW>wv2Q@F zXStqdi_Z?^W6=d{?+jniWEXughQw1`r^C0}zJqIZH?po@(qrx$v{(9<542i#>|c;U z*QyMQqT3JwkA71d|6{>vZWqD}MmJerouZXyRec zp8K6({~S`^o5=B9bhV^<>580k+at^nGuAw)TDC;k<{}gmLM)sKQdu>qaQ{ujK$6!( z*~UOD{3M3jooB%}S68J6fh-a+FuVOu-VK{O$#~(JV|0{joU01!k1EjIs@y&AKK*1o zH!@zp1Lc*HX8$00HTBW09Dg~5S$hpLn)1KVY=zZxdD*c;0sOAc3iVPv7c-tO6spsr z%ufwFLTGRv^O%nwv$#EmU@!VOdgC8Gsl)Y-36I2V^77Dg^NTdbbUk@?9OI^H+BHUo zHO3lIQ34Lu9~}%3cI1}uVXBVmpL{jSUkLLN{)-mXf3SNzy5^#S{lzALzb=4xm8V!( zI+=d3+cDw`v-?MKpuDjJQ9?>X~{^27CuA zN>3*G$nov+SnGk(Cf_U02@0=DvM@1{UwA7L1i?>EvG-5Kzx*iTQ2 z^UVmJ!Nv`6TPuYy6L^%B`DBMq=A|<&XxMd6F-1c${2e;fDopn?nh>i}PA&dQllpfX z%77sBDc0pX-&^+PfANq7|IcvyywAm@*@E!D^Fg~i@4H2h7mB{fZV7Gk$mck$Q7KEHh- zd@eP4M)(=LUybk`W|bJ%CLEO@TKYWF@XS@m-d{y?9#Nv~JZvgYRZrUeUx5Ie1T6#v zSU{$r9aH*_tzq0r9{6P4E`(O;msa{ma@= zFX#`n`lSZe0X(!^_yAbg1UUI}g*kt9?0Ea`(emkE+|1S8PRCRM27BIAiNa573a|@I zuHQ}C-fm~eUu(Z_0eCGJmt@cO0SgbX8d$1|xg|9?f2g^WyDO@_bmNdR#CUF>{#ww~ z)eMAll&v|S#+$ULh4If}Rv_|+A9H~;>Od{HS+>pxs+a4JQ}K`Z z{Cf3gff0zs-Wv^5PSs?knfF_FPCrojxiS(XFT{p%=m)C?EG5Skf9kqns4XQD`BhHL1cD$i>wnh% zt>;_E|I}RtU^=1?>eIqZ0Kld@_|F!c>>khjr*0n*)6ru<&u6Lz<}mEE(?1>jTKRZ^i9CV3O%)&m z%<;0VJG~6<`~Vnb05styuFE>VJ=lk2nH>mF=k>aZ`p}bjJdVREyCNYg^goQkzj}{Z zCua!8Z$#+wbV&MA3-mJfj@kCX@ECfR@&+oSOpe9nrA5QPc^)hHUzC@tq^{7MKDIV% z6T+_h5EXJ>R<)8ndA2(vvae_N?-1-y1T@vTMQ@eig)1~3Qr2l}uv1i_Q{>g@o_uX5 zOUsTIefY94_T?n?n%S;D_vrNq+JwOY>$&B z7QB-47F~&a=tV|%C8%uonPwMBzngztsXI;cd~A)y^SYxSLz~|IqfHkxS8G(*dlOa7 z18<+~y3xOviCY3n2b9~7*852Jb5EA(Wv%i%r=+h^sRm`)s|43#LN#4B( z)Ki5v$I(jABjbDEMhpp$h>kxUGO?M-VeZVXIM>8aHklBuID%8jIEC63m?#A4I8SPo zkrrn6>M~k7C5mNwCTzi!7aXwGNYilq@zDR;G^o%NiyV2inuSiK@iBc%^~)I=7Pu9B z=Ro?Tb{?;bwc}xyCh(zyNx18$2MMMR!|zI72pI-q`+3d1yS(S?f%jG_uAws@wVavAXLw({oBx1;_m52M(^Z71N> z_dEBY2kwE`dpq|;(kGJfQBfy-unI`wDrrm`7_;HZZOA`NF<@DjWI`q!Ncbr1dn_wK zqAK@9k2B)%aEqFd<>!_J)i|k3^`U?KTidEU`k5My`0!DgzY!JPu1&?2y6oh)3ot8@ z81S^jcGy-xUw|*kabiDv4bkno4k8Ly zY~jXIMX$3XxNNfddvuJRx58FWaw`KgPZ{3JzW-@62!G$E@i$0P%T%{84{Ip@xhP4W zY}b>S)1++6#yrh5U@_CAsr`G+P~tdYvnv9)uEphK^2y9SScj@W#?oX2V|46|+iASC!q9zoLVv%F?Y zi4`wOwguvXPujF_!Kc(h%BQl=@tdwnTUDyO6J?))$3v?|aP^7j%U+D}gVH?E7f&;B zi0r+WW8^3l5(Y)s*{{1QNjxOuC_1PQoKy%_RD_5r!l9S`aVtuuY7$AL5q}@z@54^B zy;;act(F}19{lQ-P!$|$i?^i8>F096D!VPMnOVD}DPpj<6o(Ayf^~-fO8jDAqKMly zVVQ}HRv`O*VA{1KqD_`>jzek)$M(pgI<^rdB{-hD3%&1v_qtl&e`UsIRXgTDvi}r% zLQ%hO&HNz|W$MmF618a6`iovAcT7mp?4g(vD}h>K7`IcyNah1pd`^_2Gr?U1Mhh+N zn9&5|L&68AcHZvd?~-@;;7W$4ZyVA}T&V9}4U<;5PTSc+*x|^hB)g?D6uMgO>Y{N5 z^l$zYr-9xO;?ERLn>FX*=BLCzFAmL|a#*0g-45J)na}tZay{OmrEIo*jtBAigJagm zMZVcX;YNjwk7viqE4(Q{xsU$c3+!s3xF^~xcpp?vI8IXWnk!xtptZLtIP{cV7cUxC ztt*Kv_uu(zK#Hq z{V=XT1k_=qNi(fH$`G&U*7?5n6dxbWd>_T$qdczrS8@WebUV+~l{wagJbG-6ox$!} zfD+27$1oRrB8qyiX^2M>+oFMx=a(SS(^PBbRiBnXeDiG#Q&|+s7i(- zbM$?j;(+&nRjGxTJjsa0Ax`!=y$)6^h($&yDTfnJ;E^LXx&BX&@d(zLKN8xL8iY3m zAF7v9(7xU@=?B8mAz`v*xBT(Yal`7xyF*J`L44G3Yr+jC#y2|2t-9-is5Dqr>-*|# z=ksK(Sg*}TrJjZ~y}(E-k02>Qr6&Dc-mTA7AfdyPCdo7RPlRkKqF-4lxPpPxPO_Ec zz<3#k_sxK=SH=+dZtDeP89RQRSvWzJ;@!oc5$py^PJ2}Op(>i$4W2ZZmqYiA)?r&X zT482Y?*271{5GECYIWh3S*02}L*mG>*J}e9Vz3nv;}pIplC&SS}!VJ+N#ka%+qG~bHNLbqSLDRauY_M@LHeJ z;=C&U{oS(mZNT#liM9hBittHszkI3rYMkOF@r2F?m&jK~W$=IU@^}nM}T)-}hmD#7|C|d5H{Ncm7*Gv%_;O z&)?n@+cSg2ZF_*k2kU}PUgP88^HD=v&Cs}v>gWjVIgTiW3@N( z4*y*gCS~q}9(0_&(`J1|C*F~oQw{CR zENIsW*E5!<@dB{GV(ta`Gb?!bH%8Jt0~6d~rSkESWt^#IBW|hK*uY@zpufYoy93Oq zQjdUE646@x2^xI8V-X@<@2_?Pa?;3r(DRr{SQIQmj6kUFD2f#>nGQoUw3>PR z*Qjt%zF@B!|CY}(nK)H&lz-L6m3qOMMDasMPs#RqwLbf30w-K&a)Jo-Bq8X4~yT5`u2rK(3*A7Of5m>u26JHXxSu`JNHo-mUp@-^Y+PdBHwK`3v@Xu3~ z%1En=O;O^=Xp4-X+BG{l%xe%;a_p|7{zZSLSZfeDeibMAv&B1Zmx>3r+jz-RM{#-d zczv>q<6I;ZzYuBUJ72=d*pt+F@y9k6x+F#NlRzR@QWe&Dm_Q-Pp%vBxdXX`KtTK-0 zON$?Xc)x?=f{&hKr5A9igFK>|KsV{AL7;m*#FnKqA68SjITSbsPqt`2@0obCRSbO=;*@NcsDzq*` z^RLQMhHo2fg0P!|bd*+$HNUKRM`y3gLfXD5)P-GaI+S}#`D|PsqS;T<-XwE;jIW5wMt@3UX*T1fhd1qk4^*_vYdMWA? zm|o#l6Sl-C=i)$+gJk{`V^0cb9XF5UP-`NpdCU|K9xlUs|C}s})qJBdX+1Bog_fN5 zA9+0P|GaXaAoqg>6nSVdg_T?SJWXBU!+OE9-Xq&0DLiJbhMKSH?uB5{93hC%J{Q(R zta;4&qjYVb;`B45gy5Cc<$H((5eBwL0t;6IP+_itSANnPY2h{uRfoNKIsg*S7*g!n zL{|JRra28pr zJBMzN?gphn>CSelUvNL&`Lx%E^V?^iy=p(}*=tVh zSKA%kwDl{vf3buYJ1s$Zw~ZL&_l@PAFAIF2sM*z!m_AYOLlim6h}|Z4KkoRELw73u z#|0jwMu+1I*B0U5Q*Jvb>wY0eu>9edr27)u#}WF4WH83^SG2&}IR(A#vYysBw>H_{ z+pW8zM7msY2dai!jkY&euE4It{pIMFUEf%qDG(vVe@8&xoZM*eX#3-1%bzE3Y1OtW zAbGhrH!lJ6lY<KjP~|H0=ox6AOfMFV>y3#JJpkV`BfMeE)3A_gL;V|mo%=}ribMrL<1&=vY#n{F^LXijcZSc5L`=* zVdX)PEA@tVjJ2R(1x1_%Y@VQarSzu6dZs*%DMgLOfY>(a=ACTNtk2pzDx_d#ecIw| zu21T+eXu6Y-VDU}@BG$S?HPyR=G4{{wz+bCDHzmy89(J+Ir4_5@Ds#j8`PvS2C+}&H8fx%OW81n%^UW##D|(= z(1AhSijbaFf+6MPIM#aRBeWqrk#Xpnd1s}!bx=nCe|}BR_>a=EH^{C^a*Ynxe{BI{L}U=JwLm( zyH1s18Q?$gcSl@1&_Tf`0K^*Elgoh%oVgXPio7!}0W__f;;gfM;HmPzf4sKv4=PI` z1I&t^e^bQlAFNg<4Pb7*OK2cjk4$ z=nk9S`ZFsf{6p`7+&j^B-@QvIIXYlbQIHGcb_3AI( z)_MY;UDeM6qfHxmkBe~~&6)2M=b3*MF@aAnm4AX!RO19!NBjdt_+q{~?@zsWE&KZM zPL2I~r}*wyx_q}EC z@Z7~!yngxuarNWZCV~aQ%UJF-qc~c%?Pf>*suoAa?*W0VkJ~chkG~LjB7&V3;4{A% zdfnv=uGQ?hShu1lbiFD!NiU{br2iFtH;I_Hv4HI8wn}S*#_m1BS+>cUtqFm9W1KP3y`dR*V zxQ;XPPW(zX*mnjSK77>xA4(N7Y7~O8vV~A34X{=8H2-2tlIU(eKE(NKB*e0~P5_!Q zQX~j<^F(>`ITuO5QGqq@0LiaJFxk%l=X-Vex9b~`sbBzY^(e>-b)P&l6iDoShxy|B zsRVYF-WT*(c(k_pnW#U5iiH(5sO3CBzjB46SvX8FJ$n0K4`zJC*kXETT4#*{%gb~gesfDe?;S)0E#LptJbrL3c$~K}s^tn&0zTc&ZW$-H zaib8+^3>jD1s40vQC$FjdUf1tNGolb$E&q+R|im3!Q#(P_+Y9Ks-iNFy)ut?YyPPg zKv7>Jb~tkSWl+#7d)e8F%~QfgW?X%9<62AOpZCUvz*$v;irae035w5&^XzfGR@TUS zWt^HM^b@_+nW9)UT6hC=(noXagkr}pQsYb6bzgSStcMYf#=yH&Db`9&D*jiV?*E}j z^qYw5LBRNk0q1t4Ro}z`);NEdI1Q;LaRmonUn1Iwrl=U(hz5ZZ=3iAS^ILX0Ej>E( zzP0(ifVE|-C+G0NOU2O9$Lx$TC@{c_h{KeeXmqziCo67OBOt1FVAW*>tda7$K)lWs zefv8|GCXEPi@KQ)X}4jC+HcJdIBzAYdAQHu`^#6vD1(b7vxHBPKe) z8f2NBR(OOmz2O@5RybqlgB!|9NTYD}P8Ahez->*TJVMk|lpOaj5lz39lIvC$`2ltJ z%GtqW+9Wq!6pmlP#id=2;ab)A0;l+)B8=D0|} zT2TbJ($&k=yO}(-%)13Z7);ouBbKYS&d(G+sLUDFSG}Qa~Q3XNw+8k(`m@(?ATu=;j@#y_Yh-y%!+#cS1mKSW;1Jgru2t>AF&wAwo}A z7=ZhWpGD2p4*>&^ODyJ)4~bg4y$Vif5&M<6h~!uKU+y#60=g!nrbIH9k?%@@Q9ZMx z+Yq}x{x^Wn#BY6wF#4?!sX`1n;95Sr+&HXnk`@Aj&o@A17ahJ6>+{`6*W)HVzl&Y$H$W6r~1K3 z&V<|8u*pvMbcNe`4DqESj4n%xJ{qklTF6#B;6%(tBE6+EW#i&3ve7yt`=h;m+B+2T zEw>%3(HJZIx}?Q>#n*3*NVZykKMy8mHuJYt4)gsG5$rvCg#s8;g`P`soML=5S5t6i zH^drMG2m-d*oe9_=iYwufMk=4ymO>49(R`sYbmrEyT!9_!xizjtJP~sB_2q`tG<1D_N7EcB$+9S z?sE#x*0(#EEl$)2HMU!vO{L;80}{edNh69%15NNBf$i9K2poF%9C7ZE$FV3_Qx)nmVW);0kYcmrxB@-`v1NyH4O!Qr6p(!f2Uijl3uxYe{0bU^!dqyiAPmqasq ziF7}#4^1b+66O})5roU*Yif;a6eFvDu`AP#s9EXdNoHb6AqJQcewR*2(h2Bu{ufn* z_dUh_*P}h;&8v;nznUK`@?mbe7`AMCL>CM9L3e!t@ZkcPqpj&CIP_ToKWa{+S30NT zgyLs><~}-bG~Ed2I=2(C)JxlCl~vWIKmrCd(y@uHQKrY!?*T?#5Z5Tqv|%~BOetoL^%RV$ zGg_S98oxuFtvp{py%XHEZ}7IYAPLWeloFTeAZF~n?f26q{meW#N=`_3j989|K!On^ zN(gCnBG*m{+MZC~#9D*$QKcYqv<09)t_-8@#~>YDA?3Ta$FP)M;W*lQm?|A`<9dFw zC>Y)8<6ww3iV3&3kB3?qnB~tY@O$*S9t=@mYQSn6`XN9Q0W8ImVk<#|lF-ZkyiK&C z{!eIdldU*7qw|m*vzuA|pWPHCpK%6Jk4i(lckgi1jjpUn51n7a=xSQ|L%KL|6rSaG zyl;{pV&&z!E;|7QFgCZ%jkVz8waz=5#6Y|I@fzy+gI_QI9@bF9ql#|e7UmTa(ZSPD z%Wt+vAbKqtb(0q$Ndh4wP{bGale}e)VzO!Vk;RdTRT3KD_YF?YZKr9wd#fZ?&0-G#S}?o^aBo7XE!#98?%PT)I)2Y^G&!GG#1 z1yEfJvWofai;FspmwF*!EDftH@hBz|lq(I0WNUTetBuI9!Hw5LLmxzI(M_A%aYvgx z567!TIeXc;ei!7+ z&){;v?&}&-|B|4jC!6aFliaYMOTng($2b2omdv^?NxUU*U0A;0}V)K6V+OA&1#JEjW>hxvD-HDsxVY zBaEUSq_8^5-|7;sCz+OZI`H5|p^T4*7p6=c`2#AI2=%l78&}$@>=?ouy@(cW{}!Ny zW(DOB*oTwnrX`~EpY){~Q#r0piqNePaBB?6+;Q=uApsXz#F9tqR|(AAWrAon=02^b zkos9@uh4mi*j=$dvU&l@CYl)<9u)b|y8=(QTGRFB?E?329H^OY<_hc?voZpQJm`Pk;pjB1X;w=bRaf(p(-ANRo9EZ){nM&;~e1c z@GSA8=ZpV0gx&MVrj)PgP1Je-I_f1*Eq^*kvj@o|~L|#PLlSrbx6& zx}oUhBHRc2G?2~GQrOkA`qahKK$ zN|Cv+cRIH&n?sycdIbH}G~jq1Or-QLSg~46J%%>k$sOxOzS3nL_FIj4_(DUUet`?Z z3GF*v^_id?7+l;F7SPlxl(&14$H}unRRTE0F^PYppRNjruE*I^lG%>x-5CiN-1Pq6{639C!)A-gshz;!Q!ZAa|~5G+Rd~yJy~^?n;-@^?In_@ z+ntwdu>nyRRd%hYuDnA^byP58|S+${N-_W{(sP{p-N}4dHXmP_v8qy3PUx(v|o$b41jX8dT zEyQVtDv?OlfaoO=wTT2r2Sg6el!_Y4u*X84Lnf;uIg$>RNq`~HfQu2o=PpR{O` zR4EgQ(zeauV4bKf<@S=SPI72{ z{p7~*%q4-gLGbma@RNhm?6AchfXz zXRro?(hF^T391(uy+LsUF81*VI`*-M>>34NWFD9nNl#}6Ju(>&FyRb#yz$dHS?q$< zb{i$uJr5-I!>joUg1}DC?_0Dv*O$LjscLFAbG0>guh|AAj`B9DiC(+mYZ1dimmU6*M&W2@$W{lcu&~H-JjW$U80|YBSzU1 z>m_5!w|Lm(<>wbEP7G&=S#Ns$)C-?r6Fcty2kR%;#4P$L->~Ss@%RtPiR4KO`79Sr z|DiGe?S-17_TwLw>i_;I-{4~jL+*RtLA+D*=P?MTtj~qtd+!P0$t)M-=0)rUW)! zdit$QX3vsjW;2=U5QbH?r3=SD9*o|AC>EV|aPe?u*%&^Q*GwIB`42u(GX-Cq|84Tr z5syDJ!uk8RIz3b0z=S&_w1S1!Rk0r>jWKx~ZoSxiuPk>z{VM0uzYl%7)UQEz8~XprC8 zP-J^uph)!@<8ERLSKt=jGjy5A-HVluKzNlu{!WP$F-_pXjy){Kd$9$7XoGkSImX9E zzft@wGANwpL}=Q|oM?;gG=%Cj@OV}7!{$)x{_iH|P;=(o(4d< z@G(DXv%)_T{-+4W(Y*y3R8hbjwnr-+l)cQ)nmvz9aH3zEe#h{U&hfoHx0l}*x;gpY zN>lhvtKG9eU$7U1qQ|5dG@ZsAtA+{w)V^jBc((OZ;$EhfYB^s#FyeZ8{rX~0_rvb5 z^8Jxa?)fiJY^oBgHV=LZ)XrQzgo1qmz0S-}%%&6#HN$ zpZ3bRu4n01n^^ydr^IegQV@&C9s9wz?>A-NTW`@9?QnCt8QMZR*$=gw0?*`9Zcbak zN`A+kRS*KZ^3_XcH}+G+d;YDuNBjFIWY)}#baia%j(kYO^}u#aN4xJ;gyYJ0|M~5) ze4^a3-*LBC%=KUev7wSdk0CvLw1|0m!$t>v5STAGQddG-5%r5;y?VoohYeV^-GKF3 z5CSgZ7BLU5ib3MN<-@K4vea)Lsjgh#&r&Dwp2(mvU|W3|@kQ>|)vj=B)ai^OlMhEM z2b&dzEwVn$*&C6)HfbA(BNGJqFi%CP>K7J}Z4^J$w1A*`-znrn@1w!HdcK@R+Y&~U z;sF?n zv!W8L|L)J%2QOV7{H~v^HpPy}`=fz#RH~L=m&&Re5o>uW;Ib-Fv)JV(T~d>VZc88RV(Uq zZij;ul_8i&uap+%!H_c;ABnt)=L$CnvjHZcemLD6rjGT1B0@MUX8n-GEW!{cXw<4~ zU*}i8prx2R>AU_SZ)_K>3w6y^a*@sl63l*E|RX9776xP#Kd zX(pnTHJGTn01JxzRO`bom)Br(g9WF?$7q*lI_(io_KT_ff%+VRUFdd|cO|#{w-LCgG)#a)-dsR&wn%%FZr5vn*U5&>>^NW6?jfIlnS7p*p z!jPCr#c;6H>e-b>pf>k5Ls41{gr>vAd~~1fa#DV7E>&1(&t)i8*c>g2HWV(-Fb%~P zzLEF;W53mJ_VNp`g?8;|5idI{ux(mmD%K666b$ugC<)>R;?7`KF$iZn#Z^B`V^Shf zWtP+XAN6g9E^;j8qv7;E2qVvNkOBm3+>8T>Wp3lhg{8iQAyV!Nj<0u8{=Pa|VI@Gj zp?#etf8S(J@!oY82#FS3Nb=4RDN(IAruH$pfbJ@ zo<)uKNO?1q$U|Q-YLBZJDR8tFc*LkdRX@@hYV=8lk=^uxW)<-Z$uGTYPdIaYaBzf3 zyQNy_@aHC42V#)i2?76#UDUnHliBdd2C8bL$oB-TiH>Hl*S@d85b3EC50Y)ejOcgV`sZf-Q{YTa0fRY zS;94L;m1Pkx9`eA$qzEh0y<+a;Y@k2*E={2J473~gzTmh!;7@9f7s^jiah^_$ZVe- zZgm`d%vnB+gYAxhA)^iVU1-k258?t(;z{LnMeN~V=XIFv5%Fz-*u7*M$5I^mMc?ufgGgn+%TenvpOOwPLU20eVt$)>Vbd1=ZqwQrBq@fasl zxGE43kUXCLBOo0F*MADe5zL-e##CxLE1V`KMl{hl`0GC+;Pj7WOdXnKcC-A{8E;H{ zOtOl{jWFEV4cPg1ZcE0RCQNc{MS)np+x1nmnr+PCTVndpqtRSpxIVJZby<2Rh1>f3 zSKfi=bY9Q<2a_3lJ~}_OZ;Io5isVKnY8qsa=b5_x7Ds%NNV_%RB|&-Fe~SiQTJ;^5f1{wOUvg{*hPtbo;S! z!2B0Ehvhbg0>KI<{lt_>KwCWRI=-u>u>qZs6bpTKgL(==g^Cu*N)3GyGbqAxmt%fR z(-VXHR=n=F74-JBQTBYPe$I!XQEvW@-R_s0A%6W#Wyy$f40Ab@$)n9vix=k>b# z8kBN_=`yu8xQ7K&fF`ix(|0NkrnEL`oFQ71v^cV()jz%)OA`0#1u`2xZ_q-D zQh%tv`Gz@D@7`GA`~9Ve>(ZNd&is_RGt-8 zfm(HsqAZ4&3dPnaRDUr-QThG54>ZZa{Qb@&h~O5{(d_VWi{-cHe>W#;-lRtj)Rs^? z0HxlB-hNWpgKmktB8Wcv$3_d9RgHFo(YkpV$ZAjiQP85V^5haC`> zb=uLLo}?)0PAS~T6+ | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。 | +| [imageSmoothingEnabled](#imagesmoothingenabled6)6+ | boolean | true | 用于设置绘制图片时是否进行图像平滑度调整，true为启用，false为不启用。 | ### fillStyle diff --git a/zh-cn/application-dev/usb/Readme-CN.md b/zh-cn/application-dev/usb/Readme-CN.md deleted file mode 100644 index 0c28cb672f..0000000000 --- a/zh-cn/application-dev/usb/Readme-CN.md +++ /dev/null @@ -1,4 +0,0 @@ -# USB服务 - -- [USB服务开发概述](usb-overview.md) -- [USB服务开发指导](usb-guidelines.md) -- GitLab