diff --git a/CODEOWNERS b/CODEOWNERS index 9a557753d3206996fb43ed7fe73d482968fee112..7c6530eb16de9051510d7344025cf8b61c566c78 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -29,11 +29,22 @@ zh-cn/device-dev/quick-start/quickstart-lite-env-setup.md @li-yan339 @chenmudan zh-cn/device-dev/porting/porting-thirdparty-overview.md @Austin23 @chenmudan zh-cn/device-dev/porting/porting-thirdparty-makefile.md @Austin23 @chenmudan zh-cn/device-dev/porting/porting-thirdparty-cmake.md @Austin23 @chenmudan -zh-cn/device-dev/subsystems/subsys-build-mini-lite.md @Austin23 @chenmudan -zh-cn/device-dev/subsystems/subsys-build-standard-large.md @Austin23 @chenmudan -zh-cn/device-dev/subsystems/subsys-build-gn-coding-style-and-best-practice.md @Austin23 @chenmudan -zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md @Austin23 @chenmudan -zh-cn/device-dev/subsystems/subsys-build-gn-hap-compilation-guide.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-all.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-gn-coding-style-and-best-practice.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-product.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-zh-cn/device-dev/subsystems/subsystem.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-component.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-module.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-chip_solution.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-feature.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-syscap.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-reference.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-reference.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-reference.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-reference.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-gn-hap-compilation-guide.md @Austin23 @chenmudan +zh-cn/device-dev/subsystems/subsys-build-FAQ.md @Austin23 @chenmudan zh-cn/device-dev/subsystems/subsys-remote-start.md @duangavin123_admin zh-cn/device-dev/subsystems/subsys-graphics-overview.md @duangavin123_admin zh-cn/device-dev/subsystems/subsys-graphics-container-guide.md @duangavin123_admin @@ -210,6 +221,7 @@ zh-cn/application-dev/reference/apis/js-apis-router.md @HelloCrease zh-cn/application-dev/reference/apis/js-apis-display.md @ge-yafang zh-cn/application-dev/reference/apis/js-apis-screenshot.md @ge-yafang zh-cn/application-dev/reference/apis/js-apis-window.md @ge-yafang +zh-cn/application-dev/reference/apis/js-apis-effectKit.md @ge-yafang zh-cn/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md @ge-yafang zh-cn/application-dev/reference/apis/js-apis-screen.md @ge-yafang zh-cn/application-dev/reference/apis/js-apis-windowAnimationManager.md @ge-yafang @@ -219,7 +231,7 @@ zh-cn/application-dev/reference/apis/js-apis-audio.md @zengyawen zh-cn/application-dev/reference/apis/js-apis-camera.md @zengyawen zh-cn/application-dev/reference/apis/js-apis-image.md @zengyawen zh-cn/application-dev/reference/apis/js-apis-media.md @zengyawen -zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @qinxiaowang +zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @zengyawen zh-cn/application-dev/reference/apis/js-apis-i18n.md @HelloCrease zh-cn/application-dev/reference/apis/js-apis-intl.md @HelloCrease zh-cn/application-dev/reference/apis/js-apis-resource-manager.md @HelloCrease @@ -305,6 +317,7 @@ zh-cn/application-dev/reference/apis/js-apis-system-parameter.md @qinxiaowang zh-cn/application-dev/reference/apis/js-apis-thermal.md @qinxiaowang zh-cn/application-dev/reference/apis/js-apis-update.md @HelloCrease zh-cn/application-dev/reference/apis/js-apis-usb.md @ge-yafang +zh-cn/application-dev/reference/apis/js-apis-colorSpaceManager.mdd @ge-yafang zh-cn/application-dev/reference/apis/js-apis-vibrator.md @HelloCrease zh-cn/application-dev/reference/apis/js-apis-appAccount.md @zengyawen zh-cn/application-dev/reference/apis/js-apis-distributed-account.md @zengyawen @@ -352,4 +365,7 @@ zh-cn/application-dev/reference/apis/js-apis-buffer.md @zengyawen zh-cn/application-dev/reference/js-service-widget-ui @HelloCrease zh-cn/application-dev/website.md @zengyawen zh-cn/application-dev/faqs/ @zengyawen -zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md @zengyawen \ No newline at end of file +zh-cn/application-dev/reference/apis/js-apis-useriam-faceauth.md @zengyawen +zh-cn/application-dev/reference/apis/js-apis-userfilemanager.md @zengyawen +zh-cn/application-dev/reference/apis/js-apis-cryptoFramework.md @zengyawen +zh-cn/application-dev/reference/apis/Readme-CN.md @zengyawen \ No newline at end of file diff --git a/OAT.xml b/OAT.xml index 8cc884632d4a963fa921c5905cfbf96e7e22edb7..4edf72f5a3b3e03801bdab83dad547cd7c0c18ef 100644 --- a/OAT.xml +++ b/OAT.xml @@ -66,7 +66,7 @@ - + diff --git a/en/application-dev/Readme-EN.md b/en/application-dev/Readme-EN.md index 5854144672c9a672c58e889857e1697fe4fa1ab2..f3fa0e7ac0e9b829f2418e4b1bf96001e66553d2 100644 --- a/en/application-dev/Readme-EN.md +++ b/en/application-dev/Readme-EN.md @@ -37,7 +37,7 @@ - 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) + - [Samples](https://gitee.com/openharmony/applications_app_samples/blob/master/README.md) - [Codelabs](https://gitee.com/openharmony/codelabs) - API References - [Component Reference (JavaScript-based Web-like Development Paradigm)](reference/arkui-js/Readme-EN.md) @@ -47,5 +47,6 @@ - Native APIs - [Standard Libraries](reference/native-lib/third_party_libc/musl.md) - [Node_API](reference/native-lib/third_party_napi/napi.md) +- [FAQs](faqs/Readme-EN.md) - Contribution - [How to Contribute](../contribute/documentation-contribution.md) diff --git a/en/application-dev/ability/context-userguide.md b/en/application-dev/ability/context-userguide.md index ba95ade27a3c7cb846be2d254fd3b75d65dd8701..d3e681244166cafecff86575dd1850db4ebf7f90 100644 --- a/en/application-dev/ability/context-userguide.md +++ b/en/application-dev/ability/context-userguide.md @@ -7,9 +7,11 @@ The OpenHarmony application framework has two models: Feature Ability (FA) model and stage model. Correspondingly, there are two sets of context mechanisms. **application/BaseContext** is a common context base class. It uses the **stageMode** attribute to specify whether the context is used for the stage model. - FA model + Only the methods in **app/Context** can be used for the context in the FA model. Both the application-level context and ability-level context are instances of this type. If an ability-level method is invoked in the application-level context, an error occurs. Therefore, you must pay attention to the actual meaning of the **Context** instance. - Stage model + The stage model has the following types of contexts: **application/Context**, **application/ApplicationContext**, **application/AbilityStageContext**, **application/ExtensionContext**, **application/AbilityContext**, and **application/FormExtensionContext**. For details about these contexts and how to use them, see [Context in the Stage Model](#context-in-the-stage-model). ![contextIntroduction](figures/contextIntroduction.png) diff --git a/en/application-dev/ability/figures/contextIntroduction.png b/en/application-dev/ability/figures/contextIntroduction.png index 9f49f270750549a5326724dc0db1560dbda07c44..7345a1a5a6a3471782e9399129c98f3d529bbfd5 100644 Binary files a/en/application-dev/ability/figures/contextIntroduction.png and b/en/application-dev/ability/figures/contextIntroduction.png differ diff --git a/en/application-dev/ability/figures/stage-call.png b/en/application-dev/ability/figures/stage-call.png index 28f2a0f7ea9d86fc81e0c1a37d556384b14a9bdd..4c0c0770a4dce6f275b0fc355f70c5dfca2adb17 100644 Binary files a/en/application-dev/ability/figures/stage-call.png and b/en/application-dev/ability/figures/stage-call.png differ diff --git a/en/application-dev/ability/stage-ability-continuation.md b/en/application-dev/ability/stage-ability-continuation.md index 6945f49db8ef05109452fc1b3dcad3dc1e5ddeca..701b730a833a7b97f00398746cddae4d2856a248 100644 --- a/en/application-dev/ability/stage-ability-continuation.md +++ b/en/application-dev/ability/stage-ability-continuation.md @@ -41,7 +41,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar "module": { "abilities": [ { - "continuable": true, + "continuable": true } ] } @@ -62,7 +62,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar "module": { "abilities": [ { - "launchType": "standard", + "launchType": "standard" } ] } @@ -76,7 +76,7 @@ The code snippets provided below are all from [Sample](https://gitee.com/openhar "module": { "abilities": [ { - "launchType": "singleton", + "launchType": "singleton" } ] } diff --git a/en/application-dev/ability/stage-call.md b/en/application-dev/ability/stage-call.md index 6b5823e76db2c95190111a55b9d2ef43ddd2d946..390e1b6c3ce5393956d0a7801f362ab7f49578a4 100644 --- a/en/application-dev/ability/stage-call.md +++ b/en/application-dev/ability/stage-call.md @@ -1,43 +1,63 @@ # Ability Call Development ## When to Use -Ability call is an extension of the ability capabilities. It enables an ability to be invoked by external systems. In this way, the ability can be displayed as a UI page on the foreground and created and run on the background. You can use the **Call** APIs to implement data sharing between different abilities through inter-process communication (IPC). There are two roles in the ability call: caller and callee. The following scenarios are involved in the ability call development: -- Creating a callee -- Accessing the callee +Ability call is an extension of the ability capability. It enables an ability to be invoked by and communicate with external systems. The ability invoked can be either started in the foreground or created and run in the background. You can use the ability call to implement data sharing between two abilities (caller ability and callee ability) through inter-process communication (IPC). -The following figure shows the ability call process. +The core API used for the ability call is `startAbilityByCall`, which differs from `startAbility` in the following ways: + - `startAbilityByCall` supports ability startup in the foreground and background, whereas `startAbility` supports ability startup in the foreground only. + - The caller ability can use the `Caller` object returned by `startAbilityByCall` to communicate with the callee ability, but `startAbility` does not provide the communication capability. +Ability call is usually used in the following scenarios: +- Communicating with the callee ability +- Starting the callee ability in the background + +**Table 1** Terms used in the ability call +|Term|Description| +|:------|:------| +|Caller ability|Ability that triggers the ability call.| +|Callee ability|Ability invoked by the ability call.| +|Caller |Object returned by `startAbilityByCall` and used by the caller ability to communicate with the callee ability.| +|Callee |Object held by the callee ability to communicate with the caller ability.| +|IPC |Inter-process communication.| + +The ability call process is as follows: + - The caller ability uses `startAbilityByCall` to obtain a `Caller` object and uses `call()` of the `Caller` object to send data to the callee ability. + - The callee ability, which holds a `Callee` object, uses `on()` of the `Callee` object to register a callback. This callback is invoked when the callee ability receives data from the caller ability. ![stage-call](figures/stage-call.png) -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
-> The startup mode of the callee must be **singleton**. -> Currently, only system applications and Service Extension abilities can use the **Call** APIs to access the callee. +> **NOTE**
+> The launch type of the callee ability must be `singleton`. +> Currently, only system applications can use the ability call. ## Available APIs The table below describes the ability call APIs. For details, see [Ability](../reference/apis/js-apis-application-ability.md#caller). -**Table 1** Ability call APIs +**Table 2** Ability call APIs |API|Description| |:------|:------| -|startAbilityByCall(want: Want): Promise\|Obtains the caller interface of the specified ability and, if the specified ability is not running, starts the ability in the background.| -|on(method: string, callback: CalleeCallBack): void|Callback invoked when the callee registers a method.| -|off(method: string): void|Callback invoked when the callee deregisters a method.| -|call(method: string, data: rpc.Sequenceable): Promise\|Sends agreed sequenceable data to the callee.| -|callWithResult(method: string, data: rpc.Sequenceable): Promise\|Sends agreed sequenceable data to the callee and returns the agreed sequenceable data.| -|release(): void|Releases the caller interface.| -|onRelease(callback: OnReleaseCallBack): void|Registers a callback that is invoked when the caller is disconnected.| +|startAbilityByCall(want: Want): Promise\|Starts an ability in the foreground (through the `want` configuration) or background (default) and obtains the `Caller` object for communication with the ability. For details, see [AbilityContext](../reference/apis/js-apis-ability-context.md#abilitycontextstartabilitybycall) or [ServiceExtensionContext](../reference/apis/js-apis-service-extension-context.md#serviceextensioncontextstartabilitybycall).| +|on(method: string, callback: CalleeCallBack): void|Callback invoked when the callee ability registers a method.| +|off(method: string): void|Callback invoked when the callee ability deregisters a method.| +|call(method: string, data: rpc.Sequenceable): Promise\|Sends agreed sequenceable data to the callee ability.| +|callWithResult(method: string, data: rpc.Sequenceable): Promise\|Sends agreed sequenceable data to the callee ability and obtains the agreed sequenceable data returned by the callee ability.| +|release(): void|Releases the `Caller` object.| +|onRelease(callback: OnReleaseCallBack): void|Callback invoked when the `Caller` object is released.| ## How to Develop -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
-> The sample code snippets provided in the **How to Develop** section are used to show specific development steps. They may not be able to run independently. -### Creating a Callee -For the callee, implement the callback to receive data and the methods to marshal and unmarshal data. When data needs to be received, use the **on** API to register a listener. When data does not need to be received, use the **off** API to deregister the listener. -1. Configure the ability startup mode. +The procedure for developing the ability call is as follows: +1. Create a callee ability. +2. Access the callee ability. +> **NOTE** +> +> The code snippets provided in the **How to Develop** section are used to show specific development steps. They may not be able to run independently. +### Creating a Callee Ability +For the callee ability, implement the callback to receive data and the methods to marshal and unmarshal data. When data needs to be received, use `on()` to register a listener. When data does not need to be received, use `off()` to deregister the listener. +**1. Configure the ability launch type.** - Set the ability of the callee to **singleton** in the **module.json5** file. + Set `launchType` of the callee ability to `singleton` in the `module.json5` file. |JSON Field|Description| |:------|:------| -|"launchType"|Ability startup mode. Set this parameter to **singleton**.| +|"launchType"|Ability launch type. Set this parameter to `singleton`.| An example of the ability configuration is as follows: ```json @@ -51,17 +71,17 @@ An example of the ability configuration is as follows: "visible": true }] ``` -2. Import the **Ability** module. -``` +**2. Import the Ability module.** +```ts import Ability from '@ohos.application.Ability' ``` -3. Define the agreed sequenceable data. +**3. Define the agreed sequenceable data.** - The data formats sent and received by the caller and callee must be consistent. In the following example, the data consists of numbers and strings. The sample code snippet is as follows: + The data formats sent and received by the caller and callee abilities must be consistent. In the following example, the data formats are number and string. The code snippet is as follows: ```ts export default class MySequenceable { num: number = 0 - str: String = "" + str: string = "" constructor(num, string) { this.num = num @@ -81,23 +101,23 @@ export default class MySequenceable { } } ``` -4. Implement **Callee.on** and **Callee.off**. +**4. Implement `Callee.on` and `Callee.off`.** - The time to register a listener for the callee depends on your application. The data sent and received before the listener is registered and that after the listener is deregistered are not processed. In the following example, the **MSG_SEND_METHOD** listener is registered in **onCreate** of the ability and deregistered in **onDestroy**. After receiving sequenceable data, the application processes the data and returns the data result. You need to implement processing based on service requirements. The sample code snippet is as follows: + The time to register a listener for the callee ability depends on your application. The data sent and received before the listener is registered and that after the listener is deregistered are not processed. In the following example, the `MSG_SEND_METHOD` listener is registered in `onCreate` of the ability and deregistered in `onDestroy`. After receiving sequenceable data, the application processes the data and returns the data result. You need to implement processing based on service requirements. The code snippet is as follows: ```ts const TAG: string = '[CalleeAbility]' const MSG_SEND_METHOD: string = 'CallSendMsg' function sendMsgCallback(data) { - Logger.log(TAG, 'CalleeSortFunc called') + console.log('CalleeSortFunc called') - // Obtain the sequenceable data sent by the caller. + // Obtain the sequenceable data sent by the caller ability. let receivedData = new MySequenceable(0, '') data.readSequenceable(receivedData) - Logger.log(TAG, `receiveData[${receivedData.num}, ${receivedData.str}]`) + console.log(`receiveData[${receivedData.num}, ${receivedData.str}]`) // Process the data. - // Return the sequenceable data result to the caller. + // Return the sequenceable data result to the caller ability. return new MySequenceable(receivedData.num + 1, `send ${receivedData.str} succeed`) } @@ -106,7 +126,7 @@ export default class CalleeAbility extends Ability { try { this.callee.on(MSG_SEND_METHOD, sendMsgCallback) } catch (error) { - Logger.error(TAG, `${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`) + console.log(`${MSG_SEND_METHOD} register failed with error ${JSON.stringify(error)}`) } } @@ -120,15 +140,27 @@ export default class CalleeAbility extends Ability { } ``` -### Accessing the Callee -1. Import the **Ability** module. -``` +### Accessing the Callee Ability +**1. Import the Ability module.** +```ts import Ability from '@ohos.application.Ability' ``` -2. Obtain the caller interface. +**2. Obtain the `Caller` object.** - The **context** attribute of the ability implements **startAbilityByCall** to obtain the caller interface of the ability. The following example uses **this.context** to obtain the **context** attribute of the **Ability** instance, uses **startAbilityByCall** to start the callee, obtain the caller interface, and register the **onRelease** listener of the caller. You need to implement processing based on service requirements. The sample code snippet is as follows: + The `context` attribute of the ability implements `startAbilityByCall` to obtain the `Caller` object for communication. The following example uses `this.context` to obtain the `context` attribute of the ability, uses `startAbilityByCall` to start the callee ability, obtain the `Caller` object, and register the `onRelease` listener of the caller ability. You need to implement processing based on service requirements. The code snippet is as follows: ```ts +// Register the onRelease listener of the caller ability. +private regOnRelease(caller) { + try { + caller.onRelease((msg) => { + console.log(`caller onRelease is called ${msg}`) + }) + console.log('caller register OnRelease succeed') + } catch (error) { + console.log(`caller register OnRelease failed with ${error}`) + } +} + async onButtonGetCaller() { try { this.caller = await context.startAbilityByCall({ @@ -136,73 +168,74 @@ async onButtonGetCaller() { abilityName: 'CalleeAbility' }) if (this.caller === undefined) { - Logger.error(TAG, 'get caller failed') + console.log('get caller failed') return } - Logger.log(TAG, 'get caller success') + console.log('get caller success') this.regOnRelease(this.caller) } catch (error) { - Logger.error(TAG, `get caller failed with ${error}`) + console.log(`get caller failed with ${error}`) } -}.catch((error) => { - console.error(TAG + 'get caller failed with ' + error) -}) +} ``` - In the cross-device scenario, you need to specify the ID of the peer device. The sample code snippet is as follows: + In the cross-device scenario, you need to specify the ID of the peer device. The code snippet is as follows: ```ts -let TAG = '[MainAbility] ' -var caller = undefined -let context = this.context - -context.startAbilityByCall({ - deviceId: getRemoteDeviceId(), - bundleName: 'com.samples.CallApplication', - abilityName: 'CalleeAbility' -}).then((data) => { - if (data != null) { - caller = data - console.log(TAG + 'get remote caller success') - // Register the onRelease listener of the caller. - caller.onRelease((msg) => { - console.log(TAG + 'remote caller onRelease is called ' + msg) - }) - console.log(TAG + 'remote caller register OnRelease succeed') - } -}).catch((error) => { - console.error(TAG + 'get remote caller failed with ' + error) -}) +async onButtonGetRemoteCaller() { + var caller = undefined + var context = this.context + + context.startAbilityByCall({ + deviceId: getRemoteDeviceId(), + bundleName: 'com.samples.CallApplication', + abilityName: 'CalleeAbility' + }).then((data) => { + if (data != null) { + caller = data + console.log('get remote caller success') + // Register the onRelease listener of the caller ability. + caller.onRelease((msg) => { + console.log(`remote caller onRelease is called ${msg}`) + }) + console.log('remote caller register OnRelease succeed') + } + }).catch((error) => { + console.error(`get remote caller failed with ${error}`) + }) +} ``` - Obtain the ID of the peer device from **DeviceManager**. Note that the **getTrustedDeviceListSync** API is open only to system applications. The sample code snippet is as follows: + Obtain the ID of the peer device from `DeviceManager`. Note that the `getTrustedDeviceListSync` API is open only to system applications. The code snippet is as follows: ```ts import deviceManager from '@ohos.distributedHardware.deviceManager'; var dmClass; function getRemoteDeviceId() { if (typeof dmClass === 'object' && dmClass != null) { - var list = dmClass.getTrustedDeviceListSync(); + var list = dmClass.getTrustedDeviceListSync() if (typeof (list) == 'undefined' || typeof (list.length) == 'undefined') { - console.log("MainAbility onButtonClick getRemoteDeviceId err: list is null"); - return; + console.log("MainAbility onButtonClick getRemoteDeviceId err: list is null") + return } - console.log("MainAbility onButtonClick getRemoteDeviceId success:" + list[0].deviceId); - return list[0].deviceId; + console.log("MainAbility onButtonClick getRemoteDeviceId success:" + list[0].deviceId) + return list[0].deviceId } else { - console.log("MainAbility onButtonClick getRemoteDeviceId err: dmClass is null"); + console.log("MainAbility onButtonClick getRemoteDeviceId err: dmClass is null") } } ``` - In the cross-device scenario, the application must also apply for the data synchronization permission from end users. The sample code snippet is as follows: + In the cross-device scenario, your application must also apply for the data synchronization permission from end users. The code snippet is as follows: ```ts -let context = this.context -let permissions: Array = ['ohos.permission.DISTRIBUTED_DATASYNC'] -context.requestPermissionsFromUser(permissions).then((data) => { - console.log("Succeed to request permission from user with data: "+ JSON.stringify(data)) -}).catch((error) => { - console.log("Failed to request permission from user with error: "+ JSON.stringify(error)) -}) +requestPermission() { + let context = this.context + let permissions: Array = ['ohos.permission.DISTRIBUTED_DATASYNC'] + context.requestPermissionsFromUser(permissions).then((data) => { + console.log("Succeed to request permission from user with data: "+ JSON.stringify(data)) + }).catch((error) => { + console.log("Failed to request permission from user with error: "+ JSON.stringify(error)) + }) +} ``` -3. Send agreed sequenceable data. +**3. Send agreed sequenceable data.** - The sequenceable data can be sent to the callee with or without a return value. The method and sequenceable data must be consistent with those of the callee. The following example describes how to invoke the **Call** API to send data to the callee. The sample code snippet is as follows: + The sequenceable data can be sent to the callee ability with or without a return value. The method and sequenceable data must be consistent with those of the callee ability. The following example describes how to send data to the callee ability. The code snippet is as follows: ```ts const MSG_SEND_METHOD: string = 'CallSendMsg' async onButtonCall() { @@ -210,12 +243,12 @@ async onButtonCall() { let msg = new MySequenceable(1, 'origin_Msg') await this.caller.call(MSG_SEND_METHOD, msg) } catch (error) { - Logger.error(TAG, `caller call failed with ${error}`) + console.log(`caller call failed with ${error}`) } } ``` - In the following, **CallWithResult** is used to send data **originMsg** to the callee and assign the data processed by the **CallSendMsg** method to **backMsg**. The sample code snippet is as follows: + In the following, `CallWithResult` is used to send data `originMsg` to the callee ability and assign the data processed by the `CallSendMsg` method to `backMsg`. The code snippet is as follows: ```ts const MSG_SEND_METHOD: string = 'CallSendMsg' originMsg: string = '' @@ -224,26 +257,28 @@ async onButtonCallWithResult(originMsg, backMsg) { try { let msg = new MySequenceable(1, originMsg) const data = await this.caller.callWithResult(MSG_SEND_METHOD, msg) - Logger.log(TAG, 'caller callWithResult succeed') + console.log('caller callWithResult succeed') let result = new MySequenceable(0, '') data.readSequenceable(result) backMsg(result.str) - Logger.log(TAG, `caller result is [${result.num}, ${result.str}]`) + console.log(`caller result is [${result.num}, ${result.str}]`) } catch (error) { - Logger.error(TAG, `caller callWithResult failed with ${error}`) + console.log(`caller callWithResult failed with ${error}`) } } ``` -4. Release the caller interface. +**4. Release the `Caller` object.** - When the caller interface is no longer required, call the **release** API to release it. The sample code snippet is as follows: + When the `Caller` object is no longer required, use `release()` to release it. The code snippet is as follows: ```ts -try { - this.caller.release() - this.caller = undefined - Logger.log(TAG, 'caller release succeed') -} catch (error) { - Logger.error(TAG, `caller release failed with ${error}`) +releaseCall() { + try { + this.caller.release() + this.caller = undefined + console.log('caller release succeed') + } catch (error) { + console.log(`caller release failed with ${error}`) + } } ``` diff --git a/en/application-dev/ability/wantagent.md b/en/application-dev/ability/wantagent.md index eacc92936960cca3bd022e6438a63c15a8f2688a..5a85bab15b8422aaabb0a173ad888126e08fc038 100644 --- a/en/application-dev/ability/wantagent.md +++ b/en/application-dev/ability/wantagent.md @@ -1,6 +1,8 @@ # WantAgent Development ## When to Use -The **WantAgent** class encapsulates want information that specifies a particular action, which can be starting an ability or publishing a common event. You can either call **wantAgent.trigger** to trigger a **WantAgent** directly or add a **WantAgent** to a notification so that it will be triggered when users tap the notification. +The **WantAgent** class encapsulates want information that specifies a particular action, which can be starting an ability or publishing a common event. You can either call **wantAgent.trigger** to trigger a **WantAgent** directly or add a **WantAgent** to a notification so that it will be triggered when users tap the notification. + + ## Available APIs | API | Description| @@ -21,7 +23,7 @@ The **WantAgent** class encapsulates want information that specifies a particula ``` private wantAgentObj = null // Save the WantAgent object created. It will be used to complete the trigger operations. - //wantAgentInfo + // wantAgentInfo var wantAgentInfo = { wants: [ { @@ -45,7 +47,7 @@ The **WantAgent** class encapsulates want information that specifies a particula ``` private wantAgentObj = null // Save the WantAgent object created. It will be used to complete the trigger operations. - //wantAgentInfo + // wantAgentInfo var wantAgentInfo = { wants: [ { diff --git a/en/application-dev/application-dev-guide-for-gitee.md b/en/application-dev/application-dev-guide-for-gitee.md index e60f2c01333c1bef7324b3ef6cfe2c83821a95cd..f074e1906535d708b193adea3b1ee3308fb0de4e 100644 --- a/en/application-dev/application-dev-guide-for-gitee.md +++ b/en/application-dev/application-dev-guide-for-gitee.md @@ -47,7 +47,7 @@ DevEco Studio is a high-performance integrated development environment (IDE) rec ### Hands-On Tutorials -To make you better understand how functions work together and jumpstart your application development projects, we provide stripped-down, real-world [samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) and [codelabs](https://gitee.com/openharmony/codelabs). +To make you better understand how functions work together and jumpstart your application development projects, we provide stripped-down, real-world [samples](https://gitee.com/openharmony/applications_app_samples/blob/master/README.md) and [codelabs](https://gitee.com/openharmony/codelabs). ### API References diff --git a/en/application-dev/application-dev-guide.md b/en/application-dev/application-dev-guide.md index 7065480d1c4a12bd0984f4916d678c1bed7a4997..2b22839820539e2919f1a705595a47cc491df8d0 100644 --- a/en/application-dev/application-dev-guide.md +++ b/en/application-dev/application-dev-guide.md @@ -47,7 +47,7 @@ DevEco Studio is a high-performance integrated development environment (IDE) rec ### Hands-On Tutorials -To make you better understand how functions work together and jumpstart your application development projects, we provide stripped-down, real-world [samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) and [codelabs](https://gitee.com/openharmony/codelabs). +To make you better understand how functions work together and jumpstart your application development projects, we provide stripped-down, real-world [samples](https://gitee.com/openharmony/applications_app_samples/blob/master/README.md) and [codelabs](https://gitee.com/openharmony/codelabs). ### API References diff --git a/en/application-dev/database/database-datashare-guidelines.md b/en/application-dev/database/database-datashare-guidelines.md index c8cb5c503329f6dc49c66fe457eb0aa8e6debf78..495f3b538b48b22d2d97f213d0e32189be799560 100644 --- a/en/application-dev/database/database-datashare-guidelines.md +++ b/en/application-dev/database/database-datashare-guidelines.md @@ -13,7 +13,7 @@ The **DataShare** module allows an application to manage its own data and share |query?(uri: string, predicates: DataSharePredicates, columns: Array<string>, callback: AsyncCallback<Object>): void|Queries data from the database.| |delete?(uri: string, predicates: DataSharePredicates, callback: AsyncCallback<number>): void|Deletes data from the database.| -For more details, see [DataShareExtensionAbility](../reference/apis/js-apis-application-DataShareExtensionAbility.md). +For more information, see [DataShareExtensionAbility](../reference/apis/js-apis-application-DataShareExtensionAbility.md). **Table 2** APIs of the data consumer @@ -25,11 +25,11 @@ For more details, see [DataShareExtensionAbility](../reference/apis/js-apis-appl | query(uri: string, predicates: DataSharePredicates, columns: Array<string>, callback: AsyncCallback<DataShareResultSet>): void | Queries data from the database. | | delete(uri: string, predicates: DataSharePredicates, callback: AsyncCallback<number>): void | Deletes one or more data records from the database.| -For more details, see [DataShareHelper](../reference/apis/js-apis-data-dataShare.md). +For more information, see [DataShareHelper](../reference/apis/js-apis-data-dataShare.md). ## When to Use -There are two roles in **DataShare**. +There are two roles in **DataShare**: - Data provider: adds, deletes, modifies, and queries data, opens files, and shares data. - Data consumer: accesses the data provided by the provider using **DataShareHelper**. @@ -41,10 +41,10 @@ Examples are given below. 1. Import the dependencies. ```ts - import Extension from '@ohos.application.DataShareExtensionAbility' + import Extension from '@ohos.application.DataShareExtensionAbility'; import rdb from '@ohos.data.rdb'; - import fileIo from '@ohos.fileio' - import dataSharePredicates from '@ohos.data.dataSharePredicates' + import fileIo from '@ohos.fileio'; + import dataSharePredicates from '@ohos.data.dataSharePredicates'; ``` 2. Override **DataShareExtensionAbility** APIs based on actual requirements. For example, if the data provider provides only data query, override only the **query()** API. @@ -80,7 +80,7 @@ Examples are given below. } // Override the query() API. - query(uri, predicates, columns, callback) { + query(uri, predicates, columns, callback) { if (predicates == null || predicates == undefined) { console.info('invalid predicates'); } @@ -144,48 +144,49 @@ Examples are given below. let dseUri = ("datashare:///com.samples.datasharetest.DataShare"); ``` -2. Create a **DataShareHelper** instance. +3. Create a **DataShareHelper** instance. ```ts let dsHelper; let abilityContext; + export default class MainAbility extends Ability { onWindowStageCreate(windowStage) { abilityContext = this.context; - dataShare.createDataShareHelper(abilityContext, dseUri, (err,data)=>{ + dataShare.createDataShareHelper(abilityContext, dseUri, (err, data)=>{ dsHelper = data; }); } } ``` -3. Use the APIs provided by **DataShareHelper** to access the services provided by the provider, for example, adding, deleting, modifying, and querying data. +4. Use the APIs provided by **DataShareHelper** to access the services provided by the provider, for example, adding, deleting, modifying, and querying data. ```ts // Construct a piece of data. - var valuesBucket = {"name": "ZhangSan", "age": 21, "isStudent": false, "Binary": new Uint8Array([1,2,3])}; - var updateBucket = {"name": "LiSi", "age": 18, "isStudent": true, "Binary": new Uint8Array([1,2,3])}; - let da = new dataSharePredicates.DataSharePredicates(); - var valArray =new Array("*"); + var valuesBucket = { "name": "ZhangSan", "age": 21, "isStudent": false, "Binary": new Uint8Array([1, 2, 3]) }; + var updateBucket = { "name": "LiSi", "age": 18, "isStudent": true, "Binary": new Uint8Array([1, 2, 3]) }; + let da = new dataSharePredicates.DataSharePredicates(); + var valArray = new Array("*"); let people = new Array( - {"name": "LiSi", "age": 41, "Binary": ar}, - {"name": "WangWu", "age": 21, "Binary": arr}, - {"name": "ZhaoLiu", "age": 61, "Binary": arr}); + { "name": "LiSi", "age": 41, "Binary": ar }, + { "name": "WangWu", "age": 21, "Binary": arr }, + { "name": "ZhaoLiu", "age": 61, "Binary": arr }); // Insert a piece of data. - dsHelper.insert(dseUri, valuesBucket, (err,data) => { - console.log("dsHelper insert result: " + data); + dsHelper.insert(dseUri, valuesBucket, (err, data) => { + console.log("dsHelper insert result: " + data); }); // Delete data. - dsHelper.delete(dseUri, da, (err,data) => { - console.log("dsHelper delete result: " + data); + dsHelper.delete(dseUri, da, (err, data) => { + console.log("dsHelper delete result: " + data); }); // Update data. - dsHelper.update(dseUri, da, updateBucket, (err,data) => { - console.log("dsHelper update result: " + data); + dsHelper.update(dseUri, da, updateBucket, (err, data) => { + console.log("dsHelper update result: " + data); }); // Query data. - dsHelper.query(dseUri, da, valArray, (err,data) => { - console.log("dsHelper query result: " + data); + dsHelper.query(dseUri, da, valArray, (err, data) => { + console.log("dsHelper query result: " + data); }); ``` diff --git a/en/application-dev/database/database-distributedobject-guidelines.md b/en/application-dev/database/database-distributedobject-guidelines.md index eca90200a0d711c91f64643f453ff1d22a3a367f..ec77d5330b57751e36b3ba2d96b57028c340dd36 100644 --- a/en/application-dev/database/database-distributedobject-guidelines.md +++ b/en/application-dev/database/database-distributedobject-guidelines.md @@ -2,14 +2,13 @@ ## When to Use -Distributed data objects allow data traversing across devices to be processed like local variables by shielding complex data interaction between devices. For the devices that form a Super Device, when data in the distributed data object of an application is added, deleted, or modified on a device, the data for the same application is also updated on the other devices. The devices can listen for data changes and online and offline status changes of other devices. - -The distributed data objects support basic data types, such as number, string, and Boolean, as well as complex data types, such as array and nested basic types. +The **distributedDataObject** module provides APIs to implement data collaboration of the same application across multiple devices. In addition, the devices that form a Super Device can listen for object status and data changes with each other. +For example, when the data of a distributed data object is added, deleted, or modified for application A on device 1, application A on device 2 can obtain the updated data. In addition, device 2 can listen for data changes and online/offline of the data objects on device 1. ## Available APIs -For details about the APIs related to the distributed data object, see [Distributed Data Object](../reference/apis/js-apis-data-distributedobject.md). +For details about the APIs, see [Distributed Data Object](../reference/apis/js-apis-data-distributedobject.md). ### Creating a Distributed Data Object Instance @@ -17,53 +16,54 @@ Call **createDistributedObject()** to create a distributed data object instance. **Table 1** API for creating a distributed data object instance -| Package | API | Description | +| Package| API| Description| | -------- | -------- | -------- | -| ohos.data.distributedDataObject| createDistributedObject(source: object): DistributedObject | Creates a distributed data object instance for data operations.
- **source**: attributes of the **distributedObject** set.
- **DistributedObject**: returns the distributed object created.| +| ohos.data.distributedDataObject| createDistributedObject(source: object): DistributedObject | Creates a distributed data object instance for data operations.
- **source**: attributes of the distributed data object to set.
- **DistributedObject**: returns the distributed data object created. | ### Generating a Session ID Call **genSessionId()** to generate a session ID randomly. The generated session ID can be used to set the session ID of a distributed data object. **Table 2** API for generating a session ID randomly -| Package | API | Description | +| Package| API| Description| | -------- | -------- | -------- | | ohos.data.distributedDataObject| genSessionId(): string | Generates a session ID, which can be used as the session ID of a distributed data object.| -### Setting a SessionID for Distributed Data Objects +### Setting a Session ID for a Distributed Data Object Call **setSessionId()** to set a session ID for a distributed data object. The session ID is a unique identifier for one collaboration across devices. The distributed data objects to be synchronized must be associated with the same session ID. **Table 3** API for setting a session ID | Class| API| Description| | -------- | -------- | -------- | -| DistributedDataObject | setSessionId(sessionId?: string): boolean | Sets a session ID for distributed data objects.
**sessionId**: session ID of a distributed object in a trusted network. To remove a distributed data object from the network, set this parameter to "" or leave it empty.| +| DistributedDataObject | setSessionId(sessionId?: string): boolean | Sets a session ID for a distributed data object.
**sessionId**: session ID of a distributed data object in a trusted network. To remove a distributed data object from the network, set this parameter to "" or leave it empty. | ### Observing Data Changes -Call **on()** to subscribe to data changes of a distributed data object. In the case of data change, a callback will be invoked to return the data changes. You can use **off()** to unsubscribe from the data changes. +Call **on()** to subscribe to data changes of a distributed data object. When the data changes, a callback will be invoked to return the data changes. You can use **off()** to unsubscribe from the data changes. **Table 4** APIs for observing data changes of a distributed data object -| Class | API | Description | + +| Class| API| Description| | -------- | -------- | -------- | | DistributedDataObject| on(type: 'change', callback: Callback<{ sessionId: string, fields: Array<string> }>): void | Subscribes to data changes.| -| DistributedDataObject| off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<string> }>): void | Unsubscribes from data changes.
**Callback**: specifies callback used to return changes of the distributed data object. If this parameter is not specified, all callbacks related to data changes will be unregistered.| +| DistributedDataObject| off(type: 'change', callback?: Callback<{ sessionId: string, fields: Array<string> }>): void | Unsubscribes from data changes.
**Callback**: callback to unregister. If this parameter is not specified, all data changes of this distributed data object will be unsubscribed from. | ### Observing Online or Offline Status Call **on()** to subscribe to status changes of a distributed data object. The status can be online or offline. When the status changes, a callback will be invoked to return the status. You can use **off()** to unsubscribe from the status changes. **Table 5** APIs for observing status changes of a distributed data object -| Class | API | Description | +| Class| API| Description| | -------- | -------- | -------- | | DistributedDataObject| on(type: 'status', callback: Callback<{ sessionId: string, networkId: string, status: 'online' \| 'offline' }>): void | Subscribes to the status changes of a distributed data object.| | DistributedDataObject| off(type: 'status', callback?: Callback<{ sessionId: string, deviceId: string, status: 'online' \| 'offline' }>): void | Unsubscribes from status changes of a distributed data object.| -### Saving a Distributed Data Object and Revoking the Data Saving Operation +### Saving or Deleting a Distributed Data Object Call **save()** to save a distributed data object. When the application is active, the saved data will not be released. When the application exits and restarts, the data saved on the device will be restored. -Call **revokeSave()** to revoke a distributed data object that is no longer required. If the distributed data object is saved on the local device, **revokeSave()** will delete the data from all trusted devices. If the distributed data object is not saved on the local device, **revokeSave()** will delete the data from the local device. +Call **revokeSave()** to delete a distributed data object that is no longer required. If the distributed data object is saved on the local device, **revokeSave()** will delete the data from all trusted devices. If the distributed data object is not saved on the local device, **revokeSave()** will delete the data from the local device. The saved data will be released in the following cases: @@ -71,13 +71,12 @@ The saved data will be released in the following cases: - The application has been uninstalled. - Data is successfully restored. -**Table 6** APIs for saving a distributed data object and revoking the saving -| Class | API | Description | +**Table 6** APIs for saving and deleting a distributed data object + +| Class| API| Description| | -------- | -------- | -------- | -| DistributedDataObject | save(deviceId: string): Promise<SaveSuccessResponse> | Saves a distributed data object. This API uses a promise to return the result. | -| DistributedDataObject | save(deviceId: string, callback: AsyncCallback<SaveSuccessResponse>): void | Saves a distributed data object. This API uses an asynchronous callback to return the result. | -| DistributedDataObject | revokeSave(callback: AsyncCallback<RevokeSaveSuccessResponse>): void | Revokes the data saving operation. This API uses an asynchronous callback to return the result. | -| DistributedDataObject | revokeSave(): Promise<RevokeSaveSuccessResponse> | Revokes the data saving operation. This API uses a promise to return the result. | +| DistributedDataObject | save(deviceId: string): Promise<SaveSuccessResponse> | Saves a distributed data object.| +| DistributedDataObject| revokeSave(): Promise<RevokeSaveSuccessResponse> | Deletes a distributed data object. | ## How to Develop @@ -89,11 +88,11 @@ The following example shows how to implement distributed data object synchroniza import distributedObject from '@ohos.data.distributedDataObject'; ``` -2. Request the permission. - - Add the required permission in the **config.json** file. The sample code is as follows: - - ``` +2. Apply for the permission. + + Add the permissions required (FA model) to the **config.json** file. The sample code is as follows: + + ```json { "module": { "reqPermissions": [ @@ -104,11 +103,13 @@ The following example shows how to implement distributed data object synchroniza } } ``` - This permission must also be authorized by the user through a dialog box when the application is started for the first time. The sample code is as follows: - - ``` + For the apps based on the stage model, see [Declaring Permissions](../security/accesstoken-guidelines.md#stage-model). + + This permission must also be granted by the user when the application is started for the first time. The sample code is as follows: + + ```js import featureAbility from '@ohos.ability.featureAbility'; - + function grantPermission() { console.info('grantPermission'); let context = featureAbility.getContext(); @@ -116,93 +117,105 @@ The following example shows how to implement distributed data object synchroniza console.info(`result.requestCode=${result.requestCode}`) }) - console.info('end grantPermission'); + console.info('end grantPermission'); } + grantPermission(); ``` - - - + 3. Obtain a distributed data object instance. The sample code is as follows: ```js - var local_object = distributedObject.createDistributedObject({name:undefined, age:undefined, isVis:true, - parent:undefined, list:undefined}); + var local_object = distributedObject.createDistributedObject({ + name: undefined, + age: undefined, + isVis: true, + parent: undefined, + list: undefined + }); var sessionId = distributedObject.genSessionId(); ``` - -4. Add the synchronization network. The data objects in the synchronization network include the local and remote objects. +4. Add the distributed data object instance to a network for data synchronization. The data objects in the synchronization network include the local and remote objects. The sample code is as follows: ```js // Local object - var local_object = distributedObject.createDistributedObject({name:"jack", age:18, isVis:true, - parent:{mother:"jack mom", father:"jack Dad"}, list:[{mother:"jack mom"}, {father:"jack Dad"}]}); + var local_object = distributedObject.createDistributedObject({ + name: "jack", + age: 18, + isVis: true, + parent: { mother: "jack mom", father: "jack Dad" }, + list: [{ mother: "jack mom" }, { father: "jack Dad" }] + }); local_object.setSessionId(sessionId); // Remote object - var remote_object = distributedObject.createDistributedObject({name:undefined, age:undefined, isVis:true, - parent:undefined, list:undefined}); + var remote_object = distributedObject.createDistributedObject({ + name: undefined, + age: undefined, + isVis: true, + parent: undefined, + list: undefined + }); + // After learning that the local device goes online, the remote object synchronizes data. That is, name changes to jack and age to 18. remote_object.setSessionId(sessionId); - // After learning that the device goes online, the remote object synchronizes data. That is, name changes to jack and age to 18. ``` 5. Observe the data changes of the distributed data object. - You can subscribe to data changes of the peer object. When the data in the peer object changes, a callback will be called to return the data changes. + You can subscribe to data changes of the remote object. When the data in the remote object changes, a callback will be called to return the data changes. The sample code is as follows: ```js function changeCallback(sessionId, changeData) { - console.info("change" + sessionId); + console.info("change" + sessionId); - if (changeData != null && changeData != undefined) { - changeData.forEach(element => { - console.info("changed !" + element + " " + local_object[element]); - }); - } - } + if (changeData != null && changeData != undefined) { + changeData.forEach(element => { + console.info("changed !" + element + " " + local_object[element]); + }); + } + } - // To refresh the page in changeCallback, correctly bind (this) to the changeCallback. - local_object.on("change", this.changeCallback.bind(this)); + // To refresh the page in changeCallback, correctly bind (this) to the changeCallback. + local_object.on("change", this.changeCallback.bind(this)); ``` -6. Modify object attributes. +6. Modify attributes of the distributed data object. The object attributes support basic data types (such as number, Boolean, and string) and complex data types (array and nested basic types). The sample code is as follows: + ```js local_object.name = "jack"; local_object.age = 19; local_object.isVis = false; - local_object.parent = {mother:"jack mom", father:"jack Dad"}; - local_object.list = [{mother:"jack mom"}, {father:"jack Dad"}]; + local_object.parent = { mother: "jack mom", father: "jack Dad" }; + local_object.list = [{ mother: "jack mom" }, { father: "jack Dad" }]; ``` - > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** - > - > For the distributed data object of the complex type, only the root attribute can be modified. The subordinate attributes cannot be modified. - - Example: + > **NOTE**
+ > For the distributed data object of the complex type, only the root attribute can be modified. The subordinate attributes cannot be modified. Example: ```js // Supported modification. - local_object.parent = {mother:"mom", father:"dad"}; + local_object.parent = { mother: "mom", father: "dad" }; // Modification not supported. local_object.parent.mother = "mom"; ``` 7. Access the distributed data object. - Obtain the distributed data object attribute, which is the latest data on the network. + Obtain the distributed data object attributes, which are the latest data on the network. The sample code is as follows: + ```js console.info("name " + local_object["name"]); ``` @@ -221,7 +234,6 @@ The following example shows how to implement distributed data object synchroniza ``` 9. Subscribe to the status (online/offline) changes of the distributed data object. A callback will be invoked to report the status change when the target distributed data object goes online or offline. - The sample code is as follows: ```js @@ -232,55 +244,31 @@ The following example shows how to implement distributed data object synchroniza local_object.on("status", this.statusCallback); ``` -10. Save a distributed data object and revoke the data saving operation. - - - Callback +10. Save a distributed data object and delete it. - ``` - ​```js - // Save a distributed data object. - local_object.save("local", (result, data) => { - console.log("save callback"); - console.info("save sessionId " + data.sessionId); - console.info("save version " + data.version); - console.info("save deviceId " + data.deviceId); - }); - // Revoke the data saving operation. - local_object.revokeSave((result, data) => { - console.log("revokeSave callback"); - console.info("revokeSave sessionId " + data.sessionId); - }); - ​``` - ``` - - - Promise - - ``` - ​```js - // Save a distributed data object. - g_object.save("local").then((result) => { - console.info("save sessionId " + result.sessionId); - console.info("save version " + result.version); - console.info("save deviceId " + result.deviceId); - }, (result)=>{ - console.info("save local failed."); - }); - // Revoke the data saving operation. - g_object.revokeSave().then((result) => { - console.info("revokeSave success."); - }, (result)=>{ - console.info("revokeSave failed."); - }); - ​``` - ``` - - + ```js + // Save a distributed data object. + g_object.save("local").then((result) => { + console.info("save sessionId " + result.sessionId); + console.info("save version " + result.version); + console.info("save deviceId " + result.deviceId); + }, (result) => { + console.info("save local failed."); + }); + // Delete a distributed data object.. + g_object.revokeSave().then((result) => { + console.info("revokeSave success."); + }, (result) => { + console.info("revokeSave failed."); + }); + ``` 11. Unsubscribe from the status changes of the distributed data object. - You can specify the callback to unregister. If you do not specify the callback, this API unregisters all callbacks of this distributed data object. + You can specify the callback to unregister. If you do not specify the callback, all status change callbacks of this distributed data object will be unregistered. The sample code is as follows: + ```js // Unregister the specified status change callback. local_object.off("status", this.statusCallback); @@ -290,7 +278,8 @@ The following example shows how to implement distributed data object synchroniza 12. Remove a distributed data object from the synchronization network. Data changes on the local object will not be synchronized to the removed distributed data object. - The sample code is as follows: - ```js - local_object.setSessionId(""); - ``` + The sample code is as follows: + + ```js + local_object.setSessionId(""); + ``` diff --git a/en/application-dev/database/database-distributedobject-overview.md b/en/application-dev/database/database-distributedobject-overview.md index 618bc881d563c11c51c9012831f48357a79830b1..80985ed39b8c91a5c9635e0be8fd00f4be2da702 100644 --- a/en/application-dev/database/database-distributedobject-overview.md +++ b/en/application-dev/database/database-distributedobject-overview.md @@ -1,29 +1,29 @@ # Distributed Data Object Overview -The distributed data object management framework is an object-oriented in-memory data management framework. It provides application developers with basic data object management capabilities, such as creating, querying, deleting, modifying, and subscribing to in-memory objects. This management framework also provides distributed capabilities to implement data object collaboration for the same application between multiple devices that form a Super Device. +The distributed data object management framework provides object-oriented in-memory data management. It provides basic data management capabilities, such as creating, querying, deleting, and modifying distributed data objects, and observing data and status changes of the distributed data objects. This management framework also provides distributed capabilities to implement data object collaboration for the same application between multiple devices that form a Super Device. -## Key Concepts +## Basic Concepts - **Distributed in-memory database** - The distributed in-memory database caches data in the memory, so that applications can quickly access data. This database, however, does not store data persistently. If the database is closed, the data is not retained. + The distributed in-memory database caches data in the memory so that applications can quickly access data. This database, however, does not store data persistently. If the database is closed, the data is not retained. - **Distributed data object** - A distributed data object is an encapsulation of the JS object type. Each distributed data object instance creates a data table in the in-memory database. The in-memory databases created for different applications are isolated from each other. Reading or assigning values to distributed data objects is automatically mapped to the **put** or **get** operation of the corresponding database. + A distributed data object is an encapsulation of the JS object type. Each distributed data object instance creates a data table in the in-memory database. The in-memory databases created for different applications are isolated from each other. Reading data from and writing data to a distributed data object are mapped to the **put** and **get** operations in the corresponding database, respectively. The distributed data object can be in the following states in its lifecycle: - **Uninitialized**: The distributed data object is not instantiated or has been destroyed. - **Local**: The data table is created, but the data cannot be synchronized. - - **Distributed**: The data table is created, there are at least two online with the same session ID, and data can be synchronized across devices. If the device is offline or the session ID is empty, the distributed data object changes to the local state. + - **Distributed**: The data table is created, and there are at least two online devices with the same session ID. In this case, data can be synchronized across devices. If a device is offline or the session ID is empty, the distributed data object changes to the local state. ## Working Principles -The distributed data objects are encapsulated into JS objects in distributed in-memory databases, which allows the distributed data objects to be operated in the same way as local variables. The system automatically implements cross-device data synchronization. +The distributed data objects are encapsulated into JS objects in distributed in-memory databases. This allows the distributed data objects to be operated in the same way as local variables. The system automatically implements cross-device data synchronization. **Figure 1** Working mechanism @@ -34,7 +34,7 @@ The distributed data objects are encapsulated into JS objects in distributed in- ## Constraints -- Data synchronization can be implemented across devices only for the applications with the same bundleName. +- Data synchronization can be implemented across devices only for the applications with the same **bundleName**. - Each distributed data object occupies 100 KB to 150 KB of memory. Therefore, you are advised not to create too many distributed data objects. diff --git a/en/application-dev/database/database-mdds-guidelines.md b/en/application-dev/database/database-mdds-guidelines.md index dd1594215a10d1c93c9825444253484ed8956e05..8cec5ca111cd814d599d159ab7b333259f669ea8 100644 --- a/en/application-dev/database/database-mdds-guidelines.md +++ b/en/application-dev/database/database-mdds-guidelines.md @@ -6,113 +6,181 @@ The Distributed Data Service (DDS) implements synchronization of application dat ## Available APIs -For details about the APIs related to distributed data, see [Distributed Data Management](../reference/apis/js-apis-distributed-data.md). +For details about the APIs, see [Distributed Data Management](../reference/apis/js-apis-distributed-data.md). **Table 1** APIs provided by the DDS | API | Description | | ------------------------------------------------------------ | ----------------------------------------------- | -| createKVManager(config:KVManagerConfig,callback:AsyncCallback<KVManager>):void
createKVManager(config:KVManagerConfig):Promise<KVManager> | Creates a **KVManager** object for database management.| -| getKVStore<TextendsKVStore>(storeId:string,options:Options,callback:AsyncCallback<T>):void
getKVStore<TextendsKVStore>(storeId:string,options:Options):Promise<T> | Obtains a KV store with the specified **Options** and **storeId**.| -| put(key:string,value:Uint8Array\|string\|number\|boolean,callback:AsyncCallback<void>):void
put(key:string,value:Uint8Array\|string\|number\|boolean):Promise<void> | Inserts and updates data. | -| delete(key:string,callback:AsyncCallback<void>):void
delete(key:string):Promise<void> | Deletes data. | -| get(key:string,callback:AsyncCallback<Uint8Array\|string\|boolean\|number>):void
get(key:string):Promise<Uint8Array\|string\|boolean\|number> | Queries data. | -| on(event:'dataChange',type:SubscribeType,observer:Callback<ChangeNotification>):void
on(event:'syncComplete',syncCallback:Callback<Array<[string,number]>>):void | Subscribes to data changes in the KV store. | -| sync(deviceIdList:string[],mode:SyncMode,allowedDelayMs?:number):void | Triggers database synchronization in manual mode. | - - - +| createKVManager(config: KVManagerConfig, callback: AsyncCallback<KVManager>): void
createKVManager(config: KVManagerConfig): Promise<KVManager> | Creates a **KVManager** object for database management.| +| getKVStore<TextendsKVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void
getKVStore<TextendsKVStore>(storeId: string, options: Options): Promise<T> | Obtains a KV store with the specified **Options** and **storeId**.| +| put(key: string, value: Uint8Array\|string\|number\|boolean, callback: AsyncCallback<void>): void
put(key: string, value: Uint8Array\|string\|number\|boolean): Promise<void> | Inserts and updates data. | +| delete(key: string, callback: AsyncCallback<void>): void
delete(key: string): Promise<void> | Deletes data. | +| get(key: string, callback: AsyncCallback<Uint8Array\|string\|boolean\|number>): void
get(key: string): Promise<Uint8Array\|string\|boolean\|number> | Queries data. | +| on(event: 'dataChange', type: SubscribeType, observer: Callback<ChangeNotification>): void
on(event: 'syncComplete', syncCallback: Callback<Array<[string,number]>>): void | Subscribes to data changes in the KV store. | +| sync(deviceIdList: string[], mode: SyncMode, allowedDelayMs?: number): void | Triggers database synchronization in manual mode. | ## How to Develop The following uses a single KV store as an example to describe the development procedure. 1. Import the distributed data module. + ```js import distributedData from '@ohos.data.distributedData'; ``` +2. Apply for the required permission if data synchronization is required. -2. Create a **KvManager** instance based on the specified **KvManagerConfig** object. - - (1) Create a **KvManagerConfig** object based on the application context. + Add the permission required (FA model) in the **config.json** file. The sample code is as follows: + + ```json + { + "module": { + "reqPermissions": [ + { + "name": "ohos.permission.DISTRIBUTED_DATASYNC" + } + ] + } + } + ``` + For the apps based on the stage model, see [Declaring Permissions](../security/accesstoken-guidelines.md#stage-model). + + This permission must also be granted by the user when the application is started for the first time. The sample code is as follows: + + ```js + // FA model + import featureAbility from '@ohos.ability.featureAbility'; + + function grantPermission() { + console.info('grantPermission'); + let context = featureAbility.getContext(); + context.requestPermissionsFromUser(['ohos.permission.DISTRIBUTED_DATASYNC'], 666).then((data) => { + console.info('success: ${data}'); + }).catch((error) => { + console.info('failed: ${error}'); + }) + } + + grantPermission(); + + // Stage model + import Ability from '@ohos.application.Ability'; + + let context = null; + + function grantPermission() { + class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + let context = this.context; + } + } + + let permissions = ['ohos.permission.DISTRIBUTED_DATASYNC']; + context.requestPermissionsFromUser(permissions).then((data) => { + console.log('success: ${data}'); + }).catch((error) => { + console.log('failed: ${error}'); + }); + } + + grantPermission(); + ``` + +3. Create a **kvManager** instance based on the specified **kvManagerConfig** object. + + 1. Create a **kvManagerConfig** object based on the application context. + 2. Create a **kvManager** instance. - (2) Create a **KvManager** instance. - The sample code is as follows: - - ``` + + ```js + // Obtain the context of the FA model. + import featureAbility from '@ohos.ability.featureAbility'; + let context = featureAbility.getContext(); + + // Obtain the context of the stage model. + import AbilityStage from '@ohos.application.Ability'; + let context = null; + class MainAbility extends AbilityStage{ + onWindowStageCreate(windowStage){ + context = this.context; + } + } + let kvManager; try { - const kvManagerConfig = { - bundleName : 'com.example.datamanagertest', - userInfo : { - userId : '0', - userType : distributedData.UserType.SAME_USER_ID - } + const kvManagerConfig = { + bundleName: 'com.example.datamanagertest', + userInfo: { + context:context, + userId: '0', + userType: distributedData.UserType.SAME_USER_ID } - distributedData.createKVManager(kvManagerConfig, function (err, manager) { - if (err) { - console.log("createKVManager err: " + JSON.stringify(err)); - return; - } - console.log("createKVManager success"); - kvManager = manager; - }); + } + distributedData.createKVManager(kvManagerConfig, function (err, manager) { + if (err) { + console.log('Failed to create KVManager: ${error}'); + return; + } + console.log('Created KVManager successfully'); + kvManager = manager; + }); } catch (e) { - console.log("An unexpected error occurred. Error:" + e); + console.log('An unexpected error occurred. Error: ${e}'); } ``` - - -3. Create and obtain a single KV store. - (1) Declare the ID of the single KV store to create. +4. Create and obtain a single KV store. - (2) Create a single KV store. You are advised to disable automatic synchronization (**autoSync:false**) and call **sync** when a synchronization is required. + 1. Declare the ID of the single KV store to create. + 2. Create a single KV store. You are advised to disable automatic synchronization (`autoSync:false`) and call `sync` when a synchronization is required. The sample code is as follows: + ```js let kvStore; try { - const options = { - createIfMissing : true, - encrypt : false, - backup : false, - autoSync : false, - kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, - securityLevel : distributedData.SecurityLevel.S0, - }; - kvManager.getKVStore('storeId', options, function (err, store) { - if (err) { - console.log("getKVStore err: " + JSON.stringify(err)); - return; - } - console.log("getKVStore success"); - kvStore = store; - }); + const options = { + createIfMissing: true, + encrypt: false, + backup: false, + autoSync: false, + kvStoreType: distributedData.KVStoreType.SINGLE_VERSION, + securityLevel: distributedData.SecurityLevel.S0 + }; + kvManager.getKVStore('storeId', options, function (err, store) { + if (err) { + console.log('Failed to get KVStore: ${err}'); + return; + } + console.log('Got KVStore successfully'); + kvStore = store; + }); } catch (e) { - console.log("An unexpected error occurred. Error:" + e); + console.log('An unexpected error occurred. Error: ${e}'); } ``` - > **NOTE** + > **NOTE**
> > For data synchronization between networked devices, you are advised to open the distributed KV store during application startup to obtain the database handle. With this database handle (`kvStore` in this example), you can perform operations, such as inserting data into the KV store, without creating the KV store repeatedly during the lifecycle of the handle. + +5. Subscribe to changes in the distributed data. -4. Subscribe to changes in the distributed data.
The following is the sample code for subscribing to the data changes of a single KV store: + ```js kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_ALL, function (data) { - console.log("dataChange callback call data: " + JSON.stringify(data)); + console.log("dataChange callback call data: ${data}"); }); ``` -5. Write data to the single KV store. - - (1) Construct the key and value to be written into the single KV store. +6. Write data to the single KV store. - (2) Write key-value pairs into the single KV store. + 1. Construct the `Key` and `Value` to be written into the single KV store. + 2. Write key-value pairs into the single KV store. The following is the sample code for writing key-value pairs of the string type into the single KV store: @@ -120,58 +188,60 @@ The following uses a single KV store as an example to describe the development p const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { - kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) { + kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err, data) { if (err != undefined) { - console.log("put err: " + JSON.stringify(err)); + console.log('Failed to put data: ${error}'); return; } - console.log("put success"); + console.log('Put data successfully'); }); - }catch (e) { - console.log("An unexpected error occurred. Error:" + e); + } catch (e) { + console.log('An unexpected error occurred. Error: ${e}'); } ``` -6. Query data in the single KV store. +7. Query data in the single KV store. - (1) Construct the key to be queried from the single KV store. - - (2) Query data from the single KV store. + 1. Construct the `Key` to be queried from the single KV store. + 2. Query data from the single KV store. The following is the sample code for querying data of the string type from the single KV store: + ```js const KEY_TEST_STRING_ELEMENT = 'key_test_string'; const VALUE_TEST_STRING_ELEMENT = 'value-test-string'; try { - kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err,data) { + kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, function (err, data) { if (err != undefined) { - console.log("put err: " + JSON.stringify(err)); + console.log('Failed to put data: ${error}'); return; } - console.log("put success"); - kvStore.get(KEY_TEST_STRING_ELEMENT, function (err,data) { - console.log("get success data: " + data); + console.log('Put data successfully'); + kvStore.get(KEY_TEST_STRING_ELEMENT, function (err, data) { + console.log('Got data successfully: ${data}'); }); }); - }catch (e) { - console.log("An unexpected error occurred. Error:" + e); + } catch (e) { + console.log('An unexpected error occurred. Error: ${e}'); } ``` -7. Synchronize data to other devices.
+8. Synchronize data to other devices. + Select the devices in the same network and the synchronization mode to synchronize data. - > **NOTE** + > **NOTE**
> > The APIs of the `deviceManager` module are system interfaces. + + The following is the example code for synchronizing data in a single KV store: - The following is the sample code for synchronizing data in a single KV store: ```js import deviceManager from '@ohos.distributedHardware.deviceManager'; let devManager; // Create deviceManager. - deviceManager.createDeviceManager("bundleName", (err, value) => { + deviceManager.createDeviceManager('bundleName', (err, value) => { if (!err) { devManager = value; // deviceIds is obtained by deviceManager by calling getTrustedDeviceListSync(). @@ -185,8 +255,8 @@ The following uses a single KV store as an example to describe the development p try{ // 1000 indicates that the maximum delay is 1000 ms. kvStore.sync(deviceIds, distributedData.SyncMode.PUSH_ONLY, 1000); - }catch (e) { - console.log("An unexpected error occurred. Error:" + e); + } catch (e) { + console.log('An unexpected error occurred. Error: ${e}'); } } }); diff --git a/en/application-dev/database/database-mdds-overview.md b/en/application-dev/database/database-mdds-overview.md index 26efa7491805e871017db3593f5fa50d947717f5..cfe264a4f7eb06cd51cb834bc3e38ee27e649a14 100644 --- a/en/application-dev/database/database-mdds-overview.md +++ b/en/application-dev/database/database-mdds-overview.md @@ -1,105 +1,103 @@ # Distributed Data Service Overview -The distributed data service (DDS) implements distributed database collaboration across devices for applications. +The distributed data service (DDS) implements distributed database collaboration across devices for applications. Applications save data to distributed databases by calling the DDS APIs. The DDS isolates data of different applications based on a triplet of account, application, and database to ensure secure data access. The DDS synchronizes application data between trusted devices to provide users with consistent data access experience on different devices. You do not need to care about the implementation of the database locking mechanism. + ## Basic Concepts -- **KV data model** +### KV Data Model - The key-value \(KV\) data model allows data to be organized, indexed, and stored in key-value pairs. +The key-value (KV) data model allows data to be organized, indexed, and stored in KV pairs. - The KV data model is suitable for storing service data that is not related. It provides better read and write performance than the SQL database. The KV data model is widely used in distributed scenarios because it handles database version compatibility issues and data synchronization conflicts easily. The distributed database is based on the KV data model and provides KV-based access interfaces. +The KV data model is suitable for storing service data that is not related. It provides better read and write performance than the SQL database. The KV data model is widely used in distributed scenarios because it handles database version compatibility issues and data synchronization conflicts easily. The distributed database is based on the KV data model and provides KV-based access interfaces. -- **Distributed database transactions** +### Distributed Database Transaction - Distributed database transactions include local transactions \(same as the transactions of traditional databases\) and synchronization transactions. Synchronization transactions allow data to be synchronized between devices by local transaction. Synchronization of a local transaction modification either succeeds or fails on all the devices. +Distributed database transactions include local transactions (same as the transactions of traditional databases) and synchronization transactions. Synchronization transactions allow data to be synchronized between devices by local transaction. Synchronization of a local transaction modification either succeeds or fails on all the devices. -- **Distributed database consistency** +### Distributed Database Consistency - In a distributed scenario, cross-device collaboration demands consistent data between the devices in the same network. The data consistency can be classified into the following types: +In a distributed scenario, cross-device collaboration demands consistent data between the devices in the same network. The data consistency can be classified into the following types: - - **Strong consistency**: When data is inserted, deleted, or modified on a device, other devices in the same network will obtain the latest data immediately. - - **Weak consistency**: When data is added, deleted, or modified on a device, other devices in the same network may or may not obtain the latest data. The data on these devices may be inconsistent after a certain period of time. - - **Eventual consistency**: When data is added, deleted, or modified on a device, other devices in the same network may not obtain the latest data immediately. However, data on these devices will become consistent after a certain period of time. +- **Strong consistency**: When data is inserted, deleted, or modified on a device, other devices in the same network will obtain the latest data immediately. +- **Weak consistency**: When data is added, deleted, or modified on a device, other devices in the same network may or may not obtain the latest data. The data on these devices may be inconsistent after a certain period of time. +- **Eventual consistency**: When data is added, deleted, or modified on a device, other devices in the same network may not obtain the latest data immediately. However, data on these devices will become consistent after a certain period of time. - Strong consistency has high requirements on distributed data management and may be used in distributed server deployment. The DDS supports only the eventual consistency because mobile devices are not always online and the network has no center. +Strong consistency has high requirements on distributed data management and may be used in distributed server deployment. The DDS supports only the eventual consistency because mobile devices are not always online and the network has no center. -- **Distributed database synchronization** +### Distributed Database Synchronization - After discovering and authenticating a device, the underlying communication component notifies the upper-layer application \(including the DDS\) that the device goes online. The DDS then establishes an encrypted transmission channel to synchronize data between the two devices. +After discovering and authenticating a device, the underlying communication component notifies the upper-layer application (including the DDS) that the device goes online. The DDS then establishes an encrypted transmission channel to synchronize data between the two devices. - The DDS provides the following synchronization modes: +The DDS provides the following synchronization modes: - - **Manual synchronization**: Applications call **sync** to trigger a synchronization. The list of devices to be synchronized and the synchronization mode must be specified. The synchronization mode can be **PULL\_ONLY** \(pulling remote data to the local end\), **PUSH\_ONLY** \(pushing local data to the remote end\), or **PUSH\_PULL** \(pushing local data to the remote end and pulling remote data to the local end\). The internal interface supports condition-based synchronization. The data that meets the conditions can be synchronized to the remote end. - - **Automatic synchronization**: includes full synchronization and condition-based subscription synchronization. In full synchronization, the distributed database automatically pushes local data to the remote end and pulls remote data to the local end when a device goes online or application data is updated. Applications do not need to call **sync**. The internal interface supports condition-based subscription synchronization. The data that meets the subscription conditions on the remote end is automatically synchronized to the local end. +- **Manual synchronization**: Applications call **sync()** to trigger a synchronization. The list of devices to be synchronized and the synchronization mode must be specified. The synchronization mode can be **PULL_ONLY** (pulling remote data to the local end), **PUSH_ONLY** (pushing local data to the remote end), or **PUSH_PULL** (pushing local data to the remote end and pulling remote data to the local end). The internal interface supports condition-based synchronization. The data that meets the conditions can be synchronized to the remote end. +- **Automatic synchronization**: includes full synchronization and condition-based subscription synchronization. In full synchronization, the distributed database automatically pushes local data to the remote end and pulls remote data to the local end when a device goes online or application data is updated. Applications do not need to call **sync()**. The internal interface supports condition-based subscription synchronization. The data that meets the subscription conditions on the remote end is automatically synchronized to the local end. -- **Single KV store** +### Single KV Store - Data is saved locally in the unit of a single KV entry. Only one entry is saved for each key. Data can be modified only locally and synchronized to remote devices in sequence based on the update time. +Data is saved locally in the unit of a single KV entry. Only one entry is saved for each key. Data can be modified only locally and synchronized to remote devices in sequence based on the update time. -- **Device KV store** +### Device KV Store - The device KV store is based on the single KV store. The local device ID is added to the key when KV data is stored in the device KV store. Data can be isolated, managed, and queried by device. However, the data synchronized from remote devices cannot be modified locally. +The device KV store is based on the single KV store. The local device ID is added to the key when KV data is stored in the device KV store. Data can be isolated, managed, and queried by device. However, the data synchronized from remote devices cannot be modified locally. -- **Conflict resolution** +### Conflict Resolution - A data conflict occurs when multiple devices modify the same data and commit the modification to the database. The last write wins \(LWW\) is the default conflict resolution policy used for data conflicts. Based on the commit timestamps, the data with a later timestamp is used. Currently, customized conflict resolution policies are not supported. +A data conflict occurs when multiple devices modify the same data and commit the modification to the database. The last write wins (LWW) is the default conflict resolution policy used for data conflicts. Based on the commit timestamps, the data with a later timestamp is used. Currently, customized conflict resolution policies are not supported. -- **Schema-based database management and data query based on predicates** +### Schema-based Database Management and Predicate-based Data Query - A schema is specified when you create or open a single KV store. Based on the schema, the database detects the value format of key-value pairs and checks the value structure. Based on the fields in the values, the database implements index creation and predicate-based query. +A schema is specified when you create or open a single KV store. Based on the schema, the database detects the value format of KV pairs and checks the value structure. Based on the fields in the values, the database implements index creation and predicate-based query. -- **Distributed database backup** +### Distributed Database Backup - The DDS provides the database backup capability. You can set **backup** to **true** to enable daily backup. If a distributed database is damaged, the DDS deletes the database and restores the most recent data from the backup database. If no backup database is available, the DDS creates one. The DDS can also back up encrypted databases. +The DDS provides the database backup capability. You can set **backup** to **true** to enable daily backup. If a distributed database is damaged, the DDS deletes the database and restores the most recent data from the backup database. If no backup database is available, the DDS creates one. The DDS can also back up encrypted databases. ## Working Principles -The DDS supports distributed management of application database data in the OpenHarmony system. Data can be synchronized between multiple devices with the same account, delivering a consistent user experience across devices. The DDS consists of the following: +The DDS supports distributed management of application database data in the OpenHarmony system. Data can be synchronized between multiple devices with the same account, delivering a consistent user experience across devices. -- **APIs** +The DDS consists of the following: - The DDS provides APIs to create databases, access data, and subscribe to data. The APIs support the KV data model and common data types. They are highly compatible and easy to use, and can be released. +- **APIs**
The DDS provides APIs to create databases, access data, and subscribe to data. The APIs support the KV data model and common data types. They are highly compatible and easy to use, and can be released. -- **Service component** +- **Service component**
The service component implements management of metadata, permissions, encryption, backup and restore, and multiple users, and completes initialization of the storage component, synchronization component, and communication adaptation layer of the distributed database. - The service component implements management of metadata, permissions, encryption, backup and restore, and multiple users, and completes initialization of the storage component, synchronization component, and communication adaptation layer of the distributed database. +- **Storage component**
The storage component implements data access, data reduction, transactions, snapshots, database encryption, data combination, and conflict resolution. -- **Storage component** +- **Synchronization component**
The synchronization component interacts with the storage component and the communication adaptation layer to maintain data consistency between online devices. It synchronizes data generated on the local device to other devices and merges data from other devices into the local device. - The storage component implements data access, data reduction, transactions, snapshots, database encryption, data combination, and conflict resolution. +- **Communication adaptation layer**
The communication adaptation layer calls APIs of the underlying public communication layer to create and connect to communication channels, receive device online and offline messages, update metadata of the connected and disconnected devices, send device online and offline messages to the synchronization component. The synchronization component updates the list of connected devices, and calls the APIs of the communication adaption layer to encapsulate data and send the data to the connected devices. -- **Synchronization component** +Applications call the DDS APIs to create, access, and subscribe to distributed databases. The APIs store data to the storage component based on the capabilities provided by the service component. The storage component interacts with the synchronization component to synchronize data. The synchronization component uses the communication adaptation layer to synchronize data to remote devices, which update the data in the storage component and provide the data for applications through service APIs. - The synchronization component interacts with the storage component and the communication adaptation layer to maintain data consistency between online devices. It synchronizes data generated on the local device to other devices and merges data from other devices into the local device. -- **Communication adaptation layer** +**Figure 1** How DDS works - The communication adaptation layer calls APIs of the underlying public communication layer to create and connect to communication channels, receive device online and offline messages, update metadata of the connected and disconnected devices, send device online and offline messages to the synchronization component. The synchronization component updates the list of connected devices, and calls the APIs of the communication adaption layer to encapsulate data and send the data to the connected devices. +![](figures/en-us_image_0000001183386164.png) -Applications call the DDS APIs to create, access, and subscribe to distributed databases. The APIs store data to the storage component based on the capabilities provided by the service component. The storage component interacts with the synchronization component to synchronize data. The synchronization component uses the communication adaptation layer to synchronize data to remote devices, which update the data in the storage component and provide the data for applications through service APIs. -**Figure 1** How DDS works +## Constraints +- The DDS supports the KV data model only. It does not support foreign keys or triggers of the relational database. -![](figures/en-us_image_0000001183386164.png) +- The KV data model specifications supported by the DDS are as follows: -## Constraints + - For each record in a device KV store, the key must be less than or equal to 896 bytes and the value be less than 4 MB. + - For each record in a single KV store, the key must be less than or equal to 1 KB and the value be less than 4 MB. + - An application can open a maximum of 16 KV stores simultaneously. + +- The data that needs to be synchronized between devices should be stored in distributed databases rather than local databases. -- The DDS supports the KV data model only. It does not support foreign keys or triggers of the relational database. -- The KV data model specifications supported by the DDS are as follows: - - For each record in a device KV store, the key must be less than or equal to 896 bytes and the value be less than 4 MB. - - For each record in a single KV store, the key must be less than or equal to 1 KB and the value be less than 4 MB. - - An application can open a maximum of 16 KV stores simultaneously. +- The DDS does not support customized conflict resolution policies. -- The data that needs to be synchronized between devices should be stored in distributed databases rather than local databases. -- The DDS does not support customized conflict resolution policies. -- The maximum number of access requests to the KvStore API is 1000 per second and 10000 per minute. The maximum number of access requests to the KvManager API is 50 per second and 500 per minute. -- Blocking operations, such as modifying UI components, are not allowed in the distributed database event callback. +- The maximum number of access requests to the KvStore API is 1000 per second and 10000 per minute. The maximum number of access requests to the KvManager API is 50 per second and 500 per minute. +- Blocking operations, such as modifying UI components, are not allowed in the distributed database event callback. diff --git a/en/application-dev/database/database-preference-guidelines.md b/en/application-dev/database/database-preference-guidelines.md index fdb69297523057f5530ef2f885fbe3e0b5cbf5cf..61aa2294c3f8ee077241e347e47e7780f50c4359 100644 --- a/en/application-dev/database/database-preference-guidelines.md +++ b/en/application-dev/database/database-preference-guidelines.md @@ -2,7 +2,7 @@ > **NOTE** > -> This feature is supported since API Version 9. For the versions earlier than API version 9, use [Lightweight Storage](../reference/apis/js-apis-data-storage.md) APIs. +> This feature is supported since API version 9. For the versions earlier than API version 9, use [Lightweight Storage](../reference/apis/js-apis-data-storage.md) APIs. ## When to Use @@ -88,8 +88,30 @@ Use the following APIs to delete a **Preferences** instance or data file. 2. Obtain a **Preferences** instance. Read the specified file and load its data to the **Preferences** instance for data operations. + + FA model: + ```js - let promise = data_preferences.getPreferences(this.context, 'mystore'); + // Obtain the context. + import featureAbility from '@ohos.ability.featureAbility' + var context = featureAbility.getContext() + + let promise = data_preferences.getPreferences(context, 'mystore'); + ``` + + Stage model: + + ```ts + // Obtain the context. + import Ability from '@ohos.application.Ability' + var context + class MainAbility extends Ability{ + onWindowStageCreate(windowStage){ + context = this.context + } + } + + let promise = data_preferences.getPreferences(context, 'mystore'); ``` 3. Write data. @@ -115,12 +137,12 @@ Use the following APIs to delete a **Preferences** instance or data file. ```js promise.then((preferences) => { - let getPromise = preferences.get('startup', 'default'); - getPromise.then((value) => { - console.info("The value of 'startup' is " + value); - }).catch((err) => { - console.info("Failed to get the value of 'startup'. Cause: " + err); - }) + let getPromise = preferences.get('startup', 'default'); + getPromise.then((value) => { + console.info("The value of 'startup' is " + value); + }).catch((err) => { + console.info("Failed to get the value of 'startup'. Cause: " + err); + }) }).catch((err) => { console.info("Failed to get the preferences.") }); @@ -139,24 +161,24 @@ Use the following APIs to delete a **Preferences** instance or data file. Specify an observer as the callback to subscribe to data changes for an application. When the value of the subscribed key is changed and saved by **flush()**, the observer callback will be invoked to return the new data. ```js - var observer = function (key) { - console.info("The key" + key + " changed."); - } - preferences.on('change', observer); - preferences.put('startup', 'auto', function (err) { - if (err) { - console.info("Failed to put the value of 'startup'. Cause: " + err); - return; - } + var observer = function (key) { + console.info("The key" + key + " changed."); + } + preferences.on('change', observer); + preferences.put('startup', 'auto', function (err) { + if (err) { + console.info("Failed to put the value of 'startup'. Cause: " + err); + return; + } console.info("Put the value of 'startup' successfully."); - preferences.flush(function (err) { - if (err) { - console.info("Failed to flush data. Cause: " + err); - return; - } + preferences.flush(function (err) { + if (err) { + console.info("Failed to flush data. Cause: " + err); + return; + } console.info("Flushed data successfully."); // The observer will be called. - }) - }) + }) + }) ``` 7. Delete the specified file. @@ -164,10 +186,10 @@ Use the following APIs to delete a **Preferences** instance or data file. Use the **deletePreferences** method to delete the **Preferences** instance and its persistent file and backup and corrupted files. After the specified files are deleted, the application cannot use that instance to perform any data operation. Otherwise, data inconsistency will be caused. The deleted data and files cannot be restored. ```js - let proDelete = data_preferences.deletePreferences(context, 'mystore'); - proDelete.then(() => { + let proDelete = data_preferences.deletePreferences(context, 'mystore'); + proDelete.then(() => { console.info("Deleted data successfully."); - }).catch((err) => { + }).catch((err) => { console.info("Failed to delete data. Cause: " + err); - }) + }) ``` diff --git a/en/application-dev/database/database-relational-guidelines.md b/en/application-dev/database/database-relational-guidelines.md index f6c7395339d66cb1c79bf71d424c15072f77f1b6..bd38925cbe8a17e5cb6319ffc9729ef263945e9c 100644 --- a/en/application-dev/database/database-relational-guidelines.md +++ b/en/application-dev/database/database-relational-guidelines.md @@ -30,9 +30,10 @@ The RDB provides APIs for inserting, deleting, updating, and querying data in th **Table 2** API for inserting data + | Class | API | Description | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | insert(table:string,values:ValuesBucket):Promise<number> | Inserts a row of data into a table. This API uses a promise to return the result.
If the operation is successful, the row ID will be returned; otherwise, **-1** will be returned.
- **table**: name of the target table.
- **values**: data to be inserted into the table.| + | RdbStore | insert(table: string, values: ValuesBucket): Promise<number> | Inserts a row of data into a table. This API uses a promise to return the result.
If the operation is successful, the row ID will be returned; otherwise, **-1** will be returned.
- **table**: name of the target table.
- **values**: data to be inserted into the table.| - **Updating Data** @@ -40,9 +41,10 @@ The RDB provides APIs for inserting, deleting, updating, and querying data in th **Table 3** API for updating data - | Class | API | Description | + + | Class | API | Description | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | update(values:ValuesBucket,predicates:RdbPredicates):Promise<number> | Updates data based on the specified **RdbPredicates** object. This API uses a promise to return the result.
- **values**: data to update, which is stored in **ValuesBucket**.
- **predicates**: conditions for updating data.
Return value: number of rows updated. | + | RdbStore | update(values: ValuesBucket, predicates: RdbPredicates): Promise<number> | Updates data based on the specified **RdbPredicates** object. This API uses a promise to return the result.
the number of rows updated.
- **values**: data to update, which is stored in **ValuesBucket**.
- **predicates**: conditions for updating data.| - **Deleting Data** @@ -50,11 +52,10 @@ The RDB provides APIs for inserting, deleting, updating, and querying data in th **Table 4** API for deleting data - | Class | API | Description | - | -------- | ------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | delete(predicates:RdbPredicates):Promise<number> | Deletes data from the RDB store based on the specified **RdbPredicates** object. This API uses a promise to return the result.
- **predicates**: conditions for deleting data.
Return value: number of rows updated. | - - + + | Class | API | Description | + | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | + | RdbStore | delete(predicates: RdbPredicates): Promise<number> | Deletes data from the RDB store based on the specified **RdbPredicates** object. This API uses a promise to return
the number of rows updated.
- **predicates**: conditions for deleting data.| - **Querying Data** @@ -65,10 +66,11 @@ The RDB provides APIs for inserting, deleting, updating, and querying data in th **Table 5** APIs for querying data + | Class | API | Description | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | - | RdbStore | query(predicates:RdbPredicates,columns?:Array<string>):Promise<ResultSet> | Queries data from the RDB store based on specified conditions. This API uses a promise to return the result.
- **predicates**: conditions for querying data.
- **columns**: columns to query. If this parameter is not specified, the query applies to all columns.| - | RdbStore | querySql(sql:string,bindArgs?:Array<ValueType>):Promise<ResultSet> | Queries data using the specified SQL statement. This API uses a promise to return the result.
- **sql**: SQL statement.
- **bindArgs**: arguments in the SQL statement.| + | RdbStore | query(predicates: RdbPredicates, columns?: Array<string>): Promise<ResultSet> | Queries data from the RDB store based on specified conditions. This API uses a promise to return the result.
- **predicates**: conditions for querying data.
- **columns**: columns to query. If this parameter is not specified, the query applies to all columns.| + | RdbStore | querySql(sql: string, bindArgs?: Array<ValueType>): Promise<ResultSet> | Queries data using the specified SQL statement. This API uses a promise to return the result.
- **sql**: SQL statement.
- **bindArgs**: arguments in the SQL statement.| | RdbStore | remoteQuery(device: string, table: string, predicates: RdbPredicates, columns: Array<string>): Promise<ResultSet> | Queries data from the database of a remote device based on specified conditions. This API uses a promise to return the result.
- **device**: network ID of the remote device.
- **table**: name of the table to be queried.
- **predicates**: **RdbPredicates** that specifies the query condition.
- **columns**: columns to query. If this parameter is not specified, the query applies to all columns.| ### Using Predicates @@ -81,11 +83,11 @@ The following lists common predicates. For more information about predicates, se | Class | API | Description | | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| RdbPredicates | equalTo(field:string,value:ValueType):RdbPredicates | Sets an **RdbPredicates** to match the field with data type **ValueType** and value equal to the specified value.
- **field**: column name in the database table.
- **value**: value to match the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** object that matches the specified field.| -| RdbPredicates | notEqualTo(field:string,value:ValueType):RdbPredicates | Sets an **RdbPredicates** to match the field with data type **ValueType** and value not equal to the specified value.
- **field**: column name in the database table.
- **value**: value to match the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** object that matches the specified field.| -| RdbPredicates | or():RdbPredicates | Adds the OR condition to the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** with the OR condition.| -| RdbPredicates | and():RdbPredicates | Adds the AND condition to the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** with the AND condition.| -| RdbPredicates | contains(field:string,value:string):RdbPredicates | Sets an **RdbPredicates** to match a string containing the specified value.
- **field**: column name in the database table.
- **value**: value to match the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** object that matches the specified field.| +| RdbPredicates | equalTo(field: string, value: ValueType): RdbPredicates | Sets an **RdbPredicates** to match the field with data type **ValueType** and value equal to the specified value.
- **field**: column name in the database table.
- **value**: value to match the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** object that matches the specified field.| +| RdbPredicates | notEqualTo(field: string, value: ValueType): RdbPredicates | Sets an **RdbPredicates** to match the field with data type **ValueType** and value not equal to the specified value.
- **field**: column name in the database table.
- **value**: value to match the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** object that matches the specified field.| +| RdbPredicates | or(): RdbPredicates | Adds the OR condition to the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** with the OR condition.| +| RdbPredicates | and(): RdbPredicates | Adds the AND condition to the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** with the AND condition.| +| RdbPredicates | contains(field: string, value: string): RdbPredicates | Sets an **RdbPredicates** to match a string containing the specified value.
- **field**: column name in the database table.
- **value**: value to match the **RdbPredicates**.
- **RdbPredicates**: **RdbPredicates** object that matches the specified field.| ### Using the Result Set @@ -101,12 +103,12 @@ For details about how to use result set APIs, see [Result Set](../reference/apis | Class | API | Description | | --------- | ---------------------------------------------------- | ------------------------------------------ | -| ResultSet | goToFirstRow():boolean | Moves to the first row of the result set. | -| ResultSet | getString(columnIndex:number):string | Obtains the value in the form of a string based on the specified column and current row. | -| ResultSet | getBlob(columnIndex:number):Uint8Array | Obtains the value in the form of a byte array based on the specified column and the current row.| -| ResultSet | getDouble(columnIndex:number):number | Obtains the value in the form of double based on the specified column and current row. | -| ResultSet | getLong(columnIndex:number):number | Obtains the value in the form of a long integer based on the specified column and current row. | -| ResultSet | close():void | Closes the result set. | +| ResultSet | goToFirstRow(): boolean | Moves to the first row of the result set. | +| ResultSet | getString(columnIndex: number): string | Obtains the value in the form of a string based on the specified column and current row. | +| ResultSet | getBlob(columnIndex: number): Uint8Array | Obtains the value in the form of a byte array based on the specified column and the current row.| +| ResultSet | getDouble(columnIndex: number): number | Obtains the value in the form of double based on the specified column and current row. | +| ResultSet | getLong(columnIndex: number): number | Obtains the value in the form of a long integer based on the specified column and current row. | +| ResultSet | close(): void | Closes the result set. | @@ -164,7 +166,7 @@ You can obtain the distributed table name for a remote device based on the local | Class | API | Description | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| RdbStore | backup(destName:string): Promise<void> | Backs up an RDB store. This API uses a promise to return the result.
- **destName**: name of the RDB backup file.| +| RdbStore | backup(destName: string): Promise<void> | Backs up an RDB store. This API uses a promise to return the result.
- **destName**: name of the RDB backup file.| **Restoring an RDB Store** @@ -172,7 +174,7 @@ You can obtain the distributed table name for a remote device based on the local | Class | API | Description | | -------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| RdbStore | restore(srcName:string): Promise<void> | Restores an RDB store from a backup file. This API uses a promise to return the result.
- **srcName**: name of the backup file used to restore the RDB store.| +| RdbStore | restore(srcName: string): Promise<void> | Restores an RDB store from a backup file. This API uses a promise to return the result.
- **srcName**: name of the backup file used to restore the RDB store.| **Transaction** @@ -180,9 +182,9 @@ Table 15 Transaction APIs | Class | API | Description | | -------- | ----------------------- | --------------------------------- | -| RdbStore | beginTransaction():void | Starts the transaction before executing SQL statements.| -| RdbStore | commit():void | Commits the executed SQL statements. | -| RdbStore | rollBack():void | Rolls back the SQL statements that have been executed. | +| RdbStore | beginTransaction(): void | Starts the transaction before executing SQL statements.| +| RdbStore | commit(): void | Commits the executed SQL statements. | +| RdbStore | rollBack(): void | Rolls back the SQL statements that have been executed. | ## How to Develop @@ -194,17 +196,41 @@ Table 15 Transaction APIs (3) Create an RDB store. - The sample code is as follows: + FA model: ```js - import data_rdb from '@ohos.data.rdb' - - const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)"; - const STORE_CONFIG = {name: "rdbstore.db"} - data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) { - rdbStore.executeSql(CREATE_TABLE_TEST) - console.info('create table done.') - }) + import data_rdb from '@ohos.data.rdb' + // Obtain the context. + import featureAbility from '@ohos.ability.featureAbility' + let context = featureAbility.getContext() + + const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)"; + + const STORE_CONFIG = { name: "RdbTest.db" } + data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) { + rdbStore.executeSql(CREATE_TABLE_TEST) + console.info('create table done.') + }) + ``` + Stage model: + ```ts + import data_rdb from '@ohos.data.rdb' + // Obtain the context. + import Ability from '@ohos.application.Ability' + let context = null + class MainAbility extends Ability { + onWindowStageCreate(windowStage) { + context = this.context + } + } + + const CREATE_TABLE_TEST = "CREATE TABLE IF NOT EXISTS test (" + "id INTEGER PRIMARY KEY AUTOINCREMENT, " + "name TEXT NOT NULL, " + "age INTEGER, " + "salary REAL, " + "blobType BLOB)"; + + const STORE_CONFIG = { name: "rdbstore.db" } + data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) { + rdbStore.executeSql(CREATE_TABLE_TEST) + console.info('create table done.') + }) ``` 2. Insert data. @@ -217,7 +243,7 @@ Table 15 Transaction APIs ```js var u8 = new Uint8Array([1, 2, 3]) - const valueBucket = {"name": "Tom", "age": 18, "salary": 100.5, "blobType": u8} + const valueBucket = { "name": "Tom", "age": 18, "salary": 100.5, "blobType": u8 } let insertPromise = rdbStore.insert("test", valueBucket) ``` @@ -316,6 +342,7 @@ Table 15 Transaction APIs console.log('device=' + device[i] + 'data changed') } } + try { rdbStore.on('dataChange', data_rdb.SubscribeType.SUBSCRIBE_TYPE_REMOTE, storeObserver) } catch (err) { @@ -366,9 +393,7 @@ Table 15 Transaction APIs (1) Back up the current RDB store. - (2) Restore the RDB store using the backup file. - - The sample code is as follows: + The sample code is as follows: ```js let promiseBackup = rdbStore.backup("dbBackup.db") @@ -378,6 +403,10 @@ Table 15 Transaction APIs console.info('Backup failed, err: ' + err) }) ``` + (2) Restore the RDB store using the backup file. + + The sample code is as follows: + ```js let promiseRestore = rdbStore.restore("dbBackup.db") promiseRestore.then(() => { @@ -386,4 +415,3 @@ Table 15 Transaction APIs console.info('Restore failed, err: ' + err) }) ``` - diff --git a/en/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md b/en/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md index 01fe1ed68b3eb05341438da3d81270afdc4a92e3..f18f59468d0650400adfb50b87645c763a740b9c 100644 --- a/en/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md +++ b/en/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md @@ -22,15 +22,16 @@ import stats from '@ohos.bundleState'; | function queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void | Queries the priority group of this application. This API uses an asynchronous callback to return the result.| | function queryAppUsagePriorityGroup(): Promise<number>; | Queries the priority group of this application. This API uses a promise to return the result.| | function isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void | Checks whether the application specified by **bundleName** is in the idle state. | -| function getRecentlyUsedModules(maxNum? : number, callback: AsyncCallback<BundleActiveModuleInfo>): void | Obtains the number of FA usage records specified by **maxNum**. If **maxNum** is not specified, the default value **1000** is used.| +| function getRecentlyUsedModules(callback: AsyncCallback<BundleActiveModuleInfo>): void | Obtains the number of FA usage records specified by **1000**.| +| function getRecentlyUsedModules(maxNum: number, callback: AsyncCallback<BundleActiveModuleInfo>): void | Obtains the number of FA usage records specified by **maxNum**.| | function queryAppNotificationNumber(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveEventState>>): void | Queries the number of notifications from all applications based on the specified start time and end time.| | function queryBundleActiveEventStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveEventState>>): void | Queries statistics about system events (hibernation, wakeup, unlocking, and screen locking) that occur between the specified start time and end time.| -| function queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback<number>): void | Queries the priority group of the application specified by **bundleName**. If **bundleName** is not specified, the priority group of the current application is queried. This API uses an asynchronous callback to return the result.| +| function queryAppUsagePriorityGroup(bundleName : string, callback: AsyncCallback<number>): void | Queries the priority group of the application specified by **bundleName**. This API uses an asynchronous callback to return the result.| | function queryAppUsagePriorityGroup(bundleName? : string): Promise<number>; | Queries the priority group of the application specified by **bundleName**. If **bundleName** is not specified, the priority group of the current application is queried. This API uses a promise to return the result.| | function setBundleGroup(bundleName : string, newGroup: GroupType, callback: AsyncCallback>boolean>): void | Sets the group for the application specified by **bundleName**. This API uses an asynchronous callback to return the result.| | function setBundleGroup(bundleName : string, newGroup : GroupType): Promise>boolean>; | Sets the group for the application specified by **bundleName**. This API uses a promise to return the result.| -| function registerGroupCallBack(callback: Callback>BundleActiveGroupCallbackInfo>, callback: AsyncCallback>boolean>): void | Registers a callback for application group changes. When an application group of the user changes, the change is returned to all applications that have registered the callback. This API uses an asynchronous callback to return the result.| -| function registerGroupCallBack(callback: Callback>BundleActiveGroupCallbackInfo>): Promise>boolean>; | Registers a callback for application group changes. When an application group of the user changes, the change is returned to all applications that have registered the callback. This API uses a promise to return the result.| +| function registerGroupCallBack(groupCallback: Callback>BundleActiveGroupCallbackInfo>, callback: AsyncCallback>boolean>): void | Registers a callback for application group changes. When an application group of the user changes, the change is returned to all applications that have registered the callback. This API uses an asynchronous callback to return the result.| +| function registerGroupCallBack(groupCallback: Callback>BundleActiveGroupCallbackInfo>): Promise>boolean>; | Registers a callback for application group changes. When an application group of the user changes, the change is returned to all applications that have registered the callback. This API uses a promise to return the result.| | function unRegisterGroupCallBack(callback: AsyncCallback>boolean>): void | Deregisters the callback for application group changes. This API uses an asynchronous callback to return the result.| | function unRegisterGroupCallBack(): Promise>boolean>; | Deregisters the callback for application group changes. This API uses a promise to return the result.| diff --git a/en/application-dev/device-usage-statistics/device-usage-statistics-overview.md b/en/application-dev/device-usage-statistics/device-usage-statistics-overview.md index fc2a79e0990457a483c7dc75d3ab1fd88c55f126..69fca5fb8177eddc65ddfc0ffade70350446a8a1 100644 --- a/en/application-dev/device-usage-statistics/device-usage-statistics-overview.md +++ b/en/application-dev/device-usage-statistics/device-usage-statistics-overview.md @@ -7,21 +7,21 @@ With device usage statistics APIs, you can have a better understanding of the ap Currently you can have access to statistics on the application usage, and the notification and system usage statistics feature will be available for use in later versions. - **The application usage statistics is updated**: -1. Every 30 minutes -2. Upon system time change -3. Upon start of a new day + 1. Every 30 minutes + 2. Upon system time change + 3. Upon start of a new day - **The application usage statistics can include the following**: -1. Events of all applications based on the specified start time and end time -2. Application usage duration statistics based on the specified start time and end time -3. Events of the current application based on the specified start time and end time -4. Application usage duration statistics in the specified time frame at the specified interval (daily, weekly, monthly, or annually) -5. Priority group of the current invoker application -6. Whether a specific application is in the idle state -7. Number of FA usage records specified by **maxNum**, sorted by time (most recent first). If **maxNum** is not specified, the default value **1000** will be used. -8. Number of notifications from applications based on the specified start time and end time -9. Statistics about system events (hibernation, wakeup, unlocking, and screen locking) that occur between the specified start time and end time -10. Priority group of the invoker application or a specified application + 1. Events of all applications based on the specified start time and end time + 2. Application usage duration statistics based on the specified start time and end time + 3. Events of the current application based on the specified start time and end time + 4. Application usage duration statistics in the specified time frame at the specified interval (daily, weekly, monthly, or annually) + 5. Priority group of the current invoker application + 6. Whether a specific application is in the idle state + 7. Number of FA usage records specified by **maxNum**, sorted by time (most recent first). If **maxNum** is not specified, the default value **1000** will be used. + 8. Number of notifications from applications based on the specified start time and end time + 9. Statistics about system events (hibernation, wakeup, unlocking, and screen locking) that occur between the specified start time and end time + 10. Priority group of the invoker application or a specified application - **The setters can be used to:** @@ -35,6 +35,6 @@ Currently you can have access to statistics on the application usage, and the no Deregister the callback for application group changes. -### Required Permissions +## Required Permissions - Before calling the following system APIs, you need to apply for the **ohos.permission.BUNDLE_ACTIVE_INFO** permission: **queryBundleActiveStates**, **queryBundleStateInfos**, **queryBundleStateInfoByInterval**, **queryBundleActiveEventStates**, **queryAppNotificationNumber**, **queryAppUsagePriorityGroup(bundleName?)**, **setBundleGroup**, **registerGroupCallBack**, and **unRegisterGroupCallBack**. - This permission is not required for calling third-party APIs: **queryCurrentBundleActiveStates**, **queryAppUsagePriorityGroup()**, and **isIdleState**. diff --git a/en/application-dev/device/sensor-guidelines.md b/en/application-dev/device/sensor-guidelines.md index 99c6cc6c045a6f7d9a813372af163ab1eaa2efe1..50ebd3428f89eba4f968dd98e5fe2edee91bee34 100644 --- a/en/application-dev/device/sensor-guidelines.md +++ b/en/application-dev/device/sensor-guidelines.md @@ -26,70 +26,30 @@ | -------- | -------- | -------- | | ohos.sensor | sensor.on(sensorType, callback:AsyncCallback<Response>): void | Subscribes to data changes of a type of sensor.| | ohos.sensor | sensor.once(sensorType, callback:AsyncCallback<Response>): void | Subscribes to only one data change of a type of sensor.| -| ohos.sensor | sensor.off(sensorType, callback:AsyncCallback<void>): void | Unsubscribes from sensor data changes.| +| ohos.sensor | sensor.off(sensorType, callback?:AsyncCallback<void>): void | Unsubscribes from sensor data changes.| ## How to Develop -1. To obtain data from a type of sensor, configure the requested permissions in the **config.json** file. - - ``` - "reqPermissions": [ - { - "name": "ohos.permission.ACCELEROMETER", - "reason": "", - "usedScene": { - "ability": [ - "sensor.index.MainAbility", - ".MainAbility" - ], - "when": "inuse" - } - }, - { - "name": "ohos.permission.GYROSCOPE", - "reason": "", - "usedScene": { - "ability": [ - "sensor.index.MainAbility", - ".MainAbility" - ], - "when": "inuse" - } - }, - { - "name": "ohos.permission.ACTIVITY_MOTION", - "reason": "ACTIVITY_MOTION_TEST", - "usedScene": { - "ability": [ - "sensor.index.MainAbility", - ".MainAbility" - ], - "when": "inuse" - } - }, - { - "name": "ohos.permission.READ_HEALTH_DATA", - "reason": "HEALTH_DATA_TEST", - "usedScene": { - "ability": [ - "sensor.index.MainAbility", - ".MainAbility" - ], - "when": "inuse" - } - } - ] - ``` +1. Before obtaining data from a type of sensor, check whether the required permission has been configured.
+ The system provides the following sensor-related permissions: + - ohos.permission.ACCELEROMETER + + - ohos.permission.GYROSCOPE + + - ohos.permission.ACTIVITY_MOTION + + - ohos.permission.READ_HEALTH_DATA + + For details about how to configure a permission, see [Declaring Permissions](../security/accesstoken-guidelines.md). 2. Subscribe to data changes of a type of sensor. ``` - import sensor from "@ohos.sensor" - sensor.on(sensor.sensorType.SENSOR_TYPE_ACCELEROMETER,function(data){ - console.info("Subscription succeeded. data = " + data); // The call is successful, and the obtained sensor data is printed. - } - ); + import sensor from "@ohos.sensor"; + sensor.on(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(data){ + console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained. + }); ``` The following figure shows the successful call result when **SensorType** is **SENSOR_TYPE_ID_ACCELEROMETER**. @@ -99,11 +59,8 @@ 3. Unsubscribe from sensor data changes. ``` - import sensor from "@ohos.sensor" - sensor.off(sensor.sensorType.SENSOR_TYPE_ACCELEROMETER,function() { - console.info("Succeeded in unsubscribing from acceleration sensor data."); // The unsubscription is successful, and the result is printed. - } - ); + import sensor from "@ohos.sensor"; + sensor.off(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER); ``` The following figure shows the successful call result when **SensorType** is **SENSOR_TYPE_ID_ACCELEROMETER**. @@ -113,11 +70,10 @@ 4. Subscribe to only one data change of a type of sensor. ``` - import sensor from "@ohos.sensor" - sensor.once(sensor.sensorType.SENSOR_TYPE_ACCELEROMETER,function(data) { - console.info("Data obtained successfully. data=" + data); // The call is successful, and the obtained sensor data is printed. - } - ); + import sensor from "@ohos.sensor"; + sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(data) { + console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained. + }); ``` The following figure shows the successful call result when **SensorType** is **SENSOR_TYPE_ID_ACCELEROMETER**. @@ -127,11 +83,12 @@ If the API fails to be called, you are advised to use the **try/catch** statement to capture error information that may occur in the code. Example: ``` + import sensor from "@ohos.sensor"; try { - sensor.once(sensor.sensorType.SENSOR_TYPE_ACCELEROMETER,function(data) { - console.info("Data obtained successfully. data=" + data); // The call is successful, and the obtained sensor data is printed. + sensor.once(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, function(data) { + console.info("Data obtained successfully. x: " + data.x + "y: " + data.y + "z: " + data.z); // Data is obtained. }); } catch (error) { - console.error(error); + console.error("Failed to get sensor data"); } - ``` + ``` \ No newline at end of file diff --git a/en/application-dev/device/sensor-overview.md b/en/application-dev/device/sensor-overview.md index ec2374fbdf0fe63d1e10cbf26beff696c899025b..cb6129928d3796779075bcfc28da7f606bd130d9 100644 --- a/en/application-dev/device/sensor-overview.md +++ b/en/application-dev/device/sensor-overview.md @@ -52,15 +52,12 @@ The following modules work cooperatively to implement OpenHarmony sensors: Senso 1. To obtain data of the following sensors, you must claim the required permissions. - Table 7 Sensor data permissions - -| Sensor | Permission | Sensitivity | Permission Description | -| ------------------------- | -------------------------------- | ------------ | ----------------------- | -| Acceleration sensor, uncalibrated acceleration sensor, and linear acceleration sensor| ohos.permission.ACCELEROMETER | system_grant | Allows an application to subscribe to data of these acceleration-related sensors in the motion category.| -| Gyroscope sensor and uncalibrated gyroscope sensor | ohos.permission.GYROSCOPE | system_grant | Allows an application to subscribe to data of the gyroscope-related sensors in the motion category.| -| Pedometer sensor | ohos.permission.ACTIVITY_MOTION | user_grant | Allows an application to subscribe to the motion status. | -| Heart rate sensor | ohos.permission.READ_HEALTH_DATA | user_grant | Allows an application to read health data. | - - - + | Sensor | Permission | Sensitivity | Permission Description | + | ------------------------- | -------------------------------- | ------------ | ----------------------- | + | Acceleration sensor, uncalibrated acceleration sensor, and linear acceleration sensor| ohos.permission.ACCELEROMETER | system_grant | Allows an application to subscribe to data of these acceleration-related sensors in the motion category.| + | Gyroscope sensor and uncalibrated gyroscope sensor | ohos.permission.GYROSCOPE | system_grant | Allows an application to subscribe to data of the gyroscope-related sensors in the motion category.| + | Pedometer sensor | ohos.permission.ACTIVITY_MOTION | user_grant | Allows an application to subscribe to the motion status. | + | Heart rate sensor | ohos.permission.READ_HEALTH_DATA | user_grant | Allows an application to read health data. | + 2. The APIs for subscribing to and unsubscribing from sensor data work in pairs. If you do not need sensor data, call the unsubscription API to stop sensor data reporting. + diff --git a/en/application-dev/device/usb-guidelines.md b/en/application-dev/device/usb-guidelines.md index ae40bcddfd756caf88d1bc506bfba4b9a8d01a6d..d51625ccb9605fe2fb35b95f71eebc4e1607b753 100644 --- a/en/application-dev/device/usb-guidelines.md +++ b/en/application-dev/device/usb-guidelines.md @@ -1,13 +1,13 @@ # USB Service Development -The USB service provides the following functions: query of USB device list, bulk data transfer, control transfer, and access permission management. - ## When to Use In Host mode, you can obtain the list of connected devices, enable or disable the devices, manage device access permissions, and perform data transfer or control transfer. ## APIs +The USB service provides the following functions: query of USB device list, bulk data transfer, control transfer, and access permission management. + The following table lists the USB APIs currently available. For details, see the [API Reference](../reference/apis/js-apis-usb.md). **Table 1** Open USB APIs @@ -16,12 +16,12 @@ The following table lists the USB APIs currently available. For details, see the | ------------------------------------------------------------ | ------------------------------------------------------------ | | hasRight(deviceName: string): boolean | Checks whether the user, for example, the application or system, has the device access permissions. The value **true** is returned if the user has the device access permissions; the value **false** is returned otherwise. | | requestRight(deviceName: string): Promise\ | Requests the temporary permission for a given application to access the USB device. | -| connectDevice(device: USBDevice): Readonly\ | Connects to the USB device based on the device information returned by **getDevices()**. | +| connectDevice(device: USBDevice): Readonly\ | Connects to the USB device based on the device information returned by `getDevices()`. | | getDevices(): Array> | Obtains the USB device list. | | setConfiguration(pipe: USBDevicePipe, config: USBConfig): number | Sets the USB device configuration. | | setInterface(pipe: USBDevicePipe, iface: USBInterface): number | Sets a USB interface. | -| claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number | Claims a USB interface | -| bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise\ | Performs bulk transfer. | +| claimInterface(pipe: USBDevicePipe, iface: USBInterface, force?: boolean): number | Claims a USB interface. | +| bulkTransfer(pipe: USBDevicePipe, endpoint: USBEndpoint, buffer: Uint8Array, timeout?: number): Promise\ | Performs bulk transfer. | | closePipe(pipe: USBDevicePipe): number | Closes a USB device pipe. | | releaseInterface(pipe: USBDevicePipe, iface: USBInterface): number | Releases a USB interface. | | getFileDescriptor(pipe: USBDevicePipe): number | Obtains the file descriptor. | @@ -30,7 +30,7 @@ The following table lists the USB APIs currently available. For details, see the ## How to Develop -You can set a USB device as a host to connect to a device for data transfer. The development procedure is as follows: +You can set a USB device as the USB host to connect to other USB devices for data transfer. The development procedure is as follows: 1. Obtain the USB device list. @@ -113,7 +113,7 @@ You can set a USB device as a host to connect to a device for data transfer. The Claim the corresponding interface from deviceList. interface1 must be one present in the device configuration. */ - usb.claimInterface(pipe , interface1, true); + usb.claimInterface(pipe, interface1, true); ``` 4. Perform data transfer. diff --git a/en/application-dev/device/vibrator-guidelines.md b/en/application-dev/device/vibrator-guidelines.md index 4f49e7996188a7bc668e23fc2a21a1a29ec6e562..0dfc8344e5bb27a7ab6b6cd11943595c9f7855a6 100644 --- a/en/application-dev/device/vibrator-guidelines.md +++ b/en/application-dev/device/vibrator-guidelines.md @@ -16,48 +16,13 @@ For details about the APIs, see [Vibrator](../reference/apis/js-apis-vibrator.md | ohos.vibrator | vibrate(duration: number, callback?: AsyncCallback<void>): void | Triggers vibration with the specified duration. This API uses a callback to return the result. | | ohos.vibrator | vibrate(effectId: EffectId): Promise<void> | Triggers vibration with the specified effect. This API uses a promise to return the result. | | ohos.vibrator | vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void | Triggers vibration with the specified effect. This API uses a callback to return the result.| -| ohos.vibrator | stop(stopMode: VibratorStopMode): Promise<void> | Stops vibration. This API uses a promise to return the result. | +| ohos.vibrator | stop(stopMode: VibratorStopMode): Promise<void>| Stops vibration. This API uses a promise to return the result. | | ohos.vibrator | stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void | Stops vibration. This API uses a callback to return the result. | ## How to Develop -1. Declare the permissions required for controlling vibrators on the hardware device in the `config.json` file. - - ``` - "reqPermissions": [ - { - "name": "ohos.permission.ACCELEROMETER", - "reason": "", - "usedScene": { - "ability": [ - ".MainAbility" - ], - "when": "inuse" - } - }, - { - "name": "ohos.permission.VIBRATE", - "reason": "", - "usedScene": { - "ability": [ - ".MainAbility" - ], - "when": "inuse" - } - }, - { - "name": "ohos.permission.ACTIVITY_MOTION", - "reason": "", - "usedScene": { - "ability": [ - ".MainAbility" - ], - "when": "inuse" - } - }, - ] - ``` +1. Before using the vibrator on a device, you must declare the **ohos.permission.VIBRATE** permission. For details about how to configure a permission, see [Declaring Permissions](../security/accesstoken-guidelines.md). 2. Trigger the device to vibrate. diff --git a/en/application-dev/device/vibrator-overview.md b/en/application-dev/device/vibrator-overview.md index 889f6b823cc0bbff99cd9bc9cbb2dde641766420..aea46d62cab1225c26e138decde615924593bcb6 100644 --- a/en/application-dev/device/vibrator-overview.md +++ b/en/application-dev/device/vibrator-overview.md @@ -23,4 +23,4 @@ The vibrator is a Misc device that consists of four modules: Vibrator API, Vibra ## Constraints -When using a vibrator, you must declare the **ohos.permission.VIBRATE** permission before you can control the vibration effect. The sensitivity level of this permission is **system_grant**. +When using a vibrator, you must declare the **ohos.permission.VIBRATE** permission before you can control the vibration effect. diff --git a/en/application-dev/faqs/Readme-EN.md b/en/application-dev/faqs/Readme-EN.md new file mode 100644 index 0000000000000000000000000000000000000000..dc45ed9db0eec504b1ff6f535babf11265f2df91 --- /dev/null +++ b/en/application-dev/faqs/Readme-EN.md @@ -0,0 +1,19 @@ +# FAQs + +- [Ability Framework Development](faqs-ability.md) +- [Data Management Development](faqs-data-management.md) +- [File Management Development](faqs-file-management.md) +- [Graphics and Image Development](faqs-graphics.md) +- [hdc_std Command Usage](faqs-ide.md) +- [IDE Usage](faqs-hdc-std.md) +- [ArkUI (JavaScript) Development](faqs-ui-js.md) +- [ArkUI (eTS) Development](faqs-ui-ets.md) +- [Graphics and Image Development](faqs-graphics.md) +- [File Management Development](faqs-file-management.md) +- [Data Management Development](faqs-data-management.md) +- [Device Management Development](faqs-device-management.md) +- [Native API Usage](faqs-native.md) +- [Network and Connection Development](faqs-connectivity.md) +- [Usage of Third- and Fourth-Party Libraries](faqs-third-party-library.md) +- [Development Board](faqs-development-board.md) + diff --git a/en/application-dev/faqs/faqs-ability.md b/en/application-dev/faqs/faqs-ability.md new file mode 100644 index 0000000000000000000000000000000000000000..0cabbba71815d043e29f9c840c8ce7589af76dad --- /dev/null +++ b/en/application-dev/faqs/faqs-ability.md @@ -0,0 +1,60 @@ +# Ability Framework Development + +## Is a guide similar to the Data ability development in the FA model available for the stage model? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +A guide is available for the **DataShareExtensionAbility** class in the stage model, which provides APIs for sharing data with other applications and managing the data. + +Reference: [DataShare Development](../database/database-datashare-guidelines.md) + +## What should I do if the UI does not respond when an ability is started? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +1. If the ability is started using **startAbility**, check whether the **abilityName** field in **want** uses the bundle name as the prefix. If yes, delete the bundle name. + +2. Make sure the ability's home page file configured by **onWindowStageCreate** in the **MainAbility.ts** file is defined in the **main_pages.json** file. + +3. You are advised to use the SDK and OpenHarmony SDK versions released on the same day. + +Reference: [Release Testing Version](https://gitee.com/openharmony-sig/oh-inner-release-management/blob/master/Release-Testing-Version.md) + +## How do I prevent "this" in a method from changing to "undefined" when the method is called? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Method 1: Add **.bind(this)** when calling the method. + +Method 2: Use the arrow function. + +## What should I do when the message "must have required property 'startWindowIcon'" is displayed? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Configure the **startWindowIcon** attribute under **abilities** in the **module.json5** file. + +Reference: [Application Package Structure Configuration File](../quick-start/stage-structure.md) + + Example: + +``` +{ + "module": { + // Do something. + "abilities": [{ + // Do something. + "startWindowIcon": "$media:space", + "startWindowBackground": "$color:white", + }] + } +} +``` + +## How do I obtain a notification when the device orientation changes? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Implement the **onConfigurationUpdated** callback in the **Ability** class. The callback is triggered when the system language, color mode, or display parameters (such as the orientation and density) change. + +Reference: [Ability Development](../ability/stage-ability.md) diff --git a/en/application-dev/faqs/faqs-connectivity.md b/en/application-dev/faqs/faqs-connectivity.md new file mode 100644 index 0000000000000000000000000000000000000000..3b8dea82129c03f0dc12c12296a28b9a0c46c99b --- /dev/null +++ b/en/application-dev/faqs/faqs-connectivity.md @@ -0,0 +1,33 @@ +# Network and Connection Development + + + +## What are the data formats supported by extraData in an HTTP request? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +**extraData** indicates additional data in an HTTP request. It varies depending on the HTTP request method. + +- If the HTTP request uses a POST or PUT method, **extraData** serves as the content of the HTTP request. + +- If the HTTP request uses a GET, OPTIONS, DELETE, TRACE, or CONNECT method, **extraData** serves as a supplement to the HTTP request parameters and will be added to the URL when the request is sent. + +- If you pass in a string object, **extraData** contains the string encoded on your own. + + +## What does error code 28 mean for an HTTP request? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +Error code 28 refers to **CURLE_OPERATION_TIMEDOUT**, which means a libcurl library operation timeout. For details, see any HTTP status code description available. + +Reference: [Development Guide](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-http.md#httpresponse) and [Curl Error Codes](https://curl.se/libcurl/c/libcurl-errors.html) + + +## What does error code 6 mean for the response of \@ohos.net.http.d.ts? + +Applicable to: OpenHarmony SDK 3.2.3.5 + +Error code 6 indicates a failure to resolve the host in the address. You can ping the URL carried in the request to check whether the host is accessible. + +Reference: [Development Guide](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-http.md#httpresponse) and [Curl Error Codes](https://curl.se/libcurl/c/libcurl-errors.html) diff --git a/en/application-dev/faqs/faqs-data-management.md b/en/application-dev/faqs/faqs-data-management.md new file mode 100644 index 0000000000000000000000000000000000000000..839514879b8198273bc86680614b6b2054f662e2 --- /dev/null +++ b/en/application-dev/faqs/faqs-data-management.md @@ -0,0 +1,24 @@ +# Device Management Development + + + +## How Do I Save PixelMap data to a database? + +Applicable to: OpenHarmony SDK 3.2.3.5 + +You can convert a **PixelMap** into a **ArrayBuffer** and save the **ArrayBuffer** to your database. + +Reference: [readPixelsToBuffer](../reference/apis/js-apis-image.md#readpixelstobuffer7-1) + +## How Do I Obtain RDB Store Files? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Run the hdc_std command to copy the .db, .db-shm, and .db-wal files from **/data/app/el2/100/database/Bundle name/entry/db/**, and then use the SQLite tool to open the files. + +Example: + + +``` + hdc_std file recv /data/app/el2/100/database/com.xxxx.xxxx/entry/db/test.db ./test.db +``` diff --git a/en/application-dev/faqs/faqs-development-board.md b/en/application-dev/faqs/faqs-development-board.md new file mode 100644 index 0000000000000000000000000000000000000000..4766d4f5271dec2e5ec937477cf1ce1b7946eef6 --- /dev/null +++ b/en/application-dev/faqs/faqs-development-board.md @@ -0,0 +1,52 @@ +# Development Board + + + +## How do I take screenshots on a development board? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +- Method 1: Click the screenshot button in the Control Panel from the development board UI. The screenshot is displayed in Gallery. + +- Method 2: Run the screenshot script. Connect to the development board to a computer running Windows. Create a text file on the computer, copy the following script content to the file, change the file name extension to **.bat** (the HDC environment variables must be configured in advance), and click **Run**. The screenshot is saved to the same directory as the **.bat** script file. + Example: + + + ``` + set filepath=/data/%date:~0,4%%date:~5,2%%date:~8,2%%time:~1,1%%time:~3,2%%time:~6,2%.png + echo %filepath% + : pause + hdc_std shell snapshot_display -f %filepath% + : pause + hdc_std file recv %filepath% . + : pause + ``` + +## How do I adjust Previewer in DevEco Studio so that the preview looks the same as what's displayed on a real RK3568 development board? + +Applicable to: DevEco Studio 3.0.0.991 + +1. Create a profile in Previewer. + + ![en-us_image_0000001361254285](figures/en-us_image_0000001361254285.png) +2. Set the profile parameters as follows: + + Device type : default + + Resolution: 720\*1280 + + DPI: 240 + +## What should I do if Device Manager incorrectly identifies a development board as FT232R USB UART even when the development board already has a driver installed? + +Possible cause: The USB serial driver of the development version is not installed. + +Solution: Search for **FT232R USB UART**, and download and install the driver. + +## How do I complete authentication when logging in to the development board? + +Applicable to: OpenHarmony SDK 3.2.2.5 + +When connecting to the network that requires authentication, open any web page in the browser to access the authentication page. + +If there is no browser on the development board, you can install the [sample browser application](https://gitee.com/openharmony/app_samples/tree/master/device/Browser). diff --git a/en/application-dev/faqs/faqs-device-management.md b/en/application-dev/faqs/faqs-device-management.md new file mode 100644 index 0000000000000000000000000000000000000000..5bb748f758a4636fb40ae5d7fb741eccfb5306fe --- /dev/null +++ b/en/application-dev/faqs/faqs-device-management.md @@ -0,0 +1,24 @@ +# Device Management Development + + + +## How do I obtain the DPI of a device? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +Import the **@ohos.display** module and call the **getDefaultDisplay** API. + +Example: + + +``` +import display from '@ohos.display'; +display.getDefaultDisplay((err, data) => { + if (err.code) { + console.error('Test Failed to obtain the default display object. Code: ' + JSON.stringify(err)); + return; + } + console.info('Test Succeeded in obtaining the default display object. Data:' + JSON.stringify(data)); + console.info('Test densityDPI:' + JSON.stringify(data.densityDPI)); +});https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/reference/apis/js-apis-device-info.md) +``` diff --git a/en/application-dev/faqs/faqs-file-management.md b/en/application-dev/faqs/faqs-file-management.md new file mode 100644 index 0000000000000000000000000000000000000000..1e3740047768d5d5fefa1420659c64da403ad587 --- /dev/null +++ b/en/application-dev/faqs/faqs-file-management.md @@ -0,0 +1,36 @@ +# File Management Development + + + +## What If There is No Return Value or Error Captured After getAlbums Is Called? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +The **ohos.permission.READ_MEDIA** permission is required for calling **getAlbums**, and this permission needs user authorization. For details, see OpenHarmony [Application Permission List](../security/permission-list.md). + +1. Configure the required permission in the **module.json5** file. + + ``` + "requestPermissions": [ + { + "name": "ohos.permission.READ_MEDIA" + } + ] + ``` + +2. Add the code for user authorization before the **MainAbility.ts -> onWindowStageCreate** page is loaded. + + ``` + private requestPermissions() { + let permissionList: Array = [ + "ohos.permission.READ_MEDIA" + ]; + this.context.requestPermissionsFromUser(permissionList) + .then(data => { + console.info(`request permission data result = ${data.authResults}`) + }) + .catch(err => { + console.error(`fail to request permission error:${err}`) + }) + } + ``` diff --git a/en/application-dev/faqs/faqs-graphics.md b/en/application-dev/faqs/faqs-graphics.md new file mode 100644 index 0000000000000000000000000000000000000000..c4e151559b547b2cdb4f8d7cb19b35318203674a --- /dev/null +++ b/en/application-dev/faqs/faqs-graphics.md @@ -0,0 +1,13 @@ +# Graphics and Image Development + +## Why do the isStatusBarLightIcon and isNavigationBarLightIcon attributes not take effect when window.setSystemBarProperties() is called? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +In effect, the **isStatusBarLightIcon** and **isNavigationBarLightIcon** attributes turn the font white when set to **true**. If **statusBarContentColor** is also set in **window.setSystemBarProperties()**, the **isStatusBarLightIcon** attribute does not take effect. Similarly, if **navigationBarContentColor** is set, the **isNavigationBarLightIcon** attribute does not take effect. + +## How do I set the style of the system bar? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Import the **\@ohos.window** module, and call **window.setSystemBarProperties()**. diff --git a/en/application-dev/faqs/faqs-hdc-std.md b/en/application-dev/faqs/faqs-hdc-std.md new file mode 100644 index 0000000000000000000000000000000000000000..04c0a202a57b702164b8bcb7a32299d3abd5d75c --- /dev/null +++ b/en/application-dev/faqs/faqs-hdc-std.md @@ -0,0 +1,69 @@ +# hdc_std Command Usage + + + +## What are the commands commonly used for log management? + +Applicable to: OpenHarmony SDK 3.2.2.5 + +- Clearing logs: hdc_std shell hilog -r + +- Increasing the buffer size to 20 MB: hdc_std shell hilog -G 20M + +- Capturing logs: hdc_std shell hilog > log.txt + + +## What should I do to avoid log flow control? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +- Disabling log flow control: hdc_std shell hilog -Q pidoff + +- Disabling the privacy flag: hdc_std shell hilog -p off + +- Increasing the log buffer to 200 MB: hdc_std shell hilog -G 200M + +- Enabling the log function of the specific domain (that is, disabling the global log function): hdc_std shell hilog –b D –D 0xd0xxxxx + +After performing the preceding operations, restart the DevEco Studio. + + +## Is HiLog or Console recommended for log printing? How do I set the domain if HiLog is used? + +Applicable to: OpenHarmony SDK 3.2.2.5 + +[HiLog](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-hilog.md) is recommended for an application to print logs. For details about domain setting, see [Development Guide](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-hilog.md#hilogisloggable). + + +## What is the maximum length of a log record when HiLog is used? Is it configurable? + +Applicable to: OpenHarmony SDK 3.2.2.5 + +The maximum length of a log record is 1,024 characters, and it is not changeable. + + +## What should I do if a HAP package cannot be opened after being installed on the development board using the IDE? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Check whether the SDK version is consistent with the system version on the development board. You are advised to use the SDK version and system version that are released on the same day. + + +## How do I upload files using an hdc command? + +Applicable to: OpenHarmony SDK 3.2.2.5 + +Run the **hdc_std file send** command. + +## How do I prevent the screen of the RK3568 development board from turning off? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Run the **hdc_std shell "power-shell setmode 602"** command. + + +## How do I start an ability using an hdc command? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Run the **hdc_std shell aa start -a AbilityName -b bundleName -m moduleName** command. diff --git a/en/application-dev/faqs/faqs-ide.md b/en/application-dev/faqs/faqs-ide.md new file mode 100644 index 0000000000000000000000000000000000000000..b4a089c873e1eac856c287e639556dc7facbea50 --- /dev/null +++ b/en/application-dev/faqs/faqs-ide.md @@ -0,0 +1,20 @@ +# IDE Usage + + +## What should do if the error message "npm ERR! code SELF_SIGNED_CERT_IN_CHAIN" is displayed? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +1. Run **npm config set strict-ssl=false** on the DevEco Studio terminal. + +2. Run the **npm install** on the DevEco Studio terminal. + +## After manual updating of the DevEco Studio SDK, the error message "Cannot find module 'xxx\ets\x.x.x.x\build-tools\ets-loader\node_modules\webpack\bin\webpack.js'" is displayed during HAP building. What should I do? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +1. Run **npm install** in the **ets\x.x.x.x\build-tools\ets-loader** directory of the SDK. + +2. Run **npm install** in the **js\x.x.x.x\build-tools\ace-loader** directory of the SDK. + +3. Perform HAP building again. diff --git a/en/application-dev/faqs/faqs-native.md b/en/application-dev/faqs/faqs-native.md new file mode 100644 index 0000000000000000000000000000000000000000..da00895e4a5b5a532e67f9f709dd84c25abe3205 --- /dev/null +++ b/en/application-dev/faqs/faqs-native.md @@ -0,0 +1,55 @@ +# Native API Usage + +## When a native HAP is running, the error message "Obj is not a valid object" is displayed for the imported namespace. What should I do? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Check the **abiFilters** parameter value in the **build-profile.json5** file in the root directory of the module (not the root directory of the project). If the device is 32-bit, the value must be **armeabi-v7a**. If the device is 64-bit, the value must be **arm64-v8a**. + +## How do I obtain the value of version in the package.json file of a module in the C++ code developed using native APIs? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +1. In the script file **hvigorfile.js** of Hvigor, use **subModule.getPackageJsonPath** to obtain the location of the **package.json** file in the module. + +2. Use Node.js to read the **version** field in the **package.json** file and write the value to the **buildOption.cppFlags** field in the **build-profile.json5** file. + +Example + + +``` +// Module-level hvigorfile.js +const subModule = require('@ohos/hvigor')(__filename) + +const fs = require("fs-extra") +const path = require("path") + +const packageJsonPath = subModule.getPackageJsonPath() +const buildProfilePath = path.resolve(packageJsonPath, '../build-profile.json5') +const packageJsonData = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')) +let buildProfileData = fs.readFileSync(buildProfilePath, 'utf8') +buildProfileData = buildProfileData.replace(/\"cppFlags\"\:(.*)\,/, `"cppFlags": "-D NWEBEX_VERSION=${packageJsonData.version}",`) +fs.writeFileSync(buildProfilePath, buildProfileData, 'utf8') + +const ohosPlugin = require('@ohos/hvigor-ohos-plugin').hapTasks(subModule) // The plug-in executes the C++ build task and reads the build-profile.json5 file. + +module.exports = { + ohos: ohosPlugin +} +``` + + +``` +// Read the hello.cpp file. +#define _NWEBEX_VERSION(v) #v +#define _NWEBEX_VER2STR(v) _NWEBEX_VERSION(v) + +static napi_value Add(napi_env env, napi_callback_info info) +{ + + napi_value fixed_version_value = nullptr; + napi_create_string_utf8(env, _NWEBEX_VER2STR(NWEBEX_VERSION), NAPI_AUTO_LENGTH, &fixed_version_value); + + return fixed_version_value; +} +``` diff --git a/en/application-dev/faqs/faqs-third-party-library.md b/en/application-dev/faqs/faqs-third-party-library.md new file mode 100644 index 0000000000000000000000000000000000000000..323269c5e0a4d8c84e9adbb39c4184bba9a00b5e --- /dev/null +++ b/en/application-dev/faqs/faqs-third-party-library.md @@ -0,0 +1,7 @@ +# Usage of Third- and Fourth-Party Libraries + +## What does the following error message mean : "Stage model module... does not support including OpenHarmony npm packages or modules in FA model. OpenHarmony build tasks will not be executed, and OpenHarmony resources will not be packed." + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +The third- and fourth-party libraries are not yet compatible with the stage model of API version 9 and cannot be used. diff --git a/en/application-dev/faqs/faqs-ui-ets.md b/en/application-dev/faqs/faqs-ui-ets.md new file mode 100644 index 0000000000000000000000000000000000000000..fd21421cd95edc2bc838b8401724fae10448d9fd --- /dev/null +++ b/en/application-dev/faqs/faqs-ui-ets.md @@ -0,0 +1,282 @@ +# ArkUI (eTS) Development + + + +## What are the restrictions on using generator functions in TypeScript? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Below are the restrictions on using generator functions in TypeScript: + +- Expressions can be used only in character strings (in the ${expression} format), **if** conditions, **ForEach** parameters, and component parameters. + +- No expressions should cause any application state variables (including **\@State**, **\@Link**, and **\@Prop**) to change. Otherwise, undefined and potentially unstable framework behavior may occur. + +- The generator function cannot contain local variables. + +None of the above restrictions apply to anonymous function implementations of event handlers (such as **onClick**). + +Negative example: + + +``` +build() { + let a: number = 1 // invalid: variable declaration not allowed + Column() { + Text('Hello ${this.myName.toUpperCase()}') // ok. + ForEach(this.arr.reverse(), ..., ...) // invalid: Array.reverse modifies the @State array varible in place + } + buildSpecial() // invalid: no function calls + Text(this.calcTextValue()) // this function call is ok. +} +``` + +## How do I use router to implement page redirection in the stage model? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +To implement page redirection through **router**, add all redirected-to pages to the pages list in the **main_pages.json** file. + +Page routing APIs in **router** can be invoked only after page rendering is complete. Do not call these APIs in **onInit** or **onReady** when the page is still in the rendering phase. + +## Will a page pushed into the stack through router.push be reclaimed? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +After being pushed to the stack through **router.push**, a page can be reclaimed only when it is popped from the stack through **router.back**. + +## How do I dynamically replace the %s placeholder in a resource file? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +In an application, you can replace the %s placeholder by using the second parameter in `$r('app.string.xx')`, which is used to reference application resources. + +Example: + +``` +build() { + //do something + // The second parameter indicates the referenced string resource, which can be used to replace the %s placeholder. + Text($r('app.string.entry_desc','aaa')) + .fontSize(100) + .fontColor(Color.Black) + //do something +} +``` + +## How do I read an XML file in Resource and convert data in it to the string type? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +1. Obtain data in Uint8Array format by calling the **RawFile** API of **resourceManager**. + +2. Convert data in Uint8Array format to the string type by calling the **String.fromCharCode** API. + +Reference: [Resource Management](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-resource-manager.md) + +Example: + + +``` +resourceManager.getRawFile(path, (error, value) => { + if (error != null) { + console.log("error is " + error); + } else { + let rawFile = value; + let xml = String.fromCharCode.apply(null, rawFile) + } +}); +``` + +## How do I convert a Resource object to the string type? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Use the **resourceManager.getString()** API of the **\@ohos.resourceManager** module. + +Reference: [Resource Management](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-resource-manager.md#getstring) + +## What should I do if the global static variables of a class do not work? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Objects imported to abilities and pages are packaged into two different closures, that is, two global objects. In this case, a static variable referenced by the abilities is not the same object as that referenced by the pages. Therefore, global variables cannot be defined by defining static variables in the class. You are advised to use AppStorage to manage global variables. + +Reference: [AppStorage](https://docs.openharmony.cn/pages/v3.2Beta/en/application-dev/ui/ts-application-states-appstorage.md/) + +## How do I obtain resources in the stage model? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +The stage model allows an application to obtain a **ResourceManager** object based on **context** and call its resource management APIs without first importing the required bundle. This method, however, is not applicable to the FA model. + +Example: + + +``` +const context = getContext(this) as any +context + .resourceManager + .getString($r('app.string.entry_desc').id) + .then(value => { + this.message = value.toString() +}) +``` + +## How do I position a container component to the bottom of the screen? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Create a **** component, and set the target container at the bottom of the **** component. + +Example: + +``` +build() { + Stack({alignContent : Alignment.Bottom}) { + // The container is at the bottom. + Stack() { + Column() + .width('100%') + .height('100%') + .backgroundColor(Color.Yellow) + } + .width('100%') + .height('10%') + } + .width('100%') + .height('100%') + .backgroundColor('rgba(255,255,255, 0)') +} +``` + +## Can CustomDialog be used in TypeScript files? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +No. Currently, **CustomDialog** can be used only on eTS pages. + +Reference: [Custom Dialog Box](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/arkui-ts/ts-methods-custom-dialog-box.md) + +## How do I transfer variables in CustomDialog to variables on pages? + +Applicable to: OpenHarmony SDK 3.2.2.5, stage model of API version 9 + +Use a custom callback so that when the confirm button in the custom dialog box is clicked, the value of **data** is transferred from the dialog box to the current page. + +Example: + + +``` +// CustomDialog component +@CustomDialog +struct MyDialog { + controller: CustomDialogController + title: string + data: string + cancel: () => void + confirm: (data: string) => void + Button('confirm') + .onClick(() => { + this.controller.close() + this.data = 'test' + this.confirm(this.data) + }).backgroundColor(0xffffff).fontColor(Color.Red) +// Page +@Entry +@Component +struct DialogTest { + dialogController: CustomDialogController = new CustomDialogController({ + builder: MyDialog({ title:'Custom Title',cancel: this.onCancel, + confirm: this.onAccept.bind(this)}), // Bind the custom callback to the button. + cancel: this.existApp, + autoCancel: true + }) + onAccept(data:string) { + console.info('Callback when the second button is clicked ' + data) + } +} +``` + +## What should I do if the \ component cannot be dragged to the bottom after it has a \ component added? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +The **\** component is a scrollable container. By default, it taks up the entire screen height. When any component with a fixed height takes up part of the screen height, you need to explicitly specify **layoutWeight(1)** for the parent container of the **\** component to take up the remaining height instead of the entire screen height. + +## How do I center child components in a grid container? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +By default, child components in a **\** are horizontally aligned to the left. To center them, perform the following steps: + +Nest a **\** component and set it to **justifyContent(FlexAlign.Center)**. For details, see [Grid Layout](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/ui/ui-ts-layout-grid-container.md). + + Example: + +``` +GridContainer({ sizeType: SizeType.SM, columns: 12 }) { + Row() { + Text('1') + .useSizeType({ + sm: { span: 4, offset: 0 }, + }) + .backgroundColor(0x46F2B4) + }.justifyContent(FlexAlign.Center) // Center child components. +} +``` + +## How do I obtain the height of the status bar and navigation bar? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Before the window content is loaded, enable listening for the **systemAvoidAreaChange** event. + +Example: + +``` +// MainAbility.ts +import window from '@ohos.window'; + +/** + * Set the immersive window and obtain the height of the status bar and navigation bar. + * @param mainWindow Indicates the main window. + */ +async function enterImmersion(mainWindow: window.Window) { + mainWindow.on("systemAvoidAreaChange", (area: window.AvoidArea) => { + AppStorage.SetOrCreate("topHeight", area.topRect.height); + AppStorage.SetOrCreate("bottomHeight", area.bottomRect.height); + }) + await mainWindow.setFullScreen(true) + await mainWindow.setSystemBarEnable(["status", "navigation"]) + await mainWindow.setSystemBarProperties({ + navigationBarColor: "#00000000", + statusBarColor: "#00000000", + navigationBarContentColor: "#FF0000", + statusBarContentColor: "#FF0000" + }) +} +export default class MainAbility extends Ability { + // do something + async onWindowStageCreate(windowStage: window.WindowStage) { + let mainWindow = await windowStage.getMainWindow() + await enterImmersion(mainWindow) + windowStage.loadContent('pages/index') + } + // do something +} +``` + +## How do I execute JavaScript functions in the \ component in eTS code? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +Call the **runJavaScript** API in the **WebController** to asynchronously execute JavaScript scripts. This API uses a callback to return the execution result. Note: **runJavaScript** can only be called after **loadUrl** has been completed. For example, it can be called in **onPageEnd**. + +Reference: [Web](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/arkui-ts/ts-basic-components-web.md) + +## How do I fix misidentification of the pan gesture where container nesting is involved? + +Applicable to: OpenHarmony SDK 3.2.5.3, stage model of API version 9 + +Set the **distance** attribute to **1** for the gesture. By default, this attribute is set to **5**. diff --git a/en/application-dev/faqs/faqs-ui-js.md b/en/application-dev/faqs/faqs-ui-js.md new file mode 100644 index 0000000000000000000000000000000000000000..5d39db33199fddf298e66e4bd290999b58d6dddb --- /dev/null +++ b/en/application-dev/faqs/faqs-ui-js.md @@ -0,0 +1,96 @@ +# ArkUI (JavaScript) Development + + + +## How do I convert the fields in an XML file into JavaScript objects? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +To convert fields in an XML file into JavaScript objects, call the **convert** API in the **convertxml** module. + +Example: + + +``` +import convertxml from '@ohos.convertxml'; +// Code snippet +xml = + '' + + '' + + ' Happy' + + ' Work' + + ' Play' + + ''; +let conv = new convertxml.ConvertXML(); +// Options for conversion. For details, see the reference document. +let options = {trim : false, declarationKey:"_declaration", + instructionKey : "_instruction", attributesKey : "_attributes", + textKey : "_text", cdataKey:"_cdata", doctypeKey : "_doctype", + commentKey : "_comment", parentKey : "_parent", typeKey : "_type", + nameKey : "_name", elementsKey : "_elements"} +let result:any = conv.convert(xml, options) // Convert fields in the XML file into JavaScript objects. +console.log('Test: ' + JSON.stringify(result)) +console.log('Test: ' + result._declaration._attributes.version) // vesion field in XML file +console.log('Test: ' + result._elements[0]._elements[0]._elements[0]._text) // title field in XML file +``` + +Reference: [XML-to-JavaScript Conversion](https://gitee.com/openharmony/docs/blob/master/en/application-dev/reference/apis/js-apis-convertxml.md) + +## What are the differences between JavaScript, TypeScript, and eTS? + +Applicable to: OpenHarmony SDK 3.2.3.5, stage model of API version 9 + +- JavaScript: a lightweight, weakly-typed programming language, most commonly known as the scripting language for web pages. + +- TypeScript: a superset of JavaScript, with additions of static typing and more object-oriented APIs, enums, etc. + +- eTS: a superset of TypeScript and the programming language for OpenHarmony ArkUI development, which powers UI development through a declarative development paradigm. + +## How do I convert the time to the HHMMSS format? + +Example: + + +``` +export default class DateTimeUtil{ + /** + * HHMMSS + */ + getTime() { + const DATETIME = new Date() + return this.concatTime(DATETIME.getHours(),DATETIME.getMinutes(),DATETIME.getSeconds()) + } + /** + * YYYYMMDD + */ + getDate() { + const DATETIME = new Date() + return this.concatDate(DATETIME.getFullYear(),DATETIME.getMonth()+1,DATETIME.getDate()) + } + /** + * If the date is less than 10, add a leading zero, for example, **07**. + * @param value Indicates the value. + */ + fill(value:number) { + return (value> 9 ? '' : '0') + value + } + /** + * Concatenate year, month, and date fields. + * @param year + * @param month + * @param date + */ + concatDate(year: number, month: number, date: number){ + return `${year}${this.fill(month)}${this.fill(date)}` + } + /** + Concatenate hours, minutes, and seconds fields. + * @param hours + * @param minutes + * @param seconds + */ + concatTime(hours:number,minutes:number,seconds:number){ + return `${this.fill(hours)}${this.fill(minutes)}${this.fill(seconds)}` + } +} +``` diff --git a/en/application-dev/faqs/figures/en-us_image_0000001361254285.png b/en/application-dev/faqs/figures/en-us_image_0000001361254285.png new file mode 100644 index 0000000000000000000000000000000000000000..b44ed1b13a0365a7ffaf3fcff1b00b7555e90159 Binary files /dev/null and b/en/application-dev/faqs/figures/en-us_image_0000001361254285.png differ diff --git a/en/application-dev/media/Readme-EN.md b/en/application-dev/media/Readme-EN.md index 131114d67cb3e1c8519d6d5f3a85b438e5846f6f..5f6e88fc07c88d3e5913058a26887e818a3cc3bc 100755 --- a/en/application-dev/media/Readme-EN.md +++ b/en/application-dev/media/Readme-EN.md @@ -20,4 +20,4 @@ - Camera - [Camera Development](camera.md) - + - [Distributed Camera Development](remote-camera.md) diff --git a/en/application-dev/media/audio-capturer.md b/en/application-dev/media/audio-capturer.md index 64566aba64e213ca8e088ad3a71e036625153187..0815ef31a288440271a27a8f03fb417923a46190 100644 --- a/en/application-dev/media/audio-capturer.md +++ b/en/application-dev/media/audio-capturer.md @@ -8,7 +8,7 @@ You can use the APIs provided by **AudioCapturer** to record raw audio files. During application development, you are advised to use **on('stateChange')** to subscribe to state changes of the **AudioCapturer** instance. This is because some operations can be performed only when the audio capturer is in a given state. If the application performs an operation when the audio capturer is not in the given state, the system may throw an exception or generate other undefined behavior. -For details about the APIs, see [AudioCapturer in Audio Management](../reference/apis/js-apis-audio.md). +For details about the APIs, see [AudioCapturer in Audio Management](../reference/apis/js-apis-audio.md#audiocapturer8). **Figure 1** Audio capturer state diff --git a/en/application-dev/media/audio-playback.md b/en/application-dev/media/audio-playback.md index 131cacdb3f39ecf6eafb5088525d97d209c9cf18..5227f6cdd1b9ec89818b0d1762c99267ec7eba97 100644 --- a/en/application-dev/media/audio-playback.md +++ b/en/application-dev/media/audio-playback.md @@ -18,7 +18,7 @@ You can use audio playback APIs to convert audio data into audible analog signal ## How to Develop -For details about the APIs, see [AudioPlayer in the Media API](../reference/apis/js-apis-media.md). +For details about the APIs, see [AudioPlayer in the Media API](../reference/apis/js-apis-media.md#audioplayer). ### Full-Process Scenario diff --git a/en/application-dev/media/audio-recorder.md b/en/application-dev/media/audio-recorder.md index 6fb1c28efa8bd8bd69e16b09cd577ec4bdeff6e6..f465db2b88118b77c9a4e64307170da07c3e8918 100644 --- a/en/application-dev/media/audio-recorder.md +++ b/en/application-dev/media/audio-recorder.md @@ -16,7 +16,7 @@ During audio recording, audio signals are captured, encoded, and saved to files. ## How to Develop -For details about the APIs, see [AudioRecorder in the Media API](../reference/apis/js-apis-media.md). +For details about the APIs, see [AudioRecorder in the Media API](../reference/apis/js-apis-media.md#audiorecorder). ### Full-Process Scenario @@ -185,4 +185,3 @@ export class AudioRecorderDemo { } } ``` - diff --git a/en/application-dev/media/audio-stream-manager.md b/en/application-dev/media/audio-stream-manager.md index 4f0f88c8fa2c3357e7a8d582642cf4efbb7bf1db..eb89957e9b8793b149c368445f1232bf0ff3b563 100644 --- a/en/application-dev/media/audio-stream-manager.md +++ b/en/application-dev/media/audio-stream-manager.md @@ -12,7 +12,7 @@ For details about the APIs, see [AudioStreamManager](../reference/apis/js-apis-a **Figure 1** Audio stream management invoking relationship -![](figures/zh-ch_image_audio_stream_manager.png) +![](figures/en-us_image_audio_stream_manager.png) ## How to Develop @@ -117,7 +117,7 @@ This API can be used to obtain the unique ID of the audio stream, UID of the aud console.info('Address:' + i + ':' + AudioRendererChangeInfo.deviceDescriptors[j].address); console.info('SampleRates:' + i + ':' + AudioRendererChangeInfo.deviceDescriptors[j].sampleRates[0]); console.info('ChannelCounts' + i + ':' + AudioRendererChangeInfo.deviceDescriptors[j].channelCounts[0]); - console.info('ChannnelMask:' + i + ':' + AudioRendererChangeInfo.deviceDescriptors[j].channelMasks); + console.info('ChannelMask:' + i + ':' + AudioRendererChangeInfo.deviceDescriptors[j].channelMasks); } } } diff --git a/en/application-dev/media/camera.md b/en/application-dev/media/camera.md index 5af14112df2959acbcfc606c9cd2938860ad6f85..06439dd049be835cdf5a96a35e2a2a42012ee6f8 100644 --- a/en/application-dev/media/camera.md +++ b/en/application-dev/media/camera.md @@ -54,7 +54,7 @@ await cameraManager.getCameras((err, cameras) => { cameraArray = cameras }) -for(let cameraIndex = 0; cameraIndex < cameraArray.length; cameraIndex) { +for(let cameraIndex = 0; cameraIndex < cameraArray.length; cameraIndex++) { console.log('cameraId : ' + cameraArray[cameraIndex].cameraId) // Obtain the camera ID. console.log('cameraPosition : ' + cameraArray[cameraIndex].cameraPosition) // Obtain the camera position. console.log('cameraType : ' + cameraArray[cameraIndex].cameraType) // Obtain the camera type. @@ -292,7 +292,7 @@ await captureSession.start().then(() => { ##### Switching a Session ```js -// Stop the current session. +// Stop the session. await captureSession.stop((err) => { if (err) { console.error('Failed to stop the session ${err.message}'); @@ -347,8 +347,8 @@ await captureSession.start().then(() => { ```js let settings = { - quality: camera.QualityLevel.QUALITY_LEVEL_HIGH // Set the image quality to high. - rotation: camera.ImageRotation.ROTATION_0, // Set the image rotation angle to 0. + quality: camera.QualityLevel.QUALITY_LEVEL_HIGH, // Set the image quality to high. + rotation: camera.ImageRotation.ROTATION_0 // Set the image rotation angle to 0. } // Use the current photographing settings to take photos. photoOutput.capture(settings, (err) => { @@ -395,7 +395,7 @@ await videoOutput.stop((err) => { #### Releasing Resources ```js -// Stop the current session. +// Stop the session. await captureSession.stop((err) => { if (err) { console.error('Failed to stop the session ${err.message}'); diff --git a/en/application-dev/media/figures/zh-ch_image_audio_stream_manager.png b/en/application-dev/media/figures/en-us_image_audio_stream_manager.png similarity index 100% rename from en/application-dev/media/figures/zh-ch_image_audio_stream_manager.png rename to en/application-dev/media/figures/en-us_image_audio_stream_manager.png diff --git a/en/application-dev/media/remote-camera.md b/en/application-dev/media/remote-camera.md index b63946d6a03a9fbb4d4e6b8e20c3e4920364523b..e35950e73b1993b8a446f75e3007a80e4bbaff19 100644 --- a/en/application-dev/media/remote-camera.md +++ b/en/application-dev/media/remote-camera.md @@ -5,7 +5,7 @@ You can call the APIs provided by the **Camera** module to develop a distributed camera that provides the basic camera functions such as shooting and video recording. ## How to Develop -Connect your calculator to a distributed device. Your calculator will call **getCameras()** to obtain the camera list and traverse the returned camera list to check **ConnctionType** of the **Camera** objects. If **ConnctionType** of a **Camera** object is **CAMERA_CONNECTION_REMOTE**, your calculator will use this object to create a **CameraInput** object. The subsequent call process is the same as that of the local camera development. For details about the local camera development, see [Camera Development](./camera.md). +Connect your calculator to a distributed device. Your calculator will call **getCameras()** to obtain the camera list and traverse the returned camera list to check **ConnectionType** of the **Camera** objects. If **ConnectionType** of a **Camera** object is **CAMERA_CONNECTION_REMOTE**, your calculator will use this object to create a **CameraInput** object. The subsequent call process is the same as that of the local camera development. For details about the local camera development, see [Camera Development](./camera.md). For details about the APIs, see [Camera Management](../reference/apis/js-apis-camera.md). @@ -52,7 +52,7 @@ await cameraManager.getCameras((err, cameras) => { cameraArray = cameras }) -for(let cameraIndex = 0; cameraIndex < cameraArray.length; cameraIndex) { +for(let cameraIndex = 0; cameraIndex < cameraArray.length; cameraIndex++) { console.log('cameraId : ' + cameraArray[cameraIndex].cameraId) // Obtain the camera ID. console.log('cameraPosition : ' + cameraArray[cameraIndex].cameraPosition) // Obtain the camera position. console.log('cameraType : ' + cameraArray[cameraIndex].cameraType) // Obtain the camera type. diff --git a/en/application-dev/media/video-playback.md b/en/application-dev/media/video-playback.md index cfc09db79fc853066e03205010f43c2f63c27ce5..6ee5cf660069294f717c5cac614ed707db9f1a8c 100644 --- a/en/application-dev/media/video-playback.md +++ b/en/application-dev/media/video-playback.md @@ -33,7 +33,7 @@ The table below lists the mainstream playback formats and resolutions. ## How to Develop -For details about the APIs, see [VideoPlayer in the Media API](../reference/apis/js-apis-media.md). +For details about the APIs, see [VideoPlayer in the Media API](../reference/apis/js-apis-media.md#videoplayer8). ### Full-Process Scenario diff --git a/en/application-dev/media/video-recorder.md b/en/application-dev/media/video-recorder.md index 2982675bd37ff683c83f253d23d3a6c71014d66b..62e81cf05c384a7cd1a780c562697be046153d05 100644 --- a/en/application-dev/media/video-recorder.md +++ b/en/application-dev/media/video-recorder.md @@ -14,7 +14,7 @@ During video recording, audio and video signals are captured, encoded, and saved ## How to Develop -For details about the APIs, see [VideoRecorder in the Media API](../reference/apis/js-apis-media.md). +For details about the APIs, see [VideoRecorder in the Media API](../reference/apis/js-apis-media.md#videorecorder9). ### Full-Process Scenario diff --git a/en/application-dev/napi/napi-guidelines.md b/en/application-dev/napi/napi-guidelines.md index 86854eb072b19c7ee359dcb70413ce22580cb8f7..f471f4a6eed7d3eb2c96dab8cae4cb7480a13616 100644 --- a/en/application-dev/napi/napi-guidelines.md +++ b/en/application-dev/napi/napi-guidelines.md @@ -89,7 +89,7 @@ Register four synchronous APIs (`getSync`, `setSync`, `removeSync`, and`clearSyn /*********************************************** * Module export and register ***********************************************/ -static napi_value StorgeExport(napi_env env, napi_value exports) +static napi_value StorageExport(napi_env env, napi_value exports) { napi_property_descriptor desc[] = { DECLARE_NAPI_FUNCTION("get", JSStorageGet), @@ -110,7 +110,7 @@ static napi_value StorgeExport(napi_env env, napi_value exports) static napi_module storage_module = {.nm_version = 1, .nm_flags = 0, .nm_filename = nullptr, - .nm_register_func = StorgeExport, + .nm_register_func = StorageExport, .nm_modname = "storage", .nm_priv = ((void*)0), .reserved = {0}}; diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215066868.png b/en/application-dev/quick-start/figures/en-us_image_0000001215066868.png deleted file mode 100644 index d3afe4570f4a839aaa531dea2b1889f318c81f71..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215066868.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215206886.png b/en/application-dev/quick-start/figures/en-us_image_0000001215206886.png deleted file mode 100644 index e90d0dbca27908da2964babcba1bc74876b04991..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215206886.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215226858.png b/en/application-dev/quick-start/figures/en-us_image_0000001215226858.png deleted file mode 100644 index e2444e0c8488f6632a098585409352a8ce8c7303..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215226858.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215227618.png b/en/application-dev/quick-start/figures/en-us_image_0000001215227618.png deleted file mode 100644 index d3afe4570f4a839aaa531dea2b1889f318c81f71..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215227618.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215386842.png b/en/application-dev/quick-start/figures/en-us_image_0000001215386842.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215386842.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215388136.png b/en/application-dev/quick-start/figures/en-us_image_0000001215388136.png deleted file mode 100644 index 890e12eee8b4534a2b94206c6b73edc81d1ee3ee..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215388136.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001215388262.png b/en/application-dev/quick-start/figures/en-us_image_0000001215388262.png deleted file mode 100644 index 890e12eee8b4534a2b94206c6b73edc81d1ee3ee..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001215388262.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001216084724.png b/en/application-dev/quick-start/figures/en-us_image_0000001216084724.png deleted file mode 100644 index a8fac2a024e51aeb0439463dab83f2763fa3fa76..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001216084724.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001216239356.png b/en/application-dev/quick-start/figures/en-us_image_0000001216239356.png deleted file mode 100644 index fbbde9923a131d3ab69257b28cfe33ca2a1040cf..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001216239356.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001216269940.png b/en/application-dev/quick-start/figures/en-us_image_0000001216269940.png deleted file mode 100644 index 0b9e04b55e1f9dfca33d97b6b0b80635f6aa1adf..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001216269940.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001216288558.png b/en/application-dev/quick-start/figures/en-us_image_0000001216288558.png deleted file mode 100644 index 7795d74c5ec4915a1f2d6164e0625e308704528a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001216288558.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001217047316.png b/en/application-dev/quick-start/figures/en-us_image_0000001217047316.png deleted file mode 100644 index 6c1ea01d448434e7cfd94e174474e72b57d3b4cc..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001217047316.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001217526428.png b/en/application-dev/quick-start/figures/en-us_image_0000001217526428.png deleted file mode 100644 index 2c026736133d41d80a1b92eb0db230dd6c0a7feb..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001217526428.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001217527892.png b/en/application-dev/quick-start/figures/en-us_image_0000001217527892.png deleted file mode 100644 index 0b9e04b55e1f9dfca33d97b6b0b80635f6aa1adf..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001217527892.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223397122.png b/en/application-dev/quick-start/figures/en-us_image_0000001223397122.png deleted file mode 100644 index 42b475577bcc805372336be8971afa5c69c284bd..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223397122.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223556342.png b/en/application-dev/quick-start/figures/en-us_image_0000001223556342.png deleted file mode 100644 index ab2ae3c740dfee9b303d6319516c9facb3574184..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223556342.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223557290.png b/en/application-dev/quick-start/figures/en-us_image_0000001223557290.png deleted file mode 100644 index 6e093d7a983e03a37143357001eefd57c3df2c3c..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223557290.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223558810.png b/en/application-dev/quick-start/figures/en-us_image_0000001223558810.png deleted file mode 100644 index b9c3f899421f61b39480b831a662eebf6530100f..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223558810.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223558814.png b/en/application-dev/quick-start/figures/en-us_image_0000001223558814.png deleted file mode 100644 index ab2ae3c740dfee9b303d6319516c9facb3574184..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223558814.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223716826.png b/en/application-dev/quick-start/figures/en-us_image_0000001223716826.png deleted file mode 100644 index 14dc492cb36d22c79d22bea78d0f66508867291e..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223716826.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223717294.png b/en/application-dev/quick-start/figures/en-us_image_0000001223717294.png deleted file mode 100644 index 75910aaf0daa22be2c0b56ae94febaa672df7424..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223717294.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223722586.png b/en/application-dev/quick-start/figures/en-us_image_0000001223722586.png deleted file mode 100644 index 8ed9b0d3565e5fbb2f7897bc876369ebae5a8598..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223722586.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223877162.png b/en/application-dev/quick-start/figures/en-us_image_0000001223877162.png deleted file mode 100644 index 02d730cadf10899edd91f94ce4cb8badd3ba821c..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223877162.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223877210.png b/en/application-dev/quick-start/figures/en-us_image_0000001223877210.png deleted file mode 100644 index 9ce82237297b06c04113d0368d7145661de0d997..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223877210.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001223882030.png b/en/application-dev/quick-start/figures/en-us_image_0000001223882030.png deleted file mode 100644 index 045487dc8fa30e8f87cd3fdd5c87e8ec17715c94..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001223882030.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233048996.png b/en/application-dev/quick-start/figures/en-us_image_0000001233048996.png deleted file mode 100644 index 6d8b4f343d3744e245a656987a85a6da2c9bb18e..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233048996.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233049004.png b/en/application-dev/quick-start/figures/en-us_image_0000001233049004.png deleted file mode 100644 index b34bfa591849f5f0ffd0cee1fc898ef8d2f5a5cd..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233049004.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233049040.png b/en/application-dev/quick-start/figures/en-us_image_0000001233049040.png deleted file mode 100644 index c340326cce920ed6c55965126d38ddd973d9f50a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233049040.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233209020.png b/en/application-dev/quick-start/figures/en-us_image_0000001233209020.png deleted file mode 100644 index 890e12eee8b4534a2b94206c6b73edc81d1ee3ee..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233209020.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233209024.png b/en/application-dev/quick-start/figures/en-us_image_0000001233209024.png deleted file mode 100644 index dd28ccedfa20424aad7e01ee52d9246788b72eb8..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233209024.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233368860.png b/en/application-dev/quick-start/figures/en-us_image_0000001233368860.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233368860.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233368868.png b/en/application-dev/quick-start/figures/en-us_image_0000001233368868.png deleted file mode 100644 index cd1603f14f7a5d30c79613201e85ed240f10a409..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233368868.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233368900.png b/en/application-dev/quick-start/figures/en-us_image_0000001233368900.png deleted file mode 100644 index 890e12eee8b4534a2b94206c6b73edc81d1ee3ee..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233368900.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233528152.png b/en/application-dev/quick-start/figures/en-us_image_0000001233528152.png deleted file mode 100644 index ab2ae3c740dfee9b303d6319516c9facb3574184..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233528152.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233528160.png b/en/application-dev/quick-start/figures/en-us_image_0000001233528160.png deleted file mode 100644 index 6d8b4f343d3744e245a656987a85a6da2c9bb18e..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233528160.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001233528192.png b/en/application-dev/quick-start/figures/en-us_image_0000001233528192.png deleted file mode 100644 index dd28ccedfa20424aad7e01ee52d9246788b72eb8..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001233528192.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001259866741.png b/en/application-dev/quick-start/figures/en-us_image_0000001259866741.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001259866741.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001259987441.png b/en/application-dev/quick-start/figures/en-us_image_0000001259987441.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001259987441.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001260106745.png b/en/application-dev/quick-start/figures/en-us_image_0000001260106745.png deleted file mode 100644 index d3afe4570f4a839aaa531dea2b1889f318c81f71..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001260106745.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001260107497.png b/en/application-dev/quick-start/figures/en-us_image_0000001260107497.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001260107497.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001260226691.png b/en/application-dev/quick-start/figures/en-us_image_0000001260226691.png deleted file mode 100644 index 6d8b4f343d3744e245a656987a85a6da2c9bb18e..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001260226691.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001260227453.png b/en/application-dev/quick-start/figures/en-us_image_0000001260227453.png deleted file mode 100644 index d3afe4570f4a839aaa531dea2b1889f318c81f71..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001260227453.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001260684127.png b/en/application-dev/quick-start/figures/en-us_image_0000001260684127.png deleted file mode 100644 index 2c026736133d41d80a1b92eb0db230dd6c0a7feb..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001260684127.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001261142799.png b/en/application-dev/quick-start/figures/en-us_image_0000001261142799.png deleted file mode 100644 index 86ff220370fc26319a4a23434d70e2508d8f1b9a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001261142799.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001261809595.png b/en/application-dev/quick-start/figures/en-us_image_0000001261809595.png deleted file mode 100644 index 164371727ee8a351e2c42f4b3ecab9175e088e7c..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001261809595.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001261979271.png b/en/application-dev/quick-start/figures/en-us_image_0000001261979271.png deleted file mode 100644 index 12978dc861aaa1f826404d9c6838bb8628381615..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001261979271.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001262127855.png b/en/application-dev/quick-start/figures/en-us_image_0000001262127855.png deleted file mode 100644 index 86ff220370fc26319a4a23434d70e2508d8f1b9a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001262127855.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001262206247.png b/en/application-dev/quick-start/figures/en-us_image_0000001262206247.png deleted file mode 100644 index 6c1ea01d448434e7cfd94e174474e72b57d3b4cc..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001262206247.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001262207811.png b/en/application-dev/quick-start/figures/en-us_image_0000001262207811.png deleted file mode 100644 index 6c1ea01d448434e7cfd94e174474e72b57d3b4cc..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001262207811.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001262219043.png b/en/application-dev/quick-start/figures/en-us_image_0000001262219043.png deleted file mode 100644 index 12978dc861aaa1f826404d9c6838bb8628381615..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001262219043.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001262339067.png b/en/application-dev/quick-start/figures/en-us_image_0000001262339067.png deleted file mode 100644 index 12978dc861aaa1f826404d9c6838bb8628381615..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001262339067.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001268077317.png b/en/application-dev/quick-start/figures/en-us_image_0000001268077317.png deleted file mode 100644 index 6e093d7a983e03a37143357001eefd57c3df2c3c..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001268077317.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001268082945.png b/en/application-dev/quick-start/figures/en-us_image_0000001268082945.png deleted file mode 100644 index 55d41f7eb98b1c80bc5f85ea99be6b73bcdd7c1d..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001268082945.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001268198893.png b/en/application-dev/quick-start/figures/en-us_image_0000001268198893.png deleted file mode 100644 index ab2ae3c740dfee9b303d6319516c9facb3574184..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001268198893.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001268283201.png b/en/application-dev/quick-start/figures/en-us_image_0000001268283201.png deleted file mode 100644 index 6e093d7a983e03a37143357001eefd57c3df2c3c..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001268283201.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277488985.png b/en/application-dev/quick-start/figures/en-us_image_0000001277488985.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277488985.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277489017.png b/en/application-dev/quick-start/figures/en-us_image_0000001277489017.png deleted file mode 100644 index c659e54584bf8e78543facc3a1b3f821a6a9571f..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277489017.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277608813.png b/en/application-dev/quick-start/figures/en-us_image_0000001277608813.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277608813.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277608849.png b/en/application-dev/quick-start/figures/en-us_image_0000001277608849.png deleted file mode 100644 index 12978dc861aaa1f826404d9c6838bb8628381615..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277608849.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277728569.png b/en/application-dev/quick-start/figures/en-us_image_0000001277728569.png deleted file mode 100644 index 4d6994bf5bf8dd05baf7eac6274f56de27fc23b3..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277728569.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277728577.png b/en/application-dev/quick-start/figures/en-us_image_0000001277728577.png deleted file mode 100644 index 6d8b4f343d3744e245a656987a85a6da2c9bb18e..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277728577.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277728597.png b/en/application-dev/quick-start/figures/en-us_image_0000001277728597.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277728597.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277728613.png b/en/application-dev/quick-start/figures/en-us_image_0000001277728613.png deleted file mode 100644 index cc3ca5fd7274be67f62b32e531fcbbaf294317c1..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277728613.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277809333.png b/en/application-dev/quick-start/figures/en-us_image_0000001277809333.png deleted file mode 100644 index 64bb2a8edf4720cdb4d4d3b6055baa03c81b0a54..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277809333.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277809337.png b/en/application-dev/quick-start/figures/en-us_image_0000001277809337.png deleted file mode 100644 index 335548669bb32a22f146d76f9ab88527e52f515a..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277809337.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001277809373.png b/en/application-dev/quick-start/figures/en-us_image_0000001277809373.png deleted file mode 100644 index 6c1ea01d448434e7cfd94e174474e72b57d3b4cc..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001277809373.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_0000001655128646.png b/en/application-dev/quick-start/figures/en-us_image_0000001655128646.png deleted file mode 100644 index 048b8e07817272b759781df104c1dd4526685d61..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_0000001655128646.png and /dev/null differ diff --git a/en/application-dev/quick-start/figures/en-us_image_202206250937.png b/en/application-dev/quick-start/figures/en-us_image_202206250937.png deleted file mode 100644 index c4aa65192d174763ee3b6c74e10274978868ac67..0000000000000000000000000000000000000000 Binary files a/en/application-dev/quick-start/figures/en-us_image_202206250937.png and /dev/null differ diff --git a/en/application-dev/quick-start/package-structure.md b/en/application-dev/quick-start/package-structure.md index cae1337dea083ff731be54f0536fa33f6fd64812..076bc9474ba724746938c1a4da837a3679c73d5a 100644 --- a/en/application-dev/quick-start/package-structure.md +++ b/en/application-dev/quick-start/package-structure.md @@ -232,7 +232,6 @@ Table 11 Internal structure of the module tag | distroFilter | Application distribution rules.
AppGallery uses these rules to distribute HAP files to the matching devices. Distribution rules cover three factors: API version, screen shape, and screen resolution. AppGallery distributes a HAP file to the device whose on the mapping between **deviceType** and these three factors. For details, see Table 29. | Object | Yes (initial value: left empty)
Set this attribute when an application has multiple entry modules. | | reqCapabilities | Device capabilities required for running the application. | String array| Yes (initial value: left empty) | | commonEvents | Static broadcast. For details, see Table 35. | Object array | Yes (initial value: left empty) | -| allowClassMap | Metadata of the HAP file. The value can be **true** or **false**. If the value is **true**, the HAP file uses the Java object proxy mechanism provided by the OpenHarmony framework. | Boolean | No (initial value: **false**) | | entryTheme | Keyword of an OpenHarmony internal theme. Set it to the resource index of the name.| String | Yes (initial value: left empty) | Example of the **module** tag structure: @@ -348,7 +347,7 @@ Table 17 Internal structure of the abilities attribute | Attribute | Description | Data Type | Initial Value Allowed | | ---------------- | ------------------------------------------------------------ | ---------- | -------------------------------------------------------- | | process | Name of the process running the application or ability. If the **process** attribute is configured in the **deviceConfig** tag, all abilities of the application run in this process. You can set the **process** attribute for a specific ability in the **abilities** attribute, so that the ability can run in the particular process. If this attribute is set to the name of the process running other applications, all these applications can run in the same process, provided they have the same unified user ID and the same signature. Devices running OpenHarmony do not support this attribute.| String | Yes (initial value: left empty) | -| name | Name of the ability. The value is a reverse domain name, in the format of "*Bundle name*.*Class name*", for example, **"com.example.myapplication.MainAbility"**. Alternatively, the value can start with a period (.) followed by the class name, for example, **".MainAbility"**.
The ability name must be unique in an application. This attribute applies only to the default, tablet, smart TV, head unit, and wearable device types.
Note: When you use DevEco Studio to create a project, the configuration of the first ability is generated by default, including the **MainAbility.java** file and the class name **MainAbility** defaulted in the **name** string for the **abilities** attribute in **config.json**. The value of this attribute can be customized if you use other IDE tools. The value can contain a maximum of 127 characters.| String | No | +| name | Name of the ability. The value is a reverse domain name, in the format of "*Bundle name*.*Class name*", for example, **"com.example.myapplication.MainAbility"**. Alternatively, the value can start with a period (.) followed by the class name, for example, **".MainAbility"**.
The ability name must be unique in an application. This attribute applies only to the default, tablet, smart TV, head unit, and wearable device types.
Note: If you use DevEco Studio to create the project, an ability named **MainAbility** will be created together with the default configuration in the **config.json** file. The value of this attribute can be customized if you use other IDE tools. The value can contain a maximum of 127 characters.| String | No | | description | Description of the ability. The value can be a string or a resource index to descriptions in multiple languages. The value can contain a maximum of 255 characters.| String | Yes (initial value: left empty) | | icon | Index to the ability icon file. Example value: **$media:ability_icon**. In the **skills** attribute of the ability, if the **actions** value contains **action.system.home** and the **entities** value contains **entity.system.home**, the icon of the ability is also used as the icon of the application. If multiple abilities address this condition, the icon of the first candidate ability is used as the application icon.
Note: The **icon** and **label** values of an application are visible to users. Ensure that at least one of them is different from any existing icons or labels.| String | Yes (initial value: left empty) | | label | Ability name visible to users. The value can be a name string or a resource index to names in multiple languages. In the **skills** attribute of the ability, if the **actions** value contains **action.system.home** and the **entities** value contains **entity.system.home**, the label of the ability is also used as the label of the application. If multiple abilities address this condition, the label of the first candidate ability is used as the application label.
Note: The **icon** and **label** values of an application are visible to users. Ensure that at least one of them is different from any existing icons or labels. The value can be a reference to a string defined in a resource file or a string enclosed in brackets ({}). The value can contain a maximum of 255 characters.| String | Yes (initial value: left empty) | @@ -372,7 +371,7 @@ Table 17 Internal structure of the abilities attribute | supportPipMode | Whether the ability allows the user to enter the Picture in Picture (PiP) mode. The PiP mode enables the user to watch a video in a small window that hovers on top of a full screen window (main window). This attribute applies only to the ability using the Page template. This attribute applies only to the default, tablet, smart TV, head unit, and wearable device types.| Boolean | Yes (initial value: **false**) | | formsEnabled | Whether the ability can provide forms. This attribute applies only to the ability using the Page template.
**true**: This ability can provide forms.
**false**: This ability cannot provide forms.| Boolean | Yes (initial value: **false**) | | forms | Details about the forms used by the ability. This attribute is valid only when **formsEnabled** is set to **true**. For details, see Table 27.| Object array | Yes (initial value: left empty) | -| srcLanguage | Programming language used to develop the ability. | String | The value can be **java**, **js**, or **ets**. | +| srcLanguage | Programming language used to develop the ability. | String | The value can be **js**, or **ets**. | | srcPath | Path of the JS code and components corresponding to the ability. | String | Yes (initial value: left empty) | | uriPermission | Application data that the ability can access. This attribute consists of the **mode** and **path** sub-attributes. This attribute is valid only for the capability of the type provider. Devices running OpenHarmony do not support this attribute. For details, see Table 18.| Object | Yes (initial value: left empty) | | startWindowIcon | Index to the icon file of the ability startup page. Example value: **$media:icon**. | String | Yes (initial value: left empty) | @@ -587,12 +586,10 @@ Table 27 Internal structure of the forms attribute | name | Class name of the widget. The value is a string with a maximum of 127 bytes. | String | No | | description | Description of the widget. The value can be a string or a resource index to descriptions in multiple languages. The value is a string with a maximum of 255 bytes.| String | Yes (initial value: left empty) | | isDefault | Whether the widget is a default one. Each ability has only one default widget.
**true**: The widget is the default one.
**false**: The widget is not the default one.| Boolean | No | -| type | Type of the widget. Available values are as follows:
**Java**: indicates a Java-programmed widget.
**JS**: indicates a JavaScript-programmed widget.| String | No | +| type | Type of the widget. Available values are as follows:
**JS**: indicates a JavaScript-programmed widget.| String | No | | colorMode | Color mode of the widget. Available values are as follows:
**auto**: The widget adopts the auto-adaptive color mode.
**dark**: The widget adopts the dark color mode.
**light**: The widget adopts the light color mode.| String | Yes (initial value: **auto**)| | supportDimensions | Grid styles supported by the widget. Available values are as follows:
1 * 2: indicates a grid with one row and two columns.
2 * 2: indicates a grid with two rows and two columns.
2 * 4: indicates a grid with two rows and four columns.
4 * 4: indicates a grid with four rows and four columns.| String array| No | | defaultDimension | Default grid style of the widget. The value must be available in the **supportDimensions** array of the widget.| String | No | -| landscapeLayouts | Landscape layouts for the grid styles. Values in this array must correspond to the values in the **supportDimensions** array. This field is required only by Java-programmed widgets.| String array| No | -| portraitLayouts | Portrait layouts for the grid styles. Values in this array must correspond to the values in the **supportDimensions** array. This field is required only by Java-programmed widgets.| String array| No | | updateEnabled | Whether the widget can be updated periodically. Available values are as follows:
**true**: The widget can be updated periodically, depending on the update way you select, either at a specified interval (**updateDuration**) or at the scheduled time (**scheduledUpdateTime**). **updateDuration** is preferentially recommended.
**false**: The widget cannot be updated periodically.| Boolean | No | | scheduledUpdateTime | Scheduled time to update the widget. The value is in 24-hour format and accurate to minute. | String | Yes (initial value: **0:0**) | | updateDuration | Interval to update the widget. The value is a natural number, in the unit of 30 minutes.
If the value is **0**, this field does not take effect.
If the value is a positive integer ***N***, the interval is calculated by multiplying ***N*** and 30 minutes.| Number | Yes (initial value: **0**) | @@ -632,9 +629,9 @@ Example of the **forms** attribute structure: ] }, { - "name": "Form_Java", - "description": "It's Java Form", - "type": "Java", + "name": "Form_JS", + "description": "It's JS Form", + "type": "JS", "colorMode": "auto", "isDefault": false, "updateEnabled": true, diff --git a/en/application-dev/quick-start/start-with-ets-fa.md b/en/application-dev/quick-start/start-with-ets-fa.md index 325f4983f16f0cd48899fb657d3c9e41d2f9c3d8..03ed574bb99bcd65cecf0c6ca4710ab2271db9d3 100644 --- a/en/application-dev/quick-start/start-with-ets-fa.md +++ b/en/application-dev/quick-start/start-with-ets-fa.md @@ -187,7 +187,7 @@ ## Implementing Page Redirection -You can implement page redirection through the page router, which finds the target page based on the page URL. Import the **router** module and then perform the steps below: +You can implement page redirection through the [page router](../reference/apis/js-apis-router.md#routerpush), which finds the target page based on the page URL. Import the **router** module and then perform the steps below: 1. Implement redirection from the first page to the second page. diff --git a/en/application-dev/quick-start/start-with-ets-stage.md b/en/application-dev/quick-start/start-with-ets-stage.md index 7703ff56e9336bb5e648a63eb3e7df470f0d88a5..b6b8cd11b8ba18b59931c1bf0244d4af3d7ec888 100644 --- a/en/application-dev/quick-start/start-with-ets-stage.md +++ b/en/application-dev/quick-start/start-with-ets-stage.md @@ -185,7 +185,7 @@ ## Implementing Page Redirection -You can implement page redirection through the page router, which finds the target page based on the page URL. Import the **router** module and then perform the steps below: +You can implement page redirection through the [page router](../reference/apis/js-apis-router.md#routerpush), which finds the target page based on the page URL. Import the **router** module and then perform the steps below: 1. Implement redirection from the first page to the second page. @@ -285,7 +285,7 @@ You can implement page redirection through the page router, which finds the targ 1. Connect the development board running the OpenHarmony standard system to the computer. -2. Choose **File** > **Project Structure...** > **Project** > **SigningConfigs**, and select **Automatically generate signaure**. Wait until the automatic signing is complete, and click **OK**. See the following figure. +2. Choose **File** > **Project Structure...** > **Project** > **SigningConfigs**, and select **Automatically generate signature**. Wait until the automatic signing is complete, and click **OK**. See the following figure. ![06](figures/06.png) diff --git a/en/application-dev/quick-start/start-with-js-fa.md b/en/application-dev/quick-start/start-with-js-fa.md index dbd2931eba6f6de6c6d23777a5c761dc505dc7c4..03b037aeb529dcf7d481caf56db32625943c055b 100644 --- a/en/application-dev/quick-start/start-with-js-fa.md +++ b/en/application-dev/quick-start/start-with-js-fa.md @@ -181,7 +181,7 @@ ## Implementing Page Redirection -You can implement page redirection through the [page router](../ui/ui-js-building-ui-routes.md), which finds the target page based on the page URL. Import the **router** module and then perform the steps below: +You can implement page redirection through the [page router](../reference/apis/js-apis-router.md#routerpush), which finds the target page based on the page URL. Import the **router** module and then perform the steps below: 1. Implement redirection from the first page to the second page. diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index fe77dc5347f70c5cbcef596dbd8c3b57df83d9cc..e580b6bbef7bd71869de1da19a3a3d5c4757370d 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -146,6 +146,7 @@ - [@ohos.privacyManager](js-apis-privacyManager.md) - [@ohos.security.huks ](js-apis-huks.md) - [@ohos.userIAM.userAuth ](js-apis-useriam-userauth.md) + - [@ohos.userIAM.faceAuth](js-apis-useriam-faceauth.md) - [@system.cipher](js-apis-system-cipher.md) - Data Management diff --git a/en/application-dev/reference/apis/development-intro.md b/en/application-dev/reference/apis/development-intro.md index 8528a10ab6f4ba3dd14186079357ce28e650ee6a..f1cc73aa8437b7cb20bf5fe16b284da2a788d570 100644 --- a/en/application-dev/reference/apis/development-intro.md +++ b/en/application-dev/reference/apis/development-intro.md @@ -26,6 +26,12 @@ A description regarding system APIs will be provided in the document. - If all the APIs of a module are system APIs, the following description is provided at the beginning of the reference document: "All the APIs of this module are system APIs." - If a specific API of a module is a system API, the following description is provided individually for the API: "This is a system API." +Non-system applications are applications whose Ability Privilege Level (APL) is **normal**. The default application level is **normal**. + +For details about the APL and how to declare the APL of an application higher than **normal**, see [Access Control Overview - App APLs](../../security/accesstoken-overview.md#app-apls). + +The public SDK, which does not include system APIs, is provided as standard in DevEco Studio. To use system APIs, switch to the full SDK. For details on the operation, see [Guide to Switching to Full SDK](../../quick-start/full-sdk-switch-guide.md). + ## Permission Description By default, applications can access limited system resources. However, in some cases, an application needs to access excess data (including personal data) and functions of the system or another application to implement extended functions. For details, see [Access Control Overview](../../security/accesstoken-overview.md). diff --git a/en/application-dev/reference/apis/js-apis-ability-context.md b/en/application-dev/reference/apis/js-apis-ability-context.md index cd4e27214b3617970071bcfb8e4e5b1c76bc2a2c..9d33d34e9e0275c538e1cf2913af5fc0fdc656bc 100644 --- a/en/application-dev/reference/apis/js-apis-ability-context.md +++ b/en/application-dev/reference/apis/js-apis-ability-context.md @@ -5,9 +5,9 @@ The **AbilityContext** module, inherited from **Context**, implements the contex This module provides APIs for accessing ability-specific resources. You can use the APIs to start and terminate an ability, obtain the caller interface, and request permissions from users by displaying a dialog box. > **NOTE** -> -> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. -> The APIs of this module can be used only in the stage model. +> +> - The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> - The APIs of this module can be used only in the stage model. ## Usage @@ -78,7 +78,7 @@ Starts an ability with start options specified. This API uses an asynchronous ca | callback | AsyncCallback<void> | Yes| Callback used to return the result.| **Example** - + ```js var want = { "deviceId": "", @@ -127,7 +127,7 @@ Starts an ability. This API uses a promise to return the result. windowMode: 0, }; this.context.startAbility(want, options) - .then((data) => { + .then(() => { console.log('Operation successful.') }).catch((error) => { console.log('Operation failed.'); @@ -407,8 +407,8 @@ Starts a new Service Extension ability. This API uses a promise to return the re "abilityName": "MainAbility" }; this.context.startServiceExtensionAbility(want) - .then((data) => { - console.log('---------- startServiceExtensionAbility success, data: -----------', data); + .then(() => { + console.log('---------- startServiceExtensionAbility success -----------'); }) .catch((err) => { console.log('---------- startServiceExtensionAbility fail, err: -----------', err); @@ -477,8 +477,8 @@ Starts a new Service Extension ability with the account ID specified. This API u }; var accountId = 100; this.context.startServiceExtensionAbilityWithAccount(want,accountId) - .then((data) => { - console.log('---------- startServiceExtensionAbilityWithAccount success, data: -----------', data); + .then(() => { + console.log('---------- startServiceExtensionAbilityWithAccount success -----------'); }) .catch((err) => { console.log('---------- startServiceExtensionAbilityWithAccount fail, err: -----------', err); @@ -539,8 +539,8 @@ Stops a Service Extension ability in the same application. This API uses a promi "abilityName": "MainAbility" }; this.context.stopServiceExtensionAbility(want) - .then((data) => { - console.log('---------- stopServiceExtensionAbility success, data: -----------', data); + .then(() => { + console.log('---------- stopServiceExtensionAbility success -----------'); }) .catch((err) => { console.log('---------- stopServiceExtensionAbility fail, err: -----------', err); @@ -610,8 +610,8 @@ Stops a Service Extension ability in the same application with the account ID sp }; var accountId = 100; this.context.stopServiceExtensionAbilityWithAccount(want,accountId) - .then((data) => { - console.log('---------- stopServiceExtensionAbilityWithAccount success, data: -----------', data); + .then(() => { + console.log('---------- stopServiceExtensionAbilityWithAccount success -----------'); }) .catch((err) => { console.log('---------- stopServiceExtensionAbilityWithAccount fail, err: -----------', err); @@ -658,8 +658,8 @@ Terminates this ability. This API uses a promise to return the result. **Example** ```js - this.context.terminateSelf().then((data) => { - console.log('success:' + JSON.stringify(data)); + this.context.terminateSelf().then(() => { + console.log('success'); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); @@ -848,11 +848,11 @@ Disconnects a connection. This API uses a promise to return the result. | Promise\ | Promise used to return the result.| **Example** - + ```js var connectionNumber = 0; - this.context.disconnectAbility(connectionNumber).then((data) => { - console.log('disconnectAbility success, data: ', data); + this.context.disconnectAbility(connectionNumber).then(() => { + console.log('disconnectAbility success'); }).catch((err) => { console.log('disconnectAbility fail, err: ', err); }); @@ -888,7 +888,7 @@ Disconnects a connection. This API uses an asynchronous callback to return the r startAbilityByCall(want: Want): Promise<Caller>; -Starts an ability in the foreground or background and obtains the caller interface for communication with the ability. +Starts an ability in the foreground or background and obtains the caller object for communicating with the ability. **System capability**: SystemCapability.Ability.AbilityRuntime.Core @@ -905,11 +905,11 @@ Starts an ability in the foreground or background and obtains the caller interfa | Promise<Caller> | Promise used to return the caller object to communicate with.| **Example** - + ```js let caller = undefined; - // Start an ability in the background without passing parameters. + // Start an ability in the background by not passing parameters. var wantBackground = { bundleName: "com.example.myservice", moduleName: "entry", @@ -1050,8 +1050,8 @@ Starts an ability with the account ID specified. This API uses a promise to retu windowMode: 0, }; this.context.startAbilityWithAccount(want, accountId, options) - .then((data) => { - console.log('---------- startAbilityWithAccount success, data: -----------', data); + .then(() => { + console.log('---------- startAbilityWithAccount success -----------'); }) .catch((err) => { console.log('---------- startAbilityWithAccount fail, err: -----------', err); @@ -1074,13 +1074,13 @@ Requests permissions from the user by displaying a dialog box. This API uses an | callback | AsyncCallback<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | Yes| Callback used to return the result.| **Example** - + ```js var permissions=['com.example.permission'] this.context.requestPermissionsFromUser(permissions,(result) => { console.log('requestPermissionsFromUserresult:' + JSON.stringify(result)); }); - + ``` @@ -1105,7 +1105,7 @@ Requests permissions from the user by displaying a dialog box. This API uses a p | Promise<[PermissionRequestResult](js-apis-permissionrequestresult.md)> | Promise used to return the result.| **Example** - + ```js var permissions=['com.example.permission'] this.context.requestPermissionsFromUser(permissions).then((data) => { @@ -1133,7 +1133,7 @@ Sets a label for this ability in the mission. This API uses an asynchronous call | callback | AsyncCallback<void> | Yes| Callback used to return the result.| **Example** - + ```js this.context.setMissionLabel("test",(result) => { console.log('requestPermissionsFromUserresult:' + JSON.stringify(result)); @@ -1162,10 +1162,10 @@ Sets a label for this ability in the mission. This API uses a promise to return | Promise<void> | Promise used to return the result.| **Example** - + ```js - this.context.setMissionLabel("test").then((data) => { - console.log('success:' + JSON.stringify(data)); + this.context.setMissionLabel("test").then(() => { + console.log('success'); }).catch((error) => { console.log('failed:' + JSON.stringify(error)); }); @@ -1188,7 +1188,7 @@ Sets an icon for this ability in the mission. This API uses an asynchronous call | callback | AsyncCallback\ | Yes| Callback used to return the result.| **Example** - + ```js import image from '@ohos.multimedia.image' var imagePixelMap; @@ -1235,7 +1235,7 @@ Sets an icon for this ability in the mission. This API uses a promise to return | Promise<void> | Promise used to return the result.| **Example** - + ```js import image from '@ohos.multimedia.image' var imagePixelMap; @@ -1254,8 +1254,8 @@ Sets an icon for this ability in the mission. This API uses a promise to return console.log('--------- createPixelMap fail, err: ---------', err) }); this.context.setMissionIcon(imagePixelMap) - .then((data) => { - console.log('-------------- setMissionIcon success, data: -------------', data); + .then(() => { + console.log('-------------- setMissionIcon success -------------'); }) .catch((err) => { console.log('-------------- setMissionIcon fail, err: -------------', err); diff --git a/en/application-dev/reference/apis/js-apis-ability-wantConstant.md b/en/application-dev/reference/apis/js-apis-ability-wantConstant.md index 545da5d468feefce2440a356812356e6206e11e3..4b1a66f071f464d6662d8429606c48aa025e8ef6 100644 --- a/en/application-dev/reference/apis/js-apis-ability-wantConstant.md +++ b/en/application-dev/reference/apis/js-apis-ability-wantConstant.md @@ -4,12 +4,12 @@ The **wantConstant** module provides the actions, entities, and flags used in ** > **NOTE** > -> The initial APIs of this module are supported since API 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import -``` -import wantConstant from '@ohos.ability.wantConstant' +```js +import wantConstant from '@ohos.ability.wantConstant'; ``` ## wantConstant.Action @@ -32,7 +32,7 @@ Enumerates the action constants of the **Want** object. | ACTION_DISMISS_ALARM | ohos.want.action.dismissAlarm | Action of launching the UI for deleting an alarm. | | ACTION_DISMISS_TIMER | ohos.want.action.dismissTimer | Action of launching the UI for dismissing a timer. | | ACTION_SEND_SMS | ohos.want.action.sendSms | Action of launching the UI for sending an SMS message. | -| ACTION_CHOOSE | ohos.want.action.choose | Action of launching the UI for openning a contact or picture. | +| ACTION_CHOOSE | ohos.want.action.choose | Action of launching the UI for opening a contact or picture. | | ACTION_IMAGE_CAPTURE8+ | ohos.want.action.imageCapture | Action of launching the UI for photographing. | | ACTION_VIDEO_CAPTURE8+ | ohos.want.action.videoCapture | Action of launching the UI for shooting a video. | | ACTION_SELECT | ohos.want.action.select | Action of launching the UI for application selection. | @@ -46,8 +46,13 @@ Enumerates the action constants of the **Want** object. | ACTION_FILE_SELECT7+ | ohos.action.fileSelect | Action of selecting a file. | | PARAMS_STREAM7+ | ability.params.stream | URI of the data stream associated with the target when the data is sent. | | ACTION_APP_ACCOUNT_OAUTH 8+ | ohos.account.appAccount.action.oauth | Action of providing the OAuth service. | -| ACTION_MARKER_DOWNLOAD 9+ | ohos.want.action.marketDownload | Action of downloading an application from the application market.
**System API**: This is a system API and cannot be called by third-party applications. | - +| ACTION_MARKET_DOWNLOAD 9+ | ohos.want.action.marketDownload | Action of downloading an application from the application market.
**System API**: This is a system API and cannot be called by third-party applications. | +| ACTION_MARKET_CROWDTEST 9+ | ohos.want.action.marketCrowdTest | Action of crowdtesting an application from the application market.
**System API**: This is a system API and cannot be called by third-party applications. | +| DLP_PARAMS_SANDBOX9+ |ohos.dlp.params.sandbox | Action of obtaining the sandbox flag.
**System API**: This is a system API and cannot be called by third-party applications. | +| DLP_PARAMS_BUNDLE_NAME9+ |ohos.dlp.params.bundleName |Action of obtaining the DLP bundle name.
**System API**: This is a system API and cannot be called by third-party applications. | +| DLP_PARAMS_MODULE_NAME9+ |ohos.dlp.params.moduleName |Action of obtaining the DLP module name.
**System API**: This is a system API and cannot be called by third-party applications. | +| DLP_PARAMS_ABILITY_NAME9+ |ohos.dlp.params.abilityName |Action of obtaining the DLP ability name.
**System API**: This is a system API and cannot be called by third-party applications. | +| DLP_PARAMS_INDEX9+ |ohos.dlp.params.index |Action of obtaining the DLP index.
**System API**: This is a system API and cannot be called by third-party applications. | ## wantConstant.Entity diff --git a/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md b/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md index f8323a391ace1995486ff721666805a7bbb9b658..6a592ba663ec3723884fd0f44fef90a733230fa7 100644 --- a/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md +++ b/en/application-dev/reference/apis/js-apis-accessibility-extension-context.md @@ -9,10 +9,18 @@ You can use the APIs of this module to configure the concerned information, obta > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The APIs of this module can be used only in the stage model. -## Modules to Import +## Usage + +Before using the **AccessibilityExtensionContext** module, you must define a child class that inherits from **AccessibilityExtensionAbility**. ```js import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility' +class MainAbility extends AccessibilityExtensionAbility { + onConnect(): void { + console.log("AxExtensionAbility onConnect"); + let axContext = this.context; + } +} ``` ## FocusDirection @@ -203,9 +211,9 @@ this.context.getWindows().then(windows => { }) ``` -## AccessibilityExtensionContext.gestureInject +## AccessibilityExtensionContext.injectGesture -gestureInject(gesturePath: GesturePath, listener: Callback\): Promise\): Promise\- **'accessibilityStateChange'** means to listen for enabled status changes of the accessibility application.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **'touchGuideStateChange'** means to listen for enabled status changes of the touch guide mode.
**System capability**: SystemCapability.BarrierFree.Accessibility.Vision| - | callback | Callback<boolean> | Yes| Callback invoked when the enabled status of captions configuration changes.| + | type | string | Yes| Type of the event to listen for.
- **'accessibilityStateChange'** means to listen for the enabled status changes of the accessibility application.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **'touchGuideStateChange'** means to listen for the enabled status changes of the touch guide mode.
**System capability**: SystemCapability.BarrierFree.Accessibility.Vision| + | callback | Callback\ | Yes| Callback invoked when the enabled status of captions configuration changes.| - **Example** @@ -456,13 +460,15 @@ Enables listening for the accessibility application or touch guide mode status c off(type: 'accessibilityStateChange ' | 'touchGuideStateChange', callback?: Callback<boolean>): void -Disables listening for the accessibility application or touch guide mode status changes. +Disables listening for the enabled status changes of the accessibility application or touch guide mode. + + - **Parameters** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | - | type | string | No| Type of the event to listen for.
- **'accessibilityStateChange'** means to listen for enabled status changes of the accessibility application.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **'touchGuideStateChange'** means to listen for enabled status changes of the touch guide mode.
**System capability**: SystemCapability.BarrierFree.Accessibility.Vision| + | type | string | No| Type of the event to listen for.
- **'accessibilityStateChange'** means to listen for the enabled status changes of the accessibility application.
**System capability**: SystemCapability.BarrierFree.Accessibility.Core
- **'touchGuideStateChange'** means to listen for the enabled status changes of the touch guide mode.
**System capability**: SystemCapability.BarrierFree.Accessibility.Vision| | callback | Callback<boolean> | No| Callback invoked when the enabled status changes.| - **Example** diff --git a/en/application-dev/reference/apis/js-apis-appAccount.md b/en/application-dev/reference/apis/js-apis-appAccount.md index ef0e355c63726bc167dac72801adfdce030827f3..c98d603c0092e8f2fd9e1f9a2ce0d33ecd9cc1a7 100644 --- a/en/application-dev/reference/apis/js-apis-appAccount.md +++ b/en/application-dev/reference/apis/js-apis-appAccount.md @@ -1,4 +1,4 @@ -# App Account Management +# App Account Management The **appAccount** module provides APIs for app account management. You can use the APIs to add, delete, query, modify, and authorize app accounts, write data to disks, and synchronize data. @@ -154,7 +154,7 @@ Implicitly adds an app account based on the specified account owner, authenticat } const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.addAccountImplicitly("LiSi", "readAge", {}, { + appAccountManager.addAccountImplicitly("com.example.ohos.accountjsdemo", "getSocialData", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); @@ -321,7 +321,8 @@ Enables an app account to access an app with the given bundle name. This API use **Example** ```js - app_account_instance.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.enableAppAccess("ZhangSan", "com.example.ohos.accountjsdemo").then(() => { console.log('enableAppAccess Success'); }).catch((err) => { console.log("enableAppAccess err: " + JSON.stringify(err)); @@ -334,7 +335,7 @@ checkAppAccountSyncEnable(name: string, callback: AsyncCallback<boolean>): Checks whether an app account allows app data synchronization. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC (available only to system applications) +**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **System capability**: SystemCapability.Account.AppAccount @@ -361,7 +362,7 @@ checkAppAccountSyncEnable(name: string): Promise<boolean> Checks whether an app account allows app data synchronization. This API uses a promise to return the result. -**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC (available only to system applications) +**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **System capability**: SystemCapability.Account.AppAccount @@ -510,7 +511,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean, callback: AsyncCallback Sets whether to enable app data synchronization for an app account. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC (available only to system applications) +**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **System capability**: SystemCapability.Account.AppAccount @@ -537,7 +538,7 @@ setAppAccountSyncEnable(name: string, isEnable: boolean): Promise<void> Sets whether to enable app data synchronization for an app account. This API uses a promise to return the result. -**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC (available only to system applications) +**Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC **System capability**: SystemCapability.Account.AppAccount @@ -585,7 +586,8 @@ Sets data to be associated with an app account. This API uses an asynchronous ca **Example** ```js - app_account_instance.setAssociatedData("ZhangSan", "k001", "v001", (err) => { + const appAccountManager = account_appAccount.createAppAccountManager(); + appAccountManager.setAssociatedData("ZhangSan", "k001", "v001", (err) => { console.log("setAssociatedData err: " + JSON.stringify(err)); }); ``` @@ -795,6 +797,35 @@ Obtains data associated with an app account. This API uses a promise to return t }); ``` +### getAssociatedDataSync9+ + +getAssociatedDataSync(name: string, key: string): string; + +Obtains the data associated with this app account. This API returns the result synchronously. + +**System capability**: SystemCapability.Account.AppAccount + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | --------- | +| name | string | Yes | Name of the target app account. | +| key | string | Yes | Key of the data to obtain.| + +**Return value** + +| Type | Description | +| :-------------------- | :-------------------- | +| string | Data obtained.| + +**Example** + + ```js + const appAccountManager = account_appAccount.createAppAccountManager(); + var backData = appAccountManager.getAssociatedDataSync("ZhangSan", "k001"); + console.info("getAssociatedDataSync backData:" + JSON.stringify(backData)); + ``` + ### getAllAccessibleAccounts getAllAccessibleAccounts(callback: AsyncCallback<Array<AppAccountInfo>>): void @@ -868,7 +899,7 @@ Obtains information about all app accounts of the specified app. This API uses a **Example** ```js - const appAccountManager = account.createAppAccountManager(); + const appAccountManager = account_appAccount.createAppAccountManager(); const selfBundle = "com.example.actsgetallaaccounts"; appAccountManager.getAllAccounts(selfBundle, (err, data)=>{ console.debug("getAllAccounts err:" + JSON.stringify(err)); @@ -929,7 +960,7 @@ Subscribes to the account change events of the specified account owners. This AP **Example** ```js - const appAccountManager = account.createAppAccountManager(); + const appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ console.debug("receive change data:" + JSON.stringify(data)); } @@ -959,7 +990,7 @@ Unsubscribes from the account change events. This API uses an asynchronous callb **Example** ```js - const appAccountManager = account.createAppAccountManager(); + const appAccountManager = account_appAccount.createAppAccountManager(); function changeOnCallback(data){ console.debug("receive change data:" + JSON.stringify(data)); appAccountManager.off('change', function(){ @@ -1010,7 +1041,7 @@ Authenticates an app account to obtain an Open Authorization (OAuth) token. This } const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "readAge", {}, { + appAccountManager.authenticate("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", {}, { onResult: onResultCallback, onRequestRedirected: onRequestRedirectedCallback }); @@ -1037,7 +1068,7 @@ Obtains the OAuth token of an app account based on the specified authentication ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", (err, data) => { + appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { console.log('getOAuthToken err: ' + JSON.stringify(err)); console.log('getOAuthToken token: ' + data); }); @@ -1069,7 +1100,7 @@ Obtains the OAuth token of an app account based on the specified authentication ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge").then((data) => { + appAccountManager.getOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData").then((data) => { console.log('getOAuthToken token: ' + data); }).catch((err) => { console.log("getOAuthToken err: " + JSON.stringify(err)); @@ -1097,7 +1128,7 @@ Sets an OAuth token for an app account. This API uses an asynchronous callback t ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthToken("LiSi", "readAge", "xxxx", (err) => { + appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx", (err) => { console.log('setOAuthToken err: ' + JSON.stringify(err)); }); ``` @@ -1128,7 +1159,7 @@ Sets an OAuth token for an app account. This API uses a promise to return the re ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthToken("LiSi", "readAge", "xxxx").then(() => { + appAccountManager.setOAuthToken("LiSi", "getSocialData", "xxxx").then(() => { console.log('setOAuthToken successfully'); }).catch((err) => { console.log('setOAuthToken err: ' + JSON.stringify(err)); @@ -1157,7 +1188,7 @@ Deletes the specified OAuth token for an app account. This API uses an asynchron ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", "xxxxx", (err) => { + appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx", (err) => { console.log('deleteOAuthToken err: ' + JSON.stringify(err)); }); ``` @@ -1189,7 +1220,7 @@ Deletes the specified OAuth token for an app account. This API uses a promise to ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "readAge", "xxxxx").then(() => { + appAccountManager.deleteOAuthToken("LiSi", "com.example.ohos.accountjsdemo", "getSocialData", "xxxxx").then(() => { console.log('deleteOAuthToken successfully'); }).catch((err) => { console.log("deleteOAuthToken err: " + JSON.stringify(err)); @@ -1218,7 +1249,7 @@ Sets the visibility of an OAuth token to an app. This API uses an asynchronous c ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true, (err) => { + appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true, (err) => { console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); }); ``` @@ -1250,7 +1281,7 @@ Sets the visibility of an OAuth token to an app. This API uses a promise to retu ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.setOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then(() => { + appAccountManager.setOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", true).then(() => { console.log('setOAuthTokenVisibility successfully'); }).catch((err) => { console.log('setOAuthTokenVisibility err: ' + JSON.stringify(err)); @@ -1278,7 +1309,7 @@ Checks whether an OAuth token is visible to an app. This API uses an asynchronou ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true, (err, data) => { + appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo", (err, data) => { console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); console.log('checkOAuthTokenVisibility isVisible: ' + data); }); @@ -1310,7 +1341,7 @@ Checks whether an OAuth token is visible to an app. This API uses a promise to r ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkOAuthTokenVisibility("LiSi", "readAge", "com.example.ohos.accountjsdemo", true).then((data) => { + appAccountManager.checkOAuthTokenVisibility("LiSi", "getSocialData", "com.example.ohos.accountjsdemo").then((data) => { console.log('checkOAuthTokenVisibility isVisible: ' + data); }).catch((err) => { console.log('checkOAuthTokenVisibility err: ' + JSON.stringify(err)); @@ -1369,7 +1400,7 @@ Obtains all OAuth tokens visible to the caller for an app account. This API uses ```js const appAccountManager = account_appAccount.createAppAccountManager(); appAccountManager.getAllOAuthTokens("LiSi", "com.example.ohos.accountjsdemo").then((data) => { - console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); + console.log('getAllOAuthTokens data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getAllOAuthTokens err: " + JSON.stringify(err)); }); @@ -1395,7 +1426,7 @@ Obtains a list of authorized OAuth tokens of an app account. This API uses an as ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "readAge", (err, data) => { + appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "getSocialData", (err, data) => { console.log('getOAuthList err: ' + JSON.stringify(err)); console.log('getOAuthList data: ' + JSON.stringify(data)); }); @@ -1426,7 +1457,7 @@ Obtains a list of authorized OAuth tokens of an app account. This API uses a pro ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "readAge").then((data) => { + appAccountManager.getOAuthList("com.example.ohos.accountjsdemo", "getSocialData").then((data) => { console.log('getOAuthList data: ' + JSON.stringify(data)); }).catch((err) => { console.log("getOAuthList err: " + JSON.stringify(err)); @@ -1462,9 +1493,9 @@ Obtains the authenticator callback for an authentication session. This API uses } var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "readAge", + [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.OnResult(account_appAccount.ResultCode.SUCCESS, result); + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); }); }); ``` @@ -1492,15 +1523,17 @@ Obtains the authenticator callback for an authentication session. This API uses **Example** ```js + import featureAbility from '@ohos.ability.featureAbility'; + const appAccountManager = account_appAccount.createAppAccountManager(); featureAbility.getWant().then((want) => { var sessionId = want.parameters[account_appAccount.Constants.KEY_SESSION_ID]; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "readAge", + [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.OnResult(account_appAccount.ResultCode.SUCCESS, result); + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); }).catch((err) => { console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); }); @@ -1578,7 +1611,7 @@ Checks whether an app account is authorized to access an app. This API uses an a | Name | Type | Mandatory | Description | | ---------- | ---------------------------- | ----- | ---------------- | | name | string | Yes | Name of the target app account. | -| bundleName | string | Yes | Bundle name of the app to access.| +| bundleName | string | Yes | Bundle name of the app to access. | | callback | AsyncCallback<boolean> | Yes | Callback invoked to return the result. | **Example** @@ -1604,7 +1637,7 @@ Checks whether an app account is authorized to access an app. This API uses a pr | Name | Type | Mandatory | Description | | ---------- | ------ | ----- | ---------------- | | name | string | Yes | Name of the target app account. | -| bundleName | string | Yes | Bundle name of the app to access.| +| bundleName | string | Yes | Bundle name of the app to access. | **Parameters** @@ -1702,7 +1735,8 @@ Checks whether an app account has specific labels. This API uses an asynchronous ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", (err, data) => { + var labels = ["student"]; + appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels, (err, data) => { console.log('checkAccountLabels: ' + JSON.stringify(data)); console.log("checkAccountLabels err: " + JSON.stringify(err)); }); @@ -1734,7 +1768,8 @@ Checks whether an app account has specific labels. This API uses a promise to re ```js const appAccountManager = account_appAccount.createAppAccountManager(); - appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo").then((data) => { + var labels = ["student"]; + appAccountManager.checkAccountLabels("zhangsan", "com.example.ohos.accountjsdemo", labels).then((data) => { console.log('checkAccountLabels: ' + JSON.stringify(data)); }).catch((err) => { console.log("checkAccountLabels err: " + JSON.stringify(err)); @@ -1944,7 +1979,7 @@ Defines app account information. | Name | Type | Mandatory | Description | | ----- | ------ | ---- | ----------- | | owner | string | Yes | Owner of the app account. The value is the bundle name of the app.| -| name | string | Yes | Name of the target app account. | +| name | string | Yes | Name of the app account. | ## OAuthTokenInfo8+ @@ -1967,8 +2002,8 @@ Defines OAuth authenticator information. | Name | Type | Mandatory | Description | | ------- | ------ | ---- | ---------- | | owner | string | Yes | Owner of the authenticator. The value is the bundle name of the app.| -| iconId | string | Yes | ID of the authenticator icon. | -| labelId | string | Yes | ID of the authenticator label. | +| iconId | number | Yes | ID of the authenticator icon. | +| labelId | number | Yes | ID of the authenticator label. | ## SelectAccountsOptions9+ @@ -2069,6 +2104,7 @@ Called to return the result of an authentication request. **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ------ | -------------------- | ---- | ------ | | code | number | Yes | Authentication result code.| @@ -2082,9 +2118,9 @@ Called to return the result of an authentication request. appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { var result = {[account_appAccount.Constants.KEY_NAME]: "LiSi", [account_appAccount.Constants.KEY_OWNER]: "com.example.ohos.accountjsdemo", - [account_appAccount.Constants.KEY_AUTH_TYPE]: "readAge", + [account_appAccount.Constants.KEY_AUTH_TYPE]: "getSocialData", [account_appAccount.Constants.KEY_TOKEN]: "xxxxxx"}; - callback.OnResult(account_appAccount.ResultCode.SUCCESS, result); + callback.onResult(account_appAccount.ResultCode.SUCCESS, result); }).catch((err) => { console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); }); @@ -2099,6 +2135,7 @@ Called to redirect a request. **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ------- | ---- | ---- | ---------- | | request | Want | Yes | Request to be redirected.| @@ -2137,7 +2174,7 @@ Called to continue to process the request. const appAccountManager = account_appAccount.createAppAccountManager(); var sessionId = "1234"; appAccountManager.getAuthenticatorCallback(sessionId).then((callback) => { - callback.OnRequestContinued(); + callback.onRequestContinued(); }).catch((err) => { console.log("getAuthenticatorCallback err: " + JSON.stringify(err)); }); @@ -2156,6 +2193,7 @@ Implicitly adds an app account based on the specified authentication type and op **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ---------------- | --------------------- | ---- | --------------- | | authType | string | Yes | Authentication type. | @@ -2167,11 +2205,12 @@ Implicitly adds an app account based on the specified authentication type and op authenticate(name: string, authType: string, callerBundleName: string, options: {[key: string]: any}, callback: AuthenticatorCallback): void -Authenticates an app account to obtain the OAuth access token. This API uses an asynchronous callback to return the result. +Authenticates an app account to obtain the OAuth token. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ---------------- | --------------------- | ---- | --------------- | | name | string | Yes | Name of the target app account. | @@ -2189,6 +2228,7 @@ Verifies the credential of an app account. This API uses an asynchronous callbac **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ---------------- | --------------------- | ---- | --------------- | | name | string | Yes | Name of the target app account. | @@ -2204,6 +2244,7 @@ Sets authenticator properties. This API uses an asynchronous callback to return **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ---------------- | --------------------- | ---- | --------------- | | options | [SetPropertiesOptions](#setpropertiesoptions9) | Yes | Authenticator properties to set. | @@ -2218,6 +2259,7 @@ Checks the account labels. This API uses an asynchronous callback to return the **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ---------------- | --------------------- | ---- | --------------- | | name | string | Yes | Name of the target app account. | @@ -2233,6 +2275,7 @@ Checks whether an app account can be deleted. This API uses an asynchronous call **System capability**: SystemCapability.Account.AppAccount **Parameters** + | Name | Type | Mandatory | Description | | ---------------- | --------------------- | ---- | --------------- | | name | string | Yes | Name of the target app account. | @@ -2264,7 +2307,7 @@ Obtains the remote object of an authenticator. This API cannot be overloaded. callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } - verifyCredential(name: string, options: VerifyCredentialOptions, callback: AuthenticatorCallback) { + verifyCredential(name, options, callback) { callback.onRequestRedirected({ bundleName: "com.example.ohos.accountjsdemo", abilityName: "com.example.ohos.accountjsdemo.VerifyAbility", @@ -2274,11 +2317,11 @@ Obtains the remote object of an authenticator. This API cannot be overloaded. }); } - setProperties(options: SetPropertiesOptions, callback: AuthenticatorCallback) { + setProperties(options, callback) { callback.onResult(account_appAccount.ResultCode.SUCCESS, {}); } - checkAccountLabels(name: string, labels: Array, callback: AuthenticatorCallback) { + checkAccountLabels(name, labels, callback) { var result = {[account_appAccount.Constants.KEY_BOOLEAN_RESULT]: false}; callback.onResult(account_appAccount.ResultCode.SUCCESS, result); } diff --git a/en/application-dev/reference/apis/js-apis-application-Want.md b/en/application-dev/reference/apis/js-apis-application-Want.md index fd15443a5b2ac2b28642a0c89d441cdbee5d6866..b7f2605363e849a8d5531b9ebda7d2277a2fd11c 100644 --- a/en/application-dev/reference/apis/js-apis-application-Want.md +++ b/en/application-dev/reference/apis/js-apis-application-Want.md @@ -49,6 +49,7 @@ import Want from '@ohos.application.Want'; - Passing a file descriptor (FD) ``` js + import fileio from '@ohos.fileio'; var fd; try { fd = fileio.openSync("/data/storage/el2/base/haps/pic.png"); @@ -59,9 +60,9 @@ import Want from '@ohos.application.Want'; "deviceId": "", // An empty deviceId indicates the local device. "bundleName": "com.extreme.test", "abilityName": "MainAbility", - "moduleName": "entry" // moduleName is optional. + "moduleName": "entry", // moduleName is optional. "parameters": { - "keyFd":{"type":"FD", "value":fd} + "keyFd":{"type":"FD", "value":fd} } }; this.context.startAbility(want, (error) => { diff --git a/en/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md b/en/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md index 8a366b1e21bb988c608ba0a5e57251f2bd237d75..1fa16906d34877c7e7dce4638b472b0c539b8921 100644 --- a/en/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md +++ b/en/application-dev/reference/apis/js-apis-application-WindowExtensionAbility.md @@ -25,56 +25,25 @@ import WindowExtensionAbility from '@ohos.application.WindowExtensionAbility'; ## WindowExtensionAbility.onConnect -onConnect(want: Want): rpc.RemoteObject +onConnect(want: Want): void Called when this Window Extension ability is connected to an ability for the first time. **System capability**: SystemCapability.WindowManager.WindowManager.Core +**Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | Yes| Information related to this Window Extension ability, including the ability name and bundle name. | - -**Return value** -| Type | Description | -| ----------------------------------------------- | -------------------- | -| [rpc.RemoteObject](js-apis-rpc.md#remoteobject) | Proxy of this Window Extension ability.| +| want | [Want](js-apis-application-Want.md) | Yes| Information related to this Window Extension ability, including the ability name and bundle name.| **Example** ```ts -import rpc from '@ohos.rpc'; - -class StubTest extends rpc.RemoteObject { - constructor(des) { - super(des); - } - onRemoteRequest(code, data, reply, option) { - return true; - } - queryLocalInterface(descriptor) { - return null; - } - getInterfaceDescriptor() { - return ""; - } - sendRequest(code, data, reply, options) { - return null; - } - getCallingPid() { - return 1; - } - getCallingUid() { - return 1; - } - attachLocalInterface(localInterface, descriptor){} -} - export default class MyWindowExtensionAbility extends WindowExtensionAbility { - onConnect(want): rpc.RemoteObject { + onConnect(want) { console.info('WindowExtAbility onConnect ' + want.abilityName); - return new StubTest("test"); } } @@ -88,9 +57,11 @@ Called when this Window Extension ability is disconnected from all connected abi **System capability**: SystemCapability.WindowManager.WindowManager.Core +**Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | Yes| Information related to this Window Extension ability, including the ability name and bundle name. | +| want | [Want](js-apis-application-Want.md) | Yes| Information related to this Window Extension ability, including the ability name and bundle name.| **Example** @@ -105,18 +76,19 @@ export default class MyWindowExtensionAbility extends WindowExtensionAbility { } ``` - ## WindowExtensionAbility.onWindowReady -onWindowReady(window: Window): void +onWindowReady(window: window.Window): void Called when a window is ready. **System capability**: SystemCapability.WindowManager.WindowManager.Core +**Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| window | [Window](js-apis-window.md) | Yes| Current **Window** instance.| +| window | [window.Window](js-apis-window.md#window) | Yes| Current **Window** instance.| **Example** @@ -127,7 +99,7 @@ export default class MyWindowExtensionAbility extends WindowExtensionAbility { onWindowReady(window) { window.loadContent('WindowExtAbility/pages/index1').then(() => { window.getProperties().then((pro) => { - console.log("WindowExtension " + JSON.stringify(pro)); + console.log('WindowExtension ' + JSON.stringify(pro)); }) window.show(); }) diff --git a/en/application-dev/reference/apis/js-apis-application-ability.md b/en/application-dev/reference/apis/js-apis-application-ability.md index 565210637c6e83f83ec734c0905e11596baaf0db..87a9809bb9b49db443ec6f7d1617a2228dacaf88 100644 --- a/en/application-dev/reference/apis/js-apis-application-ability.md +++ b/en/application-dev/reference/apis/js-apis-application-ability.md @@ -4,7 +4,7 @@ The **Ability** module manages the ability lifecycle and context, such as creati This module provides the following common ability-related functions: -- [Caller](#caller): implements sending of sequenceable data to the target ability when an ability (caller) invokes the target ability (callee). +- [Caller](#caller): implements sending of sequenceable data to the target ability when an ability (caller ability) invokes the target ability (callee ability). - [Callee](#callee): implements callbacks for registration and deregistration of caller notifications. > **NOTE** @@ -22,12 +22,12 @@ import Ability from '@ohos.application.Ability'; **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -| Name| Type| Readable| Writable| Description| +| Name| Type| Readable| Writable| Description| | -------- | -------- | -------- | -------- | -------- | -| context | [AbilityContext](js-apis-ability-context.md) | Yes| No| Context of an ability.| -| launchWant | [Want](js-apis-application-Want.md) | Yes| No| Parameters for starting the ability.| -| lastRequestWant | [Want](js-apis-application-Want.md) | Yes| No| Parameters used when the ability was started last time.| -| callee | [Callee](#callee) | Yes| No| Object that invokes the stub service.| +| context | [AbilityContext](js-apis-ability-context.md) | Yes| No| Context of an ability.| +| launchWant | [Want](js-apis-application-Want.md) | Yes| No| Parameters for starting the ability.| +| lastRequestWant | [Want](js-apis-application-Want.md) | Yes| No| Parameters used when the ability was started last time.| +| callee | [Callee](#callee) | Yes| No| Object that invokes the stub service.| ## Ability.onCreate @@ -39,13 +39,13 @@ Called to initialize the service logic when an ability is created. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | Yes| Information related to this ability, including the ability name and bundle name.| -| param | AbilityConstant.LaunchParam | Yes| Parameters for starting the ability, and the reason for the last abnormal exit.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-application-Want.md) | Yes| Information related to this ability, including the ability name and bundle name.| + | param | AbilityConstant.LaunchParam | Yes| Parameters for starting the ability, and the reason for the last abnormal exit.| +**Example** + ```js class myAbility extends Ability { onCreate(want, param) { @@ -65,12 +65,12 @@ Called when a **WindowStage** is created for this ability. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| windowStage | window.WindowStage | Yes| **WindowStage** information.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | windowStage | window.WindowStage | Yes| **WindowStage** information.| +**Example** + ```js class myAbility extends Ability { onWindowStageCreate(windowStage) { @@ -88,8 +88,8 @@ Called when the **WindowStage** is destroyed for this ability. **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -**Example** - +**Example** + ```js class myAbility extends Ability { onWindowStageDestroy() { @@ -109,12 +109,12 @@ Called when the **WindowStage** is restored during the migration of this ability **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| windowStage | window.WindowStage | Yes| **WindowStage** information.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | windowStage | window.WindowStage | Yes| **WindowStage** information.| +**Example** + ```js class myAbility extends Ability { onWindowStageRestore(windowStage) { @@ -132,8 +132,8 @@ Called when this ability is destroyed to clear resources. **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -**Example** - +**Example** + ```js class myAbility extends Ability { onDestroy() { @@ -151,8 +151,8 @@ Called when this ability is switched from the background to the foreground. **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -**Example** - +**Example** + ```js class myAbility extends Ability { onForeground() { @@ -170,8 +170,8 @@ Called when this ability is switched from the foreground to the background. **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -**Example** - +**Example** + ```js class myAbility extends Ability { onBackground() { @@ -191,18 +191,18 @@ Called to save data during the ability migration preparation process. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| wantParam | {[key: string]: any} | Yes| **want** parameter.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | wantParam | {[key: string]: any} | Yes| **want** parameter.| **Return value** -| Type| Description| -| -------- | -------- | -| AbilityConstant.OnContinueResult | Continuation result.| - -**Example** + | Type| Description| + | -------- | -------- | + | AbilityConstant.OnContinueResult | Continuation result.| +**Example** + ```js import AbilityConstant from "@ohos.application.AbilityConstant" class myAbility extends Ability { @@ -225,20 +225,17 @@ Called when the ability startup mode is set to singleton. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | Yes| Want parameters, such as the ability name and bundle name.| -| launchParams | AbilityConstant.LaunchParam | Yes| Reason for the ability startup and the last abnormal exit.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | want | [Want](js-apis-application-Want.md) | Yes| Want parameters, such as the ability name and bundle name.| + | launchParams | AbilityConstant.LaunchParam | Yes| Reason for the ability startup and the last abnormal exit.| +**Example** + ```js class myAbility extends Ability { - onNewWant(want, launchParams) { + onNewWant(want) { console.log('onNewWant, want:' + want.abilityName); - if (launchParams.launchReason === AbilityConstant.LaunchReason.CONTINUATION) { - console.log('onNewWant, launchReason is continuation'); - } } } ``` @@ -254,12 +251,12 @@ Called when the configuration of the environment where the ability is running is **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| config | [Configuration](js-apis-configuration.md) | Yes| New configuration.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | config | [Configuration](js-apis-configuration.md) | Yes| New configuration.| +**Example** + ```js class myAbility extends Ability { onConfigurationUpdated(config) { @@ -278,12 +275,12 @@ Dumps client information. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| params | Array\ | Yes| Parameters in the form of a command.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | params | Array\ | Yes| Parameters in the form of a command.| +**Example** + ```js class myAbility extends Ability { dump(params) { @@ -293,11 +290,35 @@ Dumps client information. } ``` +## Ability.onMemoryLevel + +onMemoryLevel(level: AbilityConstant.MemoryLevel): void; + +Called when the system has decided to adjust the memory level. For example, this API can be used when there is not enough memory to run as many background processes as possible. + +**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | Yes| Memory level that indicates the memory usage status. When the specified memory level is reached, a callback will be invoked and the system will start adjustment.| + +**Example** + + ```js + class myAbility extends Ability { + onMemoryLevel(level) { + console.log('onMemoryLevel, level:' + JSON.stringify(level)); + } + } + ``` + ## Caller -Implements sending of sequenceable data to the target ability when an ability (caller) invokes the target ability (callee). +Implements sending of sequenceable data to the target ability when an ability (caller ability) invokes the target ability (callee ability). ## Caller.call @@ -310,19 +331,19 @@ Sends sequenceable data to the target ability. **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| method | string | Yes| Notification message string negotiated between the two abilities. The message is used to instruct the callee to register a function to receive the sequenceable data.| -| data | rpc.Sequenceable | Yes| Sequenceable data. You need to customize the data.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | method | string | Yes| Notification message string negotiated between the two abilities. The message is used to instruct the callee to register a function to receive the sequenceable data.| + | data | rpc.Sequenceable | Yes| Sequenceable data. You need to customize the data.| **Return value** -| Type| Description| -| -------- | -------- | -| Promise<void> | Promise used to return a response.| - -**Example** + | Type| Description| + | -------- | -------- | + | Promise<void> | Promise used to return a response.| +**Example** + ```js import Ability from '@ohos.application.Ability'; class MyMessageAble{ // Custom sequenceable data structure @@ -383,19 +404,19 @@ Sends sequenceable data to the target ability and obtains the sequenceable data **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| method | string | Yes| Notification message string negotiated between the two abilities. The message is used to instruct the callee to register a function to receive the sequenceable data.| -| data | rpc.Sequenceable | Yes| Sequenceable data. You need to customize the data.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | method | string | Yes| Notification message string negotiated between the two abilities. The message is used to instruct the callee to register a function to receive the sequenceable data.| + | data | rpc.Sequenceable | Yes| Sequenceable data. You need to customize the data.| **Return value** -| Type| Description| -| -------- | -------- | -| Promise<rpc.MessageParcel> | Promise used to return the sequenceable data from the target ability.| - -**Example** + | Type| Description| + | -------- | -------- | + | Promise<rpc.MessageParcel> | Promise used to return the sequenceable data from the target ability.| +**Example** + ```js import Ability from '@ohos.application.Ability'; class MyMessageAble{ @@ -455,8 +476,8 @@ Releases the caller interface of the target ability. **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -**Example** - +**Example** + ```js import Ability from '@ohos.application.Ability'; var caller; @@ -492,12 +513,12 @@ Registers a callback that is invoked when the stub on the target ability is disc **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| callback | OnReleaseCallBack | Yes| Callback used for the **onRelease** API.| - -**Example** + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | OnReleaseCallBack | Yes| Callback used for the **onRelease** API.| +**Example** + ```js import Ability from '@ohos.application.Ability'; var caller; @@ -540,12 +561,13 @@ Registers a caller notification callback, which is invoked when the target abili **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| method | string | Yes| Notification message string negotiated between the two abilities.| -| callback | CalleeCallBack | Yes| JS notification synchronization callback of the **rpc.MessageParcel** type. The callback must return at least one empty **rpc.Sequenceable** object. Otherwise, the function execution fails.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | method | string | Yes| Notification message string negotiated between the two abilities.| + | callback | CalleeCallBack | Yes| JS notification synchronization callback of the **rpc.MessageParcel** type. The callback must return at least one empty **rpc.Sequenceable** object. Otherwise, the function execution fails.| -**Example** +**Example** + ```js import Ability from '@ohos.application.Ability'; class MyMessageAble{ @@ -595,9 +617,9 @@ Deregisters a caller notification callback, which is invoked when the target abi **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| method | string | Yes| Registered notification message string.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | method | string | Yes| Registered notification message string.| **Example** @@ -618,17 +640,16 @@ Deregisters a caller notification callback, which is invoked when the target abi **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -| Name| Type| Readable| Writable| Description| +| Name| Type| Readable| Writable| Description| | -------- | -------- | -------- | -------- | -------- | -| (msg: string) | function | Yes| No| Prototype of the listener function registered by the caller.| - +| (msg: string) | function | Yes| No| Prototype of the listener function registered by the caller.| - ## CalleeCallBack +## CalleeCallBack (indata: rpc.MessageParcel): rpc.Sequenceable; **System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore -| Name| Type| Readable| Writable| Description| +| Name| Type| Readable| Writable| Description| | -------- | -------- | -------- | -------- | -------- | -| (indata: rpc.MessageParcel) | rpc.Sequenceable | Yes| No| Prototype of the listener function registered by the callee.| +| (indata: rpc.MessageParcel) | rpc.Sequenceable | Yes| No| Prototype of the listener function registered by the callee.| diff --git a/en/application-dev/reference/apis/js-apis-application-abilityConstant.md b/en/application-dev/reference/apis/js-apis-application-abilityConstant.md index ca3269353344ca06935afaf6b390ae0c906f1a1a..50e65757431e7df6b9bc784c6169da902a04bf5d 100644 --- a/en/application-dev/reference/apis/js-apis-application-abilityConstant.md +++ b/en/application-dev/reference/apis/js-apis-application-abilityConstant.md @@ -65,7 +65,7 @@ Enumerates ability continuation results. ## AbilityConstant.WindowMode -Enumerates the window modes when an ability is started. +Enumerates the window modes in which an ability can be displayed at startup. **System capability**: SystemCapability.Ability.AbilityRuntime.Core @@ -76,3 +76,15 @@ Enumerates the window modes when an ability is started. | WINDOW_MODE_SPLIT_PRIMARY | 100 | The ability is displayed in the primary window in split-screen mode. | | WINDOW_MODE_SPLIT_SECONDARY | 101 | The ability is displayed in the secondary window in split-screen mode. | | WINDOW_MODE_FLOATING | 102 | The ability is displayed in a floating window.| + +## AbilityConstant.MemoryLevel + +Enumerates the memory levels. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +| Name | Value| Description | +| --- | --- | --- | +| MEMORY_LEVEL_MODERATE | 0 | Moderate memory usage. | +| MEMORY_LEVEL_LOW | 1 | Low memory usage. | +| MEMORY_LEVEL_CRITICAL | 2 | High memory usage. | diff --git a/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md b/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md index 542214482f3e5bc8a74dad3d9990e1817b3f02e8..1a6035f15c6d68dd374d21e1953163b57d1e7648 100644 --- a/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md +++ b/en/application-dev/reference/apis/js-apis-application-abilityDelegator.md @@ -875,3 +875,265 @@ abilityDelegator.finishTest(msg, 0).then(() => { console.info("finishTest promise"); }); ``` + +### addAbilityStageMonitor9+ + +addAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\): void; + +Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes of an ability stage. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. | + +**Example** + +```js +var abilityDelegator; + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityStageMonitor(monitor, (err : any) => { + console.info("addAbilityStageMonitor callback"); +}); +``` + + + +### addAbilityStageMonitor9+ + +addAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; + +Adds an **AbilityStageMonitor** instance to monitor the lifecycle state changes of an ability stage. This API uses a promise to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| + +**Return value** + +| Type | Description | +| -------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +var abilityDelegator; + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.addAbilityStageMonitor(monitor).then(() => { + console.info("addAbilityStageMonitor promise"); +}); +``` + +### removeAbilityStageMonitor9+ + +removeAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\): void; + +Removes an **AbilityStageMonitor** instance from the application memory. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. | + +**Example** + +```js +var abilityDelegator; + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.removeAbilityStageMonitor(monitor, (err : any) => { + console.info("removeAbilityStageMonitor callback"); +}); +``` + + + +### removeAbilityStageMonitor9+ + +removeAbilityStageMonitor(monitor: AbilityStageMonitor): Promise\; + +Removes an **AbilityStageMonitor** object from the application memory. This API uses a promise to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| + +**Return value** + +| Type | Description | +| -------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +var abilityDelegator; + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.removeAbilityStageMonitor(monitor).then(() => { + console.info("removeAbilityStageMonitor promise"); +}); +``` + +### waitAbilityStageMonitor9+ + +waitAbilityStageMonitor(monitor: AbilityStageMonitor, callback: AsyncCallback\): void; + +Waits for an **AbilityStage** instance that matches the conditions set in an **AbilityStageMonitor** instance and returns the **AbilityStage** instance. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, an **AbilityStage** instance is returned. Otherwise, no value is returned. | + +**Example** + +```js +var abilityDelegator; + +function onAbilityCreateCallback(data) { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityStageMonitor(monitor, (err : any, data : any) => { + console.info("waitAbilityStageMonitor callback"); +}); +``` + +### waitAbilityStageMonitor9+ + +waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout?: number): Promise\; + +Waits for an **AbilityStage** instance that matches the conditions set in an **AbilityStageMonitor** instance and returns the **AbilityStage** instance. This API uses a promise to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| +| timeout | number | No | Maximum waiting time, in milliseconds.| + +**Return value** + +| Type | Description | +| -------------- | ------------------- | +| Promise\ | Promise used to return the result. If the operation is successful, an **AbilityStage** instance is returned. Otherwise, no value is returned.| + +**Example** + +```js +var abilityDelegator; + +function onAbilityCreateCallback(data) { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityStageMonitor(monitor).then((data : any) => { + console.info("waitAbilityStageMonitor promise"); +}); +``` + +### waitAbilityStageMonitor9+ + +waitAbilityStageMonitor(monitor: AbilityStageMonitor, timeout: number, callback: AsyncCallback\): void; + +Waits a period of time for an **AbilityStage** instance that matches the conditions set in an **AbilityStageMonitor** instance and returns the **AbilityStage** instance. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| ------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | +| monitor | [AbilityStageMonitor](#abilitystagemonitor) | Yes | [AbilityStageMonitor](#abilitystagemonitor) instance.| +| timeout | number | No | Maximum waiting time, in milliseconds.| +| callback | AsyncCallback\ | Yes | Callback used to return the result. If the operation is successful, an **AbilityStage** instance is returned. Otherwise, no value is returned. | + +**Example** + +```js +var abilityDelegator; +var timeout = 100; + +function onAbilityCreateCallback(data) { + console.info("onAbilityCreateCallback"); +} + +var monitor = { + moduleName: "moduleName", + srcEntrance: "srcEntrance", +} + +abilityDelegator = AbilityDelegatorRegistry.getAbilityDelegator(); +abilityDelegator.waitAbilityStageMonitor(monitor, timeout, (err : any, data : any) => { + console.info("waitAbilityStageMonitor callback"); +}); +``` + +## AbilityStageMonitor + +Provides conditions for matching **AbilityStage** instances. The most recently matched **AbilityStage** instance is saved in an **AbilityStageMonitor** instance. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +| Name | Type | Readable| Writable| Description | +| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ | +| moduleName9+ | string | Yes | Yes | Module name of the **AbilityStage** instance.| +| srcEntrance9+ | string | Yes | Yes | Source path of the **AbilityStage** instance.| diff --git a/en/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md b/en/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md index dffe0e39e69e38123bf7e89338b3d4efb14ad82a..e1b3aa3bbe5e16262db584894055c090a224b625 100644 --- a/en/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md +++ b/en/application-dev/reference/apis/js-apis-application-abilityDelegatorArgs.md @@ -11,7 +11,7 @@ The **AbilityDelegatorArgs** module provides a global register to store the regi The ability delegator arguments are obtained by calling **getArguments** in **AbilityDelegatorRegistry**. ```js -import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry' +import AbilityDelegatorRegistry from '@ohos.application.abilityDelegatorRegistry'; var args = AbilityDelegatorRegistry.getArguments(); ``` diff --git a/en/application-dev/reference/apis/js-apis-application-abilitystage.md b/en/application-dev/reference/apis/js-apis-application-abilitystage.md index 5817123ea55725ecd6c3c7a1f1d2a88b3f27b2ca..d1c8592f97d4c8b8799d5773b391bb1798663219 100644 --- a/en/application-dev/reference/apis/js-apis-application-abilitystage.md +++ b/en/application-dev/reference/apis/js-apis-application-abilitystage.md @@ -89,6 +89,31 @@ Called when the global configuration is updated. } } ``` + +## AbilityStage.onMemoryLevel + +onMemoryLevel(level: AbilityConstant.MemoryLevel): void; + +Called when the system has decided to adjust the memory level. For example, this API can be used when there is not enough memory to run as many background processes as possible. + +**System capability**: SystemCapability.Ability.AbilityRuntime.AbilityCore + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | level | [AbilityConstant.MemoryLevel](js-apis-application-abilityConstant.md#abilityconstantmemorylevel) | Yes| Memory level that indicates the memory usage status. When the specified memory level is reached, a callback will be invoked and the system will start adjustment.| + +**Example** + + ```js + class MyAbilityStage extends AbilityStage { + onMemoryLevel(level) { + console.log('onMemoryLevel, level:' + JSON.stringify(level)); + } + } + ``` + ## AbilityStage.context context: AbilityStageContext; diff --git a/en/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md b/en/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md index 7c5ba607718d5d14317a55645627022b78976461..57a313f1f600607c143aaec48205a482221ba355 100644 --- a/en/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md +++ b/en/application-dev/reference/apis/js-apis-application-staticSubscriberExtensionAbility.md @@ -26,7 +26,7 @@ Callback of the common event of a static subscriber. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | - | event | CommonEventData | Yes| Common event of a static subscriber.| + | event | [CommonEventData](js-apis-commonEvent.md#commoneventdata) | Yes| Common event of a static subscriber.| **Example** diff --git a/en/application-dev/reference/apis/js-apis-appmanager.md b/en/application-dev/reference/apis/js-apis-appmanager.md index 1b2bd22548deeed3145803c1a3939e59399b904c..9dc3ec0c3c5f022d4aecd438f59ebc830a34ae63 100644 --- a/en/application-dev/reference/apis/js-apis-appmanager.md +++ b/en/application-dev/reference/apis/js-apis-appmanager.md @@ -22,9 +22,9 @@ Checks whether this application is undergoing a stability test. This API uses an **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | No| Callback used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | No| Callback used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| **Example** @@ -46,9 +46,9 @@ Checks whether this application is undergoing a stability test. This API uses a **Return value** -| Type| Description| -| -------- | -------- | -| Promise<boolean> | Promise used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| + | Type| Description| + | -------- | -------- | + | Promise<boolean> | Promise used to return the result. If the application is undergoing a stability test, **true** will be returned; otherwise, **false** will be returned.| **Example** @@ -72,9 +72,9 @@ Checks whether this application is running on a RAM constrained device. This API **Return value** -| Type| Description| -| -------- | -------- | -| Promise<boolean> | Promise used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| + | Type| Description| + | -------- | -------- | + | Promise<boolean> | Promise used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| **Example** @@ -96,9 +96,9 @@ Checks whether this application is running on a RAM constrained device. This API **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | No| Callback used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<boolean> | No| Callback used to return whether the application is running on a RAM constrained device. If the application is running on a RAM constrained device, **true** will be returned; otherwise, **false** will be returned.| **Example** @@ -119,9 +119,9 @@ Obtains the memory size of this application. This API uses a promise to return t **Return value** -| Type| Description| -| -------- | -------- | -| Promise<number> | Size of the application memory.| + | Type| Description| + | -------- | -------- | + | Promise<number> | Size of the application memory.| **Example** @@ -143,9 +143,9 @@ Obtains the memory size of this application. This API uses an asynchronous callb **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| callback | AsyncCallback<number> | No| Size of the application memory.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | callback | AsyncCallback<number> | No| Size of the application memory.| **Example** @@ -157,14 +157,12 @@ Obtains the memory size of this application. This API uses an asynchronous callb ``` ## appManager.getProcessRunningInfos(deprecated) -> **NOTE** -> -> This API is deprecated since API version 9. You are advised to use [appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9) instead. - getProcessRunningInfos(): Promise\>; Obtains information about the running processes. This API uses a promise to return the result. +> This API is deprecated since API version 9. You are advised to use [appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9) instead. + **Required permissions**: ohos.permission.GET_RUNNING_INFO **System capability**: SystemCapability.Ability.AbilityRuntime.Core @@ -187,14 +185,12 @@ Obtains information about the running processes. This API uses a promise to retu ## appManager.getProcessRunningInfos(deprecated) -> **NOTE** -> -> This API is deprecated since API version 9. You are advised to use [appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1) instead. - getProcessRunningInfos(callback: AsyncCallback\>): void; Obtains information about the running processes. This API uses an asynchronous callback to return the result. +> This API is deprecated since API version 9. You are advised to use [appManager.getProcessRunningInformation9+](#appmanagergetprocessrunninginformation9-1) instead. + **Required permissions**: ohos.permission.GET_RUNNING_INFO **System capability**: SystemCapability.Ability.AbilityRuntime.Core @@ -228,7 +224,7 @@ Obtains information about the running processes. This API uses a promise to retu | Type| Description| | -------- | -------- | -| Promise\> | Promise used to return the process information.| +| Promise\> | Promise used to return the process information.| **Example** @@ -254,7 +250,7 @@ Obtains information about the running processes. This API uses an asynchronous c | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback\> | No| Callback used to return the process information.| +| callback | AsyncCallback\> | No| Callback used to return the process information.| **Example** @@ -269,7 +265,7 @@ Obtains information about the running processes. This API uses an asynchronous c registerApplicationStateObserver(observer: ApplicationStateObserver): number; -Registers an observer to listen for the state of all applications. +Registers an observer to listen for the state changes of all applications. **Required permissions**: ohos.permission.RUNNING_STATE_OBSERVER @@ -307,9 +303,9 @@ Registers an observer to listen for the state of all applications. ## appManager.registerApplicationStateObserver9+ -registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array): number; +registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array\): number; -Registers an observer to listen for the state of a specified application. +Registers an observer to listen for the state changes of a specified application. **Required permissions**: ohos.permission.RUNNING_STATE_OBSERVER @@ -322,7 +318,7 @@ Registers an observer to listen for the state of a specified application. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | observer | [ApplicationStateObserver](#applicationstateobserver) | No| Numeric code of the observer.| -| bundleNameList | Array | No| **bundleName** array to be registered for listening. The maximum value is 128.| +| bundleNameList | Array | No| **bundleName** array of the application. A maximum of 128 bundle names can be passed.| **Example** @@ -359,7 +355,7 @@ Deregisters the application state observer. This API uses an asynchronous callba **System API**: This is a system API and cannot be called by third-party applications. **Parameters** - + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | observerId | number | No| Numeric code of the observer.| @@ -491,10 +487,10 @@ Kills a process by bundle name and account ID. This API uses a promise to return **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| bundleName | string | Yes| Bundle name of an application.| -| accountId | number | Yes| ID of a system account. For details, see [getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess).| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | bundleName | string | Yes| Bundle name of an application.| + | accountId | number | Yes| ID of a system account. For details, see [getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess).| **Example** @@ -525,11 +521,11 @@ Kills a process by bundle name and account ID. This API uses an asynchronous cal **Parameters** -| Name| Type| Mandatory| Description| -| -------- | -------- | -------- | -------- | -| bundleName | string | Yes| Bundle name of an application.| -| accountId | number | Yes| ID of a system account. For details, see [getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess).| -| callback | AsyncCallback\ | Yes| Callback used to return the result.| + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | bundleName | string | Yes| Bundle name of an application.| + | accountId | number | Yes| ID of a system account. For details, see [getCreatedOsAccountsCount](js-apis-osAccount.md#getosaccountlocalidfromprocess).| + | callback | AsyncCallback\ | Yes| Callback used to return the result.| **Example** @@ -708,9 +704,14 @@ Called when the application state changes. **Example** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const foregroundApplicationInfo = ApplicationStateObserver.onForegroundApplicationChanged(); -console.log('-------- foregroundApplicationInfo: ---------', foregroundApplicationInfo); + var applicationStateObserver = { + onForegroundApplicationChanged(appStateData) { + console.log('------------ onForegroundApplicationChanged -----------', appStateData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); + ``` ## ApplicationStateObserver.onAbilityStateChanged8+ @@ -732,9 +733,13 @@ Called when the ability state changes. **Example** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const abilityStateChangedInfo = ApplicationStateObserver.onAbilityStateChanged(); -console.log('-------- abilityStateChangedInfo: ---------', abilityStateChangedInfo); + var applicationStateObserver = { + onAbilityStateChanged(abilityStateData) { + console.log('------------ onAbilityStateChanged -----------', abilityStateData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); ``` ## ApplicationStateObserver.onProcessCreated8+ @@ -756,9 +761,13 @@ Called when a process is created. **Example** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const processCreatedInfo = ApplicationStateObserver.onProcessCreated(); -console.log('-------- processCreatedInfo: ---------', processCreatedInfo); + var applicationStateObserver = { + onProcessCreated(processData) { + console.log('------------ onProcessCreated -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); ``` ## ApplicationStateObserver.onProcessDied8+ @@ -775,14 +784,46 @@ Called when a process is terminated. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| processData | ProcessData | No| Process information.| +| processData | [ProcessData](#processdata) | No| Process information.| **Example** ```js -import ApplicationStateObserver from '@ohos.application.ApplicationStateObserver' -const processDiedInfo = ApplicationStateObserver.onProcessDied(); -console.log('-------- processDiedInfo: ---------', processDiedInfo); + var applicationStateObserver = { + onProcessDied(processData) { + console.log('------------ onProcessDied -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); +``` + +## ApplicationStateObserver.onProcessStateChanged9+ + + onProcessStateChanged(processData: ProcessData): void; + +Called when the process state changes. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**System API**: This is a system API and cannot be called by third-party applications. + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| processData | [ProcessData](#processdata) | No| Process information.| + +**Example** + +```js + var applicationStateObserver = { + onProcessStateChanged(processData) { + console.log('------------ onProcessStateChanged -----------', processData); + } + } + const observerCode = app.registerApplicationStateObserver(applicationStateObserver); + console.log('-------- observerCode: ---------', observerCode); ``` ## AppStateData @@ -815,7 +856,7 @@ console.log('-------- processDiedInfo: ---------', processDiedInfo); ## ProcessData -**System capability**: SystemCapability.Ability.AbilityRuntime.Mission +**System capability**: SystemCapability.Ability.AbilityRuntime.Core **System API**: This is a system API and cannot be called by third-party applications. @@ -824,19 +865,19 @@ console.log('-------- processDiedInfo: ---------', processDiedInfo); | pid8+ | number | Yes | No | Process ID. | | bundleName8+ | string | Yes | No | Bundle name of an application. | | uid8+ | number | Yes | No | User ID. | - - +| isContinuousTask9+ | boolean | Yes | No | Whether the process is a continuous task. | +| isKeepAlive9+ | boolean | Yes | No | Whether the process remains active. | ## ProcessRunningInfo -**System capability**: SystemCapability.Ability.AbilityRuntime.Core +**System capability**: SystemCapability.Ability.AbilityRuntime.Mission | Name | Readable/Writable| Type | Mandatory| Description | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| pid9+ | Read only | number | No | Process ID. | -| uid9+ | Read only | number | No | User ID.| -| processName9+ | Read only | string | No | Process name.| -| bundleNames9+ | Read only | Array\ | No | **bundleName** array in the running processes.| +| pid8+ | Read only | number | No | Process ID. | +| uid8+ | Read only | number | No | User ID.| +| processName8+ | Read only | string | No | Process name.| +| bundleNames8+ | Read only | Array\ | No | **bundleName** array in the running processes.| ## ApplicationStateObserver @@ -850,3 +891,44 @@ console.log('-------- processDiedInfo: ---------', processDiedInfo); | [onAbilityStateChanged8+](#applicationstateobserveronabilitystatechanged8) | AsyncCallback\ | Yes | No | Callback invoked when the ability state changes. | | [onProcessCreated8+](#applicationstateobserveronprocesscreated8) | AsyncCallback\ | Yes | No | Callback invoked when a process is created. | | [onProcessDied8+](#applicationstateobserveronprocessdied8) | AsyncCallback\ | Yes | No | Callback invoked when a process is destroyed. | + +## ProcessRunningInformation + +Defines the process running information. + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +| Name | Readable/Writable| Type | Mandatory| Description | +| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | +| pid9+ | Read only | number | No | Process ID. | +| uid9+ | Read only | number | No | User ID.| +| processName9+ | Read only | string | No | Process name.| +| bundleNames9+ | Read only | Array\ | No | **bundleName** array in the running processes.| + +## ApplicationState9+ + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**System API**: This is a system API and cannot be called by third-party applications. + +| Name | Value | Description | +| -------------------- | --- | --------------------------------- | +| STATE_CREATE | 1 | State indicating that the application is being created. | +| STATE_FOREGROUND | 2 | State indicating that the application is running in the foreground. | +| STATE_ACTIVE | 3 | State indicating that the application is active. | +| STATE_BACKGROUND | 4 | State indicating that the application is running in the background. | +| STATE_DESTROY | 5 | State indicating that the application is destroyed. | + +## ProcessState9+ + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +**System API**: This is a system API and cannot be called by third-party applications. + +| Name | Value | Description | +| -------------------- | --- | --------------------------------- | +| STATE_CREATE | 1 | State indicating that the process is being created. | +| STATE_FOREGROUND | 2 | State indicating that the process is running in the foreground. | +| STATE_ACTIVE | 3 | State indicating that the process is active. | +| STATE_BACKGROUND | 4 | State indicating that the process is running in the background. | +| STATE_DESTROY | 5 | State indicating that the process is destroyed. | diff --git a/en/application-dev/reference/apis/js-apis-arraylist.md b/en/application-dev/reference/apis/js-apis-arraylist.md index 341295a167878f6c3696efe01f15a29415f91cd8..0618e40a4327d72455405588df46c9f91f7262e4 100644 --- a/en/application-dev/reference/apis/js-apis-arraylist.md +++ b/en/application-dev/reference/apis/js-apis-arraylist.md @@ -12,6 +12,9 @@ When compared with **[LinkedList](js-apis-linkedlist.md)**, **ArrayList** is mor **Recommended use case**: Use **ArrayList** when elements in a container need to be frequently read. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -72,7 +75,7 @@ Adds an element at the end of this container. let result1 = arrayList.add(1); let b = [1, 2, 3]; let result2 = arrayList.add(b); - let c = {name: "lala", age: "13"}; + let c = {name: "Dylon", age: "13"}; let result3 = arrayList.add(false); ``` @@ -124,9 +127,9 @@ Checks whether this container has the specified element. ```ts let arrayList = new ArrayList(); -let result = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -arrayList.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -let result1 = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = arrayList.has("squirrel"); +arrayList.add("squirrel"); +let result1 = arrayList.has("squirrel"); ``` ### getIndexOf @@ -361,7 +364,7 @@ arrayList.add(4); arrayList.add(5); arrayList.add(4); arrayList.forEach((value, index) => { - console.log("value:" + value, index); + console.log(`value:${value}`, index); }); ``` @@ -623,14 +626,14 @@ arrayList.add(4); // Method 1: for (let item of arrayList) { - console.log("value:" + item); + console.log(`value:${item}`); } // Method 2: let iter = arrayList[Symbol.iterator](); let temp = iter.next().value; while(temp != undefined) { - console.log("value:" + temp); + console.log(`value:${temp}`); temp = iter.next().value; } ``` diff --git a/en/application-dev/reference/apis/js-apis-audio.md b/en/application-dev/reference/apis/js-apis-audio.md index f019d61969e28699cc1324a6f8d8af29ba7d60f6..7fa4e76c7a448d1272d1a50b8da71e0303b27762 100644 --- a/en/application-dev/reference/apis/js-apis-audio.md +++ b/en/application-dev/reference/apis/js-apis-audio.md @@ -4911,7 +4911,7 @@ audioCapturer.getBufferSize().then((data) => { console.info(`AudioFrameworkRecLog: getBufferSize: SUCCESS ${data}`); bufferSize = data; }).catch((err) => { - console.error(`AudioFrameworkRecLog: getBufferSize: EROOR: ${err}`); + console.error(`AudioFrameworkRecLog: getBufferSize: ERROR: ${err}`); }); audioCapturer.read(bufferSize, true, async(err, buffer) => { if (!err) { diff --git a/en/application-dev/reference/apis/js-apis-bluetooth.md b/en/application-dev/reference/apis/js-apis-bluetooth.md index e7bcef69308231e54d2786e4324969a3b0444923..eb54d689022397f603f9d93d2cc8591d9d1cdc82 100644 --- a/en/application-dev/reference/apis/js-apis-bluetooth.md +++ b/en/application-dev/reference/apis/js-apis-bluetooth.md @@ -1,6 +1,6 @@ # Bluetooth -The Bluetooth module provides classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising. +The **Bluetooth** module provides classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising. > **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. @@ -281,7 +281,7 @@ let remoteDeviceName = bluetooth.getRemoteDeviceName("XX:XX:XX:XX:XX:XX"); getRemoteDeviceClass(deviceId: string): DeviceClass -Obtains the type of the remote Bluetooth device. +Obtains the class of the remote Bluetooth device. **Required permissions**: ohos.permission.USE_BLUETOOTH @@ -297,7 +297,7 @@ Obtains the type of the remote Bluetooth device. | Type | Description | | --------------------------- | -------- | -| [DeviceClass](#deviceclass) | Type of a remote device obtained.| +| [DeviceClass](#deviceclass) | Class of the remote device obtained.| **Example** @@ -389,7 +389,7 @@ startBluetoothDiscovery(): boolean Starts Bluetooth scan to discover remote devices. -**Required permissions**: ohos.permission.DISCOVER_BLUETOOTH and ohos.permission.LOCATION +**Required permissions**: ohos.permission.DISCOVER_BLUETOOTH and ohos.permission.LOCATION **System capability**: SystemCapability.Communication.Bluetooth.Core @@ -515,7 +515,7 @@ Unsubscribes from the Bluetooth device discovery events. | Name | Type | Mandatory | Description | | -------- | ----------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **bluetoothDeviceFind** indicates an event reported when a Bluetooth device is discovered. | -| callback | Callback<Array<string>> | No | Callback used to report the discovered devices. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<Array<string>> | No | Callback for the **bluetoothDeviceFind** event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -578,7 +578,7 @@ Unsubscribes from the pairing request events of the remote Bluetooth device. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **pinRequired** indicates a pairing request event. | -| callback | Callback<[PinRequiredParam](#pinrequiredparam)> | No | Callback used to report the Bluetooth pairing request. The input parameter is the pairing request parameter. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[PinRequiredParam](#pinrequiredparam)> | No | Callback for the Bluetooth pairing request event. The input parameter is the pairing request parameter. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -599,7 +599,7 @@ bluetooth.off('pinRequired', onReceiveEvent); on(type: "bondStateChange", callback: Callback<BondStateParam>): void -Subscribes to the Bluetooth bond state change events. +Subscribes to the Bluetooth pairing state change events. **Required permissions**: ohos.permission.USE_BLUETOOTH @@ -609,8 +609,8 @@ Subscribes to the Bluetooth bond state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------------------------------ | -| type | string | Yes | Event type. The value **bondStateChange** indicates a Bluetooth bond state change event.| -| callback | Callback<[BondStateParam](#BondStateParam)> | Yes | Callback invoked to return the bond state. You need to implement this callback. | +| type | string | Yes | Event type. The value **bondStateChange** indicates a Bluetooth pairing state change event.| +| callback | Callback<[BondStateParam](#BondStateParam)> | Yes | Callback invoked to return the pairing state. You need to implement this callback. | **Return value** @@ -619,7 +619,7 @@ No value is returned. **Example** ```js -function onReceiveEvent(data) { // data, as the input parameter of the callback, indicates the bond state. +function onReceiveEvent(data) { // data, as the input parameter of the callback, indicates the pairing state. console.info('pair state = '+ JSON.stringify(data)); } bluetooth.on('bondStateChange', onReceiveEvent); @@ -630,7 +630,7 @@ bluetooth.on('bondStateChange', onReceiveEvent); off(type: "bondStateChange", callback?: Callback<BondStateParam>): void -Unsubscribes from the Bluetooth bond state change events. +Unsubscribes from the Bluetooth pairing state change events. **Required permissions**: ohos.permission.USE_BLUETOOTH @@ -640,8 +640,8 @@ Unsubscribes from the Bluetooth bond state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | -| type | string | Yes | Event type. The value **bondStateChange** indicates a Bluetooth bond state change event. | -| callback | Callback<[BondStateParam](#BondStateParam)> | No | Callback used to report the change of the Bluetooth bond state. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| type | string | Yes | Event type. The value **bondStateChange** indicates a Bluetooth pairing state change event. | +| callback | Callback<[BondStateParam](#BondStateParam)> | No | Callback for the change of the Bluetooth pairing state. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -704,7 +704,7 @@ Unsubscribes from the Bluetooth connection state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **stateChange** indicates a Bluetooth connection state change event. | -| callback | Callback<[BluetoothState](#bluetoothstate)> | No | Callback used to report the Bluetooth connection state. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[BluetoothState](#bluetoothstate)> | No | Callback for the Bluetooth connection state change event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -990,7 +990,7 @@ Unsubscribes from the SPP read request events. | ------------ | --------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **sppRead** indicates an SPP read request event. | | clientSocket | number | Yes | Client socket ID, which is obtained by **sppAccept** or **sppConnect**. | -| callback | Callback<ArrayBuffer> | No | Callback used to report an SPP read request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<ArrayBuffer> | No | Callback for the SPP read request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -1248,7 +1248,7 @@ Unsubscribes from the BLE device discovery events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **BLEDeviceFind** indicates an event reported when a BLE device is discovered. | -| callback | Callback<Array<[ScanResult](#scanresult)>> | No | Callback used to report the discovered devices. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<Array<[ScanResult](#scanresult)>> | No | Callback for the **BLEDeviceFind** event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -1558,7 +1558,7 @@ Subscribes to the HFP connection state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **connectionStateChange** indicates an HFP connection state change event.| -| callback | Callback<[StateChangeParam](#StateChangeParam)> | Yes | Callback used to return the HFP connection state change event. | +| callback | Callback<[StateChangeParam](#StateChangeParam)> | Yes | Callback invoked to return the HFP connection state change event. | **Return value** @@ -1588,7 +1588,7 @@ Unsubscribes from the HFP connection state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **connectionStateChange** indicates an HFP connection state change event.| -| callback | Callback<[StateChangeParam](#StateChangeParam)> | No | Callback used to return the HFP connection state change event. | +| callback | Callback<[StateChangeParam](#StateChangeParam)> | No | Callback for the HFP connection state change event. | **Return value** @@ -1718,7 +1718,7 @@ Unsubscribes from the HidHost connection state change events. | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- | | type | string | Yes | Event type. The value **connectionStateChange** indicates a HidHost connection state change event.| -| callback | Callback<[StateChangeParam](#StateChangeParam)> | No | Callback used to return the HidHost connection state change event. | +| callback | Callback<[StateChangeParam](#StateChangeParam)> | No | Callback for the HidHost connection state change event. | **Return value** @@ -1786,7 +1786,7 @@ Subscribes to the PAN connection state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **connectionStateChange** indicates a PAN connection state change event.| -| callback | Callback<[StateChangeParam](#StateChangeParam)> | Yes | Callback used to return the PAN connection state change event. | +| callback | Callback<[StateChangeParam](#StateChangeParam)> | Yes | Callback invoked to return the PAN connection state change event. | **Return value** @@ -1816,7 +1816,7 @@ Unsubscribes from the PAN connection state change events. | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------- | ---- | --------------------------------------------------------- | | type | string | Yes | Event type. The value **connectionStateChange** indicates a PAN connection state change event.| -| callback | Callback<[StateChangeParam](#StateChangeParam)> | No | Callback used to return the PAN connection state change event. | +| callback | Callback<[StateChangeParam](#StateChangeParam)> | No | Callback for the PAN connection state change event. | **Return value** @@ -2061,10 +2061,9 @@ Removes a service from this GATT server. **Return value** -| | | +| Type | Description | | ------- | -------------------------- | -| Type | Description | -| boolean | Returns **true** if the operation is successful; returns **false** otherwise. | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| **Example** @@ -2111,10 +2110,9 @@ Notifies the connected client device when a characteristic value changes. **Return value** -| | | +| Type | Description | | ------- | ------------------------ | -| Type | Description | -| boolean | Returns **true** if the operation is successful; returns **false** otherwise. | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| **Example** @@ -2156,10 +2154,9 @@ Sends a response to a read or write request from the GATT client. **Return value** -| | | +| Type | Description | | ------- | -------------------------- | -| Type | Description | -| boolean | Returns **true** if the operation is successful; returns **false** otherwise. | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| **Example** @@ -2249,7 +2246,7 @@ Unsubscribes from the characteristic read request events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **characteristicRead** indicates a characteristic read request event. | -| callback | Callback<[CharacteristicReadReq](#characteristicreadreq)> | No | Callback used to report a characteristic read request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[CharacteristicReadReq](#characteristicreadreq)> | No | Callback for the characteristic read request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -2329,7 +2326,7 @@ Unsubscribes from the characteristic write request events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **characteristicWrite** indicates a characteristic write request event. | -| callback | Callback<[CharacteristicWriteReq](#characteristicwritereq)> | No | Callback used to report a characteristic write request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[CharacteristicWriteReq](#characteristicwritereq)> | No | Callback for the characteristic write request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -2406,7 +2403,7 @@ Unsubscribes from the descriptor read request events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **descriptorRead** indicates a descriptor read request event. | -| callback | Callback<[DescriptorReadReq](#descriptorreadreq)> | No | Callback used to report a descriptor read request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[DescriptorReadReq](#descriptorreadreq)> | No | Callback for the descriptor read request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -2486,7 +2483,7 @@ Unsubscribes from the descriptor write request events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **descriptorWrite** indicates a descriptor write request event. | -| callback | Callback<[DescriptorWriteReq](#descriptorwritereq)> | No | Callback used to report a descriptor write request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[DescriptorWriteReq](#descriptorwritereq)> | No | Callback for the descriptor write request event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -2499,6 +2496,7 @@ let gattServer = bluetooth.BLE.createGattServer(); gattServer.off("descriptorWrite"); ``` + ### on('connectStateChange') on(type: "connectStateChange", callback: Callback<BLEConnectChangedState>): void @@ -2548,7 +2546,7 @@ Unsubscribes from the BLE connection state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **connectStateChange** indicates a BLE connection state change event.| -| callback | Callback<[BLEConnectChangedState](#bleconnectchangedstate)> | No | Callback used to report the BLE connection state. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[BLEConnectChangedState](#bleconnectchangedstate)> | No | Callback for the BLE connection state change event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -2785,10 +2783,9 @@ Reads the characteristic value of the specific service of the remote BLE device. **Return value** -| | | +| Type | Description | | ---------------------------------------- | -------------------------- | -| Type | Description | -| Promise<[BLECharacteristic](#blecharacteristic)> | Promise used to return the characteristic value read. | +| Promise<[BLECharacteristic](#blecharacteristic)> | Promise used to return the characteristic value read.| **Example** @@ -2876,10 +2873,9 @@ Reads the descriptor contained in the specific characteristic of the remote BLE **Return value** -| | | +| Type | Description | | ---------------------------------------- | -------------------------- | -| Type | Description | -| Promise<[BLEDescriptor](#bledescriptor)> | Promise used to return the descriptor read. | +| Promise<[BLEDescriptor](#bledescriptor)> | Promise used to return the descriptor read.| **Example** @@ -2990,7 +2986,7 @@ if (retWriteDesc) { setBLEMtuSize(mtu: number): boolean -Sets the maximum transmission unit (MTU) that can be transmitted between the GATT client and its remote BLE device. This method can be used only after a connection is set up by calling [connect](#connect). +Sets the maximum transmission unit (MTU) that can be transmitted between the GATT client and its remote BLE device. This API can be used only after a connection is set up by calling [connect](#connect). **Required permissions**: ohos.permission.USE_BLUETOOTH @@ -3108,7 +3104,7 @@ Unsubscribes from the BLE characteristic change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **BLECharacteristicChange** indicates a characteristic value change event.| -| callback | Callback<[BLECharacteristic](#blecharacteristic)> | No | Callback used to report the characteristic value. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[BLECharacteristic](#blecharacteristic)> | No | Callback for the characteristic value change event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -3170,7 +3166,7 @@ Unsubscribes from the BLE connection state change events. | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ---------------------------------------- | | type | string | Yes | Event type. The value **BLEConnectionStateChange** indicates a BLE connection state change event.| -| callback | Callback<[BLEConnectChangedState](#bleconnectchangedstate)> | No | Callback used to report the BLE connection state. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| +| callback | Callback<[BLEConnectChangedState](#bleconnectchangedstate)> | No | Callback for the BLE connection state change event. If this parameter is not set, this method unsubscribes from all callbacks corresponding to **type**.| **Return value** @@ -3671,13 +3667,13 @@ Defines the pairing request parameters. ## BondStateParam8+ -Defines the bond state parameters. +Defines the pairing state parameters. **System capability**: SystemCapability.Communication.Bluetooth.Core | Name | Type | Readable | Writable | Description | | -------- | ------ | ---- | ---- | ----------- | -| deviceId | string | Yes | No | ID of the device.| +| deviceId | string | Yes | No | ID of the device to pair.| | state | BondState | Yes | No | State of the device.| diff --git a/en/application-dev/reference/apis/js-apis-buffer.md b/en/application-dev/reference/apis/js-apis-buffer.md new file mode 100644 index 0000000000000000000000000000000000000000..b1c81e2eecd00b5043bb703b574bcc0c06533373 --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-buffer.md @@ -0,0 +1,2445 @@ +# Buffer + +> **NOTE** +> +> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. + +A **Buffer** object represents a fixed-length sequence of bytes. It is used to store binary data. + +You can use the APIs provided by the **Buffer** module to process images and a large amount of binary data, and receive or upload files. + +## Modules to Import + +```ts +import buffer from '@ohos.buffer'; +``` + +## Buffer + +### alloc + +alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer + +Allocates and initializes a **Buffer** instance of the specified size. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| size | number | Yes| Size of the **Buffer** instance to allocate, in bytes.| +| fill | string \| Buffer \| number | No| Pre-filled value. The default value is **0**.| +| encoding | BufferEncoding | No| Encoding format (valid only when **fill** is a string). The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | Initialized **Buffer** instance.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.alloc(5); +let buf2 = buffer.alloc(5, 'a'); +let buf3 = buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64'); +``` + +### allocUninitializedFromPool + +allocUninitializedFromPool(size: number): Buffer + +Allocates a **Buffer** instance of the specified size from the buffer pool, without initializing it. +To initialize the **Buffer** instance, call **fill()**. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| size | number | Yes| Size of the **Buffer** instance to allocate, in bytes.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | Uninitialized **Buffer** instance.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(10); +buf.fill(0); +``` + +### allocUninitialized + +allocUninitialized(size: number): Buffer + +Allocates a **Buffer** instance of the specified size, without initializing it. This API does not allocate memory from the buffer pool. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| size | number | Yes|Size of the **Buffer** instance to allocate, in bytes.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | Uninitialized **Buffer** instance.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitialized(10); +buf.fill(0); +``` + +### byteLength + +byteLength(string: string | Buffer | TypedArray | DataView | ArrayBuffer | SharedArrayBuffer, encoding?: BufferEncoding): number + +Obtains the number of bytes of a string based on the encoding format. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| string | string \| Buffer \| TypedArray \| DataView \| ArrayBuffer \| SharedArrayBuffer | Yes| Target string.| +| encoding | BufferEncoding | No| Encoding format. The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes of the string.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let str = '\u00bd + \u00bc = \u00be'; +console.log(`${str}: ${str.length} characters, ${buffer.byteLength(str, 'utf-8')} bytes`); +// Print: ½ + ¼ = ¾: 9 characters, 12 bytes +``` + +### compare + +compare(buf1: Buffer | Uint8Array, buf2: Buffer | Uint8Array): -1 | 0 | 1 + +Compares two **Buffer** instances. This API is used for sorting **Buffer** instances. + + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| buf1 | Buffer \| Uint8Array | Yes| **Buffer** instance to compare.| +| buf2 | Buffer \| Uint8Array | Yes| **Buffer** instance to compare.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| -1 \| 0 \| 1 | Returns **0** if **buf1** is the same as **buf2**.
Returns **1** if **buf1** comes after **buf2** when sorted.
Returns **-1** if **buf1** comes before **buf2** when sorted.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from('1234'); +let buf2 = buffer.from('0123'); +let res = buf1.compare(buf2); + +console.log(Number(res).toString()); +// Print 1 +``` + +### concat + +concat(list: Buffer[] | Uint8Array[], totalLength?: number): Buffer + +Concatenates an array of **Buffer** instances into a new instance of the specified length. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| list | Buffer[] \| Uint8Array[] | Yes| Array of instances to concatenate.| +| totalLength | number | No| Total length of the new **Buffer** instance, in bytes.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from("1234"); +let buf2 = buffer.from("abcd"); +let buf = buffer.concat([buf1, buf2]); +console.log(buf.toString('hex')); // 3132333461626364 +``` + +### from + +from(array: number[]): Buffer; + +Creates a **Buffer** instance with the specified array. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| array | number[] | Yes| Array to create a **Buffer** instance.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]); +console.log(buf.toString('hex')); // 627566666572 +``` + +### from + +from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: number, length?: number): Buffer + +Creates a **Buffer** instance that shares memory with the specified array of **Buffer** instances. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| arrayBuffer | ArrayBuffer \| SharedArrayBuffer | Yes| Array of **Buffer** instances, whose memory is to be shared.| +| byteOffset | number | No| Byte offset. The default value is **0**.| +| length | number | No| Length of the **Buffer** instance to create, in bytes. The default value is the length of **arrayBuffer** minus **byteOffset**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance with shared memory.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let ab = new ArrayBuffer(10); +let buf = buffer.from(ab, 0, 2); +``` + +### from + +from(buffer: Buffer | Uint8Array): Buffer + +Creates a **Buffer** instance with the copy of another instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| buffer | Buffer \| Uint8Array | Yes| **Buffer** instance to copy. | + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from('buffer'); +let buf2 = buffer.from(buf1); +``` + +### from + +from(object: Object, offsetOrEncoding: number | string, length: number): Buffer + +Creates a **Buffer** instance based on the specified object. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| object | Object | Yes| Object that supports **Symbol.toPrimitive** or **valueOf()**.| +| offsetOrEncoding | number \| string | No| Byte offset or encoding format.| +| length | number | No| Length of the **Buffer** instance to create.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from(new String('this is a test')); +``` + +### from + +from(string: String, encoding?: BufferEncoding): Buffer + +Creates a **Buffer** instance based on a string in the given encoding format. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| string | String | Yes| String.| +| encoding | BufferEncoding | No| Encoding format of the string. The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from('this is a test'); +let buf2 = buffer.from('7468697320697320612074c3a97374', 'hex'); + +console.log (buf1.toString()); // Print: this is a test +console.log(buf2.toString()); +``` + + +### isBuffer + +isBuffer(obj: Object): boolean + +Checks whether the specified object is a **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| obj | Object | Yes| Object to check.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the object is a **Buffer** instance; returns **false** otherwise.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +buffer.isBuffer(buffer.alloc(10)); // true +buffer.isBuffer(buffer.from('foo')); // true +buffer.isBuffer('a string'); // false +buffer.isBuffer([]); // false +buffer.isBuffer(new Uint8Array(1024)); // false +``` + +### isEncoding + +isEncoding(encoding: string): boolean + +Checks whether the encoding format is supported. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| encoding | string | Yes| Encoding format to check. | + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the encoding format is supported; returns **false** otherwise.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +console.log(buffer.isEncoding('utf-8').toString()); // Print: true +console.log(buffer.isEncoding('hex').toString()); // Print: true +console.log(buffer.isEncoding('utf/8').toString()); // Print: false +console.log(buffer.isEncoding('').toString()); // Print: false +``` + +### compare + +compare(target: Buffer | Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): -1 | 0 | 1 + +Compares this **Buffer** instance with another instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| target | Buffer \| Uint8Array | Yes| Target **Buffer** instance to compare.| +| targetStart | number | No| Offset to the start of the data to compare in the target **Buffer** instance. The default value is **0**.| +| targetEnd | number | No| Offset to the end of the data to compare in the target **Buffer** instance (not inclusive). The default value is the length of the target **Buffer** instance.| +| sourceStart | number | No| Offset to the start of the data to compare in this **Buffer** instance. The default value is **0**.| +| sourceEnd | number | No| Offset to the end of the data to compare in this **Buffer** instance (not inclusive). The default value is the length of this **Buffer** instance.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Returns **0** if the two **Buffer** instances are the same.
Returns **1** if this instance comes after the target instance when sorted.
Returns **-1** if this instance comes before the target instance when sorted. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]); +let buf2 = buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]); + +console.log(buf1.compare(buf2, 5, 9, 0, 4).toString()); // Print: 0 +console.log(buf1.compare(buf2, 0, 6, 4).toString()); // Print: -1 +console.log(buf1.compare(buf2, 5, 6, 5).toString()); // Print: 1 +``` + +### copy + +copy(target: Buffer| Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number + +Copies data at the specified position in this **Buffer** instance to the specified position in another **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| target | Buffer \| Uint8Array | Yes| Instance to which data is copied.| +| targetStart | number | No| Offset to the start position in the target instance where data is copied. The default value is **0**.| +| sourceStart | number | No| Offset to the start position in this **Buffer** instance where data is copied. The default value is **0**.| +| sourceEnd | number | No| Offset to the end position in this **Buffer** instance (not inclusive). The default value is the length of this **Buffer** instance.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Total length of the data copied, in bytes.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.allocUninitializedFromPool(26); +let buf2 = buffer.allocUninitializedFromPool(26).fill('!'); + +for (let i = 0; i < 26; i++) { + buf1[i] = i + 97; +} + +buf1.copy(buf2, 8, 16, 20); +console.log(buf2.toString('ascii', 0, 25)); +// Print: !!!!!!! qrst!!!!!!!!!!!!! +``` + +### entries + +entries(): IterableIterator<[number, number]> + +Creates and returns an iterator that contains key-value pairs of this **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from('buffer'); +for (let pair of buf.entries()) { + console.log(pair.toString()); +} +``` + +### equals + +equals(otherBuffer: Uint8Array | Buffer): boolean + +Checks whether this **Buffer** instance is the same as another **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| otherBuffer | Uint8Array \| Buffer | Yes| **Buffer** instance to compare.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the two instances are the same; returns **false** otherwise.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from('ABC'); +let buf2 = buffer.from('414243', 'hex'); +let buf3 = buffer.from('ABCD'); + +console.log(buf1.equals(buf2).toString()); // Print: true +console.log(buf1.equals(buf3).toString()); // Print: false + +``` + +### fill + +fill(value: string | Buffer | Uint8Array | number, offset?: number, end?: number, encoding?: BufferEncoding): Buffer + +Fills this **Buffer** instance at the specified position. By default, data is filled cyclically. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | string \| Buffer \| Uint8Array \| number | Yes| Value to fill.| +| offset | number | No| Offset to the start position in this **Buffer** instance where data is filled. The default value is **0**.| +| end | number | No| Offset to the end position in this **Buffer** instance (not inclusive). The default value is the length of this **Buffer** instance.| +| encoding | BufferEncoding | No| Encoding format (valid only when **value** is a string). The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance filled with the specified value.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let b = buffer.allocUninitializedFromPool(50).fill('h'); +console.log(b.toString()); +``` + + +### includes + +includes(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): boolean + +Checks whether this **Buffer** instance contains the specified value. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | string \| number \| Buffer \| Uint8Array | Yes| Value to match.| +| byteOffset | number | No| Number of bytes to skip before starting to check data. If the offset is a negative number, data is checked from the end of the **Buffer** instance. The default value is **0**. | +| encoding | BufferEncoding | No| Encoding format used if **value** is a string. The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the instance contains the specified value; returns **false** otherwise.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from('this is a buffer'); +console.log(buf.includes('this').toString()); // Print: true +console.log(buf.includes('be').toString()); // Print: false +``` + +### indexOf + +indexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number + +Obtains the index of the first occurrence of the specified value in this **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | string \| number \| Buffer \| Uint8Array | Yes| Value to match.| +| byteOffset | number | No| Number of bytes to skip before starting to check data. If the offset is a negative number, data is checked from the end of the **Buffer** instance. The default value is **0**. | +| encoding | BufferEncoding | No| Encoding format used if **value** is a string. The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Index obtained.
If **-1** is returned, the **Buffer** instance does not contain the specified value.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from('this is a buffer'); +console.log(buf.indexOf('this').toString()); // Print: 0 +console.log(buf.indexOf('is').toString()); // Print: 2 +``` + +### keys + +keys(): IterableIterator<number> + +Creates and returns an iterator that contains the keys of this **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Return value** + +| Type| Description| +| -------- | -------- | +| IterableIterator<number> | Iterator.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from('buffer'); +for (const key of buf.keys()) { + console.log(key.toString()); +} +``` + +### lastIndexOf + +lastIndexOf(value: string | number | Buffer | Uint8Array, byteOffset?: number, encoding?: BufferEncoding): number + +Obtains the index of the last occurrence of the specified value in this **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | string \| number \| Buffer \| Uint8Array | Yes| Value to match.| +| byteOffset | number | No| Number of bytes to skip before starting to check data. If the offset is a negative number, data is checked from the end of the **Buffer** instance. The default value is **0**. | +| encoding | BufferEncoding | No| Encoding format used if **value** is a string. The default value is **utf-8**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Index obtained.
If **-1** is returned, the **Buffer** instance does not contain the specified value.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from('this buffer is a buffer'); +console.log(buf.lastIndexOf('this').toString()); // Print: 0 +console.log(buf.lastIndexOf('buffer').toString()); // Print: 17 +``` + + +### readBigInt64BE + +readBigInt64BE(offset?: number): bigint + +Reads a signed, big-endian 64-bit Big integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| bigint | A signed, big-endian 64-bit Big integer. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, + 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]); +console.log(buf.readBigInt64BE(0).toString()); +``` + +### readBigInt64LE + +readBigInt64LE(offset?: number): bigint + +Reads a signed, little-endian 64-bit Big integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| bigint | A signed, little-endian 64-bit Big integer. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, + 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]); +console.log(buf.readBigInt64LE(0).toString()); +``` + +### readBigUInt64BE + +readBigUInt64BE(offset?: number): bigint + +Reads an unsigned, big-endian 64-bit Big integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| bigint | An unsigned, big-endian 64-bit Big integer. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, + 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]); +console.log(buf.readBigUInt64BE(0).toString()); +``` + +### readBigUInt64LE + +readBigUInt64LE(offset?: number): bigint + +Reads an unsigned, little-endian 64-bit Big integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| bigint | An unsigned, little-endian 64-bit Big integer. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x70, + 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78]); +console.log(buf.readBigUInt64LE(0).toString()); +``` + +### readDoubleBE + +readDoubleBE(offset?: number): number + +Reads a big-endian double-precision floating-point number from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A big-endian double-precision floating-point number. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); +console.log(buf.readDoubleBE(0).toString()); +``` + +### readDoubleLE + +readDoubleLE(offset?: number): number + +Reads a little-endian double-precision floating-point number from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A little-endian double-precision floating-point number. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); +console.log(buf.readDoubleLE(0).toString()); +``` + +### readFloatBE + +readFloatBE(offset?: number): number + +Reads a big-endian single-precision floating-point number from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A big-endian single-precision floating-point number. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); +console.log(buf.readFloatBE(0).toString()); +``` + +### readFloatLE + +readFloatLE(offset?: number): number + +Reads a little-endian single-precision floating-point number from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A little-endian single-precision floating-point number. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([1, 2, 3, 4, 5, 6, 7, 8]); +console.log(buf.readFloatLE(0).toString()); +``` + +### readInt8 + +readInt8(offset?: number): number + +Reads a signed 8-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A signed 8-bit integer. | + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([-1, 5]); +console.log(buf.readInt8(0).toString()); // Print: -1 +console.log(buf.readInt8(1).toString()); // Print: 5 +``` + +### readInt16BE + +readInt16BE(offset?: number): number + +Reads a signed, big-endian 16-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A signed, big-endian 16-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0, 5]); +console.log(buf.readInt16BE(0).toString()); // Print: 5 +``` + +### readInt16LE + +readInt16LE(offset?: number): number + +Reads a signed, little-endian 16-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A signed, little-endian 16-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0, 5]); +console.log(buf.readInt16LE(0).toString()); // Print: 1280 +``` + +### readInt32BE + +readInt32BE(offset?: number): number + +Reads a signed, big-endian 32-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A signed, big-endian 32-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0, 0, 0, 5]); +console.log(buf.readInt32BE(0).toString()); // Print: 5 +``` + +### readInt32LE + +readInt32LE(offset?: number): number + +Reads a signed, little-endian 32-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | A signed, little-endian 32-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0, 0, 0, 5]); +console.log(buf.readInt32LE(0).toString()); // Print: 83886080 +``` + +### readIntBE + +readIntBE(offset: number, byteLength: number): number + +Reads the specified number of bytes from this **Buffer** instance at the specified offset, and interprets the result as a big-endian, two's complement signed value that supports up to 48 bits of precision. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | Yes| Number of bytes to skip before starting to read data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to read.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Data read.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from("ab"); +let num = buf.readIntBE(0, 1); +console.log(num.toString()); // 97 +``` + + +### readIntLE + +readIntLE(offset: number, byteLength: number): number + +Reads the specified number of bytes from this **Buffer** instance at the specified offset and interprets the result as a little-endian, two's complement signed value that supports up to 48 bits of precision. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | Yes| Number of bytes to skip before starting to read data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to read.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Data read.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); +console.log(buf.readIntLE(0, 6).toString(16)); +``` + +### readUInt8 + +readUInt8(offset?: number): number + +Reads an unsigned 8-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | An unsigned 8-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([1, -2]); +console.log(buf.readUInt8(0).toString()); +console.log(buf.readUInt8(1).toString()); +``` + +### readUInt16BE + +readUInt16BE(offset?: number): number + +Reads an unsigned, big-endian 16-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | An unsigned, big-endian 16-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56]); +console.log(buf.readUInt16BE(0).toString(16)); +console.log(buf.readUInt16BE(1).toString(16)); +``` + +### readUInt16LE + +readUInt16LE(offset?: number): number + +Reads an unsigned, little-endian 16-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | An unsigned, little-endian 16-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56]); +console.log(buf.readUInt16LE(0).toString(16)); +console.log(buf.readUInt16LE(1).toString(16)); +``` + +### readUInt32BE + +readUInt32BE(offset?: number): number + +Reads an unsigned, big-endian 32-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | An unsigned, big-endian 32-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56, 0x78]); +console.log(buf.readUInt32BE(0).toString(16)); +``` + +### readUInt32LE + +readUInt32LE(offset?: number): number + +Reads an unsigned, little-endian 32-bit integer from this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | No| Number of bytes to skip before starting to read data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | An unsigned, little-endian 32-bit integer.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56, 0x78]); +console.log(buf.readUInt32LE(0).toString(16)); +``` + +### readUIntBE + +readUIntBE(offset: number, byteLength: number): number + +Reads the specified number of bytes from this **Buffer** instance at the specified offset, and interprets the result as an unsigned, big-endian integer that supports up to 48 bits of precision. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | Yes| Number of bytes to skip before starting to read data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to read.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Data read.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); +console.log(buf.readUIntBE(0, 6).toString(16)); +``` + +### readUIntLE + +readUIntLE(offset: number, byteLength: number): number + +Reads the specified number of bytes from this **Buffer** instance at the specified offset, and interprets the result as an unsigned, little-endian integer that supports up to 48 bits of precision. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| offset | number | Yes| Number of bytes to skip before starting to read data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to read.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Data read.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]); +console.log(buf.readUIntLE(0, 6).toString(16)); +``` + +### subarray + +subarray(start?: number, end?: number): Buffer + +Truncates this **Buffer** instance from the specified position to create a new **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| start | number | No| Offset to the start position in this **Buffer** instance where data is truncated. The default value is **0**.| +| end | number | No| Offset to the end position in this **Buffer** instance (not inclusive). The default value is the length of this **Buffer** instance.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.allocUninitializedFromPool(26); + +for (let i = 0; i < 26; i++) { + buf1[i] = i + 97; +} +const buf2 = buf1.subarray(0, 3); +console.log(buf2.toString('ascii', 0, buf2.length)); +// Print: abc +``` + +### swap16 + +swap16(): Buffer + +Interprets this **Buffer** instance as an array of unsigned 16-bit integers and swaps the byte order in place. + +**System capability**: SystemCapability.Utils.Lang + + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance swapped.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); +console.log(buf1.toString('hex')); // Print: 0102030405060708 + +buf1.swap16(); +console.log(buf1.toString('hex')); // Print: 0201040306050807 +``` + +### swap32 + +swap32(): Buffer + +Interprets this **Buffer** instance as an array of unsigned 32-bit integers and swaps the byte order in place. + +**System capability**: SystemCapability.Utils.Lang + + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance swapped.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); +console.log(buf1.toString('hex')); // Print: 0102030405060708 + +buf1.swap32(); +console.log(buf1.toString('hex')); // Print: 0403020108070605 +``` + +### swap64 + +swap64(): Buffer + +Interprets this **Buffer** instance as an array of unsigned 64-bit integers and swaps the byte order in place. + +**System capability**: SystemCapability.Utils.Lang + + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | **Buffer** instance swapped.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); +console.log(buf1.toString('hex')); // Print: 0102030405060708 +buf1.swap64(); +console.log(buf1.toString('hex')); // Print: 0807060504030201 +``` + +### toJSON + +toJSON(): Object + +Converts this **Buffer** instance into a JSON object. + +**System capability**: SystemCapability.Utils.Lang + + +**Return value** + +| Type| Description| +| -------- | -------- | +| Object | JSON object.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]); +let obj = buf1.toJSON(); +console.log(JSON.stringify(obj)) +// Print: {"type":"Buffer","data":[1,2,3,4,5]} +``` + +### toString + +toString(encoding?: string, start?: number, end?: number): string + +Converts the data at the specified position in this **Buffer** instance into a string in the specified encoding format. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| encoding | string | No| Encoding format of the string. The default value is **utf-8**.| +| start | number | No| Offset to the start position of the data to convert. The default value is **0**.| +| end | number | No| Offset to the end position of the data to convert. The default value is the length of this **Buffer** instance.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| string | String obtained.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.allocUninitializedFromPool(26); +for (let i = 0; i < 26; i++) { + buf1[i] = i + 97; +} +console.log(buf1.toString('utf-8')); +// Print: abcdefghijklmnopqrstuvwxyz +``` + +### values + +values(): IterableIterator<number> + +Creates and returns an iterator that contains the values of this **Buffer** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Return value** + +| Type| Description| +| -------- | -------- | +| IterableIterator<number> | Iterator created.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf1 = buffer.from('buffer'); +for (let value of buf1.values()) { + console.log(value.toString()); +} +``` + +### write + +write(str: string, offset?: number, length?: number, encoding?: string): number + +Writes a string of the specified length to this **Buffer** instance at the specified position in the given encoding format. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| str | string | Yes| String to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| +| length | number | No| Maximum number of bytes to write. The default value is the length of the **Buffer** instance minus the offset.| +| encoding | BufferEncoding | No| Encoding format of the string. The default value is **utf-8**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.alloc(256); +let len = buf.write('\u00bd + \u00bc = \u00be', 0); +console.log(`${len} bytes: ${buf.toString('utf-8', 0, len)}`); +// Print: 12 bytes: ½ + ¼ = ¾ + +let buffer1 = buffer.alloc(10); +let length = buffer1.write('abcd', 8); +``` + +### writeBigInt64BE + +writeBigInt64BE(value: bigint, offset?: number): number + +Writes a signed, big-endian 64-bit Big integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | bigint | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeBigInt64BE(0x0102030405060708n, 0); +``` + +### writeBigInt64LE + +writeBigInt64LE(value: bigint, offset?: number): number + +Writes a signed, little-endian 64-bit Big integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | bigint | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeBigInt64LE(0x0102030405060708n, 0); +``` + +### writeBigUInt64BE + +writeBigUInt64BE(value: bigint, offset?: number): number + +Writes an unsigned, big-endian 64-bit Big integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | bigint | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeBigUInt64BE(0xdecafafecacefaden, 0); +``` + +### writeBigUInt64LE + +writeBigUInt64LE(value: bigint, offset?: number): number + +Writes an unsigned, little-endian 64-bit Big integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | bigint | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeBigUInt64LE(0xdecafafecacefaden, 0); +``` + +### writeDoubleBE + +writeDoubleBE(value: number, offset?: number): number + +Writes a big-endian double-precision floating-point number to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeDoubleBE(123.456, 0); +``` + +### writeDoubleLE + +writeDoubleLE(value: number, offset?: number): number + +Writes a little-endian double-precision floating-point number to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeDoubleLE(123.456, 0); +``` + +### writeFloatBE + +writeFloatBE(value: number, offset?: number): number + +Writes a big-endian single-precision floating-point number to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeFloatBE(0xcafebabe, 0); +``` + + +### writeFloatLE + +writeFloatLE(value: number, offset?: number): number + +Writes a little-endian single-precision floating-point number to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(8); +buf.writeFloatLE(0xcafebabe, 0); +``` + +### writeInt8 + +writeInt8(value: number, offset?: number): number + +Writes a signed 8-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(2); +buf.writeInt8(2, 0); +buf.writeInt8(-2, 1); +``` + + +### writeInt16BE + +writeInt16BE(value: number, offset?: number): number + +Writes a signed, big-endian 16-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(2); +buf.writeInt16BE(0x0102, 0); +``` + + +### writeInt16LE + +writeInt16LE(value: number, offset?: number): number + +Writes a signed, little-endian 16-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(2); +buf.writeInt16LE(0x0304, 0); +``` + +### writeInt32BE + +writeInt32BE(value: number, offset?: number): number + +Writes a signed, big-endian 32-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeInt32BE(0x01020304, 0); +``` + + +### writeInt32LE + +writeInt32LE(value: number, offset?: number): number + +Writes a signed, little-endian 32-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeInt32LE(0x05060708, 0); +``` + +### writeIntBE + +writeIntBE(value: number, offset: number, byteLength: number): number + +Writes a big-endian signed value of the specified length to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | Yes| Number of bytes to skip before starting to write data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to write.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(6); +buf.writeIntBE(0x1234567890ab, 0, 6); +``` + + +### writeIntLE + +writeIntLE(value: number, offset: number, byteLength: number): number + +Writes a little-endian signed value of the specified length to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | Yes| Number of bytes to skip before starting to write data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to write.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(6); +buf.writeIntLE(0x1234567890ab, 0, 6); +``` + +### writeUInt8 + +writeUInt8(value: number, offset?: number): number + +Writes an unsigned 8-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeUInt8(0x3, 0); +buf.writeUInt8(0x4, 1); +buf.writeUInt8(0x23, 2); +buf.writeUInt8(0x42, 3); +``` + +### writeUInt16BE + +writeUInt16BE(value: number, offset?: number): number + +Writes an unsigned, big-endian 16-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeUInt16BE(0xdead, 0); +buf.writeUInt16BE(0xbeef, 2); +``` + +### writeUInt16LE + +writeUInt16LE(value: number, offset?: number): number + +Writes an unsigned, little-endian 16-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeUInt16LE(0xdead, 0); +buf.writeUInt16LE(0xbeef, 2); +``` + +### writeUInt32BE + +writeUInt32BE(value: number, offset?: number): number + +Writes an unsigned, big-endian 32-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeUInt32BE(0xfeedface, 0); +``` + +### writeUInt32LE + +writeUInt32LE(value: number, offset?: number): number + +Writes an unsigned, little-endian 32-bit integer to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | No| Number of bytes to skip before starting to write data. The default value is **0**.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(4); +buf.writeUInt32LE(0xfeedface, 0); +``` + +### writeUIntBE + +writeUIntBE(value: number, offset: number, byteLength: number): number + +Writes an unsigned big-endian value of the specified length to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | Yes| Number of bytes to skip before starting to write data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to write.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(6); +buf.writeUIntBE(0x1234567890ab, 0, 6); +``` + +### writeUIntLE + +writeUIntLE(value: number, offset: number, byteLength: number): number + +Writes an unsigned little-endian value of the specified length to this **Buffer** instance at the specified offset. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | number | Yes| Data to write.| +| offset | number | Yes| Number of bytes to skip before starting to write data. The default value is **0**.| +| byteLength | number | Yes| Number of bytes to write.| + + +**Return value** + +| Type| Description| +| -------- | -------- | +| number | Number of bytes written.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.allocUninitializedFromPool(6); +buf.writeUIntLE(0x1234567890ab, 0, 6); +``` + +### transcode + +transcode(source: Buffer | Uint8Array, fromEnc: string, toEnc: string): Buffer + +Transcodes the given **Buffer** or **Uint8Array** instance from one encoding format to another. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| source | Buffer \| Uint8Array | Yes| Instance to transcode. | +| fromEnc | string | Yes| Current encoding format.| +| toEnc | string | Yes| Target encoding format.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Buffer | New **Buffer** instance in the target encoding format.| + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let buf = buffer.alloc(50); +let newBuf = buffer.transcode(buffer.from('€'), 'utf-8', 'ascii'); +console.log(newBuf.toString('ascii')); +``` + +## Blob + +### Attributes + +**System capability**: SystemCapability.Utils.Lang + +| Name| Type| Readable| Writable| Description| +| -------- | -------- | -------- | -------- | -------- | +| size | number | Yes| No| Total size of the **Blob** instance, in bytes.| +| type | string | Yes| No| Type of the data in the **Blob** instance.| + +### constructor + +constructor(sources: string[] | ArrayBuffer[] | TypedArray[] | DataView[] | Blob[] , options?: Object) + +A constructor used to create a **Blob** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| sources | string[] \| ArrayBuffer[] \| TypedArray[] \| DataView[] \| Blob[] | Yes| Data sources of the **Blob** instance.| +| options | Object | No| options:
- **endings**: 'transparent' or 'native'.
- **type**: type of the data in **Blob**.| + + +**Example** + +```ts +import buffer from '@ohos.buffer'; + +let blob = new buffer.Blob(['a', 'b', 'c']); +let blob1 = new buffer.Blob(['a', 'b', 'c'], {endings:'native', type: 'MIME'}); +``` + +### encode + +arrayBuffer(): Promise<ArrayBuffer> + +Puts the **Blob** data into an **ArrayBuffer** instance. This API uses a promise to return the result. + +**System capability**: SystemCapability.Utils.Lang + +**Return value** +| Type| Description| +| -------- | -------- | +| Promise<ArrayBuffer> | Promise used to return the **ArrayBuffer** containing the **Blob** data.| + +**Example** + ```ts + let blob = new buffer.Blob(['a', 'b', 'c']); + let pro = blob.arrayBuffer(); + pro.then(val => { + let uintarr = new Uint8Array(val); + console.log(uintarr.toString()); + }); + ``` +### slice + +slice(start?: number, end?: number, type?: string): Blob + +Creates a **Blob** instance by copying specified data from this **Blob** instance. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| start | number | No| Offset to the start position of the data to copy.| +| end | number | No| Offset to the end position of the data to copy.| +| type | string | No| Type of the data in the new **Blob** instance.| + +**Return value** +| Type| Description| +| -------- | -------- | +| Blob | **Blob** instance created. | + +**Example** + ```ts + let blob = new buffer.Blob(['a', 'b', 'c']); + let blob2 = blob.slice(0, 2); + let blob3 = blob.slice(0, 2, "MIME"); + ``` + + ### text + +text(): Promise<string> + +Returns text in UTF-8 format. + +**System capability**: SystemCapability.Utils.Lang + +**Return value** +| Type| Description| +| -------- | -------- | +| Promise<string> | Promise used to return the text encoded in UTF-8.| + +**Example** + ```ts + let blob = new buffer.Blob(['a', 'b', 'c']); + let pro = blob.text(); + pro.then(val => { + console.log(val) + }); + ``` diff --git a/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md b/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md index 9b11bb2f18da535af770b96cda13981cef95c62a..5457c4e3154da06f26045b06b7c196eb1c5dd75d 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-ExtensionAbilityInfo.md @@ -1,13 +1,11 @@ # ExtensionAbilityInfo - +The **ExtensionAbilityInfo** module provides Extension ability information. Unless otherwise specified, all attributes are obtained through [getBundleInfo](js-apis-Bundle.md#bundlegetbundleinfo), and flags are obtained through [GET_BUNDLE_DEFAULT](js-apis-Bundle.md#bundleflag). > **NOTE** > > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. -The **ExtensionAbilityInfo** module provides Extension ability information. Unless otherwise specified, all attributes are obtained through **GET_BUNDLE_DEFAULT**. - ## ExtensionAbilityInfo **System capability**: SystemCapability.BundleManager.BundleFramework diff --git a/en/application-dev/reference/apis/js-apis-bundle-LauncherAbilityInfo.md b/en/application-dev/reference/apis/js-apis-bundle-LauncherAbilityInfo.md index 7b932cacbc2195e8c52976aa80e71bd3b638921d..ef19c14e94b36ba0f0677d8bdc35f362f709a7ae 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-LauncherAbilityInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-LauncherAbilityInfo.md @@ -1,6 +1,6 @@ # LauncherAbilityInfo -The **LauncherAbilityInfo** module provides information about a launcher ability. +The **LauncherAbilityInfo** module provides information about the launcher ability, which is obtained through [innerBundleManager.getLauncherAbilityInfos](js-apis-Bundle-InnerBundleManager.md). > **NOTE** > @@ -10,8 +10,10 @@ The **LauncherAbilityInfo** module provides information about a launcher ability **System capability**: SystemCapability.BundleManager.BundleFramework -| Name | Type | Readable| Writable| Description | -| --------------- | ---------------------------------------------------- | ---- | ---- | ------------------------------------ | +**System API**: This is a system API and cannot be called by third-party applications. + +| Name | Type | Readable| Writable| Description | +| --------------- | ---------------------------------------------------- | ---- | ---- | -------------------------------------- | | applicationInfo | [ApplicationInfo](js-apis-bundle-ApplicationInfo.md) | Yes | No | Application information of the launcher ability.| | elementName | [ElementName](js-apis-bundle-ElementName.md) | Yes | No | Element name of the launcher ability. | | labelId | number | Yes | No | Label ID of the launcher ability. | diff --git a/en/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md b/en/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md index d45f34389b0cf049376e282fb2fdf2a2f3130075..9e70a90e4fc19197ebd37021ad3326ab64c3ccfc 100644 --- a/en/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md +++ b/en/application-dev/reference/apis/js-apis-bundle-ShortcutInfo.md @@ -1,6 +1,6 @@ # ShortcutInfo -The **ShortcutInfo** module provides shortcut information defined in the configuration file. +The **ShortcutInfo** module provides shortcut information defined in the configuration file. For details about the configuration in the FA model, see [config.json](../../quick-start/package-structure.md). For details about the configuration in the stage model, see [Internal Structure of the shortcuts Attribute](../../quick-start/stage-structure.md#internal-structure-of-the-shortcuts-attribute). > **NOTE** > diff --git a/en/application-dev/reference/apis/js-apis-call.md b/en/application-dev/reference/apis/js-apis-call.md index 1631e3318f49bd07012e836449dfa4431a67db65..9b20ccb9f359ed6f8109d3fc57fdebd9d4d728ed 100644 --- a/en/application-dev/reference/apis/js-apis-call.md +++ b/en/application-dev/reference/apis/js-apis-call.md @@ -824,11 +824,8 @@ This is a system API. **Example** ```js -let promise = call.reject(1); -promise.then(data => { - console.log(`reject success, promise: data->${JSON.stringify(data)}`); -}).catch(err => { - console.error(`reject fail, promise: err->${JSON.stringify(err)}`); +call.reject(1, (error, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); }); ``` @@ -2810,10 +2807,11 @@ This is a system API. | Name | Value | Description | | -------------------- | ---- | ------------ | -| DEVICE_EARPIECE | 0 | Headset device. | -| DEVICE_SPEAKER | 1 | Speaker device.| -| DEVICE_WIRED_HEADSET | 2 | Wired headset device.| +| DEVICE_EARPIECE | 0 | Earpiece. | +| DEVICE_SPEAKER | 1 | Speaker.| +| DEVICE_WIRED_HEADSET | 2 | Wired headset.| | DEVICE_BLUETOOTH_SCO | 3 | Bluetooth SCO device. | +| DEVICE_MIC | 4 | Microphone. | ## CallRestrictionType8+ diff --git a/en/application-dev/reference/apis/js-apis-camera.md b/en/application-dev/reference/apis/js-apis-camera.md index f9c55898029eee1a6782df976cfd40ec43574735..5d57d317cb2a4ae2fa0e7ba29e61a23d95c8dbd1 100644 --- a/en/application-dev/reference/apis/js-apis-camera.md +++ b/en/application-dev/reference/apis/js-apis-camera.md @@ -20,9 +20,9 @@ Obtains a **CameraManager** instance. This API uses an asynchronous callback to **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------- | ---- | ---------------------------- | -| context | Context | Yes | Application context. | +| Name | Type | Mandatory| Description | +| -------- | ----------------------------------------------- | ---- | ---------------------------------- | +| context | Context | Yes | Application context. | | callback | AsyncCallback<[CameraManager](#cameramanager)\> | Yes | Callback used to return the **CameraManager** instance.| **Example** @@ -30,7 +30,7 @@ Obtains a **CameraManager** instance. This API uses an asynchronous callback to ```js camera.getCameraManager(context, (err, cameraManager) => { if (err) { - console.error(`Failed to get the CameraManager instance ${err.message}`); + console.error('Failed to get the CameraManager instance ${err.message}'); return; } console.log('Callback returned with the CameraManager instance'); @@ -53,8 +53,8 @@ Obtains a **CameraManager** instance. This API uses a promise to return the resu **Return value** -| Type | Description | -| ----------------------------------------- | ----------------------------------- | +| Type | Description | +| ----------------------------------------- | ----------------------------------------- | | Promise<[CameraManager](#cameramanager)\> | Promise used to return the **CameraManager** instance.| **Example** @@ -78,1149 +78,947 @@ Enumerates the camera statuses. | CAMERA_STATUS_AVAILABLE | 2 | The camera is available. | | CAMERA_STATUS_UNAVAILABLE | 3 | The camera is unavailable.| -## Profile -Defines the camera profile. +## CameraPosition + +Enumerates the camera positions. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Read only| Description | -| -------- | ----------------------------- |---- | ------------- | -| format | [CameraFormat](#cameraformat) | Yes | Output format. | -| size | [Size](#size) | Yes | Resolution. | +| Name | Value | Description | +| --------------------------- | ---- | ---------------- | +| CAMERA_POSITION_UNSPECIFIED | 0 | Unspecified position.| +| CAMERA_POSITION_BACK | 1 | Rear camera. | +| CAMERA_POSITION_FRONT | 2 | Front camera. | -## FrameRateRange +## CameraType - Defines the frame rate range. +Enumerates the camera types. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Read only| Description | -| ------------------------- | ------ | ---- | ------------------- | -| min | number | Yes | Minimum rate, in fps. | -| max | number | Yes | Maximum rate, in fps. | +| Name | Value | Description | +| ----------------------- | ---- | ---------------- | +| CAMERA_TYPE_UNSPECIFIED | 0 | Unspecified camera type.| +| CAMERA_TYPE_WIDE_ANGLE | 1 | Wide camera. | +| CAMERA_TYPE_ULTRA_WIDE | 2 | Ultra wide camera. | +| CAMERA_TYPE_TELEPHOTO | 3 | Telephoto camera. | +| CAMERA_TYPE_TRUE_DEPTH | 4 | Camera with depth of field information. | + -## VideoProfile +## ConnectionType -Defines the video profile. +Enumerates the camera connection types. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Read only| Description | -| ------------------------- | ----------------------------------------- | --- |------------ | -| frameRateRanges | [FrameRateRange](#frameraterange) | Yes | Frame rate range. | +| Name | Value | Description | +| ---------------------------- | ---- | ------------- | +| CAMERA_CONNECTION_BUILT_IN | 0 | Built-in camera. | +| CAMERA_CONNECTION_USB_PLUGIN | 1 | Camera connected using USB.| +| CAMERA_CONNECTION_REMOTE | 2 | Remote camera. | -## CameraOutputCapability +## Size -Defines the camera output capability. +Defines the image size that can be used in previewing, photographing, and video recording. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Read only| Description | -| ----------------------------- | -------------------------------------------------- | --- |------------------- | -| previewProfiles | Array<[Profile](#profile)\> | Yes | Supported preview profiles. | -| photoProfiles | Array<[Profile](#profile)\> | Yes | Supported shooting profiles. | -| videoProfiles | Array<[VideoProfile](#videoprofile)\> | Yes | Supported video recording profiles. | -| supportedMetadataObjectTypes | Array<[MetadataObjectType](#metadataobjecttype)\> | Yes | Supported metadata object types.| +| Name | Type | Readable| Writable| Description | +| ------ | ------ | ---- | ---- | ------------ | +| height | string | Yes | Yes | Image height.| +| width | number | Yes | Yes | Image width.| ## CameraManager Implements camera management. Before calling any API in **CameraManager**, you must use **getCameraManager** to obtain a **CameraManager** instance. -### getSupportedCameras +### getCameras -getSupportedCameras(callback: AsyncCallback\>): void +getCameras(callback: AsyncCallback\>): void -Obtains supported cameras. This API uses an asynchronous callback to return the result. +Obtains all cameras supported by the device. This API uses an asynchronous callback to return the array of supported cameras. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------- | ---- | ------------------------------- | -| callback | AsyncCallback\> | Yes | Callback used to return the array of supported cameras.| +| Name | Type | Mandatory| Description | +| -------- | ----------------------------------------- | ---- | ------------------------------------ | +| callback | AsyncCallback\> | Yes | Callback used to return the array of supported cameras.| **Example** ```js -cameraManager.getSupportedCameras((err, cameras) => { +cameraManager.getCameras((err, cameras) => { if (err) { - console.error(`Failed to get the cameras. ${err.message}`); + console.error('Failed to get the cameras. ${err.message}'); return; } - console.log(`Callback returned with an array of supported cameras: ${cameras.length}`); + console.log('Callback returned with an array of supported cameras: ' + cameras.length); }) ``` -### getSupportedCameras +### getCameras -getSupportedCameras(): Promise\> +getCameras(): Promise\> -Obtains supported cameras. This API uses a promise to return the result. +Obtains all cameras supported by the device. This API uses a promise to return the array of supported cameras. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| ----------------------------------------------- | ------------------------- | -| Promise\> | Promise used to return the array of supported cameras.| +| Type | Description | +| ----------------------------------- | ----------------------------- | +| Promise\> | Promise used to return the array of supported cameras.| **Example** ```js -cameraManager.getSupportedCameras().then((cameraArray) => { - console.log(`Promise returned with an array of supported cameras: ${cameraArray.length}`); +cameraManager.getCameras().then((cameraArray) => { + console.log('Promise returned with an array of supported cameras: ' + cameraArray.length); }) ``` -### getSupportedOutputCapability +### createCameraInput + +createCameraInput(cameraId: string, callback: AsyncCallback): void -getSupportedOutputCapability(camera:CameraDevice, callback: AsyncCallback): void +Creates a **CameraInput** instance with the specified camera ID. This API uses an asynchronous callback to return the result. -Obtains the output capability supported by a camera. This API uses an asynchronous callback to return the result. +**Required permissions**: ohos.permission.CAMERA **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------------------------------------- | -- | -------------------------- | -| camera | [CameraDevice](#cameradevice) | Yes| **CameraDevice** object. | -| callback | AsyncCallback<[CameraOutputCapability](#cameraoutputcapability)\> | Yes| Callback used to return the output capability.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------- | ---- | ----------------------------------- | +| cameraId | string | Yes | ID of the target camera. | +| callback | AsyncCallback<[CameraInput](#camerainput)\> | Yes | Callback used to return the **CameraInput** instance.| **Example** ```js -cameraManager.getSupportedOutputCapability(cameraDevice, (err, cameras) => { +cameraManager.createCameraInput(cameraId, (err, cameraInput) => { if (err) { - console.error(`Failed to get the cameras. ${err.message}`); + console.error('Failed to create the CameraInput instance. ${err.message}'); return; } - console.log('Callback returned with an array of supported outputCapability'); + console.log('Callback returned with the CameraInput instance.'); }) ``` -### getSupportedOutputCapability +### createCameraInput + +createCameraInput(cameraId: string): Promise -getSupportedOutputCapability(camera:CameraDevice): Promise +Creates a **CameraInput** instance with the specified camera ID. This API uses a promise to return the result. -Obtains the output capability supported by a camera. This API uses a promise to return the result. +**Required permissions**: ohos.permission.CAMERA **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory | Description | -| -------- | --------------------------------- | ---- | ---------- | -| camera | [CameraDevice](#cameradevice) | Yes | **CameraDevice** object.| +| Name | Type | Mandatory| Description | +| -------- | ------ | ---- | ------------ | +| cameraId | string | Yes | ID of the target camera.| **Return value** -| Type | Description | -| -------------------------------------------------------------- | ----------------------------- | -| Promise<[CameraOutputCapability](#cameraoutputcapability)\> | Promise used to return the output capability.| - +| Type | Description | +| ------------------------------------- | ---------------------------------------- | +| Promise<[CameraInput](#camerainput)\> | Promise used to return the **CameraInput** instance.| **Example** ```js -cameraManager.getSupportedOutputCapability(cameraDevice).then((cameraoutputcapability) => { - console.log('Promise returned with an array of supported outputCapability'); +cameraManager.createCameraInput(cameraId).then((cameraInput) => { + console.log('Promise returned with the CameraInput instance'); }) ``` -### getSupportedMetadataObjectType +### createCameraInput + +createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCallback): void -getSupportedMetadataObjectType(callback: AsyncCallback\>): void +Creates a **CameraInput** instance with the specified camera position and type. This API uses an asynchronous callback to return the result. -Obtains the metadata object types supported by this camera. This API uses an asynchronous callback to return the result. +**Required permissions**: ohos.permission.CAMERA **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------------------------------------- | -- | -------------------------- | -| callback | AsyncCallback\> | Yes| Callback used to return the metadata object types.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------- | ---- | ----------------------------------- | +| position | [CameraPosition](#cameraposition) | Yes | Camera position. | +| type | [CameraType](#cameratype) | Yes | Camera type. | +| callback | AsyncCallback<[CameraInput](#camerainput)\> | Yes | Callback used to return the **CameraInput** instance.| **Example** ```js -cameraManager.getSupportedMetadataObjectType((err, metadataobject) => { +cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED, (err, cameraInput) => { if (err) { - console.error(`Failed to get the supported metadataObjectType. ${err.message}`); + console.error('Failed to create the CameraInput instance. ${err.message}'); return; } - console.log('Callback returned with an array of supported metadataObjectType.' ); + console.log('Callback returned with the CameraInput instance'); }) ``` -### getSupportedMetadataObjectType +### createCameraInput + +createCameraInput(position: CameraPosition, type: CameraType): Promise -getSupportedMetadataObjectType(camera:CameraDevice): Promise +Creates a **CameraInput** instance with the specified camera position and type. This API uses a promise to return the result. -Obtains the metadata object types supported by this camera. This API uses a promise to return the result. +**Required permissions**: ohos.permission.CAMERA **System capability**: SystemCapability.Multimedia.Camera.Core -**Return value** +**Parameters** -| Type | Description | -| -------------------------------------------------------------- | ----------------------------- | -| Promise\> | Promise used to return the metadata object types.| +| Name | Type | Mandatory| Description | +| -------- | --------------------------------- | ---- | ---------- | +| position | [CameraPosition](#cameraposition) | Yes | Camera position.| +| type | [CameraType](#cameratype) | Yes | Camera type.| + +**Return value** +| Type | Description | +| ------------------------------------- | ---------------------------------------- | +| Promise<[CameraInput](#camerainput)\> | Promise used to return the **CameraInput** instance.| **Example** ```js -cameraManager.getSupportedMetadataObjectType().then((metadataobject) => { - console.log('Promise returned with an array of supported metadataObjectType.' ); +cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED).then((cameraInput) => { + console.log('Promise returned with the CameraInput instance.'); }) ``` -### isCameraMuted +### on('cameraStatus') -isCameraMuted(callback: AsyncCallback): void +on(type: 'cameraStatus', callback: AsyncCallback): void -Checks whether this camera is muted. This API uses an asynchronous callback to return the result. +Listens for camera status changes. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------------- | ---- | ------------------------------------ | -| callback | AsyncCallback | Yes | Callback used to return the result. The value **true** means that the camera is muted, and **false** means the opposite.| +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------- | :--- | :--------------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **`cameraStatus`**, indicating the camera status change event.| +| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | Yes | Callback used to return the camera status change. | **Example** ```js -cameraManager.isCameraMuted((err, status) => { +cameraManager.on('cameraStatus', (err, cameraStatusInfo) => { if (err) { - console.error(`Failed to get the cameraMuted status. ${err.message}`); + console.error('Failed to get cameraStatus callback. ${err.message}'); return; } - console.log('Callback returned with cameraMuted status'); + console.log('camera : ' + cameraStatusInfo.camera.cameraId); + console.log('status: ' + cameraStatusInfo.status); }) ``` -### isCameraMuted - -isCameraMuted(): Promise +## Camera -Checks whether this camera is muted. This API uses a promise to return the result. +After **[camera.getCameraManager](#cameragetcameramanager)** is called, a camera instance is returned, with camera-related metadata such as **cameraId**, **cameraPosition**, **cameraType**, and **connectionType**. **System capability**: SystemCapability.Multimedia.Camera.Core -**Return value** - -| Type | Description | -| ------------------------------------ | --------------------------------------------- | -| Promise | Promise used to return the result. The value **true** means that the camera is muted, and **false** means the opposite. | - +| Name | Type | Read only| Description | +| -------------- | --------------------------------- | ---- | -------------- | +| cameraId | string | Yes | Camera ID. | +| cameraPosition | [CameraPosition](#cameraposition) | Yes | Camera position. | +| cameraType | [CameraType](#cameratype) | Yes | Camera type. | +| connectionType | [ConnectionType](#connectiontype) | Yes | Camera connection type.| **Example** ```js -cameraManager.isCameraMuted().then((status) => { - console.log('Promise returned with the status whether camera is muted.'); -}) +async function getCameraInfo("cameraId") { + var cameraManager = await camera.getCameraManager(context); + var cameras = await cameraManager.getCameras(); + var cameraObj = cameras[0]; + var cameraId = cameraObj.cameraId; + var cameraPosition = cameraObj.cameraPosition; + var cameraType = cameraObj.cameraType; + var connectionType = cameraObj.connectionType; +} ``` -### isCameraMuteSupported +## CameraStatusInfo + +Describes the camera status information. + +**System capability**: SystemCapability.Multimedia.Camera.Core -isCameraMuteSupported(callback: AsyncCallback): void +| Name | Type | Description | +| ------ | ----------------------------- | ---------- | +| camera | [Camera](#camera) | Camera object.| +| status | [CameraStatus](#camerastatus) | Camera status.| -Checks whether this camera can be muted. This API uses an asynchronous callback to return the result. -This is a system API. +## CameraInput -**Required permissions**: ohos.permission.CAMERA +Implements a **CameraInput** instance. Before calling any API in **CameraInput**, you must create a **CameraInput** instance. + +### getCameraId + +getCameraId(callback: AsyncCallback\): void + +Obtains the camera ID based on which this **CameraInput** instance is created. This API uses an asynchronous callback to return the camera ID. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ------------------------------------ | -| callback | AsyncCallback | Yes | Callback used to return the result. The value **true** means that the camera can be muted, and **false** means the opposite. | +| Name | Type | Mandatory| Description | +| -------- | ---------------------- | ---- | -------------------------- | +| callback | AsyncCallback | Yes | Callback used to return the camera ID.| **Example** ```js -cameraManager.isCameraMuteSupported((err, status) => { +cameraInput.getCameraId((err, cameraId) => { if (err) { - console.error(`Failed to get the cameraMuteSupported. ${err.message}`); + console.error('Failed to get the camera ID. ${err.message}'); return; } - console.log('Callback returned with the status whether cameraMuteSupported.'); + console.log('Callback returned with the camera ID: ' + cameraId); }) ``` -### isCameraMuteSupported +### getCameraId -isCameraMuteSupported(): Promise +getCameraId(): Promise -Checks whether this camera can be muted. This API uses a promise to return the result. - -This is a system API. - -**Required permissions**: ohos.permission.CAMERA +Obtains the camera ID based on which this **CameraInput** instance is created. This API uses a promise to return the camera ID. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| --------------------- | ----------------------------- | -| Promise | Promise used to return the result. The value **true** means that the camera can be muted, and **false** means the opposite.| - +| Type | Description | +| ---------------- | ----------------------------- | +| Promise | Promise used to return the camera ID.| **Example** ```js -cameraManager.isCameraMuteSupported().then((status) => { - console.log('Promise returned with the status whether cameraMuteSupported.'); +cameraInput.getCameraId().then((cameraId) => { + console.log('Promise returned with the camera ID:' + cameraId); }) ``` -### muteCamera -muteCamera(mute:boolean, callback: AsyncCallback): void - -Mutes this camera. This API uses an asynchronous callback to return the result. +### hasFlash -This is a system API. +hasFlash(callback: AsyncCallback): void -**Required permissions**: ohos.permission.CAMERA +Checks whether the device has flash. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ----------------------------------------- | ---- | ------------------------------------ | -| mute | boolean | Yes | Whether to mute the camera. The value **true** means to mute the camera, and **false** means the opposite. | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | ----------------------- | ---- | -------------------------------------- | +| callback | AsyncCallback | Yes | Callback used to return the flash support status. The value **true** means that the device has flash.| **Example** ```js -cameraManager.muteCamera(isMuted, (err) => { +cameraInput.hasFlash((err, status) => { if (err) { - console.error(`Failed to mute the camera. ${err.message}`); + console.error('Failed to check whether the device has flash light. ${err.message}'); return; } - console.log('Callback returned with the muteCamera.'); + console.log('Callback returned with flash light support status: ' + status); }) ``` -### muteCamera - -muteCamera(mute:boolean): Promise - -Mutes this camera. This API uses a promise to return the result. +### hasFlash -This is a system API. +hasFlash(): Promise -**Required permissions**: ohos.permission.CAMERA +Checks whether the device has flash. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------- | ---- | ------------ | -| mute | boolean | Yes | Whether to mute the camera. The value **true** means to mute the camera, and **false** means the opposite. | - **Return value** -| Type | Description | -| ----------------------------------- | ----------------------------- | -| Promise | Promise used to return the result.| - +| Type | Description | +| ----------------- | ------------------------------------------------------- | +| Promise | Promise used to return the flash support status. The value **true** means that the device has flash.| **Example** -```js -cameraManager.muteCamera(isMuted).then(() => { - console.log('Promise returned muteCamera.'); +```js +cameraInput.hasFlash().then((status) => { + console.log('Promise returned with the flash light support status:' + status); }) ``` -### createCameraInput - -createCameraInput(camera: CameraDevice, callback: AsyncCallback): void - -Creates a **CameraInput** instance with the specified **CameraDevice** object. This API uses an asynchronous callback to return the result. +### isFlashModeSupported -This is a system API. +isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback): void -**Required permissions**: ohos.permission.CAMERA +Checks whether a specified flash mode is supported. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------- | ---- | --------------------------------- | -| camera | [CameraDevice](#cameradevice) | Yes | **CameraDevice** object. | -| callback | AsyncCallback<[CameraInput](#camerainput)\> | Yes | Callback used to return the **CameraInput** instance. | +| Name | Type | Mandatory| Description | +| --------- | ----------------------- | ---- | ---------------------------------------- | +| flashMode | [FlashMode](#flashmode) | Yes | Flash mode. | +| callback | AsyncCallback | Yes | Callback used to return the flash mode support status. The value **true** means that the flash mode is supported, and **false** means the opposite.| **Example** ```js -cameraManager.createCameraInput(camera, (err, cameraInput) => { +cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO, (err, status) => { if (err) { - console.error(`Failed to create the CameraInput instance. ${err.message}`); + console.error('Failed to check whether the flash mode is supported. ${err.message}'); return; } - console.log('Callback returned with the CameraInput instance.'); + console.log('Callback returned with the flash mode support status: ' + status); }) ``` -### createCameraInput - -createCameraInput(camera: CameraDevice): Promise - -Creates a **CameraInput** instance with the specified **CameraDevice** object. This API uses a promise to return the result. +### isFlashModeSupported -This is a system API. +isFlashModeSupported(flashMode: FlashMode): Promise -**Required permissions**: ohos.permission.CAMERA +Checks whether a specified flash mode is supported. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------- | ---- | ---------- | -| camera | [CameraDevice](#cameradevice) | Yes | **CameraDevice** object.| +| Name | Type | Mandatory| Description | +| --------- | ----------------------- | ---- | ---------------- | +| flashMode | [FlashMode](#flashmode) | Yes | Flash mode.| **Return value** -| Type | Description | -| ------------------------------------- | ------------------------------------ | -| Promise<[CameraInput](#camerainput)\> | Promise used to return the **CameraInput** instance.| +| Type | Description | +| ----------------- | ------------------------------------------------------------ | +| Promise | Promise used to return the flash mode support status. The value **true** means that the flash mode is supported, and **false** means the opposite.| **Example** ```js -cameraManager.createCameraInput(camera).then((cameraInput) => { - console.log('Promise returned with the CameraInput instance'); +cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO).then((status) => { + console.log('Promise returned with flash mode support status.' + status); }) ``` -### createCameraInput +### setFlashMode -createCameraInput(position: CameraPosition, type: CameraType, callback: AsyncCallback): void +setFlashMode(flashMode: FlashMode, callback: AsyncCallback): void -Creates a **CameraInput** instance with the specified camera position and type. This API uses an asynchronous callback to return the result. +Sets the flash mode. This API uses an asynchronous callback to return the result. -This is a system API. +Before the setting, do the following checks: -**Required permissions**: ohos.permission.CAMERA +1. Use **[hasFlash](#hasflash)** to check whether the device has flash. +2. Use **[isFlashModeSupported](#isflashmodesupported)** to check whether the device supports the flash mode. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------- | ---- | --------------------------------- | -| position | [CameraPosition](#cameraposition) | Yes | Camera position. | -| type | [CameraType](#cameratype) | Yes | Camera type. | -| callback | AsyncCallback<[CameraInput](#camerainput)\> | Yes | Callback used to return the **CameraInput** instance. | +| Name | Type | Mandatory| Description | +| --------- | ----------------------- | ---- | ------------------------ | +| flashMode | [FlashMode](#flashmode) | Yes | Flash mode. | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED, (err, cameraInput) => { +cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO, (err) => { if (err) { - console.error(`Failed to create the CameraInput instance. ${err.message}`); + console.error('Failed to set the flash mode ${err.message}'); return; } - console.log('Callback returned with the CameraInput instance'); + console.log('Callback returned with the successful execution of setFlashMode.'); }) ``` -### createCameraInput +### setFlashMode -createCameraInput(position: CameraPosition, type:CameraType ): Promise +setFlashMode(flashMode: FlashMode): Promise -Creates a **CameraInput** instance with the specified camera position and type. This API uses a promise to return the result. +Sets a flash mode. This API uses a promise to return the result. -This is a system API. +Before the setting, do the following checks: -**Required permissions**: ohos.permission.CAMERA +1. Use **[hasFlash](#hasflash)** to check whether the device has flash. +2. Use **[isFlashModeSupported](#isflashmodesupported)** to check whether the device supports the flash mode. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | --------------------------------- | ---- | ------------ | -| position | [CameraPosition](#cameraposition) | Yes | Camera position. | -| type | [CameraType](#cameratype) | Yes | Camera type. | +| Name | Type | Mandatory| Description | +| --------- | ----------------------- | ---- | ---------------- | +| flashMode | [FlashMode](#flashmode) | Yes | Flash mode.| **Return value** -| Type | Description | -| ------------------------------------- | ------------------------------------ | -| Promise<[CameraInput](#camerainput)\> | Promise used to return the **CameraInput** instance.| +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| **Example** ```js -cameraManager.createCameraInput(camera.CameraPosition.CAMERA_POSITION_BACK, camera.CameraType.CAMERA_TYPE_UNSPECIFIED).then((cameraInput) => { - console.log('Promise returned with the CameraInput instance'); +cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO).then(() => { + console.log('Promise returned with the successful execution of setFlashMode.'); }) ``` -### createPreviewOutput +### getFlashMode -createPreviewOutput(profile: Profile, surfaceId: string, callback: AsyncCallback): void +getFlashMode(callback: AsyncCallback): void -Creates a **PreviewOutput** instance. This API uses an asynchronous callback to return the result. +Obtains the flash mode in use. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------- | ---- | ------------------------------- | -| profile | [Profile](#profile) | Yes | Supported preview profile. | -| surfaceId| string | Yes | Surface ID, which is obtained from **[XComponent](../arkui-ts/ts-basic-components-xcomponent.md)** or **[ImageReceiver](js-apis-image.md#imagereceiver9)**.| -| callback | AsyncCallback<[PreviewOutput](#previewoutput)\> | Yes | Callback used to return the **PreviewOutput** instance.| +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------- | ---- | ---------------------------------------- | +| callback | AsyncCallback<[FlashMode](#flashmode)\> | Yes | Callback used to return the flash mode.| **Example** ```js -cameraManager.createPreviewOutput(profile, surfaceId, (err, previewoutput) => { +cameraInput.getFlashMode((err, flashMode) => { if (err) { - console.error(`Failed to gcreate previewOutput. ${err.message}`); + console.error('Failed to get the flash mode ${err.message}'); return; } - console.log('Callback returned with previewOutput created.'); + console.log('Callback returned with current flash mode: ' + flashMode); }) ``` -### createPreviewOutput +### getFlashMode -createPreviewOutput(profile: Profile, surfaceId: string): Promise +getFlashMode(): Promise -Creates a **PreviewOutput** instance. This API uses a promise to return the result. +Obtains the flash mode in use. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------| ---- | ----------------- | -| profile | [Profile](#profile) | Yes | Supported preview profile. | -| surfaceId| string | Yes | Surface ID, which is obtained from **[XComponent](../arkui-ts/ts-basic-components-xcomponent.md)** or **[ImageReceiver](js-apis-image.md#imagereceiver9)**.| - **Return value** -| Type | Description | -| ---------------------------------------- | ---------------------------------------- | -| Promise<[PreviewOutput](#previewoutput)\> | Promise used to return the **PreviewOutput** instance. | +| Type | Description | +| --------------------------------- | --------------------------------------- | +| Promise<[FlashMode](#flashmode)\> | Promise used to return the flash mode.| **Example** ```js -cameraManager.createPreviewOutput(profile, survaceId).then((previewoutput) => { - console.log('Promise returned with previewOutput created.'); +cameraInput.getFlashMode().then((flashMode) => { + console.log('Promise returned with current flash mode : ' + flashMode); }) ``` -### createDeferredPreviewOutput +### isFocusModeSupported -createDeferredPreviewOutput(profile: Profile, callback: AsyncCallback): void +isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback): void -Creates a **PreviewOutput** instance without a surface ID. This API uses an asynchronous callback to return the result. +Checks whether a specified focus mode is supported. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------- | ---- | --------------------------------- | -| profile | [Profile](#profile) | Yes | Supported preview profile. | -| callback | AsyncCallback<[PreviewOutput](#previewoutput)\> | Yes | Callback used to return the **PreviewOutput** instance. | +| Name | Type | Mandatory| Description | +| -------- | ----------------------- | ---- | -------------------------------------- | +| afMode | [FocusMode](#focusmode) | Yes | Focus mode. | +| callback | AsyncCallback | Yes | Callback used to return the focus mode support status. The value **true** means that the focus mode is supported, and **false** means the opposite.| **Example** ```js -cameraManager.createDeferredPreviewOutput(profile, (err, previewoutput) => { +cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO, (err, status) => { if (err) { - console.error(`Failed to create deferredPreviewOutput. ${err.message}`); + console.error('Failed to check whether the focus mode is supported. ${err.message}'); return; } - console.log('Callback returned with deferredPreviewOutput created.'); + console.log('Callback returned with the focus mode support status: ' + status); }) ``` -### createDeferredPreviewOutput +### isFocusModeSupported -createDeferredPreviewOutput(profile: Profile): Promise +isFocusModeSupported(afMode: FocusMode): Promise -Creates a **PreviewOutput** instance without a surface ID. This API uses a promise to return the result. +Checks whether a specified focus mode is supported. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ---------------------------------| ---- | ---------- | -| profile | [Profile](#profile) | Yes | Supported preview profile. | +| Name | Type | Mandatory| Description | +| ------ | ----------------------- | ---- | ---------------- | +| afMode | [FocusMode](#focusmode) | Yes | Focus mode.| **Return value** -| Type | Description | -| ----------------------------------------- | --------------------------------------- | -| Promise<[PreviewOutput](#previewoutput)\> | Promise used to return the **PreviewOutput** instance.| +| Type | Description | +| ----------------- | ----------------------------------------------------------- | +| Promise | Promise used to return the focus mode support status. The value **true** means that the focus mode is supported, and **false** means the opposite.| **Example** ```js -cameraManager.createDeferredPreviewOutput(profile).then((previewoutput) => { - console.log('Promise returned with DefeerredPreviewOutput created.'); +cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO).then((status) => { + console.log('Promise returned with focus mode support status.' + status); }) ``` -### createPhotoOutput +### setFocusMode -createPhotoOutput(profile: Profile, surfaceId: string, callback: AsyncCallback): void +setFocusMode(afMode: FocusMode, callback: AsyncCallback): void -Creates a **PhotoOutput** instance. This API uses an asynchronous callback to return the result. +Sets a focus mode. This API uses an asynchronous callback to return the result. + +Before the setting, use **[isFocusModeSupported](#isfocusmodesupported)** to check whether the focus mode is supported. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------- | ---- | ----------------------------------- | -| profile | [Profile](#profile) | Yes | Supported shooting profile. | -| surfaceId| string | Yes | Surface ID, which is obtained from **[ImageReceiver](js-apis-image.md#imagereceiver9)**.| -| callback | AsyncCallback<[PhotoOutput](#photooutput)\> | Yes | Callback used to return the **PhotoOutput** instance. | +| Name | Type | Mandatory| Description | +| -------- | ----------------------- | ---- | ------------------------ | +| afMode | [FocusMode](#focusmode) | Yes | Focus mode. | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -cameraManager.createPhotoOutput(profile, surfaceId, (err, photooutput) => { +cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO, (err) => { if (err) { - console.error(`Failed to create photoOutput. ${err.message}`); + console.error('Failed to set the focus mode ${err.message}'); return; } - console.log('Callback returned with photoOutput created.'); + console.log('Callback returned with the successful execution of setFocusMode.'); }) ``` -### createPhotoOutput +### setFocusMode + +setFocusMode(afMode: FocusMode): Promise -createPhotoOutput(profile: Profile, surfaceId: string): Promise +Sets a focus mode. This API uses a promise to return the result. -Creates a **PhotoOutput** instance. This API uses a promise to return the result. +Before the setting, use **[isFocusModeSupported](#isfocusmodesupported)** to check whether the focus mode is supported. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------| ---- | ----------- | -| profile | [Profile](#profile) | Yes | Supported shooting profile. | -| surfaceId| string | Yes | Surface ID, which is obtained from **[ImageReceiver](js-apis-image.md#imagereceiver9)**.| +| Name | Type | Mandatory| Description | +| ------ | ----------------------- | ---- | ---------------- | +| afMode | [FocusMode](#focusmode) | Yes | Focus mode.| **Return value** -| Type | Description | -| ------------------------------------- | -------------------------------------- | -| Promise<[PhotoOutput](#photooutput)\> | Promise used to return the **PhotoOutput** instance. | +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| **Example** ```js -cameraManager.createPhotoOutput(profile, surfaceId).then((photooutput) => { - console.log('Promise returned with photoOutput created.'); +cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO).then(() => { + console.log('Promise returned with the successful execution of setFocusMode.'); }) ``` -### createVideoOutput +### getFocusMode -createVideoOutput(profile: VideoProfile, surfaceId: string, callback: AsyncCallback): void +getFocusMode(callback: AsyncCallback): void -Creates a **VideoOutput** instance. This API uses an asynchronous callback to return the result. +Obtains the focus mode in use. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------- | ---- | ------------------------------ | -| profile | [VideoProfile](#videoprofile) | Yes | Supported video recording profile. | -| surfaceId| string | Yes | Surface ID, which is obtained from **[VideoRecorder](js-apis-media.md#videorecorder9)**.| -| callback | AsyncCallback<[VideoOutput](#videooutput)\> | Yes | Callback used to return the **VideoOutput** instance.| +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------- | ---- | -------------------------------------- | +| callback | AsyncCallback<[FocusMode](#focusmode)\> | Yes | Callback used to return the focus mode.| **Example** ```js -cameraManager.createVideoOutput(profile, surfaceId, (err, videooutput) => { +cameraInput.getFocusMode((err, afMode) => { if (err) { - console.error(`Failed to create videoOutput. ${err.message}`); + console.error('Failed to get the focus mode ${err.message}'); return; } - console.log('Callback returned with an array of supported outputCapability' ); + console.log('Callback returned with current focus mode: ' + afMode); }) ``` -### createVideoOutput +### getFocusMode -createVideoOutput(profile: VideoProfile, surfaceId: string): Promise +getFocusMode(): Promise -Creates a **VideoOutput** instance. This API uses a promise to return the result. +Obtains the focus mode in use. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------| ---- | ---------- | -| profile | [VideoProfile](#videoprofile) | Yes | Supported video recording profile. | -| surfaceId| string | Yes | Surface ID, which is obtained from **[VideoRecorder](js-apis-media.md#videorecorder9)**.| - **Return value** -| Type | Description | -| ------------------------------------- | -------------------------------------- | -| Promise<[VideoOutput](#videooutput)\> | Promise used to return the **VideoOutput** instance. | +| Type | Description | +| ------------------- | ------------------------------------- | +| Promise | Promise used to return the focus mode.| **Example** ```js -cameraManager.createVideoOutput(profile, surfaceId).then((videooutput) => { - console.log('Promise returned with videoOutput created.'); +cameraInput.getFocusMode().then((afMode) => { + console.log('Promise returned with current focus mode : ' + afMode); }) ``` -### createMetadataOutput +### getZoomRatioRange -createMetadataOutput(metadataObjectTypes: Array, callback: AsyncCallback): void +getZoomRatioRange\(callback: AsyncCallback\>\): void -Creates a **MetadataOutput** instance. This API uses an asynchronous callback to return the result. +Obtains the zoom ratio range. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------------------- | -------------------------------------------------- | --- | ---------------------------- | -| metadataObjectTypes | Array<[MetadataObjectType](#metadataobjecttype)\> | Yes | Supported metadata object types. | -| callback | AsyncCallback<[MetadataOutput](#metadataoutput)\> | Yes | Callback used to return the **MetadataOutput** instance. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------------ | ---- | ------------------------ | +| callback | AsyncCallback\> | Yes | Callback used to return an array containing the minimum and maximum zoom ratios.| **Example** ```js -cameraManager.createMetadataOutput(metadataObjectTypes, (err, metadataoutput) => { +cameraInput.getZoomRatioRange((err, zoomRatioRange) => { if (err) { - console.error(`Failed to create metadataOutput. ${err.message}`); + console.error('Failed to get the zoom ratio range. ${err.message}'); return; } - console.log('Callback returned with metadataOutput created.'); + console.log('Callback returned with zoom ratio range: ' + zoomRatioRange.length); }) ``` -### createMetadataOutput +### getZoomRatioRange -createMetadataOutput(metadataObjectTypes: Array): Promise +getZoomRatioRange\(\): Promise\> -Creates a **MetadataOutput** instance. This API uses a promise to return the result. +Obtains the zoom ratio range. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Type | Mandatory| Description | -| -------------------- | -------------------------------------------------- | --- | -------------- | -| metadataObjectTypes | Array<[MetadataObjectType](#metadataobjecttype)\> | Yes | Supported metadata object types.| - **Return value** -| Type | Description | -| ------------------------------------------ | ----------------------------------------- | -| Promise<[MetadataOutput](#metadataoutput)\> | Promise used to return the **MetadataOutput** instance.| +| Type | Description | +| ------------------------ | ------------------------------------------- | +| Promise\> | Promise used to return an array containing the minimum and maximum zoom ratios.| **Example** ```js -cameraManager.createMetadataOutput(metadataObjectTypes).then((metadataoutput) => { - console.log('Promise returned with metadataOutput created.'); +cameraInput.getZoomRatioRange().then((zoomRatioRange) => { + console.log('Promise returned with zoom ratio range: ' + zoomRatioRange.length); }) ``` -### createCaptureSession +### setZoomRatio -createCaptureSession(callback: AsyncCallback): void +setZoomRatio(zoomRatio: number, callback: AsyncCallback): void -Creates a **CaptureSession** instance. This API uses an asynchronous callback to return the result. +Sets a zoom ratio. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory | Description | -| -------------------- | ----------------------------------------- | ----------- | ---------------------------- | -| callback | AsyncCallback<[CaptureSession](#capturesession)\> | Yes | Callback used to return the **CaptureSession** instance.| +| Name | Type | Mandatory| Description | +| --------- | -------------------- | ---- | ------------------------ | +| zoomRatio | number | Yes | Zoom ratio. | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -cameraManager.createCaptureSession((err, capturesession) => { +cameraInput.setZoomRatio(1, (err) => { if (err) { - console.error(`Failed to create captureSession. ${err.message}`); + console.error('Failed to set the zoom ratio value ${err.message}'); return; } - console.log('Callback returned with captureSession created.'); + console.log('Callback returned with the successful execution of setZoomRatio.'); }) ``` -### createCaptureSession +### setZoomRatio -createCaptureSession(): Promise - -Creates a **CaptureSession** instance. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ------------------------------------------- | ---------------------------------------- | -| Promise<[CaptureSession](#capturesession)\> | Promise used to return the **CaptureSession** instance.| - -**Example** - -```js -cameraManager.createCaptureSession().then((capturesession) => { - console.log('Promise returned with captureSession created.'); -}) -``` - -### on('cameraStatus') - -on(type: 'cameraStatus', callback: AsyncCallback): void +setZoomRatio(zoomRatio: number): Promise -Listens for camera status changes. This API uses an asynchronous callback to return the result. +Sets a zoom ratio. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------- | ---- | --------- | -| type | string | Yes | Event type. The value is fixed at **'cameraStatus'**, indicating the camera status change event.| -| callback | AsyncCallback<[CameraStatusInfo](#camerastatusinfo)\> | Yes | Callback used to return the camera status change. | - -**Example** - -```js -cameraManager.on('cameraStatus', (err, cameraStatusInfo) => { - if (err) { - console.error(`Failed to get cameraStatus callback. ${err.message}`); - return; - } - console.log(`camera : ${cameraStatusInfo.camera.cameraId}`); - console.log(`status: ${cameraStatusInfo.status}`); -}) -``` - -### on('cameraMute') - -on(type: 'cameraMute', callback: AsyncCallback): void - -Listens for camera mute status changes. This API uses an asynchronous callback to return the result. - -This is a system API. - -**Required permissions**: ohos.permission.CAMERA - -**System capability**: SystemCapability.Multimedia.Camera.Core +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | ------------ | +| zoomRatio | number | Yes | Zoom ratio.| -**Parameters** +**Return value** -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'cameraMute'**, indicating the camera mute status change event.| -| callback | AsyncCallback | Yes | Callback used to return the camera mute status. | +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| **Example** ```js -cameraManager.on('cameraMute', (err, status) => { - if (err) { - console.error(`Failed to get cameraMute callback. ${err.message}`); - return; - } - console.log(`status: ${status}`); +cameraInput.setZoomRatio(1).then(() => { + console.log('Promise returned with the successful execution of setZoomRatio.'); }) ``` -## CameraStatusInfo - -Describes the camera status information. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Type | Description | -| ------ | ----------------------------- | ---------- | -| camera | [CameraDevice](#cameradevice) | Camera object.| -| status | [CameraStatus](#camerastatus) | Camera status.| - -## CameraPosition - -Enumerates the camera positions. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| --------------------------- | ---- | -------------- | -| CAMERA_POSITION_UNSPECIFIED | 0 | Unspecified position. | -| CAMERA_POSITION_BACK | 1 | Rear camera. | -| CAMERA_POSITION_FRONT | 2 | Front camera. | - -## CameraType - -Enumerates the camera types. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| ----------------------- | ---- | -------------- | -| CAMERA_TYPE_UNSPECIFIED | 0 | Unspecified camera type. | -| CAMERA_TYPE_WIDE_ANGLE | 1 | Wide camera. | -| CAMERA_TYPE_ULTRA_WIDE | 2 | Ultra wide camera. | -| CAMERA_TYPE_TELEPHOTO | 3 | Telephoto camera. | -| CAMERA_TYPE_TRUE_DEPTH | 4 | Camera with depth of field information.| - -## ConnectionType - -Enumerates the camera connection types. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| ---------------------------- | ---- | ------------- | -| CAMERA_CONNECTION_BUILT_IN | 0 | Built-in camera. | -| CAMERA_CONNECTION_USB_PLUGIN | 1 | Camera connected using USB.| -| CAMERA_CONNECTION_REMOTE | 2 | Remote camera.| - -## CameraDevice - -Defines the camera device information. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Type | Read only| Description | -| -------------- | --------------------------------- | ---- | ---------- | -| cameraId | string | Yes | **CameraDevice** object.| -| cameraPosition | [CameraPosition](#cameraposition) | Yes | Camera position. | -| cameraType | [CameraType](#cameratype) | Yes | Camera type. | -| connectionType | [ConnectionType](#connectiontype) | Yes | Camera connection type.| - -**Example** - -```js -async function getCameraInfo("cameraId") { - let cameraManager = await camera.getCameraManager(context); - let cameras = await cameraManager.getSupportedCameras(); - let cameraObj = cameras[0]; - let cameraId = cameraObj.cameraId; - let cameraPosition = cameraObj.cameraPosition; - let cameraType = cameraObj.cameraType; - let connectionType = cameraObj.connectionType; -} -``` - -## Size - -Enumerates the camera output capability. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Type | Readable| Writable| Description | -| ------ | ------ | ---- | ---- | ------------ | -| height | number | Yes | Yes | Image height, in pixels.| -| width | number | Yes | Yes | Image width, in pixels.| - -## Point - -Enumerates the point coordinates, which are used for focus and exposure configuration. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Type | Mandatory | Description | -| ------ | ------ | ---- | ------------ | -| x | number | Yes | X coordinate of a point. | -| y | number | Yes | Y coordinate of a point. | - -## CameraFormat - -Enumerates the camera output formats. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Default Value | Description | -| ----------------------- | --------- | ------------ | -| CAMERA_FORMAT_YUV_420_SP| 1003 | YUV 420 SP image. | -| CAMERA_FORMAT_JPEG | 2000 | JPEG image. | - -## CameraInput - -Provides camera information used in **[CaptureSession](#capturesession)**. - -### open +### getZoomRatio -open\(callback: AsyncCallback\): void +getZoomRatio(callback: AsyncCallback): void -Opens this camera. This API uses an asynchronous callback to return the result. +Obtains the zoom ratio in use. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | ---------------------- | ---- | ------------------------ | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -cameraInput.open((err) => { +cameraInput.getZoomRatio((err, zoomRatio) => { if (err) { - console.error(`Failed to open the camera. ${err.message}`); + console.error('Failed to get the zoom ratio ${err.message}'); return; } - console.log('Callback returned with camera opened.'); + console.log('Callback returned with current zoom ratio: ' + zoomRatio); }) ``` -### open +### getZoomRatio -open(): Promise +getZoomRatio(): Promise -Opens this camera. This API uses a promise to return the result. +Obtains the zoom ratio in use. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| +| Type | Description | +| ---------------- | --------------------------- | +| Promise | Promise used to return the zoom ratio.| **Example** ```js -cameraInput.open().then(() => { - console.log('Promise returned with camera opened.'); +cameraInput.getZoomRatio().then((zoomRatio) => { + console.log('Promise returned with current zoom ratio : ' + zoomRatio); }) ``` -### close +### release -close\(callback: AsyncCallback\): void +release\(callback: AsyncCallback\): void -Closes this camera. This API uses an asynchronous callback to return the result. +Releases this **CameraInput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -cameraInput.close((err) => { +cameraInput.release((err) => { if (err) { - console.error(`Failed to close the cameras. ${err.message}`); + console.error('Failed to release the CameraInput instance ${err.message}'); return; } - console.log('Callback returned with camera closed.'); -}) + console.log('Callback invoked to indicate that the CameraInput instance is released successfully.'); +}); ``` -### close +### release -close(): Promise +release(): Promise -Closes this camera. This API uses a promise to return the result. +Releases this **CameraInput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| -------------- | ----------------------- | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** ```js -cameraInput.close().then(() => { - console.log('Promise returned with camera closed.'); +cameraInput.release().then(() => { + console.log('Promise returned to indicate that the CameraInput instance is released successfully.'); }) ``` -### release +### on('focusStateChange') -release\(callback: AsyncCallback\): void +on(type: 'focusStateChange', callback: AsyncCallback): void -Releases this camera. This API uses an asynchronous callback to return the result. +Listens for focus state changes. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.release((err) => { - if (err) { - console.error(`Failed to release the CameraInput instance ${err.message}`); - return; - } - console.log('Callback invoked to indicate that the CameraInput instance is released successfully.'); -}); -``` - -### release - -release(): Promise - -Releases this camera. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------- | :--- | :------------------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'focusStateChange'**, indicating the focus state change event.| +| callback | AsyncCallback<[FocusState](#focusstate)\> | Yes | Callback used to return the focus state change. | **Example** ```js -cameraInput.release().then(() => { - console.log('Promise returned to indicate that the CameraInput instance is released successfully.'); +cameraInput.on('focusStateChange', (focusState) => { + console.log('Focus state : ' + focusState); }) ``` @@ -1234,42 +1032,37 @@ Listens for **CameraInput** errors. This API uses a callback to return the resul **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------------------- | ---- | ------------------------------------------- | +| Name | Type | Mandatory| Description | +| :------- | :------------------------------- | :--- | :----------------------------------------------- | | type | string | Yes | Event type. The value is fixed at **'error'**, indicating the camera input error event.| -| callback | ErrorCallback<[CameraInputError](#camerainputerror)\> | Yes | Callback used to return the result. | +| callback | ErrorCallback<[CameraInputError](#camerainputerror)\> | Yes | Callback used to return the result. | **Example** ```js cameraInput.on('error', (cameraInputError) => { - console.log(`Camera input error code: ${cameraInputError.code}`); + console.log('Camera input error code: ' + cameraInputError.code); }) ``` -## CameraInputErrorCode +## CameraInputErrorCode -Enumerates the error codes used for camera input. +Enumerates the error codes used in a **CameraInput** instance. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| ------------------------- | ---- | ---------- | -| ERROR_UNKNOWN | -1 | Unknown error.| -| ERROR_NO_PERMISSION | 0 | You do not have the required permission.| -| ERROR_DEVICE_PREEMPTED | 1 | The camera is preempted.| -| ERROR_DEVICE_DISCONNECTED | 2 | The camera is disconnected.| -| ERROR_DEVICE_IN_USE | 3 | The camera is in use.| -| ERROR_DRIVER_ERROR | 4 | Driver error. | +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## CameraInputError +## CameraInputError -Defines an error object used for **[CameraInput](#camerainput)**. +Defines a **CameraInput** error. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name| Type | Description | -| ---- | --------------------------------------------- | --------------------- | +| Name| Type | Description | +| ---- | ------------------------------------------- | -------------------------- | | code | [CameraInputErrorCode](#camerainputerrorcode) | **CameraInput** error code.| @@ -1279,37 +1072,25 @@ Enumerates the flash modes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| ---------------------- | ---- | ---------- | +| Name | Value | Description | +| ---------------------- | ---- | ------------ | | FLASH_MODE_CLOSE | 0 | The flash is off.| | FLASH_MODE_OPEN | 1 | The flash is on.| | FLASH_MODE_AUTO | 2 | The flash mode is auto, indicating that the flash fires automatically depending on the shooting conditions.| | FLASH_MODE_ALWAYS_OPEN | 3 | The flash is steady on.| -## ExposureMode - -Enumerates the exposure modes. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| ----------------------------- | ---- | ----------- | -| EXPOSURE_MODE_LOCKED | 0 | Exposure locked.| -| EXPOSURE_MODE_AUTO | 1 | Auto exposure.| -| EXPOSURE_MODE_CONTINUOUS_AUTO | 2 | Continuous auto exposure.| - ## FocusMode Enumerates the focus modes. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| -------------------------- | ---- | ------------ | +| Name | Value | Description | +| -------------------------- | ---- | ------------------ | | FOCUS_MODE_MANUAL | 0 | Manual focus. | | FOCUS_MODE_CONTINUOUS_AUTO | 1 | Continuous auto focus.| | FOCUS_MODE_AUTO | 2 | Auto focus. | -| FOCUS_MODE_LOCKED | 3 | Focus locked. | +| FOCUS_MODE_LOCKED | 3 | Focus locked. | ## FocusState @@ -1317,40 +1098,70 @@ Enumerates the focus states. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| --------------------- | ---- | --------- | -| FOCUS_STATE_SCAN | 0 | Focusing. | -| FOCUS_STATE_FOCUSED | 1 | Focused. | +| Name | Value | Description | +| --------------------- | ---- | ------------ | +| FOCUS_STATE_SCAN | 0 | Focusing. | +| FOCUS_STATE_FOCUSED | 1 | Focused.| | FOCUS_STATE_UNFOCUSED | 2 | Unfocused.| -## ExposureState +## camera.createCaptureSession + +createCaptureSession\(context: Context, callback: AsyncCallback\): void -Enumerates the exposure states. +Creates a **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| ------------------------- | ---- | -------- | -| EXPOSURE_STATE_SCAN | 0 | Exposing. | -| EXPOSURE_STATE_CONVERGED | 1 | Exposure converged.| +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------------- | ---- | -------------------------------------- | +| context | Context | Yes | Application context. | +| callback | AsyncCallback<[CaptureSession](#capturesession)\> | Yes | Callback used to return the **CaptureSession** instance.| + +**Example** + +```js +camera.createCaptureSession((context), (err, captureSession) => { + if (err) { + console.error('Failed to create the CaptureSession instance. ${err.message}'); + return; + } + console.log('Callback returned with the CaptureSession instance.' + captureSession); +}); +``` + +## camera.createCaptureSession -## VideoStabilizationMode +createCaptureSession(context: Context\): Promise; -Enumerates the video stabilization modes. +Creates a **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| --------- | ---- | ------------ | -| OFF | 0 | Video stabilization is disabled. | -| LOW | 1 | The basic video stabilization algorithm is used. | -| MIDDLE | 2 | A video stabilization algorithm with a stabilization effect better than that of the **LOW** type is used. | -| HIGH | 3 | A video stabilization algorithm with a stabilization effect better than that of the **MIDDLE** type is used. | -| AUTO | 4 | Automatic video stabilization is used. | +**Parameters** + +| Name | Type | Mandatory| Description | +| ------- | ------- | ---- | ------------ | +| context | Context | Yes | Application context.| + +**Return value** + +| Type | Description | +| ------------------------------------------- | ----------------------------------------- | +| Promise<[CaptureSession](#capturesession)\> | Promise used to return the **CaptureSession** instance.| + +**Example** + +```js +camera.createCaptureSession(context).then((captureSession) => { + console.log('Promise returned with the CaptureSession instance'); +}) +``` ## CaptureSession -Implements a shooting session, which saves all **[CameraInput](#camerainput)** and **[CameraOutput](#cameraoutput)** instances required to run the camera and requests the camera to complete shooting or video recording. +Implements a shooting session. ### beginConfig @@ -1362,8 +1173,8 @@ Starts configuration for this **CaptureSession** instance. This API uses an asyn **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result.| **Example** @@ -1371,7 +1182,7 @@ Starts configuration for this **CaptureSession** instance. This API uses an asyn ```js captureSession.beginConfig((err) => { if (err) { - console.error(`Failed to start the configuration. ${err.message}`); + console.error('Failed to start the configuration. ${err.message}'); return; } console.log('Callback invoked to indicate the begin config success.'); @@ -1388,8 +1199,8 @@ Starts configuration for this **CaptureSession** instance. This API uses a promi **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| @@ -1411,8 +1222,8 @@ Commits the configuration for this **CaptureSession** instance. This API uses an **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result.| **Example** @@ -1420,7 +1231,7 @@ Commits the configuration for this **CaptureSession** instance. This API uses an ```js captureSession.commitConfig((err) => { if (err) { - console.error(`Failed to commit the configuration. ${err.message}`); + console.error('Failed to commit the configuration. ${err.message}'); return; } console.log('Callback invoked to indicate the commit config success.'); @@ -1437,8 +1248,8 @@ Commits the configuration for this **CaptureSession** instance. This API uses a **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** @@ -1449,529 +1260,546 @@ captureSession.commitConfig().then(() => { }) ``` -### canAddInput +### addInput -canAddInput(cameraInput: CameraInput, callback: AsyncCallback): void +addInput\(cameraInput: CameraInput, callback: AsyncCallback\): void -Checks whether a **[CameraInput](#camerainput)** instance can be added to this **CaptureSession**. This API uses an asynchronous callback to return the result. +Adds a **CameraInput** instance to this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ------------------------ | +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | | cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to add.| -| callback | AsyncCallback | Yes | Callback used to return the result. | +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.canAddInput(cameraInput, (err, status) => { +captureSession.addInput(cameraInput, (err) => { if (err) { - console.error(`Can not add cameraInput. ${err.message}`); + console.error('Failed to add the CameraInput instance. ${err.message}'); return; } - console.log('Callback returned with cameraInput can added.'); -}) + console.log('Callback invoked to indicate that the CameraInput instance is added.'); +}); ``` -### canAddInput +### addInput -canAddInput(cameraInput: CameraInput): Promise +addInput\(cameraInput: CameraInput\): Promise -Checks whether a **[CameraInput](#camerainput)** instance can be added to this **CaptureSession**. This API uses a promise to return the result. +Adds a **CameraInput** instance to this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ------------------------ | +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | | cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to add.| **Return value** -| Type | Description | -| -------------- | -------------------------- | -| Promise | Promise used to return the result.| +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| **Example** ```js -captureSession.canAddInput(cameraInput).then(() => { - console.log('Promise returned with cameraInput can added.'); +captureSession.addInput(cameraInput).then(() => { + console.log('Promise used to indicate that the CameraInput instance is added.'); }) ``` -### addInput +### addOutput -addInput\(cameraInput: CameraInput, callback: AsyncCallback\): void +addOutput\(previewOutput: PreviewOutput, callback: AsyncCallback\): void -Adds a **[CameraInput](#camerainput)** instance to this **CaptureSession**. This API uses an asynchronous callback to return the result. +Adds a **PreviewOutput** instance to this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ------------------------ | -| cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to add.| -| callback | AsyncCallback | Yes | Callback used to return the result. | +| Name | Type | Mandatory| Description | +| ------------- | ------------------------------- | ---- | ----------------------------- | +| previewOutput | [PreviewOutput](#previewoutput) | Yes | **PreviewOutput** instance to add.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.addInput(cameraInput, (err) => { +captureSession.addOutput(previewOutput, (err) => { if (err) { - console.error(`Failed to add the CameraInput instance. ${err.message}`); + console.error('Failed to add the PreviewOutput instance ${err.message}'); return; } - console.log('Callback invoked to indicate that the CameraInput instance is added.'); + console.log('Callback invoked to indicate that the PreviewOutput instance is added.'); }); ``` -### addInput +### addOutput -addInput\(cameraInput: CameraInput\): Promise +addOutput\(previewOutput: PreviewOutput\): Promise -Adds a **[CameraInput](#camerainput)** instance to this **CaptureSession**. This API uses a promise to return the result. +Adds a **PreviewOutput** instance to this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ------------------------ | -| cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to add.| +| Name | Type | Mandatory| Description | +| ------------- | ------------------------------- | ---- | ----------------------------- | +| previewOutput | [PreviewOutput](#previewoutput) | Yes | **PreviewOutput** instance to add.| **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** ```js -captureSession.addInput(cameraInput).then(() => { - console.log('Promise used to indicate that the CameraInput instance is added.'); +captureSession.addOutput(previewOutput).then(() => { + console.log('Promise used to indicate that the PreviewOutput instance is added.'); }) ``` -### removeInput +### addOutput -removeInput\(cameraInput: CameraInput, callback: AsyncCallback\): void +addOutput\(photoOutput: PhotoOutput, callback: AsyncCallback\): void -Removes a **[CameraInput](#camerainput)** instance from this **CaptureSession**. This API uses an asynchronous callback to return the result. +Adds a **PhotoOutput** instance to this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ------------------------ | -| cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to remove.| +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| photoOutput | [PhotoOutput](#photooutput) | Yes | **PhotoOutput** instance to add.| | callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.removeInput(cameraInput, (err) => { +captureSession.addOutput(photoOutput, (err) => { if (err) { - console.error(`Failed to remove the CameraInput instance. ${err.message}`); + console.error('Failed to add the PhotoOutput instance ${err.message}'); return; } - console.log('Callback invoked to indicate that the cameraInput instance is removed.'); + console.log('Callback invoked to indicate that the PhotoOutput instance is added.'); }); ``` -### removeInput +### addOutput -removeInput\(cameraInput: CameraInput\): Promise +addOutput\(photoOutput: PhotoOutput\): Promise -Removes a **[CameraInput](#camerainput)** instance from this **CaptureSession**. This API uses a promise to return the result. +Adds a **PhotoOutput** instance to this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ----------- | --------------------------- | ---- | ------------------------ | -| cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to remove.| +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| photoOutput | [PhotoOutput](#photooutput) | Yes | **PhotoOutput** instance to add.| **Return value** -| Type | Description | -| -------------- | ------------------------- | -| Promise\ | Promise used to return the result.| +| Type | Description | +| -------------- | --------------------------- | +| Promise\ | Promise used to return the result.| **Example** ```js -captureSession.removeInput(cameraInput).then(() => { - console.log('Promise returned to indicate that the cameraInput instance is removed.'); +captureSession.addOutput(photoOutput).then(() => { + console.log('Promise used to indicate that the PhotoOutput instance is added.'); }) ``` -### canAddOutput +### addOutput -canAddOutput(cameraOutput: CameraOutput, callback: AsyncCallback\): void +addOutput\(videoOutput: VideoOutput, callback: AsyncCallback\): void -Checks whether a **[CameraOutput](#cameraoutput)** instance can be added to this **CaptureSession**. This API uses an asynchronous callback to return the result. +Adds a **VideoOutput** instance to this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ------------- | ------------------------------- | ---- | ------------------------- | -| cameraOutput | [CameraOutput](#cameraoutput) | Yes | **CameraOutput** instance to add.| -| callback | AsyncCallback | Yes | Callback used to return the result. | +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| videoOutput | [VideoOutput](#videooutput) | Yes | **VideoOutput** instance to add.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.canAddOutput(cameraOutput, (err, status) => { +captureSession.addOutput(videoOutput, (err) => { if (err) { - console.error(`Can not add cameraOutput. ${err.message}`); + console.error('Failed to add the VideoOutput instance ${err.message}'); return; } - console.log('Callback returned with cameraOutput can added.'); -}) + console.log('Callback invoked to indicate that the VideoOutput instance is added.'); +}); ``` -### canAddOutput +### addOutput -canAddOutput(cameraOutput: CameraOutput): Promise +addOutput\(videoOutput: VideoOutput\): Promise -Checks whether a **[CameraOutput](#cameraoutput)** instance can be added to this **CaptureSession**. This API uses a promise to return the result. +Adds a **VideoOutput** instance to this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ------------- | ------------------------------- | ---- | ------------------------- | -| cameraOutput | [CameraOutput](#cameraoutput) | Yes | **CameraOutput** instance to add.| - +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| videoOutput | [VideoOutput](#videooutput) | Yes | **VideoOutput** instance to add.| **Return value** -| Type | Description | +| Type | Description | | -------------- | --------------------------- | -| Promise | Promise used to return the result.| - +| Promise\ | Promise used to return the result.| **Example** ```js -captureSession.canAddOutput(cameraOutput).then(() => { - console.log('Promise returned with cameraOutput can added.'); +captureSession.addOutput(videoOutput).then(() => { + console.log('Promise used to indicate that the VideoOutput instance is added.'); }) ``` -### addOutput +### removeInput -addOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void +removeInput\(cameraInput: CameraInput, callback: AsyncCallback\): void -Adds a **[CameraOutput](#cameraoutput)** instance to this **CaptureSession**. This API uses an asynchronous callback to return the result. +Removes a **CameraInput** instance from this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ------------- | ------------------------------- | ---- | ------------------------ | -| cameraOutput | [CameraOutput](#cameraoutput) | Yes | **CameraOutput** instance to add.| -| callback | AsyncCallback | Yes | Callback used to return the result. | +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to remove.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.addOutput(cameraOutput, (err) => { +captureSession.removeInput(cameraInput, (err) => { if (err) { - console.error(`Failed to add output. ${err.message}`); + console.error('Failed to remove the CameraInput instance. ${err.message}'); return; } - console.log('Callback returned with output added.'); -}) + console.log('Callback invoked to indicate that the cameraInput instance is removed.'); +}); ``` -### addOutput +### removeInput -addOutput\(cameraOutput: CameraOutput\): Promise +removeInput\(cameraInput: CameraInput\): Promise -Adds a **[CameraOutput](#cameraoutput)** instance to this **CaptureSession**. This API uses a promise to return the result. +Removes a **CameraInput** instance from this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ------------- | ------------------------------- | ---- | ------------------------- | -| cameraOutput | [CameraOutput](#cameraoutput) | Yes | **CameraOutput** instance to add.| +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| cameraInput | [CameraInput](#camerainput) | Yes | **CameraInput** instance to remove.| **Return value** -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| +| Type | Description | +| -------------- | --------------------------- | +| Promise\ | Promise used to return the result.| **Example** ```js -captureSession.addOutput(cameraOutput).then(() => { - console.log('Promise returned with cameraOutput added.'); +captureSession.removeInput(cameraInput).then(() => { + console.log('Promise returned to indicate that the cameraInput instance is removed.'); }) ``` ### removeOutput -removeOutput\(cameraOutput: CameraOutput, callback: AsyncCallback\): void +removeOutput\(previewOutput: PreviewOutput, callback: AsyncCallback\): void -Removes a **[CameraOutput](#cameraoutput)** instance from this **CaptureSession**. This API uses an asynchronous callback to return the result. +Removes a **PreviewOutput** instance from this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ------------- | ------------------------------- | ---- | ------------------------ | -| cameraOutput | [CameraOutput](#cameraoutput) | Yes | **CameraOutput** instance to remove.| +| Name | Type | Mandatory| Description | +| ------------- | ------------------------------- | ---- | ----------------------------- | +| previewOutput | [PreviewOutput](#previewoutput) | Yes | **PreviewOutput** instance to remove.| | callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.removeOutput(cameraOutput, (err) => { +captureSession.removeOutput(previewOutput, (err) => { if (err) { - console.error(`Failed to remove the CameraOutput instance. ${err.message}`); + console.error('Failed to remove the PreviewOutput instance. ${err.message}'); return; } - console.log('Callback invoked to indicate that the CameraOutput instance is removed.'); + console.log('Callback invoked to indicate that the PreviewOutput instance is removed.'); }); ``` ### removeOutput -removeOutput(cameraOutput: CameraOutput): Promise +removeOutput(previewOutput: PreviewOutput): Promise -Removes a **[CameraOutput](#cameraoutput)** instance from this **CaptureSession**. This API uses a promise to return the result. +Removes a **PreviewOutput** instance from this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| ------------- | ------------------------------- | ---- | ------------------------- | -| cameraOutput | [CameraOutput](#cameraoutput) | Yes | **CameraOutput** instance to remove.| +| Name | Type | Mandatory| Description | +| ------------- | ------------------------------- | ---- | ----------------------------- | +| previewOutput | [PreviewOutput](#previewoutput) | Yes | **PreviewOutput** instance to remove.| **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** ```js -captureSession.removeOutput(cameraOutput).then(() => { - console.log('Promise returned to indicate that the CameraOutput instance is removed.'); +captureSession.removeOutput(previewOutput).then(() => { + console.log('Promise returned to indicate that the PreviewOutput instance is removed.'); }) ``` -### start +### removeOutput -start\(callback: AsyncCallback\): void +removeOutput(photoOutput: PhotoOutput, callback: AsyncCallback): void -Starts this **CaptureSession**. This API uses an asynchronous callback to return the result. +Removes a **PhotoOutput** instance from this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| photoOutput | [PhotoOutput](#photooutput) | Yes | **PhotoOutput** instance to remove.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.start((err) => { +captureSession.removeOutput(photoOutput, (err) => { if (err) { - console.error(`Failed to start the session ${err.message}`); + console.error('Failed to remove the PhotoOutput instance. ${err.message}'); return; } - console.log('Callback invoked to indicate the session start success.'); + console.log('Callback invoked to indicate that the PhotoOutput instance is removed.'); }); ``` -### start +### removeOutput -start\(\): Promise +removeOutput(photoOutput: PhotoOutput): Promise -Starts this **CaptureSession**. This API uses a promise to return the result. +Removes a **PhotoOutput** instance from this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core +**Parameters** + +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| photoOutput | [PhotoOutput](#photooutput) | Yes | **PhotoOutput** instance to remove.| + + **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| + **Example** ```js -captureSession.start().then(() => { - console.log('Promise returned to indicate the session start success.'); +captureSession.removeOutput(photoOutput).then(() => { + console.log('Promise returned to indicate that the PhotoOutput instance is removed.'); }) ``` -### stop +### removeOutput -stop\(callback: AsyncCallback\): void +removeOutput(videoOutput: VideoOutput, callback: AsyncCallback): void -Stops this **CaptureSession**. This API uses an asynchronous callback to return the result. +Removes a **VideoOutput** instance from this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| videoOutput | [VideoOutput](#videooutput) | Yes | **VideoOutput** instance to remove.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -captureSession.stop((err) => { +captureSession.removeOutput(videoOutput, (err) => { if (err) { - console.error(`Failed to stop the session ${err.message}`); + console.error('Failed to remove the VideoOutput instance. ${err.message}'); return; } - console.log('Callback invoked to indicate the session stop success.'); + console.log('Callback invoked to indicate that the VideoOutput instance is removed.'); }); ``` -### stop +### removeOutput -stop(): Promise +removeOutput(videoOutput: VideoOutput): Promise -Stops this **CaptureSession**. This API uses a promise to return the result. +Removes a **VideoOutput** instance from this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core +**Parameters** + +| Name | Type | Mandatory| Description | +| ----------- | --------------------------- | ---- | --------------------------- | +| videoOutput | [VideoOutput](#videooutput) | Yes | **VideoOutput** instance to remove.| + + **Return value** -| Type | Description | -| -------------- | ----------------------- | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| + **Example** ```js -captureSession.stop().then(() => { - console.log('Promise returned to indicate the session stop success.'); +captureSession.removeOutput(videoOutput).then(() => { + console.log('Promise returned to indicate that the VideoOutput instance is removed.'); }) ``` -### lockForControl +### start -lockForControl(callback: AsyncCallback): void +start\(callback: AsyncCallback\): void -Requests to exclusively control the hardware attributes **[CameraInput](#camerainput)** of the camera device. This API uses an asynchronous callback to return the result. After the exclusive control is complete, you must call **[unlockForControl](#unlockforcontrol)** to release the exclusive control. +Starts this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -captureSession.lockForControl((err) => { +captureSession.start((err) => { if (err) { - console.error(`Failed to lock. ${err.message}`); + console.error('Failed to start the session ${err.message}'); return; } - console.log('Locked.'); -}) + console.log('Callback invoked to indicate the session start success.'); +}); ``` -### lockForControl +### start -lockForControl(): Promise +start\(\): Promise -Requests to exclusively control the hardware attributes **[CameraInput](#camerainput)** of the camera device. This API uses a promise to return the result. After the exclusive control is complete, you must call **[unlockForControl](#unlockforcontrol)** to release the exclusive control. +Starts this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** ```js -captureSession.lockForControl().then(() => { - console.log('Locked.'); +captureSession.start().then(() => { + console.log('Promise returned to indicate the session start success.'); }) ``` -### unlockForControl +### stop -unlockForControl(callback: AsyncCallback): void +stop\(callback: AsyncCallback\): void -Releases the exclusive control on the device configuration. This API uses an asynchronous callback to return the result. +Stops this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | + +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -captureSession.unlockForControl((err) => { +captureSession.stop((err) => { if (err) { - console.error(`Failed to unlock. ${err.message}`); + console.error('Failed to stop the session ${err.message}'); return; } - console.log('Unlocked.'); -}) + console.log('Callback invoked to indicate the session stop success.'); +}); ``` -### unlockForControl +### stop -unlockForControl(): Promise +stop(): Promise -Releases the exclusive control on the device configuration. This API uses a promise to return the result. +Stops this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** ```js -captureSession.unlockForControl().then(() => { - console.log('Unlocked.'); +captureSession.stop().then(() => { + console.log('Promise returned to indicate the session stop success.'); }) ``` @@ -1979,14 +1807,14 @@ captureSession.unlockForControl().then(() => { release\(callback: AsyncCallback\): void -Releases this **CaptureSession**. This API uses an asynchronous callback to return the result. +Releases this **CaptureSession** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | | callback | AsyncCallback | Yes | Callback used to return the result.| **Example** @@ -1994,7 +1822,7 @@ Releases this **CaptureSession**. This API uses an asynchronous callback to retu ```js captureSession.release((err) => { if (err) { - console.error(`Failed to release the CaptureSession instance ${err.message}`); + console.error('Failed to release the CaptureSession instance ${err.message}'); return; } console.log('Callback invoked to indicate that the CaptureSession instance is released successfully.'); @@ -2005,14 +1833,14 @@ captureSession.release((err) => { release(): Promise -Releases this **CaptureSession**. This API uses a promise to return the result. +Releases this **CaptureSession** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** @@ -2023,2077 +1851,433 @@ captureSession.release().then(() => { }) ``` -### hasFlash +### on('error') -hasFlash(callback: AsyncCallback): void +on(type: 'error', callback: ErrorCallback): void -Checks whether the device has flash. This API uses an asynchronous callback to return the result. +Listens for **CaptureSession** errors. This API uses a callback to return the errors. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------- | ---- | -------------------------------- | -| callback | AsyncCallback | Yes | Callback used to return the flash support status. The value **true** means that the device has flash.| +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------------- | :--- | :-------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the capture session error event.| +| callback | ErrorCallback<[CaptureSessionError](#capturesessionerror)\> | Yes | Callback used to return the error information. | **Example** ```js -cameraInput.hasFlash((err, status) => { - if (err) { - console.error(`Failed to check whether the device has flash light. ${err.message}`); - return; - } - console.log(`Callback returned with flash light support status: ${status}`); +captureSession.on('error', (captureSessionError) => { + console.log('Capture session error code: ' + captureSessionError.code); }) ``` -### hasFlash - -hasFlash(): Promise +## CaptureSessionErrorCode -Checks whether the device has flash. This API uses a promise to return the result. +Enumerates the error codes used in a **CaptureSession** instance. **System capability**: SystemCapability.Multimedia.Camera.Core -**Return value** +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -| Type | Description | -| ----------------- | ----------------------------------------------- | -| Promise | Promise used to return the flash support status. The value **true** means that the device has flash.| +## CaptureSessionError -**Example** +Defines a **CaptureSession** error. -```js -cameraInput.hasFlash().then((status) => { - console.log(`Promise returned with the flash light support status: ${status}`); -}) -``` +**System capability**: SystemCapability.Multimedia.Camera.Core -### isFlashModeSupported +| Name| Type | Description | +| ---- | ------------------------------------------- | -------------------------- | +| code | [CaptureSessionError](#capturesessionerror) | **CaptureSession** error code.| -isFlashModeSupported(flashMode: FlashMode, callback: AsyncCallback): void +## camera.createPreviewOutput -Checks whether a specified flash mode is supported. This API uses an asynchronous callback to return the result. +createPreviewOutput(surfaceId: string, callback: AsyncCallback): void + +Creates a **PreviewOutput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| --------- | ----------------------- | ---- | --------------------------------- | -| flashMode | [FlashMode](#flashmode) | Yes | Flash mode. | -| callback | AsyncCallback | Yes | Callback used to return the flash mode support status. The value **true** means that the flash mode is supported, and **false** means the opposite.| +| Name | Type | Mandatory| Description | +| --------- | ----------------------------------------------- | ---- | ------------------------------------- | +| surfaceId | string | Yes | Surface ID, which is obtained from **XComponent**. | +| callback | AsyncCallback<[PreviewOutput](#previewoutput)\> | Yes | Callback used to return the **PreviewOutput** instance.| **Example** ```js -cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO, (err, status) => { +camera.createPreviewOutput(("surfaceId"), (err, previewOutput) => { if (err) { - console.error(`Failed to check whether the flash mode is supported. ${err.message}`); + console.error('Failed to create the PreviewOutput instance. ${err.message}'); return; } - console.log(`Callback returned with the flash mode support status: ${status}`); -}) + console.log('Callback returned with previewOutput instance'); +}); ``` -### isFlashModeSupported +## camera.createPreviewOutput -isFlashModeSupported(flashMode: FlashMode): Promise +createPreviewOutput(surfaceId: string): Promise\ -Checks whether a specified flash mode is supported. This API uses a promise to return the result. +Creates a **PreviewOutput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| --------- | ----------------------- | ---- | ------------- | -| flashMode | [FlashMode](#flashmode) | Yes | Flash mode.| +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | ---------------------------------- | +| surfaceId | string | Yes | Surface ID, which is obtained from **XComponent**.| **Return value** -| Type | Description | -| ----------------- | ---------------------------------------------------- | -| Promise | Promise used to return the flash mode support status. The value **true** means that the flash mode is supported, and **false** means the opposite.| +| Type | Description | +| ----------------------------------------- | --------------------------- | +| Promise<[PreviewOutput](#previewoutput)\> | Promise used to return the result.| **Example** ```js -cameraInput.isFlashModeSupported(camera.FlashMode.FLASH_MODE_AUTO).then((status) => { - console.log(`Promise returned with flash mode support status.${status}`); +camera.createPreviewOutput("surfaceId").then((previewOutput) => { + console.log('Promise returned with the PreviewOutput instance'); }) ``` -### setFlashMode +## PreviewOutput -setFlashMode(flashMode: FlashMode, callback: AsyncCallback): void +Implements preview output. -Sets the flash mode. This API uses an asynchronous callback to return the result. +### release -Before the setting, do the following checks: +release(callback: AsyncCallback): void -1. Use **[hasFlash](#hasflash)** to check whether the device has flash. -2. Use **[isFlashModeSupported](#isflashmodesupported)** to check whether the device supports the flash mode. +Releases this **PreviewOutput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| --------- | ----------------------- | ---- | --------------------- | -| flashMode | [FlashMode](#flashmode) | Yes | Flash mode. | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO, (err) => { +previewOutput.release((err) => { if (err) { - console.error(`Failed to set the flash mode ${err.message}`); + console.error('Failed to release the PreviewOutput instance ${err.message}'); return; } - console.log('Callback returned with the successful execution of setFlashMode.'); -}) + console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.'); +}); ``` -### setFlashMode - -setFlashMode(flashMode: FlashMode): Promise - -Sets a flash mode. This API uses a promise to return the result. +### release -Before the setting, do the following checks: +release(): Promise -1. Use **[hasFlash](#hasflash)** to check whether the device has flash. -2. Use **[isFlashModeSupported](#isflashmodesupported)** to check whether the device supports the flash mode. +Releases this **PreviewOutput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Type | Mandatory| Description | -| --------- | ----------------------- | ---- | ------------- | -| flashMode | [FlashMode](#flashmode) | Yes | Flash mode.| - **Return value** -| Type | Description | -| -------------- | ------------------------ | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| + **Example** ```js -cameraInput.setFlashMode(camera.FlashMode.FLASH_MODE_AUTO).then(() => { - console.log('Promise returned with the successful execution of setFlashMode.'); +previewOutput.release().then(() => { + console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); }) ``` -### getFlashMode +### on('frameStart') -getFlashMode(callback: AsyncCallback): void +on(type: 'frameStart', callback: AsyncCallback): void -Obtains the flash mode in use. This API uses an asynchronous callback to return the result. +Listens for preview frame start events. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | --------------------------------- | -| callback | AsyncCallback<[FlashMode](#flashmode)\> | Yes | Callback used to return the flash mode.| +| Name | Type | Mandatory| Description | +| :------- | :------------------- | :--- | :------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'frameStart'**, indicating the preview frame start event.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -cameraInput.getFlashMode((err, flashMode) => { - if (err) { - console.error(`Failed to get the flash mode ${err.message}`); - return; - } - console.log(`Callback returned with current flash mode: ${flashMode}`); +previewOutput.on('frameStart', () => { + console.log('Preview frame started'); }) ``` -### getFlashMode +### on('frameEnd') -getFlashMode(): Promise +on(type: 'frameEnd', callback: AsyncCallback): void -Obtains the flash mode in use. This API uses a promise to return the result. +Listens for preview frame end events. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Return value** +**Parameters** -| Type | Description | -| --------------------------------- | --------------------------------- | -| Promise<[FlashMode](#flashmode)\> | Promise used to return the flash mode.| +| Name | Type | Mandatory| Description | +| :------- | :------------------- | :--- | :----------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'frameEnd'**, indicating the preview frame end event.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -cameraInput.getFlashMode().then((flashMode) => { - console.log(`Promise returned with current flash mode : ${flashMode}`); +previewOutput.on('frameEnd', () => { + console.log('Preview frame ended'); }) ``` -### isExposureModeSupported +### on('error') -isExposureModeSupported(aeMode: ExposureMode, callback: AsyncCallback): void; +on(type: 'error', callback: ErrorCallback): void -Checks whether a specified exposure mode is supported. This API uses an asynchronous callback to return the result. +Listens for **PreviewOutput** errors. This API uses a callback to return the errors. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory | Description | -| -------- | -------------------------------| ---- | ----------------------------- | -| aeMode | [ExposureMode](#exposuremode) | Yes | Exposure mode. | -| callback | AsyncCallback | Yes | Callback used to return the exposure mode support status. The value **true** means that the exposure mode is supported, and **false** means the opposite.| +| Name | Type | Mandatory| Description | +| :------- | :----------------------------------------------------------- | :--- | :-------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the preview output error event.| +| callback | ErrorCallback<[PreviewOutputErrorCode](#previewoutputerrorcode)\> | Yes | Callback used to return the error information. | **Example** ```js -cameraInput.isExposureModeSupported(camera.ExposureMode.EXPOSURE_MODE_LOCKEN,(err) => { - if (err) { - console.log(`Failed to check exposure mode supported ${err.message}`); - return ; - } - console.log('Callback returned with the successful excution of isExposureModeSupported'); +previewOutput.on('error', (previewOutputError) => { + console.log('Preview output error code: ' + previewOutputError.code); }) ``` -### isExposureModeSupported - -isExposureModeSupported(aeMode: ExposureMode): Promise +## PreviewOutputErrorCode -Checks whether a specified exposure mode is supported. This API uses a promise to return the result. +Enumerates the error codes used in a **PreviewOutput** instance. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** - -| Name | Type | Mandatory | Description | -| -------- | -------------------------------| ---- | ----------------------------- | -| aeMode | [ExposureMode](#exposuremode) | Yes | Exposure mode. | +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -**Return value** +## PreviewOutputError -| Name | Description | -| ----------------- |--------------------------------- | -| Promise | Promise used to return the exposure mode support status. The value **true** means that the exposure mode is supported, and **false** means the opposite.| +Defines a **PreviewOutput** error. -**Example** +**System capability**: SystemCapability.Multimedia.Camera.Core -```js -cameraInput.isExposureModeSupported(camera.ExposureMode.EXPOSURE_MODE_LOCKED).then((isSupported) => { - console.log(`Promise returned with exposure mode supported : ${isSupported}`); -}) -``` +| Name| Type | Description | +| ---- | ------------------------------------------------- | ---------------------- | +| code | [PreviewOutputErrorCode](#previewoutputerrorcode) | **PreviewOutput** error code.| -### getExposureMode +## camera.createPhotoOutput -getExposureMode(callback: AsyncCallback): void +createPhotoOutput(surfaceId: string, callback: AsyncCallback): void -Obtains the exposure mode in use. This API uses an asynchronous callback to return the result. +Creates a **PhotoOutput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------------------| ---- | ---------------------------------------- | -| callback | AsyncCallback<[ExposureMode](#exposuremode)\> | Yes | Callback used to return the exposure mode.| +| Name | Type | Mandatory| Description | +| --------- | ------------------------------------------- | ---- | ----------------------------------- | +| surfaceId | string | Yes | Surface ID, which is obtained from **[ImageReceiver](js-apis-image.md#imagereceiver9)**. | +| callback | AsyncCallback<[PhotoOutput](#photooutput)\> | Yes | Callback used to return the **PhotoOutput** instance.| **Example** ```js -cameraInput.getExposureMode((err, exposureMode) => { +camera.createPhotoOutput(("surfaceId"), (err, photoOutput) => { if (err) { - console.log(`Failed to get the exposure mode ${err.message}`); - return ; + console.error('Failed to create the PhotoOutput instance. ${err.message}'); + return; } - console.log(`Callback returned with current exposure mode: ${exposureMode}`); -}) + console.log('Callback returned with the PhotoOutput instance.'); +}); ``` -### getExposureMode +## camera.createPhotoOutput -getExposureMode(): Promise +createPhotoOutput(surfaceId: string): Promise -Obtains the exposure mode in use. This API uses a promise to return the result. +Creates a **PhotoOutput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core +**Parameters** + +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | --------------------------------- | +| surfaceId | string | Yes | Surface ID, which is obtained from **[ImageReceiver](js-apis-image.md#imagereceiver9)**.| + **Return value** -| Name | Description | -| --------------------------------------- |------------------------------- | -| Promise<[ExposureMode](#exposuremode)\> | Promise used to return the exposure mode.| +| Type | Description | +| ------------------------------------- | -------------------------------------- | +| Promise<[PhotoOutput](#photooutput)\> | Promise used to return the **PhotoOutput** instance.| **Example** ```js -cameraInput.getExposureMode().then((exposureMode) => { - console.log(`Promise returned with current exposure mode : ${exposureMode}`); +camera.createPhotoOutput("surfaceId").then((photoOutput) => { + console.log('Promise returned with PhotoOutput instance'); }) ``` +## ImageRotation -### setExposureMode - -setExposureMode(aeMode: ExposureMode, callback: AsyncCallback): void - -Sets an exposure mode. This API uses an asynchronous callback to return the result. +Enumerates the image rotation angles. **System capability**: SystemCapability.Multimedia.Camera.Core -**Parameters** +| Name | Value | Description | +| ------------ | ---- | --------------- | +| ROTATION_0 | 0 | The image rotates 0 degrees. | +| ROTATION_90 | 90 | The image rotates 90 degrees. | +| ROTATION_180 | 180 | The image rotates 180 degrees.| +| ROTATION_270 | 270 | The image rotates 270 degrees.| -| Name | Type | Mandatory| Description | -| -------- | -------------------------------| ---- | ----------------------- | -| aeMode | [ExposureMode](#exposuremode) | Yes | Exposure mode. | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.setExposureMode(camera.ExposureMode.EXPOSURE_MODE_LOCKEN,(err) => { - if (err) { - console.log(`Failed to set the exposure mode ${err.message}`); - return ; - } - console.log('Callback returned with the successful excution of setExposureMode'); -}) -``` - -### setExposureMode - -setExposureMode(aeMode: ExposureMode): Promise - -Sets an exposure mode. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Name | Description | -| ----------------- |---------------------------- | -| Promise | Promise used to return the result.| - -**Example** - -```js -cameraInput.setExposureMode(camera.ExposureMode.EXPOSURE_MODE_LOCKED).then(() => { - console.log('Promise returned with the successful execution of setExposureMode.'); -}) -``` - -### getMeteringPoint - -getMeteringPoint(callback: AsyncCallback): void - -Obtains the center of the metering area. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------------------| ---- | ------------------------ | -| callback | AsyncCallback<[Point](#point)\>| Yes | Callback used to return the center of the metering area.| - -**Example** - -```js -cameraInput.getMeteringPoint((err, exposurePoint) => { - if (err) { - console.log(`Failed to get the current exposure point ${err.message}`); - return ; - } - console.log(`Callback returned with current exposure point: ${exposurePoint}`); -}) -``` - -### getMeteringPoint - -getMeteringPoint(): Promise - -Obtains the center of the metering area. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Name | Description | -| ------------------------- |----------------------------- | -| Promise<[Point](#point)\> | Promise used to return the center of the metering area.| - -**Example** - -```js -cameraInput.getMeteringPoint().then((exposurePoint) => { - console.log(`Promise returned with current exposure point : ${exposurePoint}`); -}) -``` - -### setMeteringPoint - -setMeteringPoint(point: Point, callback: AsyncCallback): void - -Sets the center of the metering area. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------------- | -------------------------------| ---- | ------------------- | -| exposurePoint | [Point](#point) | Yes | Exposure point. | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -const Point1 = {x: 1, y: 1}; - -cameraInput.setMeteringPoint(Point1,(err) => { - if (err) { - console.log(`Failed to set the exposure point ${err.message}`); - return ; - } - console.log('Callback returned with the successful excution of setMeteringPoint'); -}) -``` - -### setMeteringPoint - -setMeteringPoint(point: Point): Promise - -Sets the center of the metering area. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------------- | -------------------------------| ---- | ------------------- | -| exposurePoint | [Point](#point) | Yes | Exposure point. | - -**Return value** - -| Name | Description | -| ----------------- |------------------------ | -| Promise | Promise used to return the center of the metering area.| - -**Example** - -```js -const Point2 = {x: 2, y: 2}; - -cameraInput.setMeteringPoint(Point2).then(() => { - console.log('Promise returned with the successful execution of setMeteringPoint'); -}) -``` - -### getExposureBiasRange - -getExposureBiasRange(callback: AsyncCallback\>): void - -Obtains the exposure compensation values. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------------------| ---- | ----------------------------- | -| callback | AsyncCallback\> | Yes | Callback used to return the array of compensation values.| - -**Example** - -```js -cameraInput.getExposureBiasRange((err, biasRangeArray) => { - if (err) { - console.log(`Failed to get the array of compenstation range ${err.message}`); - return ; - } - console.log('Callback returned with the array of compenstation range: ' + JSON.stringify(biasRangeArray)); -}) -``` - -### getExposureBiasRange - -getExposureBiasRange(): Promise\> - -Obtains the exposure compensation values. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Name | Description | -| ----------------- |-------------------------------------- | -| Promise\> | Promise used to return the array of compensation values.| - -**Example** - -```js -cameraInput.isExposureModeSupported(camera.ExposureMode.EXPOSURE_MODE_LOCKED).then((isSupported) => { - console.log(`Promise returned with exposure mode supported : ${isSupported}`); -}) -``` - -### setExposureBias - -setExposureBias(exposureBias: number, callback: AsyncCallback): void - -Sets an exposure compensation value. This API uses an asynchronous callback to return the result. - -Before the setting, you are advised to use **[getExposureBiasRange](#getexposurebiasrange)** to obtain the supported values. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------------------| ---- | ------------------- | -| exposureBias | number | Yes | Compensation value. | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.setExposureBias(-4,(err) => { - if (err) { - console.log(`Failed to set the exposure bias ${err.message}`); - return ; - } - console.log('Callback returned with the successful excution of setExposureBias'); -}) -``` - -### setExposureBias - -setExposureBias(exposureBias: number): Promise - -Sets an exposure compensation value. This API uses a promise to return the result. - -Before the setting, you are advised to use **[getExposureBiasRange](#getexposurebiasrange)** to obtain the supported values. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------------- | --------- | ---- | --------- | -| exposureBias | number | Yes | Compensation value. | - -**Return value** - -| Name | Description | -| ----------------- |------------------------- | -| Promise | Promise used to return the result.| - -**Example** - -```js -cameraInput.setExposureBias(-4).then(() => { - console.log('Promise returned with the successful execution of setExposureBias.'); -}) -``` - -### getExposureValue - -getExposureValue(callback: AsyncCallback): void - -Obtains the exposure value in use. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------| ---- | --------------------- | -| callback | AsyncCallback | Yes | Callback used to the exposure value.| - -**Example** - -```js -cameraInput.getExposureValue((err, exposureValue) => { - if (err) { - console.log(`Failed to get the exposure value ${err.message}`); - return ; - } - console.log(`Callback returned with the exposure value: ${exposureValue}`); -}) -``` - -### getExposureValue - -getExposureValue(): Promise - -Obtains the exposure value in use. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Name | Description | -| ----------------- |-------------------------- | -| Promise | Promise used to the exposure value.| - -**Example** - -```js -cameraInput.getExposureValue().then((exposureValue) => { - console.log(`Promise returned with exposure value: ${exposureValude}`); -}) -``` - -### isFocusModeSupported - -isFocusModeSupported(afMode: FocusMode, callback: AsyncCallback): void - -Checks whether a specified focus mode is supported. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------- | ---- | -------------------------------- | -| afMode | [FocusMode](#focusmode) | Yes | Focus mode. | -| callback | AsyncCallback | Yes | Callback used to return the focus mode support status. The value **true** means that the focus mode is supported, and **false** means the opposite.| - -**Example** - -```js -cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO, (err, status) => { - if (err) { - console.error(`Failed to check whether the focus mode is supported. ${err.message}`); - return; - } - console.log(`Callback returned with the focus mode support status: ${status}`); -}) -``` - -### isFocusModeSupported - -isFocusModeSupported(afMode: FocusMode): Promise - -Checks whether a specified focus mode is supported. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------ | ----------------------- | ---- | ------------- | -| afMode | [FocusMode](#focusmode) | Yes | Focus mode.| - -**Return value** - -| Type | Description | -| ----------------- | --------------------------------------------------- | -| Promise | Promise used to return the focus mode support status. The value **true** means that the focus mode is supported, and **false** means the opposite.| - -**Example** - -```js -cameraInput.isFocusModeSupported(camera.FocusMode.FOCUS_MODE_AUTO).then((status) => { - console.log(`Promise returned with focus mode support status ${status}.`); -}) -``` - -### setFocusMode - -setFocusMode(afMode: FocusMode, callback: AsyncCallback): void - -Sets a focus mode. This API uses an asynchronous callback to return the result. - -Before the setting, use **[isFocusModeSupported](#isfocusmodesupported)** to check whether the focus mode is supported. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------- | ---- | ------------------- | -| afMode | [FocusMode](#focusmode) | Yes | Focus mode. | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO, (err) => { - if (err) { - console.error(`Failed to set the focus mode ${err.message}`); - return; - } - console.log('Callback returned with the successful execution of setFocusMode.'); -}) -``` - -### setFocusMode - -setFocusMode(afMode: FocusMode): Promise - -Sets a focus mode. This API uses a promise to return the result. - -Before the setting, use **[isFocusModeSupported](#isfocusmodesupported)** to check whether the focus mode is supported. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------ | ----------------------- | ---- | ------------- | -| afMode | [FocusMode](#focusmode) | Yes | Focus mode.| - -**Return value** - -| Type | Description | -| -------------- | ------------------------ | -| Promise| Promise used to return the result.| - -**Example** - -```js -cameraInput.setFocusMode(camera.FocusMode.FOCUS_MODE_AUTO).then(() => { - console.log('Promise returned with the successful execution of setFocusMode.'); -}) -``` - -### getFocusMode - -getFocusMode(callback: AsyncCallback): void - -Obtains the focus mode in use. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ------------------------------- | -| callback | AsyncCallback<[FocusMode](#focusmode)\> | Yes | Callback used to return the focus mode.| - -**Example** - -```js -cameraInput.getFocusMode((err, afMode) => { - if (err) { - console.error(`Failed to get the focus mode ${err.message}`); - return; - } - console.log(`Callback returned with current focus mode: ${afMode}`); -}) -``` - -### getFocusMode - -getFocusMode(): Promise - -Obtains the focus mode in use. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ------------------- | -------------------------------- | -| Promise | Promise used to return the focus mode.| - -**Example** - -```js -cameraInput.getFocusMode().then((afMode) => { - console.log(`Promise returned with current focus mode : ${afMode}`); -}) -``` - -### setFocusPoint - -setFocusPoint(point: Point, callback: AsyncCallback): void - -Sets a focus point. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------- | ---- | ------------------- | -| point | [Point](#point) | Yes | Focus point. | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -const Point1 = {x: 1, y: 1}; - -cameraInput.setFocusPoint(Point1, (err) => { - if (err) { - console.error(`Failed to set the focus point ${err.message}`); - return; - } - console.log('Callback returned with the successful execution of setFocusPoint.'); -}) -``` - -### setFocusPoint - -setFocusPoint(point: Point): Promise - -Sets a focal point. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------- | ---- | ------------------- | -| point | [Point](#point) | Yes | Focal point. | - -**Return value** - -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| - -**Example** - -```js -const Point2 = {x: 2, y: 2}; - -cameraInput.setFocusPoint(Point2).then(() => { - console.log('Promise returned with the successful execution of setFocusPoint.'); -}) -``` - -### getFocusPoint - -getFocusPoint(callback: AsyncCallback): void - -Obtains the focal point. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------------------- | ---- | ----------------------- | -| callback | AsyncCallback<[Point](#point)\> | Yes | Callback used to return the focal point.| - -**Example** - -```js -cameraInput.getFocusPoint((err, point) => { - if (err) { - console.error(`Failed to get the current focus point ${err.message}`); - return; - } - console.log('Callback returned with the current focus point: ' + JSON.stringify(point)); -}) -``` - -### getFocusPoint - -getFocusPoint(): Promise - -Obtains the focal point. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| --------------- | --------------------------- | -| Promise | Promise used to return the focal point.| - -**Example** - -```js -cameraInput.getFocusPoint().then((point) => { - console.log('Promise returned with the current focus point: ' + JSON.stringify(point)); -}) -``` - -### getFocalLength - -getFocalLength(callback: AsyncCallback): void - -Obtains the focal length. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------- | ---- | ----------------------- | -| callback | AsyncCallback | Yes | Callback used to return the focal length.| - -**Example** - -```js -cameraInput.getFocalLength((err, focalLength) => { - if (err) { - console.error(`Failed to get the current focal length ${err.message}`); - return; - } - console.log(`Callback returned with the current focal length: ${focalLength}`); -}) -``` - -### getFocalLength - -getFocalLength(): Promise - -Obtains the focal length. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ---------------- | ----------------------- | -| Promise | Promise used to return the focal length.| - -**Example** - -```js -cameraInput.getFocalLength().then((focalLength) => { - console.log(`Promise returned with the current focal length: ${focalLength}`); -}) -``` - -### getZoomRatioRange - -getZoomRatioRange\(callback: AsyncCallback\>\): void - -Obtains the zoom ratio range. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------ | ---- | ------------------- | -| callback | AsyncCallback\> | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.getZoomRatioRange((err, zoomRatioRange) => { - if (err) { - console.error(`Failed to get the zoom ratio range. ${err.message}`); - return; - } - console.log(`Callback returned with zoom ratio range: ${zoomRatioRange.length}`); -}) -``` - -### getZoomRatioRange - -getZoomRatioRange\(\): Promise\> - -Obtains the zoom ratio range. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ------------------------ | --------------------------- | -| Promise\> | Promise used to return the zoom ratio range.| - -**Example** - -```js -cameraInput.getZoomRatioRange().then((zoomRatioRange) => { - console.log(`Promise returned with zoom ratio range: ${zoomRatioRange.length}`); -}) -``` - -### setZoomRatio - -setZoomRatio(zoomRatio: number, callback: AsyncCallback): void - -Sets a zoom ratio. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| --------- | -------------------- | ---- | ------------------- | -| zoomRatio | number | Yes | Zoom ratio. | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.setZoomRatio(1, (err) => { - if (err) { - console.error(`Failed to set the zoom ratio value ${err.message}`); - return; - } - console.log('Callback returned with the successful execution of setZoomRatio.'); -}) -``` - -### setZoomRatio - -setZoomRatio(zoomRatio: number): Promise - -Sets a zoom ratio. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| --------- | ------ | ---- | --------- | -| zoomRatio | number | Yes | Zoom ratio.| - -**Return value** - -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| - -**Example** - -```js -cameraInput.setZoomRatio(1).then(() => { - console.log('Promise returned with the successful execution of setZoomRatio.'); -}) -``` - -### getZoomRatio - -getZoomRatio(callback: AsyncCallback): void - -Obtains the zoom ratio in use. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -cameraInput.getZoomRatio((err, zoomRatio) => { - if (err) { - console.error(`Failed to get the zoom ratio ${err.message}`); - return; - } - console.log(`Callback returned with current zoom ratio: ${zoomRatio}`); -}) -``` - -### getZoomRatio - -getZoomRatio(): Promise - -Obtains the zoom ratio in use. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ---------------- | ----------------------- | -| Promise | Promise used to return the zoom ratio.| - -**Example** - -```js -cameraInput.getZoomRatio().then((zoomRatio) => { - console.log(`Promise returned with current zoom ratio : ${zoomRatio}`); -}) -``` - -### isVideoStablizationModeSupported - -isVideoStablizationModeSupported(vsMode: VideoStabilizationMode, callback: AsyncCallback): void - -Checks whether the specified video stabilization mode is supported. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------- | ---- | ------------------------------ | -| vsMode | [VideoStabilizationMode](#videostabilizationmode) | Yes | Video stabilization mode. | -| callback | AsyncCallback | Yes | Callback used to return whether the video stabilization mode is supported. The value **true** means that the video stabilization mode is supported, and **false** means the opposite. | - -**Example** - -```js -captureSession.isVideoStablizationModeSupported(camera.VideoStabilizationMode.OFF, (err, isSupported) => { - if (err) { - console.error(`Failed to check whether video stabilization mode supported. ${err.message}`); - return; - } - console.log(`Callback returned with the successful execution of isVideoStabilizationModeSupported: ${status}`); -}) -``` - -### isVideoStablizationModeSupported - -isVideoStablizationModeSupported(vsMode: VideoStabilizationMode): Promise - -Checks whether the specified video stabilization mode is supported. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ----------------- | --------------------------------------------- | -| Promise | Promise used to return whether the video stabilization mode is supported. The value **true** means that the video stabilization mode is supported, and **false** means the opposite.| - -**Example** - -```js -captureSession.isVideoStablizationModeSupported(camera.VideoStabilizationMode.OFF).then((isSupported) => { - console.log(`Promise returned with video stabilization mode supported: ${isSupported}`); -}) -``` - -### getActiveVideoStabilizationMode - -getActiveVideoStabilizationMode(callback: AsyncCallback): void - -Obtains the video stabilization mode in use. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------- | ---- | ------------------------------ | -| callback | AsyncCallback | Yes | Callback used to return the video stabilization mode. | - -**Example** - -```js -captureSession.getActiveVideoStabilizationMode((err, vsMode) => { - if (err) { - console.error(`Failed to get active video stabilization mode ${err.message}`); - return; - } - console.log('Callback returned with the successful execution of getActiveVideoStabilizationMode.'); -}) -``` - -### getActiveVideoStabilizationMode - -getActiveVideoStabilizationMode(): Promise - -Obtains the video stabilization mode in use. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| -------------------------------- | ------------------------------------------------- | -| Promise | Promise used to return the video stabilization mode. | - -**Example** - -```js -captureSession.getActiveVideoStabilizationMode().then((vsMode) => { - console.log(`Promise returned with the current video stabilization mode: ${vsMode}`); -}) -``` - -### setVideoStabilizationMode - -setVideoStabilizationMode(mode: VideoStabilizationMode, callback: AsyncCallback): void - -Sets a video stabilization mode. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------- | ---- | --------------------- | -| mode | [VideoStabilizationMode](#videostabilizationmode) | Yes | Video stabilization mode. | -| callback | AsyncCallback | Yes | Callback used to return the result. | - -**Example** - -```js -captureSession.setVideoStabilizationMode(camera.VideoStabilizationMode.OFF, (err) => { - if (err) { - console.error(`Failed to set the video stabilization mode ${err.message}`); - return; - } - console.log('Callback returned with the successful execution of setVideoStabilizationMode.'); -}) -``` - -### setVideoStabilizationMode - -setVideoStabilizationMode(mode: VideoStabilizationMode): Promise - -Sets a video stabilization mode. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------- | ---- | --------------------- | -| mode | [VideoStabilizationMode](#videostabilizationmode) | Yes | Video stabilization mode. | - -**Return value** - -| Type | Description | -| -------------- | ------------------------------------------------- | -| Promise| Promise used to return the result. | - -**Example** - -```js -captureSession.setVideoStabilizationMode(camera.VideoStabilizationMode.OFF).then(() => { - console.log('Promise returned with the successful execution of setVideoStabilizationMode.'); -}) -``` - -### on('focusStateChange') - -on(type: 'focusStateChange', callback: AsyncCallback): void - -Listens for focus state changes. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------- | ---- | ------------------------ | -| type | string | Yes | Event type. The value is fixed at **'focusStateChange'**, indicating the focus state change event.| -| callback | AsyncCallback<[FocusState](#focusstate)\> | Yes | Callback used to return the focus state change. | - -**Example** - -```js -cameraInput.on('focusStateChange', (focusState) => { - console.log(`Focus state : ${focusState}`); -}) -``` - -### on('exposureStateChange') - -on(type: 'exposureStateChange', callback: AsyncCallback): void - -Listens for exposure state changes. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------- | ---- | ---------------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'exposureStateChange'**, indicating the exposure state change event.| -| callback | AsyncCallback<[ExposureState](#exposurestate)\> | Yes | Callback used to return the exposure state change. | - -**Example** - -```js -cameraInput.on('exposureStateChange', (exposureState) => { - console.log(`Exposuer state : ${exposureState}`); -}) -``` - -### on('error') - -on(type: 'error', callback: ErrorCallback): void - -Listens for **CaptureSession** errors. This API uses a callback to return the errors. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------------- | ---- | ------------------------------ | -| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the capture session error event.| -| callback | ErrorCallback<[CaptureSessionError](#capturesessionerror)\> | Yes | Callback used to return the error information. | - -**Example** - -```js -captureSession.on('error', (captureSessionError) => { - console.log(`Capture session error code: ${captureSessionError.code}`); -}) -``` - -## CaptureSessionErrorCode - -Enumerates the error codes used in a **CaptureSession**. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| ----------------------------- | ---- | -------- | -| ERROR_UNKNOWN | -1 | Unknown error.| -| ERROR_INSUFFICIENT_RESOURCES | 0 | Insufficient resources.| -| ERROR_TIMEOUT | 1 | Timeout.| - -## CaptureSessionError - -Defines a **CaptureSession** error. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name| Type | Description | -| ---- | ------------------------------------------- | -------------------------- | -| code | [CaptureSessionError](#capturesessionerror) | **CaptureSession** error code.| - -## CameraOutput - -Implements output information used in a **[CaptureSession](#capturesession)**. It is the base class of **output**. - -### release - -release(callback: AsyncCallback): void - -Releases output resources. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -previewOutput.release((err) => { - if (err) { - console.error(`Failed to release the PreviewOutput instance ${err.message}`); - return; - } - console.log('Callback invoked to indicate that the PreviewOutput instance is released successfully.'); -}); -``` - -### release - -release(): Promise - -Releases output resources. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| - -**Example** - -```js -previewOutput.release().then(() => { - console.log('Promise returned to indicate that the PreviewOutput instance is released successfully.'); -}) -``` - -## PreviewOutput - -Implements preview output. It inherits **[CameraOutput](#cameraoutput)**. - -### addDeferredSurface - -addDeferredSurface(surfaceId: string, callback: AsyncCallback): void - -Adds a surface after a **PreviewOutput** instance is created. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------------------------------------------------------- | -| surfaceId| string | Yes | Surface ID, which is obtained from **[XComponent](../arkui-ts/ts-basic-components-xcomponent.md)**.| -| callback | AsyncCallback | Yes | Callback used to return the result. | - -**Example** - -```js -previewOutput.addDeferredSurface('surfaceId', (err) => { - if (err) { - console.error(`Failed to add deferredSurface. ${err.message}`); - return; - } - console.log('Callback returned with deferredSurface added.'); -}) -``` - -### addDeferredSurface - -addDeferredSurface(surfaceId: string): Promise - -Adds a surface after a **PreviewOutput** instance is created. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -----------| ---- | ------------------------------------------------------------------------------ | -| surfaceId| string | Yes | Surface ID, which is obtained from **[XComponent](../arkui-ts/ts-basic-components-xcomponent.md)**.| - -**Return value** - -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| - -**Example** - -```js -previewOutput.addDeferredSurface('surfaceId').then(() => { - console.log('Promise returned with deferredSurface added.'); -}) -``` - -### start - -start(callback: AsyncCallback): void - -Starts to output preview streams. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -previewOutput.start((err) => { - if (err) { - console.error(`Failed to start the previewOutput. ${err.message}`); - return; - } - console.log('Callback returned with previewOutput started.'); -}) -``` - -### start - -start(): Promise - -Starts to output preview streams. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| -------------- | ----------------------- | -| Promise| Promise used to return the result.| - -**Example** - -```js -previewOutput.start().then(() => { - console.log('Promise returned with previewOutput started.'); -}) -``` - -### stop - -stop(callback: AsyncCallback): void - -Stops outputting preview streams. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -previewOutput.stop((err) => { - if (err) { - console.error(`Failed to stop the previewOutput. ${err.message}`); - return; - } - console.log('Callback returned with previewOutput stoped.'); -}) -``` - -### stop - -stop(): Promise - -Stops outputting preview streams. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| -------------- | ------------------------ | -| Promise| Promise used to return the result.| - -**Example** - -```js -previewOutput.stop().then(() => { - console.log('Callback returned with previewOutput stoped.'); -}) -``` - -### on('frameStart') - -on(type: 'frameStart', callback: AsyncCallback): void - -Listens for preview frame start events. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | --------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'frameStart'**, indicating the preview frame start event.| -| callback | AsyncCallback | Yes | Callback used to return the result. | - -**Example** - -```js -previewOutput.on('frameStart', () => { - console.log('Preview frame started'); -}) -``` - -### on('frameEnd') - -on(type: 'frameEnd', callback: AsyncCallback): void - -Listens for preview frame end events. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'frameEnd'**, indicating the preview frame end event.| -| callback | AsyncCallback | Yes | Callback used to return the result. | - -**Example** - -```js -previewOutput.on('frameEnd', () => { - console.log('Preview frame ended'); -}) -``` - -### on('error') - -on(type: 'error', callback: ErrorCallback): void - -Listens for **PreviewOutput** errors. This API uses a callback to return the errors. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------------------- | ---- | ------------------------ | -| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the preview output error event.| -| callback | ErrorCallback<[PreviewOutputErrorCode](#previewoutputerrorcode)\> | Yes | Callback used to return the error information. | - -**Example** - -```js -previewOutput.on('error', (previewOutputError) => { - console.log(`Preview output error code: ${previewOutputError.code}`); -}) -``` - -## PreviewOutputErrorCode - -Enumerates the error codes used for preview output. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| ------------- | ---- | -------- | -| ERROR_UNKNOWN | -1 | Unknown error.| - -## PreviewOutputError - -Defines the preview output error. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name| Type | Description | -| ---- | ------------------------------------------------- | ---------------------- | -| code | [PreviewOutputErrorCode](#previewoutputerrorcode) | **PreviewOutput** error code.| - -## ImageRotation - -Enumerates the image rotation angles. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| ------------ | ---- | ------------- | -| ROTATION_0 | 0 | The image rotates 0 degrees. | -| ROTATION_90 | 90 | The image rotates 90 degrees. | -| ROTATION_180 | 180 | The image rotates 180 degrees.| -| ROTATION_270 | 270 | The image rotates 270 degrees.| - -## Location - -Defines geolocation information. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Type | Mandatory|Description | -| ------------ | ------ | --- |------------ | -| latitude | number | Yes |Latitude, in degrees. | -| longitude | number | Yes |Longitude, in degrees. | -| altitude | number | Yes |Altitude, in meters. | - -## QualityLevel - -Enumerates the image quality levels. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Value | Description | -| -------------------- | ---- | ------------ | -| QUALITY_LEVEL_HIGH | 0 | High image quality. | -| QUALITY_LEVEL_MEDIUM | 1 | Medium image quality.| -| QUALITY_LEVEL_LOW | 2 | Low image quality. | - - -## PhotoCaptureSetting - -Defines the settings for photo capture. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -| Name | Type | Mandatory | Default Value | Description | -| -------- | ------------------------------- | ---- | ----------------- | -----------------| -| quality | [QualityLevel](#qualitylevel) | No | QUALITY_LEVEL_HIGH| Photo quality. | -| rotation | [ImageRotation](#imagerotation) | No | ROTATION_0 | Rotation angle of the photo. | -| location | [Location](#location) | No | (0,0,0) | Geolocation information of the photo. | -| mirror | boolean | No | false |Whether mirroring is enabled. By default, mirroring is disabled.| - -## PhotoOutput - -Implements output information used in a **CaptureSession**. - -### getDefaultCaptureSetting - -getDefaultCaptureSetting(callback: AsyncCallback): void - -Obtains the default shooting parameters. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------------- | ---- | -------------------- | -| callback | AsyncCallback<[PhotoCaptureSetting](#photocapturesetting)\> | Yes | Callback used to return the result.| - -**Example** - -```js -photoOutput.getDefaultCaptureSetting((err, photocapturesetting) => { - if (err) { - console.error(`Failed to get the defaultCaptureSetting. ${err.message}`); - return; - } - console.log('Callback returned with an array of defaultCaptureSetting.'); -}) -``` - -### getDefaultCaptureSetting - -getDefaultCaptureSetting(): Promise - -Obtains the default shooting parameters. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ----------------------------------------------------- | ----------------------- | -| Promise<[PhotoCaptureSetting](#photocapturesetting)\> | Promise used to return the result.| - -**Example** - -```js -photoOutput.getDefaultCaptureSetting().then((photocapturesetting) => { - console.log('Callback returned with an array of defaultCaptureSetting.'); -}) -``` - -### capture - -capture(callback: AsyncCallback): void - -Captures a photo with the default shooting parameters. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| - -**Example** - -```js -photoOutput.capture((err) => { - if (err) { - console.error(`Failed to capture the photo ${err.message}`); - return; - } - console.log('Callback invoked to indicate the photo capture request success.'); -}); -``` - -### capture - -capture(setting: PhotoCaptureSetting, callback: AsyncCallback): void - -Captures a photo with the specified shooting parameters. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------- | ---- | -------------------- | -| setting | [PhotoCaptureSetting](#photocapturesetting) | Yes | Shooting settings. | -| callback | AsyncCallback | Yes | Callback used to return the result. | - -**Example** - -```js -let settings:PhotoCaptureSetting = { - quality = 1, - rotation = 0 -} -photoOutput.capture(settings, (err) => { - if (err) { - console.error(`Failed to capture the photo ${err.message}`); - return; - } - console.log('Callback invoked to indicate the photo capture request success.'); -}); -``` - -### capture - -capture(setting?: PhotoCaptureSetting): Promise - -Captures a photo with the specified shooting parameters. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| ------- | ------------------------------------------- | ---- | -------- | -| setting | [PhotoCaptureSetting](#photocapturesetting) | No | Shooting settings.| - -**Return value** - -| Type | Description | -| -------------- | ------------------------ | -| Promise| Promise used to return the result.| - - -**Example** - -```js -photoOutput.capture().then(() => { - console.log('Promise returned to indicate that photo capture request success.'); -}) -``` - -### isMirrorSupported - -isMirrorSupported(callback: AsyncCallback): void - -Checks whether mirroring is supported. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------- | ---- | -------------------------- | -| callback | AsyncCallback | Yes | Callback used to return the mirroring support status. The value **true** means that mirroring is supported, and **false** means the opposite. | - -**Example** - -```js -captureSession.isMirrorSupported((err, isSupported) => { - if (err) { - console.error(`Failed to check mirror is supported ${err.message}`); - return; - } - console.log('Callback returned with the successful execution of isMirrorSupported.'); -}) -``` - -### isMirrorSupported - -isMirrorSupported(): Promise - -Checks whether mirroring is supported. This API uses a promise to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Return value** - -| Type | Description | -| ----------------- | ------------------------------------------- | -| Promise | Promise used to return the mirroring support status. The value **true** means that mirroring is supported, and **false** means the opposite. | - -**Example** - -```js -captureSession.isMirrorSupported().then((isSupported) => { - console.log(`Promise returned with mirror supported: ${isSupported}`); -}) -``` - -### on('captureStart') - -on(type: 'captureStart', callback: AsyncCallback): void - -Listens for shooting start events. This API uses an asynchronous callback to return the capture ID. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ---------------------- | ---- | ------------------------------------------ | -| type | string | Yes | Event type. The value is fixed at **'captureStart'**, indicating the shooting start event.| -| callback | AsyncCallback | Yes | Callback used to return the capture ID. | - -**Example** - -```js -photoOutput.on('captureStart', (err, captureId) => { - console.log(`photo capture stated, captureId : ${captureId}`); -}) -``` - -### on('frameShutter') - -on(type: 'frameShutter', callback: AsyncCallback): void - -Listens for frame shutter events. This API uses an asynchronous callback to return the event information. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------- | --- | ------------------------------------ | -| type | string | Yes | Event type. The value is fixed at **'frameShutter'**, indicating the frame shutter event.| -| callback | AsyncCallback<[FrameShutterInfo](#frameshutterinfo)\> | Yes | Callback used to return the result. | - -**Example** - -```js -photoOutput.on('frameShutter', (err, frameShutterInfo) => { - console.log(`photo capture end, captureId : ${frameShutterInfo.captureId}`); - console.log(`Timestamp for frame : ${frameShutterInfo.timestamp}`); -}) -``` - -### on('captureEnd') - -on(type: 'captureEnd', callback: AsyncCallback): void - -Listens for shooting end events. This API uses an asynchronous callback to return the event information. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------- | ---- | ---------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'captureEnd'**, indicating the shooting end event.| -| callback | AsyncCallback<[CaptureEndInfo](#captureendinfo)\> | Yes | Callback used to return the result. | - -**Example** - -```js -photoOutput.on('captureEnd', (err, captureEndInfo) => { - console.log(`photo capture end, captureId : ${captureEndInfo.captureId}`); - console.log(`frameCount : ${captureEndInfo.frameCount}`); -}) -``` - -### on('error') - -on(type: 'error', callback: ErrorCallback): void - -Listens for **PhotoOutput** errors. This API uses a callback to return the errors. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------- | ---- | ----------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the photo output error event.| -| callback | ErrorCallback<[PhotoOutputError](#photooutputerror)\> | Yes | Callback used to return the error information. | - -**Example** - -```js -photoOutput.on('error', (err, photoOutputError) => { - console.log(`Photo output error code: ${photoOutputError.code}`); -}) -``` - -## FrameShutterInfo +## QualityLevel -Defines the frame shutter information. +Enumerates the image quality levels. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Mandatory| Description | -| --------- | ------ | ---- | ---------- | -| captureId | number | Yes | ID of this capture action. | -| timestamp | number | Yes | Timestamp when the frame shutter event is triggered.| +| Name | Value | Description | +| -------------------- | ---- | -------------- | +| QUALITY_LEVEL_HIGH | 0 | High image quality. | +| QUALITY_LEVEL_MEDIUM | 1 | Medium image quality.| +| QUALITY_LEVEL_LOW | 2 | Low image quality. | -## CaptureEndInfo -Defines the capture end information. +## PhotoCaptureSetting + +Defines the settings for photo capture. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Mandatory| Description | -| ---------- | ------ | ---- | ---------| -| captureId | number | Yes | ID of this capture action.| -| frameCount | number | Yes | Number of frames captured. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------------- | ---- | -------------- | +| quality | [QualityLevel](#qualitylevel) | No | Photo quality. | +| rotation | [ImageRotation](#imagerotation) | No | Rotation angle of the photo.| -## PhotoOutputErrorCode -Enumerates the error codes used for photo output. +## PhotoOutput -**System capability**: SystemCapability.Multimedia.Camera.Core +Implements photo output. -| Name | Value | Description | -| ----------------------------- | ---- | --------------- | -| ERROR_UNKNOWN | -1 | Unknown error. | -| ERROR_DRIVER_ERROR | 0 | The driver or hardware is faulty.| -| ERROR_INSUFFICIENT_RESOURCES | 1 | Insufficient resources. | -| ERROR_TIMEOUT | 2 | Timeout. | +### capture -## PhotoOutputError +capture(callback: AsyncCallback): void -Defines a photo output error. +Captures a photo with the default shooting settings. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name| Type | Description | -| ---- | ------------------------------------- | ----------------------- | -| code | [PhotoOutputError](#photooutputerror) | **PhotoOutput** error code.| +**Parameters** -## VideoOutput +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback | Yes | Callback used to return the result.| -Implements output information used in a video recording session. +**Example** -### start +```js +photoOutput.capture((err) => { + if (err) { + console.error('Failed to capture the photo ${err.message}'); + return; + } + console.log('Callback invoked to indicate the photo capture request success.'); +}); +``` -start(callback: AsyncCallback): void +### capture -Starts video recording. This API uses an asynchronous callback to return the result. +capture(setting: PhotoCaptureSetting, callback: AsyncCallback): void + +Captures a photo with the specified shooting settings. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | -------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------------- | ---- | ------------------------ | +| setting | [PhotoCaptureSetting](#photocapturesetting) | Yes | Shooting settings. | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -videoOutput.start((err) => { +let settings:PhotoCaptureSetting = { + quality = 1, + rotation = 0 +} +photoOutput.capture(settings, (err) => { if (err) { - console.error(`Failed to start the video output ${err.message}`); + console.error('Failed to capture the photo ${err.message}'); return; } - console.log('Callback invoked to indicate the video output start success.'); + console.log('Callback invoked to indicate the photo capture request success.'); }); ``` -### start +### capture -start(): Promise +capture(setting?: PhotoCaptureSetting): Promise -Starts video recording. This API uses a promise to return the result. +Captures a photo with the specified shooting settings. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core +**Parameters** + +| Name | Type | Mandatory| Description | +| ------- | ------------------------------------------- | ---- | ---------- | +| setting | [PhotoCaptureSetting](#photocapturesetting) | No | Shooting settings.| + **Return value** -| Type | Description | -| -------------- | ----------------------- | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| **Example** ```js -videoOutput.start().then(() => { - console.log('Promise returned to indicate that start method execution success.'); +photoOutput.capture().then(() => { + console.log('Promise returned to indicate that photo capture request success.'); }) ``` -### stop +### release -stop(callback: AsyncCallback): void +release(callback: AsyncCallback): void -Stops video recording. This API uses an asynchronous callback to return the result. +Releases this **PhotoOutput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core @@ -4106,465 +2290,465 @@ Stops video recording. This API uses an asynchronous callback to return the resu **Example** ```js -videoOutput.stop((err) => { +photoOutput.release((err) => { if (err) { - console.error(`Failed to stop the video output ${err.message}`); + console.error('Failed to release the PhotoOutput instance ${err.message}'); return; } - console.log('Callback invoked to indicate the video output stop success.'); + console.log('Callback invoked to indicate that the PhotoOutput instance is released successfully.'); }); ``` -### stop +### release -stop(): Promise +release(): Promise -Stops video recording. This API uses a promise to return the result. +Releases this **PhotoOutput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| -------------- | ----------------------- | +| Type | Description | +| -------------- | --------------------------- | | Promise| Promise used to return the result.| + **Example** ```js -videoOutput.stop().then(() => { - console.log('Promise returned to indicate that stop method execution success.'); +photoOutput.release().then(() => { + console.log('Promise returned to indicate that the PhotoOutput instance is released successfully.'); }) -``` +``` -### on('frameStart') +### on('captureStart') -on(type: 'frameStart', callback: AsyncCallback): void +on(type: 'captureStart', callback: AsyncCallback): void -Listens for video recording start events. This API uses an asynchronous callback to return the result. +Listens for shooting start events. This API uses an asynchronous callback to return the capture ID. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ----------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **frameStart**, indicating the video recording start event.| -| callback | AsyncCallback | Yes | Callback used to return the result. | +| Name | Type | Mandatory| Description | +| :------- | :--------------------- | :--- | :----------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'captureStart'**, indicating the shooting start event.| +| callback | AsyncCallback | Yes | Callback used to return the capture ID. | **Example** ```js -videoOutput.on('frameStart', () => { - console.log('Video frame started'); +photoOutput.on('captureStart', (err, captureId) => { + console.log('photo capture stated, captureId : ' + captureId); }) ``` -### on('frameEnd') +### on('frameShutter') -on(type: 'frameEnd', callback: AsyncCallback): void +on(type: 'frameShutter', callback: AsyncCallback): void -Listens for video recording stop events. This API uses an asynchronous callback to return the result. +Listens for frame shutter events. This API uses an asynchronous callback to return the event information. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | -------------------- | ---- | ------------------------------------------ | -| type | string | Yes | Event type. The value is fixed at **'frameEnd'**, indicating the video recording stop event.| -| callback | AsyncCallback | Yes | Callback used to return the result. | +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------- | :--- | :--------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'frameShutter'**, indicating the frame shutter event.| +| callback | AsyncCallback<[FrameShutterInfo](#frameshutterinfo)\> | Yes | Callback used to return the result. | **Example** ```js -videoOutput.on('frameEnd', () => { - console.log('Video frame ended'); +photoOutput.on('frameShutter', (err, frameShutterInfo) => { + console.log('photo capture end, captureId : ' + frameShutterInfo.captureId); + console.log('Timestamp for frame : ' + frameShutterInfo.timestamp); }) ``` -### on('error') +### on('captureEnd') -on(type: 'error', callback: ErrorCallback): void +on(type: 'captureEnd', callback: AsyncCallback): void -Listens for errors that occur during video recording. This API uses a callback to return the result. +Listens for shooting end events. This API uses an asynchronous callback to return the event information. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------ | ---- | -------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the video output error event.| -| callback | Callback<[VideoOutputError](#videooutputerror)\> | Yes | Callback used to return the error information. | +| Name | Type | Mandatory| Description | +| :------- | :------------------------------------------------ | :--- | :--------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'captureEnd'**, indicating the shooting end event.| +| callback | AsyncCallback<[CaptureEndInfo](#captureendinfo)\> | Yes | Callback used to return the result. | **Example** ```js -videoOutput.on('error', (VideoOutputError) => { - console.log(`Video output error code: ${VideoOutputError.code}`); +photoOutput.on('captureEnd', (err, captureEndInfo) => { + console.log('photo capture end, captureId : ' + captureEndInfo.captureId); + console.log('frameCount : ' + captureEndInfo.frameCount); }) ``` -## VideoOutputErrorCode +### on('error') + +on(type: 'error', callback: ErrorCallback): void -Enumerates the error codes used for video recording. +Listens for **PhotoOutput** errors. This API uses a callback to return the errors. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| --------------------- | ---- | ------------ | -| ERROR_UNKNOWN | -1 | Unknown error. | -| ERROR_DRIVER_ERROR | 0 | The driver or hardware is faulty.| +**Parameters** + +| Name | Type | Mandatory| Description | +| :------- | :---------------------------------------------------- | :--- | :---------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the photo output error event.| +| callback | ErrorCallback<[PhotoOutputError](#photooutputerror)\> | Yes | Callback used to return the error information. | + +**Example** -## VideoOutputError +```js +photoOutput.on('error', (err, photoOutputError) => { + console.log('Photo output error code: ' + photoOutputError.code); +}) +``` -Defines a video output error. +## FrameShutterInfo + +Defines the frame shutter information. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name| Type | Description | -| ---- | ------------------------------------- | ----------------------- | -| code | [PhotoOutputError](#photooutputerror) | **VideoOutput** error code.| +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | ----------------------------- | +| captureId | number | Yes | ID of this capture action.| +| timestamp | number | Yes | Timestamp when the frame shutter event is triggered. | -## MetadataObjectType +## CaptureEndInfo -Enumerates metadata streams. +Defines the capture end information. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| ------------------------- | ---- | ----------------- | -| FACE_DETECTION | 0 | Metadata object type.| +| Name | Type | Mandatory| Description | +| ---------- | ------ | ---- | ----------------------------- | +| captureId | number | Yes | ID of this capture action.| +| frameCount | number | Yes | Number of frames captured. | -## Rect +## PhotoOutputErrorCode -Defines a rectangle. +Enumerates the error codes used in a **PhotoOutput** instance. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Type | Description | -| -------- | ------ | -------------------- | -| topLeftX | number | X-axis coordinate of the upper left corner of the rectangle. | -| topLeftY | number | Y-axis coordinate of the upper left corner of the rectangle. | -| width | number | Width of the rectangle. | -| height | number | Height of the rectangle. | +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| + +## PhotoOutputError + +Defines a **PhotoOutput** error. -## MetadataObject +**System capability**: SystemCapability.Multimedia.Camera.Core -Implements camera metadata, which is the data source of **[CameraInput](#camerainput)**. +| Name| Type | Description | +| ---- | ------------------------------------- | ----------------------- | +| code | [PhotoOutputError](#photooutputerror) | **PhotoOutput** error code.| -### getType +## camera.createVideoOutput -getType(callback: AsyncCallback): void +createVideoOutput(surfaceId: string, callback: AsyncCallback): void -Obtains the metadata object type. This API uses an asynchronous callback to return the result. +Creates a **VideoOutput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------------------------- | --- | -------------------- | -| callback | AsyncCallback<[MetadataObjectType](#metadataobjecttype)\> | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| --------- | ------------------------------------------- | ---- | ----------------------------------- | +| surfaceId | string | Yes | Surface ID, which is obtained from **VideoRecorder**. | +| callback | AsyncCallback<[VideoOutput](#videooutput)\> | Yes | Callback used to return the **VideoOutput** instance.| **Example** ```js -metadataObject.getType((err, metadataObjectType) => { +camera.createVideoOutput(("surfaceId"), (err, videoOutput) => { if (err) { - console.error(`Failed to get type. ${err.message}`); + console.error('Failed to create the VideoOutput instance. ${err.message}'); return; } - console.log('Callback returned with an array of metadataObjectType.'); -}) + console.log('Callback returned with the VideoOutput instance'); +}); ``` -### getType +## camera.createVideoOutput -getType(): Promise +createVideoOutput(surfaceId: string): Promise -Obtains the metadata object type. This API uses a promise to return the result. +Creates a **VideoOutput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core +**Parameters** + +| Name | Type | Mandatory| Description | +| --------- | ------ | ---- | --------------------------------- | +| surfaceId | string | Yes | Surface ID, which is obtained from **VideoRecorder**.| + **Return value** -| Type | Description | -| --------------------------------------------------- | --------------------------- | -| Promise<[MetadataObjectType](#metadataobjecttype)\> | Promise used to return the result.| +| Type | Description | +| ------------------------------------- | -------------------------------------- | +| Promise<[VideoOutput](#videooutput)\> | Promise used to return the **VideoOutput** instance.| **Example** ```js -metadataObject.getType().then((metadataObjectType) => { - console.log('Callback returned with an array of metadataObjectType.'); +camera.createVideoOutput("surfaceId" +).then((videoOutput) => { + console.log('Promise returned with the VideoOutput instance'); }) ``` -### getTimestamp +## VideoOutput + +Implements output information used in a video recording session. + +### start -getTimestamp(callback: AsyncCallback): void +start(callback: AsyncCallback): void -Obtains the metadata timestamp. This API uses an asynchronous callback to return the result. +Starts video recording. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -metadataObject.getTimestamp((err) => { +videoOutput.start((err) => { if (err) { - console.error(`Failed to get timestamp. ${err.message}`); + console.error('Failed to start the video output ${err.message}'); return; } - console.log('Callback returned with timestamp getted.'); -}) + console.log('Callback invoked to indicate the video output start success.'); +}); ``` -### getTimestamp +### start -getTimestamp(): Promise +start(): Promise -Obtains the metadata timestamp. This API uses a promise to return the result. +Starts video recording. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| ---------------- | --------------------------- | -| Promise | Promise used to return the result.| +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| + **Example** ```js -metadataObject.getTimestamp().then(() => { - console.log('Callback returned with timestamp getted.'); +videoOutput.start().then(() => { + console.log('Promise returned to indicate that start method execution success.'); }) ``` -### getBoundingBox +### stop -getBoundingBox(callback: AsyncCallback): void +stop(callback: AsyncCallback): void -Obtains the bounding box of metadata. This API uses an asynchronous callback to return the result. +Stops video recording. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------------- | ---- | ------------------------ | -| callback | AsyncCallback<[Rect](#rect)\> | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -metadataObject.getBoundingBox((err, rect) => { +videoOutput.stop((err) => { if (err) { - console.error(`Failed to get boundingBox. ${err.message}`); + console.error('Failed to stop the video output ${err.message}'); return; } - console.log('Callback returned with boundingBox getted.'); -}) + console.log('Callback invoked to indicate the video output stop success.'); +}); ``` -### getBoundingBox +### stop -getBoundingBox(): Promise +stop(): Promise -Obtains the bounding box of metadata. This API uses a promise to return the result. +Stops video recording. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| ---------------------- | --------------------------- | -| Promise<[Rect](#rect)\> | Promise used to return the result.| +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| **Example** ```js -metadataObject.getBoundingBox().then((rect) => { - console.log('Callback returned with boundingBox getted.'); +videoOutput.start().then(() => { + console.log('Promise returned to indicate that stop method execution success.'); }) ``` -## MetadataFaceObject - -Implements the face object of metadata. It inherits [MetadataObject](#metadataobject). - -## MetadataOutput - -Implements metadata streams. It inherits **[CameraOutput](#cameraoutput)**. - -### start +### release -start(callback: AsyncCallback): void +release(callback: AsyncCallback): void -Starts to output metadata. This API uses an asynchronous callback to return the result. +Releases this **VideoOutput** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| +| Name | Type | Mandatory| Description | +| -------- | -------------------- | ---- | ------------------------ | +| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -metadataOutput.start((err) => { +videoOutput.release((err) => { if (err) { - console.error(`Failed to start metadataOutput. ${err.message}`); + console.error('Failed to release the VideoOutput instance ${err.message}'); return; } - console.log('Callback returned with metadataOutput started.'); -}) + console.log('Callback invoked to indicate that the VideoOutput instance is released successfully.'); +}); ``` -### start +### release -start(): Promise +release(): Promise -Starts to output metadata. This API uses a promise to return the result. +Releases this **VideoOutput** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Return value** -| Type | Description | -| ---------------------- | ------------------------ | -| Promise | Promise used to return the result.| - -**Example** - -```js -metadataOutput.start().then(() => { - console.log('Callback returned with metadataOutput started.'); -}) -``` - -### stop - -stop(callback: AsyncCallback): void - -Stops outputting metadata. This API uses an asynchronous callback to return the result. - -**System capability**: SystemCapability.Multimedia.Camera.Core - -**Parameters** +| Type | Description | +| -------------- | --------------------------- | +| Promise| Promise used to return the result.| -| Name | Type | Mandatory| Description | -| -------- | -------------------------- | ---- | ------------------- | -| callback | AsyncCallback | Yes | Callback used to return the result.| **Example** ```js -metadataOutput.stop((err) => { - if (err) { - console.error(`Failed to stop the metadataOutput. ${err.message}`); - return; - } - console.log('Callback returned with metadataOutput stoped.'); +videoOutput.release().then(() => { + console.log('Promise returned to indicate that the VideoOutput instance is released successfully.'); }) ``` -### stop +### on('frameStart') -stop(): Promise +on(type: 'frameStart', callback: AsyncCallback): void -Stops outputting metadata. This API uses a promise to return the result. +Listens for video recording start events. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core -**Return value** +**Parameters** -| Type | Description | -| ---------------------- | --------------------------- | -| Promise | Promise used to return the result.| +| Name | Type | Mandatory| Description | +| :------- | :------------------- | :--- | :----------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **`frameStart`**, indicating the video recording start event.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -metadataOutput.stop().then(() => { - console.log('Callback returned with metadataOutput stoped.'); +videoOutput.on('frameStart', () => { + console.log('Video frame started'); }) ``` -### on('metadataObjectsAvailable') +### on('frameEnd') -on(type: 'metadataObjectsAvailable', callback: AsyncCallback\>): void +on(type: 'frameEnd', callback: AsyncCallback): void -Listens for metadata objects. This API uses an asynchronous callback to return the result. +Listens for video recording end events. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ----------------------------------------------- - | ---- | ------------------------------------ | -| type | string | Yes | Event type. The value is fixed at **'metadataObjectsAvailable'**, that is, the metadata object.| -| callback | Callback\> | Yes | Callback used to return the error information. | +| Name | Type | Mandatory| Description | +| :------- | :------------------- | :--- | :--------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **`frameEnd`**, indicating the video frame end event.| +| callback | AsyncCallback | Yes | Callback used to return the result. | **Example** ```js -metadataOutput.on('metadataObjectsAvailable', (metadataObject) => { - console.log(`metadata output error code: ${metadataObject.code}`); +videoOutput.on('frameEnd', () => { + console.log('Video frame ended'); }) ``` ### on('error') -on(tuype: 'error', callback: ErrorCallback): void +on(type: 'error', callback: ErrorCallback): void -Listens for metadata errors. This API uses an asynchronous callback to return the result. +Listens for **VideoOutput** errors. This API uses a callback to return the result. **System capability**: SystemCapability.Multimedia.Camera.Core **Parameters** -| Name | Type | Mandatory| Description | -| -------- | ------------------------------------------------ | ---- | --------------------------------------- | -| type | string | Yes | Event type. The value is fixed at **'error'**, that is, the metadata error.| -| callback | Callback<[MetadataOutputError](#metadataoutputerror)\> | Yes | Callback used to return the error information. | +| Name | Type | Mandatory| Description | +| :------- | :----------------------------------------------- | :--- | :-------------------------------------------- | +| type | string | Yes | Event type. The value is fixed at **'error'**, indicating the video output error event.| +| callback | Callback<[VideoOutputError](#videooutputerror)\> | Yes | Callback used to return the error information. | **Example** ```js -metadataOutput.on('error', (metadataOutputError) => { - console.log(`Metadata output error code: ${metadataOutputError.code}`); +videoOutput.on('error', (VideoOutputError) => { + console.log('Video output error code: ' + VideoOutputError.code); }) ``` -## MetadataOutputErrorCode +## VideoOutputErrorCode -Enumerates the codes used for metadata output errors. +Enumerates the error codes used in a **VideoOutput** instance. **System capability**: SystemCapability.Multimedia.Camera.Core -| Name | Value | Description | -| ------------------------------- | ---- | -------- | -| ERROR_UNKNOWN | -1 | Unknown error.| -| ERROR_INSUFFICIENT_RESOURCES | 0 | Insufficient resources.| +| Name | Value | Description | +| ------------- | ---- | ---------- | +| ERROR_UNKNOWN | -1 | Unknown error.| -## MetadataOutputError +## VideoOutputError -Defines a metadata output error. +Defines a **VideoOutput** error. **System capability**: SystemCapability.Multimedia.Camera.Core | Name| Type | Description | | ---- | ------------------------------------- | ----------------------- | -| code | [MetadataOutputErrorCode](#metadataoutputerrorcode) | **MetadataOutput** error code.| +| code | [PhotoOutputError](#photooutputerror) | **VideoOutput** error code.| diff --git a/en/application-dev/reference/apis/js-apis-commonEvent.md b/en/application-dev/reference/apis/js-apis-commonEvent.md index 710d6ccb8820e88ed98e3519c36824efdd5e5b17..50fad38058530104fda01f09d5745c0f8051000a 100644 --- a/en/application-dev/reference/apis/js-apis-commonEvent.md +++ b/en/application-dev/reference/apis/js-apis-commonEvent.md @@ -66,15 +66,11 @@ Provides the event types supported by the **CommonEvent** module. The name and v | COMMON_EVENT_USER_STARTED | usual.event.USER_STARTED | - | Indicates the common event that the user has been started. | | COMMON_EVENT_USER_BACKGROUND | usual.event.USER_BACKGROUND | - | Indicates the common event that the user has been brought to the background. | | COMMON_EVENT_USER_FOREGROUND | usual.event.USER_FOREGROUND | - | Indicates the common event that the user has been brought to the foreground. | -| COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_USERS | Indicates the common event that user switching is happening. | -| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_USERS | Indicates the common event that the user is going to be started. | +| COMMON_EVENT_USER_SWITCHED | usual.event.USER_SWITCHED | ohos.permission.MANAGE_LOCAL_ACCOUNTS | Indicates the common event that user switching is happening. | +| COMMON_EVENT_USER_STARTING | usual.event.USER_STARTING | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | Indicates the common event that the user is going to be started. | | COMMON_EVENT_USER_UNLOCKED | usual.event.USER_UNLOCKED | - | Indicates the common event that the credential-encrypted storage has been unlocked for the current user when the device is unlocked after being restarted. | -| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_USERS | Indicates the common event that the user is going to be stopped. | +| COMMON_EVENT_USER_STOPPING | usual.event.USER_STOPPING | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | Indicates the common event that the user is going to be stopped. | | COMMON_EVENT_USER_STOPPED | usual.event.USER_STOPPED | - | Indicates the common event that the user has been stopped. | -| COMMON_EVENT_HWID_LOGIN | common.event.HWID_LOGIN | - | Indicates the common event about a HUAWEI ID login. | -| COMMON_EVENT_HWID_LOGOUT | common.event.HWID_LOGOUT | - | Indicates the common event about a HUAWEI ID logout. | -| COMMON_EVENT_HWID_TOKEN_INVALID | common.event.HWID_TOKEN_INVALID | - | Indicates the common event that the HUAWEI ID is invalid. | -| COMMON_EVENT_HWID_LOGOFF | common.event.HWID_LOGOFF | - | Indicates the common event about a HUAWEI ID logoff. | | COMMON_EVENT_WIFI_POWER_STATE | usual.event.wifi.POWER_STATE | - | Indicates the common event about the Wi-Fi network state, such as enabled and disabled. | | COMMON_EVENT_WIFI_SCAN_FINISHED | usual.event.wifi.SCAN_FINISHED | ohos.permission.LOCATION | Indicates the common event that the Wi-Fi access point has been scanned and proven to be available. | | COMMON_EVENT_WIFI_RSSI_VALUE | usual.event.wifi.RSSI_VALUE | ohos.permission.GET_WIFI_INFO | Indicates the common event that the Wi-Fi signal strength (RSSI) has changed. | @@ -133,8 +129,8 @@ Provides the event types supported by the **CommonEvent** module. The name and v | COMMON_EVENT_CHARGING | usual.event.CHARGING | - | Indicates the common event that the system starts charging the battery. | | COMMON_EVENT_DEVICE_IDLE_MODE_CHANGED | usual.event.DEVICE_IDLE_MODE_CHANGED | - | Indicates the common event that the system idle mode has changed. | | COMMON_EVENT_POWER_SAVE_MODE_CHANGED | usual.event.POWER_SAVE_MODE_CHANGED | - | Indicates the common event that the power saving mode of the system has changed. | -| COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_USERS | Indicates the common event that a user has been added to the system. | -| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_USERS | Indicates the common event that a user has been removed from the system. | +| COMMON_EVENT_USER_ADDED | usual.event.USER_ADDED | ohos.permission.MANAGE_LOCAL_ACCOUNTS | Indicates the common event that a user has been added to the system. | +| COMMON_EVENT_USER_REMOVED | usual.event.USER_REMOVED | ohos.permission.MANAGE_LOCAL_ACCOUNTS | Indicates the common event that a user has been removed from the system. | | COMMON_EVENT_ABILITY_ADDED | usual.event.ABILITY_ADDED | ohos.permission.LISTEN_BUNDLE_CHANGE | Indicates the common event that an ability has been added. | | COMMON_EVENT_ABILITY_REMOVED | usual.event.ABILITY_REMOVED | ohos.permission.LISTEN_BUNDLE_CHANGE | Indicates the common event that an ability has been removed. | | COMMON_EVENT_ABILITY_UPDATED | usual.event.ABILITY_UPDATED | ohos.permission.LISTEN_BUNDLE_CHANGE | Indicates the common event that an ability has been updated. | diff --git a/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md b/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md index 499dafec721fd280beee9e9ccfcab76ae895bd14..4c04dd7a835c647889d70dff754d6baf14730efb 100644 --- a/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md +++ b/en/application-dev/reference/apis/js-apis-continuation-continuationManager.md @@ -119,6 +119,25 @@ Subscribes to device connection events. This API uses an asynchronous callback t > This API is deprecated since API version 9. You are advised to use [on](#continuationmanagerondeviceconnect9) instead. +**System capability**: SystemCapability.Ability.DistributedAbilityManager + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is fixed at **deviceConnect**.| + | callback | Callback\<[ContinuationResult](js-apis-continuation-continuationResult.md)> | Yes| Callback invoked when a device is selected from the device list provided by the device selection module. This callback returns the device ID, type, and name.| + +**Example** + + ```js + continuationManager.on("deviceConnect", (data) => { + console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id)); + console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type)); + console.info('onDeviceConnect deviceName: ' + JSON.stringify(data.name)); + }); + ``` + ## continuationManager.on("deviceDisconnect")(deprecated) on(type: "deviceDisconnect", callback: Callback\): void; @@ -127,6 +146,23 @@ Subscribes to device disconnection events. This API uses an asynchronous callbac > This API is deprecated since API version 9. You are advised to use [on](#continuationmanagerondevicedisconnect9) instead. +**System capability**: SystemCapability.Ability.DistributedAbilityManager + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is fixed at **deviceDisconnect**.| + | callback | Callback\ | Yes| Callback invoked when a device is disconnected in the device selection module. This callback returns the device ID.| + +**Example** + + ```js + continuationManager.on("deviceDisconnect", (data) => { + console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data)); + }); + ``` + ## continuationManager.off("deviceConnect")(deprecated) off(type: "deviceConnect", callback?: Callback\): void; @@ -135,6 +171,25 @@ Unsubscribes from device connection events. This API uses an asynchronous callba > This API is deprecated since API version 9. You are advised to use [off](#continuationmanageroffdeviceconnect9) instead. +**System capability**: SystemCapability.Ability.DistributedAbilityManager + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is fixed at **deviceConnect**.| + | callback | Callback\<[ContinuationResult](js-apis-continuation-continuationResult.md)> | No| Callback invoked when a device is selected from the device list provided by the device selection module. This callback returns the device ID, type, and name.| + +**Example** + + ```js + continuationManager.off("deviceConnect", (data) => { + console.info('onDeviceConnect deviceId: ' + JSON.stringify(data.id)); + console.info('onDeviceConnect deviceType: ' + JSON.stringify(data.type)); + console.info('onDeviceConnect deviceName: ' + JSON.stringify(data.name)); + }); + ``` + ## continuationManager.off("deviceDisconnect")(deprecated) off(type: "deviceDisconnect", callback?: Callback\): void; @@ -143,6 +198,23 @@ Unsubscribes from device disconnection events. This API uses an asynchronous cal > This API is deprecated since API version 9. You are advised to use [off](#continuationmanageroffdevicedisconnect9) instead. +**System capability**: SystemCapability.Ability.DistributedAbilityManager + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | type | string | Yes| Event type. The value is fixed at **deviceDisconnect**.| + | callback | Callback\ | No| Callback invoked when a device is disconnected in the device selection module. This callback returns the device ID.| + +**Example** + + ```js + continuationManager.off("deviceDisconnect", (data) => { + console.info('onDeviceDisconnect deviceId: ' + JSON.stringify(data)); + }); + ``` + ## continuationManager.on("deviceConnect")9+ on(type: "deviceConnect", token: number, callback: Callback\>): void; diff --git a/en/application-dev/reference/apis/js-apis-convertxml.md b/en/application-dev/reference/apis/js-apis-convertxml.md index 82941689b8d2d511ca1878b0b03fac2e1c32dafd..3a2f046c36b3c17bca7c87c71e18c69971b5683c 100644 --- a/en/application-dev/reference/apis/js-apis-convertxml.md +++ b/en/application-dev/reference/apis/js-apis-convertxml.md @@ -55,8 +55,8 @@ let options = {trim : false, declarationKey:"_declaration", commentKey : "_comment", parentKey : "_parent", typeKey : "_type", nameKey : "_name", elementsKey : "_elements"} let result = JSON.stringify(conv.convert(xml, options)); -console.log(result) -// Output(Non compact) +console.log(result); +// Output (non-compact) // {"_declaration":{"_attributes":{"version":"1.0","encoding":"utf-8"}},"_elements":[{"_type":"element","_name":"note","_attributes":{"importance":"high","logged":"true"},"_elements":[{"_type":"element","_name":"title","_elements":[{"_type":"text","_text":"Happy"}]},{"_type":"element","_name":"todo","_elements":[{"_type":"text","_text":"Work"}]},{"_type":"element","_name":"todo","_elements":[{"_type":"text","_text":"Play"}]}]}]} ``` diff --git a/en/application-dev/reference/apis/js-apis-data-ability.md b/en/application-dev/reference/apis/js-apis-data-ability.md index 3860be1f4cd4fae2b432c7286ae5aca1c2b44868..5d393653ce602b60438df2b6f9e54f6ba9cb9fe6 100644 --- a/en/application-dev/reference/apis/js-apis-data-ability.md +++ b/en/application-dev/reference/apis/js-apis-data-ability.md @@ -13,13 +13,10 @@ import dataAbility from '@ohos.data.dataAbility'; ``` - ## dataAbility.createRdbPredicates - createRdbPredicates(name: string, dataAbilityPredicates: DataAbilityPredicates): rdb.RdbPredicates - Creates an **RdbPredicates** object from a **DataAbilityPredicates** object. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core @@ -32,93 +29,93 @@ Creates an **RdbPredicates** object from a **DataAbilityPredicates** object. | dataAbilityPredicates | [DataAbilityPredicates](#dataabilitypredicates) | Yes| **DataAbilityPredicates** object. | **Return value** + | Type| Description| | -------- | -------- | | rdb.[RdbPredicates](js-apis-data-rdb.md#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let dataAbilityPredicates = new dataAbility.DataAbilityPredicates() - dataAbilityPredicates.equalTo("NAME", "Rose").between("AGE", 16, 30) + dataAbilityPredicates.equalTo("NAME", "Rose") let predicates = dataAbility.createRdbPredicates("EMPLOYEE", dataAbilityPredicates) ``` - ## DataAbilityPredicates Provides predicates for implementing diverse query methods. - ### equalTo - equalTo(field: string, value: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value equal to the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | [ValueType](#valuetype) | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "lisi") ``` - ### notEqualTo - notEqualTo(field: string, value: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value not equal to the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | [ValueType](#valuetype) | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.notEqualTo("NAME", "lisi") ``` - ### beginWrap - beginWrap(): DataAbilityPredicates - Adds a left parenthesis to this **DataAbilityPredicates**. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object with a left parenthesis.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "lisi") .beginWrap() @@ -128,23 +125,22 @@ Adds a left parenthesis to this **DataAbilityPredicates**. .endWrap() ``` - ### endWrap - endWrap(): DataAbilityPredicates - Adds a right parenthesis to this **DataAbilityPredicates**. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object with a right parenthesis.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "lisi") .beginWrap() @@ -154,251 +150,247 @@ Adds a right parenthesis to this **DataAbilityPredicates**. .endWrap() ``` - ### or - or(): DataAbilityPredicates - Adds the OR condition to this **DataAbilityPredicates**. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object with the OR condition.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "Lisa") .or() .equalTo("NAME", "Rose") ``` - ### and - and(): DataAbilityPredicates - Adds the AND condition to this **DataAbilityPredicates**. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object with the AND condition.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "Lisa") .and() .equalTo("SALARY", 200.5) ``` - ### contains - contains(field: string, value: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match a string containing the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | string | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.contains("NAME", "os") ``` - ### beginsWith - beginsWith(field: string, value: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match a string that starts with the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | string | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.beginsWith("NAME", "os") ``` - ### endsWith - endsWith(field: string, value: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match a string that ends with the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | string | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ``` dataAbilityPredicates.endsWith("NAME", "se") ``` - ### isNull - isNull(field: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field whose value is null. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.isNull("NAME") ``` - ### isNotNull - isNotNull(field: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field whose value is not null. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.isNotNull("NAME") ``` - ### like - like(field: string, value: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match a string that is similar to the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | string | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.like("NAME", "%os%") ``` - ### glob - glob(field: string, value: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the specified string. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | string | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.glob("NAME", "?h*g") ``` - ### between - between(field: string, low: ValueType, high: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match a field whose data type is **ValueType** and value is within the specified range. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| @@ -406,27 +398,27 @@ Sets a **DataAbilityPredicates** object to match a field whose data type is **Va | high | [ValueType](#valuetype) | Yes| Maximum value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.between("AGE", 10, 50) ``` - ### notBetween - notBetween(field: string, low: ValueType, high: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value out of the specified range. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| @@ -434,244 +426,245 @@ Sets a **DataAbilityPredicates** object to match the field with data type **Valu | high | [ValueType](#valuetype) | Yes| Maximum value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.notBetween("AGE", 10, 50) ``` - ### greaterThan - greaterThan(field: string, value: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value greater than the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | [ValueType](#valuetype) | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.greaterThan("AGE", 18) ``` - ### lessThan - lessThan(field: string, value: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value less than the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | [ValueType](#valuetype) | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.lessThan("AGE", 20) ``` - ### greaterThanOrEqualTo - greaterThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value greater than or equal to the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | [ValueType](#valuetype) | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.greaterThanOrEqualTo("AGE", 18) ``` - ### lessThanOrEqualTo - lessThanOrEqualTo(field: string, value: ValueType): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type **ValueType** and value less than or equal to the specified value. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | [ValueType](#valuetype) | Yes| Value to match the **DataAbilityPredicates**.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.lessThanOrEqualTo("AGE", 20) ``` - ### orderByAsc - orderByAsc(field: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the column with values sorted in ascending order. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.orderByAsc("NAME") ``` - ### orderByDesc - orderByDesc(field: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the column with values sorted in descending order. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.orderByDesc("AGE") ``` - ### distinct - distinct(): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to filter out duplicate records. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that can filter out duplicate records.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "Rose").distinct() ``` - ### limitAs - limitAs(value: number): DataAbilityPredicates - Set a **DataAbilityPredicates** object to specify the maximum number of records. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | number | Yes| Maximum number of records.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that specifies the maximum number of records.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "Rose").limitAs(3) ``` - ### offsetAs - offsetAs(rowOffset: number): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to specify the start position of the returned result. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | rowOffset | number | Yes| Number of rows to offset from the beginning. The value is a positive integer.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that specifies the start position of the returned result.| **Example** + ```js dataAbilityPredicates.equalTo("NAME", "Rose").offsetAs(3) ``` @@ -679,66 +672,66 @@ Sets a **DataAbilityPredicates** object to specify the start position of the ret ### groupBy - groupBy(fields: Array<string>): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to group rows that have the same value into summary rows. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | fields | Array<string> | Yes| Names of columns to group.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that groups rows with the same value.| **Example** + ```js dataAbilityPredicates.groupBy(["AGE", "NAME"]) ``` ### indexedBy - indexedBy(field: string): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to specify the index column. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | indexName | string | Yes| Name of the index column.| **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that specifies the index column.| **Example** + ```js dataAbilityPredicates.indexedBy("SALARY_INDEX") ``` - ### in - in(field: string, value: Array<ValueType>): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type Array and value within the specified range. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| @@ -746,39 +739,40 @@ Sets a **DataAbilityPredicates** object to match the field with data type Array< **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.in("AGE", [18, 20]) ``` - ### notIn - notIn(field: string, value: Array<ValueType>): DataAbilityPredicates - Sets a **DataAbilityPredicates** object to match the field with data type Array and value out of the specified range. **System capability**: SystemCapability.DistributedDataManager.DataShare.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the table.| | value | Array<[ValueType](#valuetype)> | Yes| Array of **ValueType**s to match.| - **Return value** + | Type| Description| | -------- | -------- | | [DataAbilityPredicates](#dataabilitypredicates) | **DataAbilityPredicates** object that matches the specified field.| **Example** + ```js dataAbilityPredicates.notIn("NAME", ["Lisa", "Rose"]) ``` diff --git a/en/application-dev/reference/apis/js-apis-data-rdb.md b/en/application-dev/reference/apis/js-apis-data-rdb.md index 296b8a58c2e89677eed23ee377c7568603429646..87c75a024fb144c72c0942e44b114a7d250a8008 100644 --- a/en/application-dev/reference/apis/js-apis-data-rdb.md +++ b/en/application-dev/reference/apis/js-apis-data-rdb.md @@ -36,9 +36,16 @@ Obtains an RDB store. This API uses an asynchronous callback to return the resul **Example** +FA model: + ```js +// Obtain the context. +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() + +// Call getRdbStore. const STORE_CONFIG = { name: "RdbTest.db"} -data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) { +data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) { if (err) { console.info("Failed to get RdbStore, err: " + err) return @@ -47,6 +54,28 @@ data_rdb.getRdbStore(this.context, STORE_CONFIG, 1, function (err, rdbStore) { }) ``` +Stage model: + +```ts +// Obtain the context. +import Ability from '@ohos.application.Ability' +var context +class MainAbility extends Ability{ + onWindowStageCreate(windowStage){ + context = this.context + } +} + +// Call getRdbStore. +const STORE_CONFIG = { name: "RdbTest.db"} +data_rdb.getRdbStore(context, STORE_CONFIG, 1, function (err, rdbStore) { + if (err) { + console.info("Failed to get RdbStore, err: " + err) + return + } + console.log("Got RdbStore successfully.") +}) +``` ## data_rdb.getRdbStore getRdbStore(context: Context, config: StoreConfig, version: number): Promise<RdbStore> @@ -71,9 +100,38 @@ Obtains an RDB store. This API uses a promise to return the result. You can set **Example** +FA model: + ```js +// Obtain the context. +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() + +// Call getRdbStore. +const STORE_CONFIG = { name: "RdbTest.db" } +let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1); +promise.then(async (rdbStore) => { + console.log("Got RdbStore successfully.") +}).catch((err) => { + console.log("Failed to get RdbStore, err: " + err) +}) +``` + +Stage model: + +```ts +// Obtain the context. +import Ability from '@ohos.application.Ability' +var context +class MainAbility extends Ability{ + onWindowStageCreate(windowStage){ + context = this.context + } +} + +// Call getRdbStore. const STORE_CONFIG = { name: "RdbTest.db" } -let promise = data_rdb.getRdbStore(this.context, STORE_CONFIG, 1); +let promise = data_rdb.getRdbStore(context, STORE_CONFIG, 1); promise.then(async (rdbStore) => { console.log("Got RdbStore successfully.") }).catch((err) => { @@ -90,6 +148,7 @@ Deletes an RDB store. This API uses an asynchronous callback to return the resul **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | context | Context | Yes| Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| @@ -97,8 +156,38 @@ Deletes an RDB store. This API uses an asynchronous callback to return the resul | callback | AsyncCallback<void> | Yes| Callback invoked to return the result.| **Example** + +FA model: + ```js -data_rdb.deleteRdbStore(this.context, "RdbTest.db", function (err, rdbStore) { +// Obtain the context. +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() + +// Call deleteRdbStore. +data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) { + if (err) { + console.info("Failed to delete RdbStore, err: " + err) + return + } + console.log("Deleted RdbStore successfully.") +}) +``` + +Stage model: + +```ts +// Obtain the context. +import Ability from '@ohos.application.Ability' +var context +class MainAbility extends Ability{ + onWindowStageCreate(windowStage){ + context = this.context + } +} + +// Call deleteRdbStore. +data_rdb.deleteRdbStore(context, "RdbTest.db", function (err) { if (err) { console.info("Failed to delete RdbStore, err: " + err) return @@ -116,19 +205,29 @@ Deletes an RDB store. This API uses a promise to return the result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | context | Context | Yes| Application context.
For the application context of the FA model, see [Context](js-apis-Context.md).
For the application context of the stage model, see [Context](js-apis-ability-context.md).| | name | string | Yes| Name of the RDB store to delete.| **Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| **Example** + +FA model: + ```js -let promise = data_rdb.deleteRdbStore(this.context, "RdbTest.db") +// Obtain the context. +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() + +// Call deleteRdbStore. +let promise = data_rdb.deleteRdbStore(context, "RdbTest.db") promise.then(()=>{ console.log("Deleted RdbStore successfully.") }).catch((err) => { @@ -136,6 +235,26 @@ promise.then(()=>{ }) ``` +Stage model: + +```ts +// Obtain the context. +import Ability from '@ohos.application.Ability' +var context +class MainAbility extends Ability{ + onWindowStageCreate(windowStage){ + context = this.context + } +} + +// Call deleteRdbStore. +let promise = data_rdb.deleteRdbStore(context, "RdbTest.db") +promise.then(()=>{ + console.log("Deleted RdbStore successfully.") +}).catch((err) => { + console.info("Failed to delete RdbStore, err: " + err) +}) +``` ## RdbPredicates @@ -152,11 +271,13 @@ A constructor used to create an **RdbPredicates** object. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | name | string | Yes| Database table name.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") ``` @@ -166,21 +287,24 @@ let predicates = new data_rdb.RdbPredicates("EMPLOYEE") inDevices(devices: Array<string>): RdbPredicates -Connects to the specified remote devices on the network during distributed database synchronization. +Sets an **RdbPredicates** to specify the remote devices on the network to connect during distributed database synchronization. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | devices | Array<string> | Yes| IDs of the remote devices in the same network.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.inDevices(['12345678abcde']) @@ -191,16 +315,18 @@ predicates.inDevices(['12345678abcde']) inAllDevices(): RdbPredicates -Connects to all remote devices on the network during distributed database synchronization. +Sets an **RdbPredicates** to specify all remote devices on the network to connect during distributed database synchronization. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.inAllDevices() @@ -216,17 +342,20 @@ Sets an **RdbPredicates** to match the field with data type **ValueType** and va **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | [ValueType](#valuetype) | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") @@ -243,17 +372,20 @@ Sets an **RdbPredicates** to match the field with data type **ValueType** and va **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | [ValueType](#valuetype) | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notEqualTo("NAME", "lisi") @@ -270,11 +402,13 @@ Adds a left parenthesis to the **RdbPredicates**. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** with a left parenthesis.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") @@ -285,22 +419,22 @@ predicates.equalTo("NAME", "lisi") .endWrap() ``` - ### endWrap endWrap(): RdbPredicates - Adds a right parenthesis to the **RdbPredicates**. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** with a right parenthesis.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "lisi") @@ -311,22 +445,22 @@ predicates.equalTo("NAME", "lisi") .endWrap() ``` - ### or or(): RdbPredicates - Adds the OR condition to the **RdbPredicates**. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** with the OR condition.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -334,22 +468,22 @@ predicates.equalTo("NAME", "Lisa") .equalTo("NAME", "Rose") ``` - ### and and(): RdbPredicates - Adds the AND condition to the **RdbPredicates**. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** with the AND condition.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -357,7 +491,6 @@ predicates.equalTo("NAME", "Lisa") .equalTo("SALARY", 200.5) ``` - ### contains contains(field: string, value: string): RdbPredicates @@ -367,193 +500,200 @@ Sets an **RdbPredicates** to match a string containing the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | string | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.contains("NAME", "os") ``` - ### beginsWith beginsWith(field: string, value: string): RdbPredicates - Sets an **RdbPredicates** to match a string that starts with the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | string | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.beginsWith("NAME", "os") ``` - ### endsWith endsWith(field: string, value: string): RdbPredicates - Sets an **RdbPredicates** to match a string that ends with the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | string | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.endsWith("NAME", "se") ``` - ### isNull isNull(field: string): RdbPredicates - Sets an **RdbPredicates** to match the field whose value is null. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| -- Example +**Example** ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNull("NAME") ``` - ### isNotNull isNotNull(field: string): RdbPredicates - Sets an **RdbPredicates** to match the field whose value is not null. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.isNotNull("NAME") ``` - ### like like(field: string, value: string): RdbPredicates - Sets an **RdbPredicates** to match a string that is similar to the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | string | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.like("NAME", "%os%") ``` - ### glob glob(field: string, value: string): RdbPredicates - Sets an **RdbPredicates** to match the specified string. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | string | Yes| Value to match the **RdbPredicates**.

Wildcards are supported. * indicates zero, one, or multiple digits or characters. **?** indicates a single digit or character.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.glob("NAME", "?h*g") ``` - ### between between(field: string, low: ValueType, high: ValueType): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **ValueType** and value within the specified range. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| @@ -561,27 +701,28 @@ Sets an **RdbPredicates** to match the field with data type **ValueType** and va | high | [ValueType](#valuetype) | Yes| Maximum value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.between("AGE", 10, 50) ``` - ### notBetween notBetween(field: string, low: ValueType, high: ValueType): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **ValueType** and value out of the specified range. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| @@ -589,17 +730,18 @@ Sets an **RdbPredicates** to match the field with data type **ValueType** and va | high | [ValueType](#valuetype) | Yes| Maximum value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notBetween("AGE", 10, 50) ``` - ### greaterThan greaterThan(field: string, value: ValueType): RdbPredicates @@ -609,259 +751,265 @@ Sets an **RdbPredicates** to match the field with data type **ValueType** and va **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | [ValueType](#valuetype) | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThan("AGE", 18) ``` - ### lessThan lessThan(field: string, value: ValueType): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **ValueType** and value less than the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | [ValueType](#valuetype) | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThan("AGE", 20) ``` - ### greaterThanOrEqualTo - greaterThanOrEqualTo(field: string, value: ValueType): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **ValueType** and value greater than or equal to the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | [ValueType](#valuetype) | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.greaterThanOrEqualTo("AGE", 18) ``` - ### lessThanOrEqualTo - lessThanOrEqualTo(field: string, value: ValueType): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **ValueType** and value less than or equal to the specified value. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | [ValueType](#valuetype) | Yes| Value to match the **RdbPredicates**.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.lessThanOrEqualTo("AGE", 20) ``` - ### orderByAsc - orderByAsc(field: string): RdbPredicates - Sets an **RdbPredicates** to match the column with values sorted in ascending order. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByAsc("NAME") ``` - ### orderByDesc - orderByDesc(field: string): RdbPredicates - Sets an **RdbPredicates** to match the column with values sorted in descending order. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.orderByDesc("AGE") ``` - ### distinct distinct(): RdbPredicates - Sets an **RdbPredicates** to filter out duplicate records. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that can filter out duplicate records.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") -predicates.equalTo("NAME", "Rose").distinct("NAME") +predicates.equalTo("NAME", "Rose").distinct() ``` - ### limitAs limitAs(value: number): RdbPredicates - Sets an **RdbPredicates** to specify the maximum number of records. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | number | Yes| Maximum number of records.| **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that specifies the maximum number of records.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").limitAs(3) ``` - ### offsetAs offsetAs(rowOffset: number): RdbPredicates - Sets an **RdbPredicates** to specify the start position of the returned result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | rowOffset | number | Yes| Number of rows to offset from the beginning. The value is a positive integer.| **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that specifies the start position of the returned result.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose").offsetAs(3) ``` - ### groupBy groupBy(fields: Array<string>): RdbPredicates - Sets an **RdbPredicates** to group rows that have the same value into summary rows. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | fields | Array<string> | Yes| Names of columns to group.| **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that groups rows with the same value.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.groupBy(["AGE", "NAME"]) ``` - ### indexedBy indexedBy(field: string): RdbPredicates @@ -871,86 +1019,87 @@ Sets an **RdbPredicates** object to specify the index column. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Name of the index column.| **Return value** + | Type| Description| | -------- | -------- | | [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that specifies the index column.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.indexedBy("SALARY_INDEX") ``` - ### in in(field: string, value: Array<ValueType>): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **Array<ValueType>** and value within the specified range. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | Array<[ValueType](#valuetype)> | Yes| Array of **ValueType**s to match.| - **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.in("AGE", [18, 20]) ``` - ### notIn notIn(field: string, value: Array<ValueType>): RdbPredicates - Sets an **RdbPredicates** to match the field with data type **Array<ValueType>** and value out of the specified range. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | field | string | Yes| Column name in the database table.| | value | Array<[ValueType](#valuetype)> | Yes| Array of **ValueType**s to match.| - **Return value** + | Type| Description| | -------- | -------- | -| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object that matches the specified field.| +| [RdbPredicates](#rdbpredicates) | **RdbPredicates** object created.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.notIn("NAME", ["Lisa", "Rose"]) ``` - ## RdbStore Provides methods to manage an RDB store. Before using the following APIs, use [executeSql](#executesql) to initialize the database table structure and related data. For details, see [RDB Development](../../database/database-relational-guidelines.md). - ### insert insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void @@ -960,6 +1109,7 @@ Inserts a row of data into a table. This API uses an asynchronous callback to re **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -967,6 +1117,7 @@ Inserts a row of data into a table. This API uses an asynchronous callback to re | callback | AsyncCallback<number> | Yes| Callback invoked to return the result. If the operation is successful, the row ID will be returned. Otherwise, **-1** will be returned.| **Example** + ```js const valueBucket = { "NAME": "Lisa", @@ -983,7 +1134,6 @@ rdbStore.insert("EMPLOYEE", valueBucket, function (status, rowId) { }) ``` - ### insert insert(table: string, values: ValuesBucket):Promise<number> @@ -993,17 +1143,20 @@ Inserts a row of data into a table. This API uses a promise to return the result **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| | values | [ValuesBucket](#valuesbucket) | Yes| Row of data to insert.| **Return value** + | Type| Description| | -------- | -------- | | Promise<number> | Promise used to return the result. If the operation is successful, the row ID will be returned. Otherwise, **-1** will be returned.| **Example** + ```js const valueBucket = { "NAME": "Lisa", @@ -1028,6 +1181,7 @@ Batch inserts data into a table. This API uses an asynchronous callback to retur **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -1035,6 +1189,7 @@ Batch inserts data into a table. This API uses an asynchronous callback to retur | callback | AsyncCallback<number> | Yes| Callback invoked to return the result. If the operation is successful, the number of inserted data records is returned. Otherwise, **-1** is returned.| **Example** + ```js const valueBucket1 = { "NAME": "Lisa", @@ -1074,17 +1229,20 @@ Batch inserts data into a table. This API uses a promise to return the result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| | values | Array<[ValuesBucket](#valuesbucket)> | Yes| An array of data to insert.| **Return value** + | Type| Description| | -------- | -------- | | Promise<number> | Promise used to return the result. If the operation is successful, the number of inserted data records is returned. Otherwise, **-1** is returned.| **Example** + ```js const valueBucket1 = { "NAME": "Lisa", @@ -1123,13 +1281,15 @@ Updates data in the RDB store based on the specified **RdbPredicates** object. T **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| values | [ValuesBucket](#valuesbucket) | Yes| Data to update. The key-value pair is associated with the column name in the target table.| +| values | [ValuesBucket](#valuesbucket) | Yes| Data to update in the RDB store. The key-value pair is associated with the column name in the target table.| | predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.| | callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows updated.| **Example** + ```js const valueBucket = { "NAME": "Rose", @@ -1148,7 +1308,6 @@ rdbStore.update(valueBucket, predicates, function (err, ret) { }) ``` - ### update update(values: ValuesBucket, predicates: RdbPredicates):Promise<number> @@ -1158,17 +1317,20 @@ Updates data based on the specified **RdbPredicates** object. This API uses a pr **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| values | [ValuesBucket](#valuesbucket) | Yes| Data to update. The key-value pair is associated with the column name in the target table.| +| values | [ValuesBucket](#valuesbucket) | Yes| Data to update in the RDB store. The key-value pair is associated with the column name in the target table.| | predicates | [RdbPredicates](#rdbpredicates) | Yes| Update conditions specified by the **RdbPredicates** object.| **Return value** + | Type| Description| | -------- | -------- | | Promise<number> | Promise used to return the number of rows updated.| **Example** + ```js const valueBucket = { "NAME": "Rose", @@ -1191,9 +1353,12 @@ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.Data Updates data in the RDB store based on the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -1202,6 +1367,7 @@ Updates data in the RDB store based on the specified **DataSharePredicates** obj | callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows updated.| **Example** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' const valueBucket = { @@ -1220,15 +1386,19 @@ rdbStore.update("EMPLOYEE", valueBucket, predicates, function (err, ret) { console.log("Updated row count: " + ret) }) ``` + ### update9+ update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates):Promise<number> Updates data in the RDB store based on the specified **DataSharePredicates** object. This API uses a promise to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -1236,11 +1406,13 @@ Updates data in the RDB store based on the specified **DataSharePredicates** obj | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes| Update conditions specified by the **DataSharePredicates** object.| **Return value** + | Type| Description| | -------- | -------- | | Promise<number> | Promise used to return the number of rows updated.| **Example** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' const valueBucket = { @@ -1263,18 +1435,19 @@ promise.then(async (ret) => { delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void - Deletes data from the RDB store based on the specified **RdbPredicates** object. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | Yes| Conditions specified by the **RdbPredicates** object for deleting data.| | callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows updated.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -1287,7 +1460,6 @@ rdbStore.delete(predicates, function (err, rows) { }) ``` - ### delete delete(predicates: RdbPredicates):Promise<number> @@ -1297,16 +1469,19 @@ Deletes data from the RDB store based on the specified **RdbPredicates** object. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | Yes| Conditions specified by the **RdbPredicates** object for deleting data.| **Return value** + | Type| Description| | -------- | -------- | | Promise<number> | Promise used to return the number of rows updated.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Lisa") @@ -1322,12 +1497,14 @@ promise.then((rows) => { delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void - Deletes data from the RDB store based on the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -1335,6 +1512,7 @@ Deletes data from the RDB store based on the specified **DataSharePredicates** o | callback | AsyncCallback<number> | Yes| Callback invoked to return the number of rows updated.| **Example** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' let predicates = new dataSharePredicates.DataSharePredicates() @@ -1347,26 +1525,32 @@ rdbStore.delete("EMPLOYEE", predicates, function (err, rows) { console.log("Deleted rows: " + rows) }) ``` + ### delete9+ delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise<number> Deletes data from the RDB store based on the specified **DataSharePredicates** object. This API uses a promise to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes| Conditions specified by the **DataSharePredicates** object for deleting data.| **Return value** + | Type| Description| | -------- | -------- | | Promise<number> | Promise used to return the number of rows updated.| **Example** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' let predicates = new dataSharePredicates.DataSharePredicates() @@ -1388,6 +1572,7 @@ Queries data from the RDB store based on specified conditions. This API uses an **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | Yes| Query conditions specified by the **RdbPredicates** object.| @@ -1395,6 +1580,7 @@ Queries data from the RDB store based on specified conditions. This API uses an | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | Yes| Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") @@ -1408,7 +1594,6 @@ rdbStore.query(predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], function (e }) ``` - ### query query(predicates: RdbPredicates, columns?: Array<string>):Promise<ResultSet> @@ -1418,17 +1603,20 @@ Queries data from the RDB store based on specified conditions. This API uses a p **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | predicates | [RdbPredicates](#rdbpredicates) | Yes| Query conditions specified by the **RdbPredicates** object.| | columns | Array<string> | No| Columns to query. If this parameter is not specified, the query applies to all columns.| **Return value** + | Type| Description| | -------- | -------- | | Promise<[ResultSet](js-apis-data-resultset.md)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.| **Example** + ```js let predicates = new data_rdb.RdbPredicates("EMPLOYEE") predicates.equalTo("NAME", "Rose") @@ -1447,9 +1635,12 @@ query(table: string, predicates: dataSharePredicates.DataSharePredicates, column Queries data from the RDB store based on specified conditions. This API uses an asynchronous callback to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -1479,9 +1670,12 @@ query(table: string, predicates: dataSharePredicates.DataSharePredicates, column Queries data from the RDB store based on specified conditions. This API uses a promise to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | table | string | Yes| Name of the target table.| @@ -1495,6 +1689,7 @@ Queries data from the RDB store based on specified conditions. This API uses a p | Promise<[ResultSet](js-apis-data-resultset.md)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.| **Example** + ```js import dataSharePredicates from '@ohos.data.dataSharePredicates' let predicates = new dataSharePredicates.DataSharePredicates() @@ -1529,9 +1724,10 @@ Queries data from the RDB store of a remote device based on specified conditions **Example** ```js -let predicates = new rdb.RdbPredicates('EPLOYEE') +let predicates = new data_rdb.RdbPredicates('EMPLOYEE') predicates.greaterThan("id", 0) -rdbStore.remoteQuery("deviceId", "EPLOYEE", predicates, function(err, resultSet){ +rdbStore.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"], + function(err, resultSet){ if (err) { console.info("Failed to remoteQuery, err: " + err) return @@ -1567,9 +1763,9 @@ Queries data from the RDB store of a remote device based on specified conditions **Example** ```js -let predicates = new rdb.RdbPredicates('EPLOYEE') +let predicates = new data_rdb.RdbPredicates('EMPLOYEE') predicates.greaterThan("id", 0) -let promise = rdbStore.remoteQuery("deviceId", "EMPLOYEE", predicates) +let promise = rdbStore.remoteQuery("deviceId", "EMPLOYEE", predicates, ["ID", "NAME", "AGE", "SALARY", "CODES"]) promise.then((resultSet) => { console.info("ResultSet column names: " + resultSet.columnNames) console.info("ResultSet column count: " + resultSet.columnCount) @@ -1587,6 +1783,7 @@ Queries data in the RDB store using the specified SQL statement. This API uses a **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | sql | string | Yes| SQL statement to run.| @@ -1594,6 +1791,7 @@ Queries data in the RDB store using the specified SQL statement. This API uses a | callback | AsyncCallback<[ResultSet](js-apis-data-resultset.md)> | Yes| Callback invoked to return the result. If the operation is successful, a **ResultSet** object will be returned.| **Example** + ```js rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo'], function (err, resultSet) { if (err) { @@ -1605,7 +1803,6 @@ rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", }) ``` - ### querySql8+ querySql(sql: string, bindArgs?: Array<ValueType>):Promise<ResultSet> @@ -1615,17 +1812,20 @@ Queries data in the RDB store using the specified SQL statement. This API uses a **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | sql | string | Yes| SQL statement to run.| | bindArgs | Array<[ValueType](#valuetype)> | No| Arguments in the SQL statement.| **Return value** + | Type| Description| | -------- | -------- | | Promise<[ResultSet](js-apis-data-resultset.md)> | Promise used to return the result. If the operation is successful, a **ResultSet** object will be returned.| **Example** + ```js let promise = rdbStore.querySql("SELECT * FROM EMPLOYEE CROSS JOIN BOOK WHERE BOOK.NAME = ?", ['sanguo']) promise.then((resultSet) => { @@ -1636,7 +1836,6 @@ promise.then((resultSet) => { }) ``` - ### executeSql executeSql(sql: string, bindArgs: Array<ValueType>, callback: AsyncCallback<void>):void @@ -1646,6 +1845,7 @@ Executes an SQL statement that contains specified arguments but returns no value **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | sql | string | Yes| SQL statement to run.| @@ -1653,6 +1853,7 @@ Executes an SQL statement that contains specified arguments but returns no value | callback | AsyncCallback<void> | Yes| Callback invoked to return the result.| **Example** + ```js const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) { @@ -1664,7 +1865,6 @@ rdbStore.executeSql(SQL_CREATE_TABLE, null, function(err) { }) ``` - ### executeSql executeSql(sql: string, bindArgs?: Array<ValueType>):Promise<void> @@ -1674,17 +1874,20 @@ Executes an SQL statement that contains specified arguments but returns no value **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | sql | string | Yes| SQL statement to run.| | bindArgs | Array<[ValueType](#valuetype)> | No| Arguments in the SQL statement.| **Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| **Example** + ```js const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)" let promise = rdbStore.executeSql(SQL_CREATE_TABLE) @@ -1704,19 +1907,24 @@ Starts the transaction before executing an SQL statement. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Example** + ```js -rdbStore.beginTransaction() -const valueBucket = { - "name": "lisi", - "age": 18, - "salary": 100.5, - "blobType": new Uint8Array([1, 2, 3]), -} -await rdbStore.insert("test", valueBucket) -rdbStore.commit() +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() +const STORE_CONFIG = { name: "RdbTest.db"} +data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) { + rdbStore.beginTransaction() + const valueBucket = { + "name": "lisi", + "age": 18, + "salary": 100.5, + "blobType": new Uint8Array([1, 2, 3]), + } + await rdbStore.insert("test", valueBucket) + rdbStore.commit() +}) ``` - ### commit8+ commit():void @@ -1726,20 +1934,24 @@ Commits the executed SQL statements. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Example** -```js -rdbStore.beginTransaction() -const valueBucket = { - "name": "lisi", - "age": 18, - "salary": 100.5, - "blobType": new Uint8Array([1, 2, 3]), -} -await rdbStore.insert("test", valueBucket) -rdbStore.commit() +```js +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() +const STORE_CONFIG = { name: "RdbTest.db"} +data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) { + rdbStore.beginTransaction() + const valueBucket = { + "name": "lisi", + "age": 18, + "salary": 100.5, + "blobType": new Uint8Array([1, 2, 3]), + } + await rdbStore.insert("test", valueBucket) + rdbStore.commit() +}) ``` - ### rollBack8+ rollBack():void @@ -1749,21 +1961,27 @@ Rolls back the SQL statements that have been executed. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Example** + ```js -try { - rdbStore.beginTransaction() - const valueBucket = { - "id": 1, - "name": "lisi", - "age": 18, - "salary": 100.5, - "blobType": new Uint8Array([1, 2, 3]), - } - await rdbStore.insert("test", valueBucket) - rdbStore.commit() -} catch (e) { - rdbStore.rollBack() -} +import featureAbility from '@ohos.ability.featureAbility' +var context = featureAbility.getContext() +const STORE_CONFIG = { name: "RdbTest.db"} +data_rdb.getRdbStore(context, STORE_CONFIG, 1, async function (err, rdbStore) { + try { + rdbStore.beginTransaction() + const valueBucket = { + "id": 1, + "name": "lisi", + "age": 18, + "salary": 100.5, + "blobType": new Uint8Array([1, 2, 3]), + } + await rdbStore.insert("test", valueBucket) + rdbStore.commit() + } catch (e) { + rdbStore.rollBack() + } +}) ``` ### backup9+ @@ -1775,12 +1993,14 @@ Backs up an RDB store. This API uses an asynchronous callback to return the resu **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | destName | string | Yes| Name of the RDB store backup file.| | callback | AsyncCallback<void> | Yes| Callback invoked to return the result.| **Example** + ```js rdbStore.backup("dbBackup.db", function(err) { if (err) { @@ -1800,16 +2020,19 @@ Backs up an RDB store. This API uses a promise to return the result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | destName | string | Yes| Name of the RDB store backup file.| **Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| **Example** + ```js let promiseBackup = rdbStore.backup("dbBackup.db") promiseBackup.then(()=>{ @@ -1828,12 +2051,14 @@ Restores an RDB store from a backup file. This API uses an asynchronous callback **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | srcName | string | Yes| Name of the RDB store backup file.| | callback | AsyncCallback<void> | Yes| Callback invoked to return the result.| **Example** + ```js rdbStore.restore("dbBackup.db", function(err) { if (err) { @@ -1853,16 +2078,19 @@ Restores an RDB store from a backup file. This API uses a promise to return the **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | srcName | string | Yes| Name of the RDB store backup file.| **Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| **Example** + ```js let promiseRestore = rdbStore.restore("dbBackup.db") promiseRestore.then(()=>{ @@ -1883,12 +2111,14 @@ Sets distributed tables. This API uses an asynchronous callback to return the re **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | tables | Array<string> | Yes| Names of the distributed tables to set.| | callback | AsyncCallback<void> | Yes| Callback invoked to return the result.| **Example** + ```js rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { if (err) { @@ -1899,7 +2129,6 @@ rdbStore.setDistributedTables(["EMPLOYEE"], function (err) { }) ``` - ### setDistributedTables8+ setDistributedTables(tables: Array<string>): Promise<void> @@ -1911,22 +2140,25 @@ Sets distributed tables. This API uses a promise to return the result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | tables | Array<string> | Yes| Names of the distributed tables to set.| **Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| **Example** + ```js let promise = rdbStore.setDistributedTables(["EMPLOYEE"]) promise.then(() => { console.info("Set distributed tables successfully.") }).catch((err) => { - console.info('Failed to set distributed tables, err: ' + err) + console.info("Failed to set distributed tables, err: " + err) }) ``` @@ -1941,6 +2173,7 @@ Obtains the distributed table name for a remote device based on the local table **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | device | string | Yes| Remote device.| @@ -1948,6 +2181,7 @@ Obtains the distributed table name for a remote device based on the local table | callback | AsyncCallback<string> | Yes| Callback invoked to return the result. If the operation succeeds, the distributed table name of the remote device is returned.| **Example** + ```js rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, tableName) { if (err) { @@ -1958,7 +2192,6 @@ rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE", function (err, }) ``` - ### obtainDistributedTableName8+ obtainDistributedTableName(device: string, table: string): Promise<string> @@ -1970,17 +2203,20 @@ Obtains the distributed table name for a remote device based on the local table **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | device | string | Yes| Remote device.| | table | string | Yes| Local table name.| **Return value** + | Type| Description| | -------- | -------- | | Promise<string> | Promise used to return the result. If the operation succeeds, the distributed table name of the remote device is returned.| **Example** + ```js let promise = rdbStore.obtainDistributedTableName("12345678abcde", "EMPLOYEE") promise.then((tableName) => { @@ -2001,6 +2237,7 @@ Synchronizes data between devices. This API uses an asynchronous callback to ret **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | mode | [SyncMode](#syncmode8) | Yes| Data synchronization mode. The value can be **push** or **pull**.| @@ -2008,6 +2245,7 @@ Synchronizes data between devices. This API uses an asynchronous callback to ret | callback | AsyncCallback<Array<[string, number]>> | Yes| Callback invoked to send the synchronization result to the caller.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. | **Example** + ```js let predicates = new data_rdb.RdbPredicates('EMPLOYEE') predicates.inDevices(['12345678abcde']) @@ -2023,7 +2261,6 @@ rdbStore.sync(data_rdb.SyncMode.SYNC_MODE_PUSH, predicates, function (err, resul }) ``` - ### sync8+ sync(mode: SyncMode, predicates: RdbPredicates): Promise<Array<[string, number]>> @@ -2035,6 +2272,7 @@ Synchronizes data between devices. This API uses a promise to return the result. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | mode | [SyncMode](#syncmode8) | Yes| Data synchronization mode. The value can be **push** or **pull**.| @@ -2047,6 +2285,7 @@ Synchronizes data between devices. This API uses a promise to return the result. | Promise<Array<[string, number]>> | Promise used to return the synchronization result to the caller.
**string** indicates the device ID.
**number** indicates the synchronization status of that device. The value **0** indicates a successful synchronization. Other values indicate a synchronization failure. | **Example** + ```js let predicates = new data_rdb.RdbPredicates('EMPLOYEE') predicates.inDevices(['12345678abcde']) @@ -2080,6 +2319,7 @@ Registers an observer for this RDB store. When the data in the RDB store changes | observer | Callback<Array<string>> | Yes| Observer that listens for the data changes in the RDB store.| **Example** + ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { @@ -2112,6 +2352,7 @@ Unregisters the observer of the specified type from the RDB store. This API uses | observer | Callback<Array<string>> | Yes| Data change observer registered.| **Example** + ```js function storeObserver(devices) { for (let i = 0; i < devices.length; i++) { @@ -2127,14 +2368,14 @@ try { ## StoreConfig -Manages the configuration of an RDB store. +Defines the RDB store configuration. **System capability**: SystemCapability.DistributedDataManager.RelationalStore.Core | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | name | string | Yes| Database file name.| - +| encrypt9+ | boolean | No| Whether to encrypt the RDB store.
The value **true** means to encrypt the RDB store, and the value **false** means the opposite.| ## ValueType diff --git a/en/application-dev/reference/apis/js-apis-data-storage.md b/en/application-dev/reference/apis/js-apis-data-storage.md index cd1535b43bfe4e5d13a6460b066a082e31db8020..f01e1a3ab8db3d7fb42d8362a35e29455066b15e 100644 --- a/en/application-dev/reference/apis/js-apis-data-storage.md +++ b/en/application-dev/reference/apis/js-apis-data-storage.md @@ -5,9 +5,11 @@ Lightweight storage provides applications with data processing capability and al > **NOTE** > -> - The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> - The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > -> - The APIs of this module are no longer maintained since API Version 9. You are advised to use [`@ohos.data.preferences`](js-apis-data-preferences.md). +> - The APIs of this module are no longer maintained since API version 9. You are advised to use [`@ohos.data.preferences`](js-apis-data-preferences.md). +> +> - The APIs of this module can be used only in the FA model. ## Modules to Import @@ -36,15 +38,15 @@ Reads the specified file and loads its data to the **Storage** instance for data **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------ | -| path | string | Yes | Path of the target file. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| **Return value** -| Type | Description | -| ------------------- | ------------------------------------------------------ | -| [Storage](#storage) | **Storage** instance used for data storage operations. | +| Type | Description | +| ------------------- | ------------------------------------------------- | +| [Storage](#storage) | **Storage** instance used for data storage operations.| **Example** @@ -54,13 +56,13 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -let storage = data_storage.getStorageSync(path + '/mystore'); -storage.putSync('startup', 'auto'); -storage.flushSync(); + let storage = data_storage.getStorageSync(path + '/mystore'); + storage.putSync('startup', 'auto'); + storage.flushSync(); +}); ``` @@ -74,10 +76,10 @@ Reads the specified file and loads its data to the **Storage** instance for data **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ---------------------------------------- | --------- | --------------------------------------------- | -| path | string | Yes | Path of the target file. | -| callback | AsyncCallback<[Storage](#storage)> | Yes | Callback used to return the execution result. | +| Name | Type | Mandatory| Description | +| -------- | ---------------------------------------- | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| +| callback | AsyncCallback<[Storage](#storage)> | Yes | Callback used to return the execution result. | **Example** @@ -87,18 +89,18 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -data_storage.getStorage(path + '/mystore', function (err, storage) { + data_storage.getStorage(path + '/mystore', function (err, storage) { if (err) { - console.info("Failed to get the storage. path: " + path + '/mystore'); - return; + console.info("Failed to get the storage. path: " + path + '/mystore'); + return; } storage.putSync('startup', 'auto'); storage.flushSync(); -}) + }) +}); ``` @@ -112,15 +114,15 @@ Reads the specified file and loads its data to the **Storage** instance for data **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------ | -| path | string | Yes | Path of the target file. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| **Return value** -| Type | Description | -| ---------------------------------- | ---------------------------------- | -| Promise<[Storage](#storage)> | Promise used to return the result. | +| Type | Description | +| ---------------------------------- | ------------------------------- | +| Promise<[Storage](#storage)> | Promise used to return the result.| **Example** @@ -130,17 +132,17 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -let getPromise = data_storage.getStorage(path + '/mystore'); -getPromise.then((storage) => { + let getPromise = data_storage.getStorage(path + '/mystore'); + getPromise.then((storage) => { storage.putSync('startup', 'auto'); storage.flushSync(); -}).catch((err) => { + }).catch((err) => { console.info("Failed to get the storage. path: " + path + '/mystore'); -}) + }) +}); ``` @@ -154,9 +156,9 @@ Deletes the singleton **Storage** instance of a file from the memory, and delete **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------ | -| path | string | Yes | Path of the target file. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| **Example** @@ -167,13 +169,12 @@ var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + console.info("======================>getFilesDirPromise====================>"); -data_storage.deleteStorageSync(path + '/mystore'); + data_storage.deleteStorageSync(path + '/mystore'); +}); ``` - ## data_storage.deleteStorage deleteStorage(path: string, callback: AsyncCallback<void>): void @@ -184,9 +185,9 @@ Deletes the singleton **Storage** instance of a file from the memory, and delete **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | --------- | ------------------------------- | -| path | string | Yes | Path of the target file. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| | callback | AsyncCallback<void> | Yes | Callback that returns no value. | **Example** @@ -197,17 +198,17 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -data_storage.deleteStorage(path + '/mystore', function (err) { + data_storage.deleteStorage(path + '/mystore', function (err) { if (err) { - console.info("Failed to delete the storage with err: " + err); - return; + console.info("Failed to delete the storage with err: " + err); + return; } console.info("Succeeded in deleting the storage."); -}) + }) +}); ``` @@ -221,13 +222,14 @@ Deletes the singleton **Storage** instance of a file from the memory, and delete **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------ | -| path | string | Yes | Path of the target file. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| **Return value** -| Type | Description | -| ------------------- | ------------------------------ | + +| Type | Description | +| ------------------- | ------------------------------- | | Promise<void> | Promise that returns no value. | **Example** @@ -238,16 +240,16 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -let promisedelSt = data_storage.deleteStorage(path + '/mystore'); -promisedelSt.then(() => { + let promisedelSt = data_storage.deleteStorage(path + '/mystore'); + promisedelSt.then(() => { console.info("Succeeded in deleting the storage."); -}).catch((err) => { + }).catch((err) => { console.info("Failed to delete the storage with err: " + err); -}) + }) +}); ``` @@ -260,10 +262,9 @@ Removes the singleton **Storage** instance of a file from the cache. The removed **System capability**: SystemCapability.DistributedDataManager.Preferences.Core **Parameters** - -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------ | -| path | string | Yes | Path of the target file. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| **Example** @@ -274,10 +275,10 @@ var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { path = filePath; - console.info("======================>getFilesDirPromsie====================>"); + console.info("======================>getFilesDirPromise====================>"); + + data_storage.removeStorageFromCacheSync(path + '/mystore'); }); - -data_storage.removeStorageFromCacheSync(path + '/mystore'); ``` @@ -291,9 +292,9 @@ Removes the singleton **Storage** instance of a file from the cache. The removed **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | --------- | ------------------------------- | -| path | string | Yes | Path of the target file. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| | callback | AsyncCallback<void> | Yes | Callback that returns no value. | **Example** @@ -304,17 +305,17 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -data_storage.removeStorageFromCache(path + '/mystore', function (err) { + data_storage.removeStorageFromCache(path + '/mystore', function (err) { if (err) { - console.info("Failed to remove storage from cache with err: " + err); - return; + console.info("Failed to remove storage from cache with err: " + err); + return; } console.info("Succeeded in removing storage from cache."); -}) + }) +}); ``` @@ -328,14 +329,14 @@ Removes the singleton **Storage** instance of a file from the cache. The removed **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------ | -| path | string | Yes | Path of the target file. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | -------------------------- | +| path | string | Yes | Path of the target file.| **Return value** -| Type | Description | -| ------------------- | ------------------------------ | +| Type | Description | +| ------------------- | ------------------------------- | | Promise<void> | Promise that returns no value. | **Example** @@ -346,24 +347,22 @@ import featureAbility from '@ohos.ability.featureAbility'; var path; var context = featureAbility.getContext(); context.getFilesDir().then((filePath) => { - path = filePath; - console.info("======================>getFilesDirPromsie====================>"); -}); + path = filePath; + console.info("======================>getFilesDirPromise====================>"); -let promiserevSt = data_storage.removeStorageFromCache(path + '/mystore') -promiserevSt.then(() => { + let promiserevSt = data_storage.removeStorageFromCache(path + '/mystore') + promiserevSt.then(() => { console.info("Succeeded in removing storage from cache."); -}).catch((err) => { + }).catch((err) => { console.info("Failed to remove storage from cache with err: " + err); -}) + }) +}); ``` - ## Storage Provides APIs for obtaining and modifying storage data. - ### getSync getSync(key: string, defValue: ValueType): ValueType @@ -374,16 +373,16 @@ Obtains the value corresponding to a key. If the value is null or not in the def **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ----------------------- | --------- | ------------------------------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | -| defValue | [ValueType](#valuetype) | Yes | Default value to be returned if the value of the specified key does not exist. It can be a number, string, or Boolean value. | +| Name | Type | Mandatory| Description | +| -------- | ----------------------- | ---- | ------------------------------------------------------------ | +| key | string | Yes | Key of the data. It cannot be empty. | +| defValue | [ValueType](#valuetype) | Yes | Default value to be returned if the value of the specified key does not exist. It can be a number, string, or Boolean value.| **Return value** -| Type | Description | -| --------- | ------------------------------------------------------------ | -| ValueType | Value corresponding to the specified key. If the value is null or not in the default value format, the default value is returned. | +| Type | Description | +| --------- | -------------------------------------------------------- | +| ValueType | Value corresponding to the specified key. If the value is null or not in the default value format, the default value is returned.| **Example** @@ -403,11 +402,11 @@ Obtains the value corresponding to a key. If the value is null or not in the def **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------------ | --------- | ------------------------------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | -| defValue | [ValueType](#valuetype) | Yes | Default value to be returned. It can be a number, string, or Boolean value. | -| callback | AsyncCallback<ValueType> | Yes | Callback used to return the execution result. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------------ | ---- | ----------------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty. | +| defValue | [ValueType](#valuetype) | Yes | Default value to be returned. It can be a number, string, or Boolean value.| +| callback | AsyncCallback<ValueType> | Yes | Callback used to return the execution result. | **Example** @@ -432,18 +431,19 @@ Obtains the value corresponding to a key. If the value is null or not in the def **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ----------------------- | --------- | ------------------------------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | -| defValue | [ValueType](#valuetype) | Yes | Default value to be returned. It can be a number, string, or Boolean value. | +| Name | Type | Mandatory| Description | +| -------- | ----------------------- | ---- | ----------------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty. | +| defValue | [ValueType](#valuetype) | Yes | Default value to be returned. It can be a number, string, or Boolean value.| **Return value** -| Type | Description | -| ------------------------ | ---------------------------------- | -| Promise<ValueType> | Promise used to return the result. | +| Type | Description | +| ------------------------ | ------------------------------- | +| Promise<ValueType> | Promise used to return the result.| **Example** + ```js let promiseget = storage.get('startup', 'default'); promiseget.then((value) => { @@ -464,15 +464,15 @@ Obtains the **Storage** instance corresponding to the specified file, writes dat **Parameters** -| Name | Type | Mandatory | Description | -| ----- | ----------------------- | --------- | ------------------------------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | -| value | [ValueType](#valuetype) | Yes | New value to store. It can be a number, string, or Boolean value. | +| Name| Type | Mandatory| Description | +| ------ | ----------------------- | ---- | ----------------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty. | +| value | [ValueType](#valuetype) | Yes | New value to store. It can be a number, string, or Boolean value.| **Example** ```js -storage.putSync('startup', 'auto') +storage.putSync('startup', 'auto'); ``` @@ -486,10 +486,10 @@ Obtains the **Storage** instance corresponding to the specified file, writes dat **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | --------- | ------------------------------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | -| value | [ValueType](#valuetype) | Yes | New value to store. It can be a number, string, or Boolean value. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ----------------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty. | +| value | [ValueType](#valuetype) | Yes | New value to store. It can be a number, string, or Boolean value.| | callback | AsyncCallback<void> | Yes | Callback that returns no value. | **Example** @@ -515,18 +515,19 @@ Obtains the **Storage** instance corresponding to the specified file, writes dat **Parameters** -| Name | Type | Mandatory | Description | -| ----- | ----------------------- | --------- | ------------------------------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | -| value | [ValueType](#valuetype) | Yes | New value to store. It can be a number, string, or Boolean value. | +| Name| Type | Mandatory| Description | +| ------ | ----------------------- | ---- | ----------------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty. | +| value | [ValueType](#valuetype) | Yes | New value to store. It can be a number, string, or Boolean value.| **Return value** -| Type | Description | -| ------------------- | ------------------------------ | +| Type | Description | +| ------------------- | --------------------------- | | Promise<void> | Promise that returns no value. | **Example** + ```js let promiseput = storage.put('startup', 'auto'); promiseput.then(() => { @@ -547,15 +548,15 @@ Checks whether the storage object contains data with a given key. **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty.| **Return value** -| Type | Description | -| ------- | ------------------------------------------------------------ | -| boolean | Returns **true** if the storage object contains data with the specified key; returns **false** otherwise. | +| Type | Description | +| ------- | ------------------------------------- | +| boolean | Returns **true** if the storage object contains data with the specified key; returns **false** otherwise.| **Example** @@ -577,16 +578,16 @@ Checks whether the storage object contains data with a given key. This API uses **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ---------------------------- | --------- | --------------------------------------------- | -| key | string | Yes | Key of the data. It cannot be empty. | -| callback | AsyncCallback<boolean> | Yes | Callback used to return the execution result. | +| Name | Type | Mandatory| Description | +| -------- | ---------------------------- | ---- | ------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty.| +| callback | AsyncCallback<boolean> | Yes | Callback used to return the execution result. | **Return value** -| Type | Description | -| ------- | ------------------------------------------------------------ | -| boolean | Returns **true** if the storage object contains data with the specified key; returns **false** otherwise. | +| Type | Description | +| ------- | ------------------------------- | +| boolean | Returns **true** if the storage object contains data with the specified key; returns **false** otherwise.| **Example** @@ -613,15 +614,15 @@ Checks whether the storage object contains data with a given key. This API uses **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | ------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty.| **Return value** -| Type | Description | -| ---------------------- | ---------------------------------- | -| Promise<boolean> | Promise used to return the result. | +| Type | Description | +| ---------------------- | --------------------------- | +| Promise<boolean> | Promise used to return the result.| **Example** @@ -647,14 +648,14 @@ Deletes data with the specified key from this storage object. **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | --------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty.| **Example** ```js -storage.deleteSync('startup') + storage.deleteSync('startup'); ``` @@ -668,9 +669,9 @@ Deletes data with the specified key from this storage object. This API uses an a **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | --------- | ------------------------------------ | -| key | string | Yes | Key of the data. It cannot be empty. | +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ------------------------------- | +| key | string | Yes | Key of the data. It cannot be empty.| | callback | AsyncCallback<void> | Yes | Callback that returns no value. | **Example** @@ -696,14 +697,14 @@ Deletes data with the specified key from this storage object. This API uses a pr **Parameters** -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ---------------- | -| key | string | Yes | Key of the data. | +| Name| Type | Mandatory| Description | +| ------ | ------ | ---- | --------------------- | +| key | string | Yes | Key of the data.| **Return value** -| Type | Description | -| ------------------- | ------------------------------ | +| Type | Description | +| ------------------- | --------------------------- | | Promise<void> | Promise that returns no value. | **Example** @@ -729,7 +730,7 @@ Saves the modification of this object to the **Storage** instance and synchroniz **Example** ```js -storage.flushSync() +storage.flushSync(); ``` @@ -743,8 +744,8 @@ Saves the modification of this object to the **Storage** instance and synchroniz **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | --------- | ------------------------------- | +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ---------- | | callback | AsyncCallback<void> | Yes | Callback that returns no value. | **Example** @@ -770,8 +771,8 @@ Saves the modification of this object to the **Storage** instance and synchroniz **Return value** -| Type | Description | -| ------------------- | ------------------------------ | +| Type | Description | +| ------------------- | --------------------------- | | Promise<void> | Promise that returns no value. | **Example** @@ -797,7 +798,7 @@ Clears this **Storage** object. **Example** ```js -storage.clearSync() +storage.clearSync(); ``` @@ -811,8 +812,8 @@ Clears this **Storage** object. This API uses an asynchronous callback to return **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | --------- | ------------------------------- | +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ---------- | | callback | AsyncCallback<void> | Yes | Callback that returns no value. | **Example** @@ -837,9 +838,8 @@ Clears this **Storage** object. This API uses a promise to return the result. **System capability**: SystemCapability.DistributedDataManager.Preferences.Core **Return value** - -| Type | Description | -| ------------------- | ------------------------------ | +| Type | Description | +| ------------------- | --------------------------- | | Promise<void> | Promise that returns no value. | **Example** @@ -864,10 +864,10 @@ Subscribes to data changes. The **StorageObserver** needs to be implemented. Whe **Parameters** -| Name | Type | Description | -| -------- | --------------------------------------------------- | ------------------------------------------------------------ | -| type | string | Event type. The value **change** indicates data change events. | -| callback | Callback<[StorageObserver](#storageobserver)> | Callback used to return data changes. | +| Name | Type | Description | +| -------- | --------------------------------------------------- | ---------------------------------------- | +| type | string | Event type. The value **change** indicates data change events.| +| callback | Callback<[StorageObserver](#storageobserver)> | Callback used to return data changes. | **Example** @@ -891,10 +891,10 @@ Unsubscribes from data changes. **Parameters** -| Name | Type | Description | -| -------- | --------------------------------------------------- | ------------------------------------------------------------ | -| type | string | Event type. The value **change** indicates data change events. | -| callback | Callback<[StorageObserver](#storageobserver)> | Callback used to return data changes. | +| Name | Type | Description | +| -------- | --------------------------------------------------- | ---------------------------------------- | +| type | string | Event type. The value **change** indicates data change events.| +| callback | Callback<[StorageObserver](#storageobserver)> | Callback used to return data changes. | **Example** @@ -910,9 +910,9 @@ storage.off('change', observer); **System capability**: SystemCapability.DistributedDataManager.Preferences.Core -| Name | Type | Mandatory | Description | -| ---- | ------ | --------- | ------------- | -| key | string | No | Data changed. | +| Name| Type| Mandatory| Description | +| ---- | -------- | ---- | ---------------- | +| key | string | No | Data changed.| ## ValueType @@ -920,8 +920,8 @@ Enumerates the value types. **System capability**: SystemCapability.DistributedDataManager.Preferences.Core -| Type | Description | -| ------- | ----------------------------- | -| number | The value is a number. | -| string | The value is a string. | -| boolean | The value is of Boolean type. | \ No newline at end of file +| Type | Description | +| ------- | -------------------- | +| number | The value is a number. | +| string | The value is a string. | +| boolean | The value is of Boolean type.| diff --git a/en/application-dev/reference/apis/js-apis-deque.md b/en/application-dev/reference/apis/js-apis-deque.md index 8d9a9c1b42bef6ce74fdfb21a8033b80e68c1868..973cdfb78725ba03576d7cc6a561c71e6930aeb2 100644 --- a/en/application-dev/reference/apis/js-apis-deque.md +++ b/en/application-dev/reference/apis/js-apis-deque.md @@ -8,10 +8,13 @@ Double-ended queue (deque) is a sequence container implemented based on the queu **Queue** follows the principle of FIFO only and allows element removal at the front and insertion at the rear. -**Vector** supports insertion and deletion of elements in between, as well asat both the ends. When compared with **Vector**, **Deque** is more efficient in inserting and removing header elements, but less efficient in accessing elements. +**Vector** supports insertion and deletion of elements in between, as well as at both the ends. When compared with **Vector**, **Deque** is more efficient in inserting and removing header elements, but less efficient in accessing elements. **Recommended use case**: Use **Deque** when you need to frequently insert or remove elements at both the ends of a container. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -64,7 +67,7 @@ deque.insertFront("a"); deque.insertFront(1); let b = [1, 2, 3]; deque.insertFront(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; deque.insertFront(false); ``` @@ -90,7 +93,7 @@ deque.insertEnd("a"); deque.insertEnd(1); let b = [1, 2, 3]; deque.insertEnd(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; deque.insertEnd(false); ``` @@ -118,9 +121,9 @@ Checks whether this container has the specified element. ```ts let deque = new Deque(); -let result = deque.has("Ahfbrgrbgnutfodgorrogorg"); -deque.insertFront("Ahfbrgrbgnutfodgorrogorg"); -let result1 = deque.has("Ahfbrgrbgnutfodgorrogorg"); +let result = deque.has("squirrel"); +deque.insertFront("squirrel"); +let result1 = deque.has("squirrel"); ``` ### popFirst diff --git a/en/application-dev/reference/apis/js-apis-deviceUsageStatistics.md b/en/application-dev/reference/apis/js-apis-deviceUsageStatistics.md index 8d18622ce2eb432210858545308e2a607891b1f0..81ee6f74b796de60b190f06b3f2a8a719f8569c3 100644 --- a/en/application-dev/reference/apis/js-apis-deviceUsageStatistics.md +++ b/en/application-dev/reference/apis/js-apis-deviceUsageStatistics.md @@ -484,9 +484,9 @@ Obtains the number of FA usage records specified by **maxNum**. This API uses a ## bundleState.getRecentlyUsedModules9+ -getRecentlyUsedModules(maxNum?: number, callback: AsyncCallback<Array<BundleActiveModuleInfo>>): void +getRecentlyUsedModules(callback: AsyncCallback<Array<BundleActiveModuleInfo>>): void -Obtains the number of FA usage records specified by **maxNum**. This API uses an asynchronous callback to return the records sorted by time (most recent first). +This API uses an asynchronous callback to return at most 1000 records sorted by time (most recent first). **Required permissions**: ohos.permission.BUNDLE_ACTIVE_INFO @@ -498,13 +498,12 @@ Obtains the number of FA usage records specified by **maxNum**. This API uses an | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ----------------------------------- | -| maxNum | number | No | Maximum number of returned records. The maximum and default value is **1000**. If this parameter is not specified, **1000** is used. | | callback | AsyncCallback<Array<[BundleActiveModuleInfo](#bundleactivemoduleinfo9)>> | Yes | Callback used to return the result.| **Example** ```js - bundleState.getRecentlyUsedModules(1000,(err, res) => { + bundleState.getRecentlyUsedModules((err, res) => { if(err) { console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code); } else { @@ -513,11 +512,33 @@ Obtains the number of FA usage records specified by **maxNum**. This API uses an console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback number : ' + (i + 1)); console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback result ' + JSON.stringify(res[i])); } - } + } }); + ``` - // Invocation when maxNum is not passed - bundleState.getRecentlyUsedModules((err, res) => { +## bundleState.getRecentlyUsedModules9+ + +getRecentlyUsedModules(maxNum: number, callback: AsyncCallback<Array<BundleActiveModuleInfo>>): void + +Obtains the number of FA usage records specified by **maxNum**. This API uses an asynchronous callback to return the records sorted by time (most recent first). + +**Required permissions**: ohos.permission.BUNDLE_ACTIVE_INFO + +**System capability**: SystemCapability.ResourceSchedule.UsageStatistics.App + +**System API**: This is a system API and cannot be called by third-party applications. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | ---- | ----------------------------------- | +| maxNum | number | Yes | Maximum number of returned records. The maximum and default value is **1000**.| +| callback | AsyncCallback<Array<[BundleActiveModuleInfo](#bundleactivemoduleinfo9)>> | Yes | Callback used to return the result.| + +**Example** + + ```js + bundleState.getRecentlyUsedModules(1000,(err, res) => { if(err) { console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code); } else { @@ -526,7 +547,7 @@ Obtains the number of FA usage records specified by **maxNum**. This API uses an console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback number : ' + (i + 1)); console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback result ' + JSON.stringify(res[i])); } - } + } }); ``` @@ -574,9 +595,9 @@ bundleState.queryAppUsagePriorityGroup().then( res => { ## bundleState.queryAppUsagePriorityGroup9+ -queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback<number>): void +queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void -Queries the priority group of the application specified by **bundleName**. If **bundleName** is not specified, the priority group of the current application is queried. This API uses an asynchronous callback to return the result. +Queries the priority group of the current application . This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.BUNDLE_ACTIVE_INFO @@ -588,23 +609,44 @@ Queries the priority group of the application specified by **bundleName**. If ** | Name | Type | Mandatory | Description | | ---------- | --------------------- | ---- | ---------------------------------------- | -| bundleName | string | No | Bundle name of the target application. If this parameter is not specified, the priority group of the current application is queried.| | callback | AsyncCallback<number> | Yes | Callback used to return the result. | **Example** ```javascript -// Callback with bundleName -let bundleName = "com.ohos.camera"; -bundleState.queryAppUsagePriorityGroup(bundleName, (err, res) => { +bundleState.queryAppUsagePriorityGroup((err, res) => { if(err) { console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code); } else { console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res)); } }); -// Callback without bundleName -bundleState.queryAppUsagePriorityGroup((err, res) => { +``` + +## bundleState.queryAppUsagePriorityGroup9+ + +queryAppUsagePriorityGroup(bundleName : string, callback: AsyncCallback<number>): void + +Queries the priority group of the application specified by **bundleName**. This API uses an asynchronous callback to return the result. + +**Required permissions**: ohos.permission.BUNDLE_ACTIVE_INFO + +**System capability**: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup + +**System API**: This is a system API and cannot be called by third-party applications. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---------- | --------------------- | ---- | ---------------------------------------- | +| bundleName | string | Yes | Bundle name of the target application.| +| callback | AsyncCallback<number> | Yes | Callback used to return the result. | + +**Example** + +```javascript +let bundleName = "com.ohos.camera"; +bundleState.queryAppUsagePriorityGroup(bundleName, (err, res) => { if(err) { console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code); } else { @@ -688,7 +730,7 @@ bundleState.setBundleGroup(bundleName, newGroup, (err) => { ## bundleState.registerGroupCallBack9+ -registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>): Promise<void> +registerGroupCallBack(groupCallback: Callback<BundleActiveGroupCallbackInfo>): Promise<void> Registers a callback for application group changes. When an application group of the user changes, a **[BundleActiveGroupCallbackInfo](#bundleactivegroupcallbackinfo9)** instance is returned to all applications that have registered the callback. This API uses a promise to return the result. @@ -730,7 +772,7 @@ bundleState.registerGroupCallBack(onBundleGroupChanged).then( () => { ## bundleState.registerGroupCallBack9+ -registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>, callback: AsyncCallback<void>): void +registerGroupCallBack(groupCallback: Callback<BundleActiveGroupCallbackInfo>, callback: AsyncCallback<void>): void Registers a callback for application group changes. When an application group of the user changes, a **[BundleActiveGroupCallbackInfo](#bundleactivegroupcallbackinfo9)** instance is returned to all applications that have registered the callback. This API uses an asynchronous callback to return the result. @@ -1034,20 +1076,6 @@ Provides the usage duration information of applications. | infosBeginTime | number | No | Time logged in the first application usage record in the **BundleActiveInfo** object.
This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.| | infosEndTime | number | No | Time logged in the last application usage record in the **BundleActiveInfo** object.
This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR.| -### merge - -merge(toMerge: BundleStateInfo): void - -Merges the application usage information that has the same bundle name. - -**System capability**: SystemCapability.ResourceSchedule.UsageStatistics.App - -**Parameters** - -| Name | Type | Mandatory | Description | -| ------- | ----------------------------------- | ---- | -------------- | -| toMerge | [BundleStateInfo](#bundlestateinfo) | Yes | Application usage information to merge.| - ## BundleActiveState Provides information about an application event. diff --git a/en/application-dev/reference/apis/js-apis-dispatchInfo.md b/en/application-dev/reference/apis/js-apis-dispatchInfo.md index 5f476f34bd9ed8c08fc0e033243c1f4fb55ca23c..749ff83e51d077e066bc426c78a5e329510bf0c8 100644 --- a/en/application-dev/reference/apis/js-apis-dispatchInfo.md +++ b/en/application-dev/reference/apis/js-apis-dispatchInfo.md @@ -10,7 +10,9 @@ The **DispatchInfo** module provides dispatch information. **System capability**: SystemCapability.BundleManager.BundleFramework +**System API**: This is a system API and cannot be called by third-party applications. + | Name | Type | Readable| Writable| Description | | ----------- | ------ | ---- | ---- | ------------------------ | -| verison | string | Yes | No | Version of the API to dispatch.| +| version | string | Yes | No | Version of the API to dispatch.| | dispatchAPI | string | Yes | No | API to dispatch. | diff --git a/en/application-dev/reference/apis/js-apis-distributed-account.md b/en/application-dev/reference/apis/js-apis-distributed-account.md index 46b962bb7e0dfbb16ea2ef4ba6a0bf2ac37ec5e0..4dc76cd2d39f631d74d5c51b61259bd88a1ea924 100644 --- a/en/application-dev/reference/apis/js-apis-distributed-account.md +++ b/en/application-dev/reference/apis/js-apis-distributed-account.md @@ -19,12 +19,15 @@ getDistributedAccountAbility(): DistributedAccountAbility Obtains a **DistributedAccountAbility** instance. -- Return value +**System capability**: SystemCapability.Account.OsAccount + +**Return value** + | Type| Description| | -------- | -------- | | [DistributedAccountAbility](#distributedaccountability) | **DistributedAccountAbility** instance obtained. This instance provides methods for querying and updating the login state of a distributed account.| -- Example +**Example** ```js const accountAbility = account_distributedAccount.getDistributedAccountAbility(); ``` @@ -43,12 +46,13 @@ Obtains distributed account information. This API uses an asynchronous callback **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.DISTRIBUTED_DATASYNC -- Parameters +**Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[DistributedInfo](#distributedinfo)> | Yes| Callback invoked to return the distributed account information obtained.| -- Example +**Example** ```js const accountAbility = account_distributedAccount.getDistributedAccountAbility(); accountAbility.queryOsAccountDistributedInfo((err, data) => { @@ -68,12 +72,13 @@ Obtains distributed account information. This API uses a promise to return the r **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS or ohos.permission.DISTRIBUTED_DATASYNC -- Return value +**Return value** + | Type| Description| | -------- | -------- | | Promise<[DistributedInfo](#distributedinfo)> | Promise used to return the distributed account information obtained.| -- Example +**Example** ```js const accountAbility = account_distributedAccount.getDistributedAccountAbility(); accountAbility.queryOsAccountDistributedInfo().then((data) => { @@ -94,13 +99,14 @@ Updates distributed account information. This API uses an asynchronous callback **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS -- Parameters +**Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | accountInfo | [DistributedInfo](#distributedinfo) | Yes| Distributed account information.| | callback | AsyncCallback<void> | Yes| Callback invoked when the distributed account information is updated.| -- Example +**Example** ```js const accountAbility = account_distributedAccount.getDistributedAccountAbility(); let accountInfo = {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'}; @@ -119,17 +125,19 @@ Updates distributed account information. This API uses a promise to return the r **Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS -- Parameters +**Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | accountInfo | [DistributedInfo](#distributedinfo) | Yes| Distributed account information.| -- Return value +**Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| -- Example +**Example** ```js const accountAbility = account_distributedAccount.getDistributedAccountAbility(); let accountInfo = {id: '12345', name: 'ZhangSan', event: 'Ohos.account.event.LOGIN'}; 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 5682921badad9367817fd3e421b1afb823970425..b1ceeabca8640799415596532a757f67d62e92c8 100644 --- a/en/application-dev/reference/apis/js-apis-distributed-data.md +++ b/en/application-dev/reference/apis/js-apis-distributed-data.md @@ -45,55 +45,50 @@ Stage model: import AbilityStage from '@ohos.application.Ability' let kvManager; export default class MyAbilityStage extends AbilityStage { - onCreate() { - console.log("MyAbilityStage onCreate") - let context = this.context - const kvManagerConfig = { - context: context, - bundleName: 'com.example.datamanagertest', - userInfo: { - userId: '0', - userType: distributedData.UserType.SAME_USER_ID - } + onCreate() { + console.log("MyAbilityStage onCreate") + let context = this.context + const kvManagerConfig = { + context: context, + bundleName: 'com.example.datamanagertest', + userInfo: { + userId: '0', + userType: distributedData.UserType.SAME_USER_ID + } + } + distributedData.createKVManager(kvManagerConfig, function (err, manager) { + if (err) { + console.log("Failed to create KVManager: " + JSON.stringify(err)); + return; + } + console.log("Created KVManager successfully"); + kvManager = manager; + }); } - distributedData.createKVManager(kvManagerConfig, function (err, manager) { - if (err) { - console.log("Failed to create KVManager: " + JSON.stringify(err)); - return; - } - console.log("Created KVManager"); - kvManager = manager; - }); - } } ``` FA model: ```js -import AbilityStage from '@ohos.application.Ability' +import featureAbility from '@ohos.ability.featureAbility' let kvManager; -export default class MyAbilityStage extends AbilityStage { - onCreate() { - console.log("MyAbilityStage onCreate") - let context = this.context - const kvManagerConfig = { - context: context.getApplicationContext(), - bundleName: 'com.example.datamanagertest', - userInfo: { +let context = featureAbility.getContext() +const kvManagerConfig = { + context: context, + bundleName: 'com.example.datamanagertest', + userInfo: { userId: '0', userType: distributedData.UserType.SAME_USER_ID - } } - distributedData.createKVManager(kvManagerConfig, function (err, manager) { - if (err) { +} +distributedData.createKVManager(kvManagerConfig, function (err, manager) { + if (err) { console.log("Failed to create KVManager: " + JSON.stringify(err)); return; - } - console.log("Created KVManager"); - kvManager = manager; - }); - } -} + } + console.log("Created KVManager successfully"); + kvManager = manager; +}); ``` ## distributedData.createKVManager @@ -123,55 +118,46 @@ Stage model: import AbilityStage from '@ohos.application.Ability' let kvManager; export default class MyAbilityStage extends AbilityStage { - onCreate() { - console.log("MyAbilityStage onCreate") - let context = this.context - const kvManagerConfig = { - context: context, - bundleName: 'com.example.datamanagertest', - userInfo: { - userId: '0', - userType: distributedData.UserType.SAME_USER_ID - } + onCreate() { + console.log("MyAbilityStage onCreate") + let context = this.context + const kvManagerConfig = { + context: context, + bundleName: 'com.example.datamanagertest', + userInfo: { + userId: '0', + userType: distributedData.UserType.SAME_USER_ID + } + } + distributedData.createKVManager(kvManagerConfig).then((manager) => { + console.log("Created KVManager successfully"); + kvManager = manager; + }).catch((err) => { + console.log("Failed to create KVManager: " + JSON.stringify(err)); + }); } - distributedData.createKVManager(kvManagerConfig, function (err, manager) { - if (err) { - console.log("Failed to create KVManager: " + JSON.stringify(err)); - return; - } - console.log("Created KVManager"); - kvManager = manager; - }); - } } ``` FA model: ```js -import AbilityStage from '@ohos.application.Ability' +import featureAbility from '@ohos.ability.featureAbility' let kvManager; -export default class MyAbilityStage extends AbilityStage { - onCreate() { - console.log("MyAbilityStage onCreate") - let context = this.context - const kvManagerConfig = { - context: context.getApplicationContext(), - bundleName: 'com.example.datamanagertest', - userInfo: { +let context = featureAbility.getContext() +const kvManagerConfig = { + context: context, + bundleName: 'com.example.datamanagertest', + userInfo: { userId: '0', userType: distributedData.UserType.SAME_USER_ID - } } - distributedData.createKVManager(kvManagerConfig, function (err, manager) { - if (err) { - console.log("Failed to create KVManager: " + JSON.stringify(err)); - return; - } - console.log("Created KVManager"); - kvManager = manager; - }); - } } +distributedData.createKVManager(kvManagerConfig).then((manager) => { + console.log("Created KVManager successfully"); + kvManager = manager; +}).catch((err) => { + console.log("Failed to create KVManager: " + JSON.stringify(err)); +}); ``` ## KVManagerConfig @@ -304,7 +290,7 @@ try { } ``` -### closeKVStore8+ ### +### closeKVStore8+ closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback<void>): void @@ -320,7 +306,7 @@ Closes a KV store. This API uses an asynchronous callback to return the result. | appId | string | Yes | Bundle name of the app that invokes the KV store. | | storeId | string | Yes | Unique identifier of the KV store to close. The length cannot exceed [MAX_STORE_ID_LENGTH](#constants).| | kvStore | [KVStore](#kvstore) | Yes | KV store to close. | -| callback | AsyncCallback<void> | Yes | Callback used to return the result.| +| callback | AsyncCallback<void> | Yes | Callback invoked to return the result.| **Example** @@ -328,21 +314,21 @@ Closes a KV store. This API uses an asynchronous callback to return the result. let kvStore; let kvManager; const options = { - createIfMissing : true, - encrypt : false, - backup : false, - autoSync : true, - kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, - schema : '', - securityLevel : distributedData.SecurityLevel.S2, - } - try { + createIfMissing: true, + encrypt: false, + backup: false, + autoSync: true, + kvStoreType: distributedData.KVStoreType.SINGLE_VERSION, + schema: '', + securityLevel: distributedData.SecurityLevel.S2, +} +try { kvManager.getKVStore('storeId', options, async function (err, store) { - console.log('getKVStore success'); - kvStore = store; - kvManager.closeKVStore('appId', 'storeId', kvStore, function (err, data) { - console.log('closeKVStore success'); - }); + console.log('getKVStore success'); + kvStore = store; + kvManager.closeKVStore('appId', 'storeId', kvStore, function (err, data) { + console.log('closeKVStore success'); + }); }); } catch (e) { console.log('closeKVStore e ' + e); @@ -350,7 +336,7 @@ const options = { ``` -### closeKVStore8+ ### +### closeKVStore8+ closeKVStore(appId: string, storeId: string, kvStore: KVStore): Promise<void> @@ -378,33 +364,33 @@ Closes a KV store. This API uses a promise to return the result. let kvManager; let kvStore; const options = { - createIfMissing : true, - encrypt : false, - backup : false, - autoSync : true, - kvStoreType : distributedData.KVStoreType.SINGLE_VERSION, - schema : '', - securityLevel : distributedData.SecurityLevel.S2, + createIfMissing: true, + encrypt: false, + backup: false, + autoSync: true, + kvStoreType: distributedData.KVStoreType.SINGLE_VERSION, + schema: '', + securityLevel: distributedData.SecurityLevel.S2, } - try { +try { kvManager.getKVStore('storeId', options).then(async (store) => { - console.log('getKVStore success'); - kvStore = store; - kvManager.closeKVStore('appId', 'storeId', kvStore).then(() => { - console.log('closeKVStore success'); - }).catch((err) => { - console.log('closeKVStore err ' + JSON.stringify(err)); - }); + console.log('getKVStore success'); + kvStore = store; + kvManager.closeKVStore('appId', 'storeId', kvStore).then(() => { + console.log('closeKVStore success'); + }).catch((err) => { + console.log('closeKVStore err ' + JSON.stringify(err)); + }); }).catch((err) => { console.log('CloseKVStore getKVStore err ' + JSON.stringify(err)); }); - } catch (e) { +} catch (e) { console.log('closeKVStore e ' + e); -} +} ``` -### deleteKVStore8+ ### +### deleteKVStore8+ deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void @@ -418,7 +404,7 @@ Deletes a KV store. This API uses an asynchronous callback to return the result. | ----- | ------ | ---- | ----------------------- | | appId | string | Yes | Bundle name of the app that invokes the KV store. | | storeId | string | Yes | Unique identifier of the KV store to delete. The length cannot exceed [MAX_STORE_ID_LENGTH](#constants).| -| callback | AsyncCallback<void> | Yes | Callback used to return the result.| +| callback | AsyncCallback<void> | Yes | Callback invoked to return the result.| **Example** @@ -447,7 +433,7 @@ try { } ``` -### deleteKVStore8+ ### +### deleteKVStore8+ deleteKVStore(appId: string, storeId: string): Promise<void> @@ -501,7 +487,7 @@ try { ``` -### getAllKVStoreId8+ ### +### getAllKVStoreId8+ getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>): void @@ -514,7 +500,7 @@ Obtains the IDs of all KV stores that are created by [getKVStore()](#getkvstore) | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | appId | string | Yes | Bundle name of the app that invokes the KV store. | -| callback | AsyncCallback<string[]> | Yes |Callback used to return the KV store IDs obtained. | +| callback | AsyncCallback<string[]> | Yes |Callback invoked to return the KV store IDs obtained. | **Example** @@ -531,7 +517,7 @@ try { ``` -### getAllKVStoreId8+ ### +### getAllKVStoreId8+ getAllKVStoreId(appId: string): Promise<string[]> @@ -570,11 +556,11 @@ try { ``` -### on('distributedDataServiceDie')8+ ### +### on('distributedDataServiceDie')8+ on(event: 'distributedDataServiceDie', deathCallback: Callback<void>): void -Subscribes to service status changes. +Subscribes to service status changes. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -582,15 +568,14 @@ Subscribes to service status changes. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event | string | Yes | Event to subscribe to. The value is **distributedDataServiceDie**, which indicates service status changes.| -| deathCallback | Callback<void> | Yes | Callback invoked to return service status changes.| +| event | string | Yes | Event to subscribe to. The value is **distributedDataServiceDie**, which indicates a service status change event.| +| deathCallback | Callback<void> | Yes | Callback invoked to return a service status change event.| **Example** ```js let kvManager; try { - console.log('KVManagerOn'); const deathCallback = function () { console.log('death callback call'); @@ -602,11 +587,11 @@ try { ``` -### off('distributedDataServiceDie')8+ ### +### off('distributedDataServiceDie')8+ off(event: 'distributedDataServiceDie', deathCallback?: Callback<void>): void -Unsubscribes from the service status changes. +Unsubscribes from service status changes. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.DistributedKVStore @@ -614,8 +599,8 @@ Unsubscribes from the service status changes. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event | string | Yes | Event to unsubscribe from. The value is **distributedDataServiceDie**, which indicates service status changes.| -| deathCallback | Callback<void> | No | Callback used to return service status changes.| +| event | string | Yes | Event to unsubscribe from. The value is **distributedDataServiceDie**, which indicates a service status change event.| +| deathCallback | Callback<void> | No | Callback for the service status change event.| **Example** @@ -666,16 +651,14 @@ Enumerates the KV store types. Enumerates the KV store security levels. -**System capability**: SystemCapability.DistributedDataManager.KVStore.Core - | Name | Value| Description | | --- | ---- | ----------------------- | -| NO_LEVEL | 0 | No security level is set for the KV store. | -| S0 | 1 | The KV store security level is public.| -| S1 | 2 | The KV store security level is low. If data leakage occurs, minor impact will be caused on the database. For example, a KV store that contains system data such as wallpapers.| -| S2 | 3 | The KV store security level is medium. If data leakage occurs, moderate impact will be caused on the database. For example, a KV store that contains information created by users or call records, such as audio or video clips.| -| S3 | 5 | The KV store security level is high. If data leakage occurs, major impact will be caused on the database. For example, a KV store that contains information such as user fitness, health, and location data.| -| S4 | 6 | The KV store security level is critical. If data leakage occurs, severe impact will be caused on the database. For example, a KV store that contains information such as authentication credentials and financial data.| +| NO_LEVEL | 0 | No security level is set for the KV store.
**System capability**: SystemCapability.DistributedDataManager.KVStore.DistributedKVStore | +| S0 | 1 | The KV store security level is public.
**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | +| S1 | 2 | The KV store security level is low. If data leakage occurs, minor impact will be caused on the database. For example, a KV store that contains system data such as wallpapers.
**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | +| S2 | 3 | The KV store security level is medium. If data leakage occurs, moderate impact will be caused on the database. For example, a KV store that contains information created by users or call records, such as audio or video clips.
**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | +| S3 | 5 | The KV store security level is high. If data leakage occurs, major impact will be caused on the database. For example, a KV store that contains information such as user fitness, health, and location data.
**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | +| S4 | 6 | The KV store security level is critical. If data leakage occurs, severe impact will be caused on the database. For example, a KV store that contains information such as authentication credentials and financial data.
**System capability**: SystemCapability.DistributedDataManager.KVStore.Core | ## Constants @@ -706,7 +689,7 @@ Defines the schema of a KV store. You can create a **Schema** object and place i | mode8+ | number | Schema mode. | | skip8+ | number | Size of a skip of the schema. | -### constructor8+ ### +### constructor8+ constructor() @@ -726,7 +709,7 @@ Represents a **Schema** instance, which provides the methods for defining the va | default8+ | string | Default value of a **FieldNode**.| | type8+ | number | Value of the data type corresponding to the specified node.| -### constructor8+ ### +### constructor8+ constructor(name: string) @@ -740,7 +723,7 @@ A constructor used to create a **FieldNode** instance with a string field. | ------ | -------- | ---- | --------------- | | name | string | Yes | Value of **FieldNode**.| -### appendChild8+ ### +### appendChild8+ appendChild(child: FieldNode): boolean @@ -790,7 +773,7 @@ Provides methods to obtain the KV store result sets, and query and move the data Before calling any method in **KvStoreResultSet**, you must use [getKVStore](#getkvstore) to obtain a **KVStore** object. -### getCount8+ ### +### getCount8+ getCount(): number @@ -823,7 +806,7 @@ try { } ``` -### getPosition8+ ### +### getPosition8+ getPosition(): number @@ -857,7 +840,7 @@ try { ``` -### moveToFirst8+ ### +### moveToFirst8+ moveToFirst(): boolean @@ -891,7 +874,7 @@ try { ``` -### moveToLast8+ ### +### moveToLast8+ moveToLast(): boolean @@ -925,7 +908,7 @@ try { ``` -### moveToNext8+ ### +### moveToNext8+ moveToNext(): boolean @@ -959,7 +942,7 @@ try { ``` -### moveToPrevious8+ ### +### moveToPrevious8+ moveToPrevious(): boolean @@ -993,7 +976,7 @@ try { ``` -### move8+ ### +### move8+ move(offset: number): boolean @@ -1025,7 +1008,7 @@ try { }).catch((err) => { console.log('getResultSet failed: ' + err); }); - const moved5 = resultSet.move(); + const moved5 = resultSet.move(1); console.log("move succeed:" + moved5); } catch (e) { console.log("move failed: " + e); @@ -1033,7 +1016,7 @@ try { ``` -### moveToPosition8+ ### +### moveToPosition8+ moveToPosition(position: number): boolean @@ -1065,7 +1048,7 @@ try { }).catch((err) => { console.log('getResultSet failed: ' + err); }); - const moved6 = resultSet.moveToPosition(); + const moved6 = resultSet.moveToPosition(1); console.log("moveToPosition succeed: " + moved6); } catch (e) { console.log("moveToPosition failed: " + e); @@ -1073,7 +1056,7 @@ try { ``` -### isFirst8+ ### +### isFirst8+ isFirst(): boolean @@ -1107,7 +1090,7 @@ try { ``` -### isLast8+ ### +### isLast8+ isLast(): boolean @@ -1140,7 +1123,7 @@ try { } ``` -### isBeforeFirst8+ ### +### isBeforeFirst8+ isBeforeFirst(): boolean @@ -1174,7 +1157,7 @@ try { ``` -### isAfterLast8+ ### +### isAfterLast8+ isAfterLast(): boolean @@ -1208,7 +1191,7 @@ try { ``` -### getEntry8+ ### +### getEntry8+ getEntry(): Entry @@ -1248,7 +1231,7 @@ Provides methods to create a **Query** object, which defines different data quer **System capability**: SystemCapability.DistributedDataManager.KVStore.Core -### constructor8+ ### +### constructor8+ constructor() @@ -1257,7 +1240,7 @@ A constructor used to create a **Schema** instance. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core -### reset8+ ### +### reset8+ reset(): Query @@ -1288,7 +1271,7 @@ try { ``` -### equalTo8+ ### +### equalTo8+ equalTo(field: string, value: number|string|boolean): Query @@ -1323,7 +1306,7 @@ try { ``` -### notEqualTo8+ ### +### notEqualTo8+ notEqualTo(field: string, value: number|string|boolean): Query @@ -1358,7 +1341,7 @@ try { ``` -### greaterThan8+ ### +### greaterThan8+ greaterThan(field: string, value: number|string|boolean): Query @@ -1393,7 +1376,7 @@ try { ``` -### lessThan8+ ### +### lessThan8+ lessThan(field: string, value: number|string): Query @@ -1428,7 +1411,7 @@ try { ``` -### greaterThanOrEqualTo8+ ### +### greaterThanOrEqualTo8+ greaterThanOrEqualTo(field: string, value: number|string): Query @@ -1463,7 +1446,7 @@ try { ``` -### lessThanOrEqualTo8+ ### +### lessThanOrEqualTo8+ lessThanOrEqualTo(field: string, value: number|string): Query @@ -1498,7 +1481,7 @@ try { ``` -### isNull8+ ### +### isNull8+ isNull(field: string): Query @@ -1532,7 +1515,7 @@ try { ``` -### inNumber8+ ### +### inNumber8+ inNumber(field: string, valueList: number[]): Query @@ -1568,7 +1551,7 @@ try { ``` -### inString8+ ### +### inString8+ inString(field: string, valueList: string[]): Query @@ -1603,7 +1586,7 @@ try { ``` -### notInNumber8+ ### +### notInNumber8+ notInNumber(field: string, valueList: number[]): Query @@ -1638,7 +1621,7 @@ try { ``` -### notInString8+ ### +### notInString8+ notInString(field: string, valueList: string[]): Query @@ -1673,7 +1656,7 @@ try { ``` -### like8+ ### +### like8+ like(field: string, value: string): Query @@ -1708,7 +1691,7 @@ try { ``` -### unlike8+ ### +### unlike8+ unlike(field: string, value: string): Query @@ -1743,7 +1726,7 @@ try { ``` -### and8+ ### +### and8+ and(): Query @@ -1773,7 +1756,7 @@ try { ``` -### or8+ ### +### or8+ or(): Query @@ -1803,7 +1786,7 @@ try { ``` -### orderByAsc8+ ### +### orderByAsc8+ orderByAsc(field: string): Query @@ -1838,7 +1821,7 @@ try { ``` -### orderByDesc8+ ### +### orderByDesc8+ orderByDesc(field: string): Query @@ -1873,7 +1856,7 @@ try { ``` -### limit8+ ### +### limit8+ limit(total: number, offset: number): Query @@ -1911,7 +1894,7 @@ try { ``` -### isNotNull8+ ### +### isNotNull8+ isNotNull(field: string): Query @@ -1945,7 +1928,7 @@ try { ``` -### beginGroup8+ ### +### beginGroup8+ beginGroup(): Query @@ -1975,7 +1958,7 @@ try { ``` -### endGroup8+ ### +### endGroup8+ endGroup(): Query @@ -2005,7 +1988,7 @@ try { ``` -### prefixKey8+ ### +### prefixKey8+ prefixKey(prefix: string): Query @@ -2040,7 +2023,7 @@ try { ``` -### setSuggestIndex8+ ### +### setSuggestIndex8+ setSuggestIndex(index: string): Query @@ -2075,7 +2058,7 @@ try { ``` -### deviceId8+ ### +### deviceId8+ deviceId(deviceId:string):Query @@ -2109,7 +2092,7 @@ try { ``` -### getSqlLike8+ ### +### getSqlLike8+ getSqlLike():string @@ -2156,7 +2139,7 @@ Adds a KV pair of the specified type to this KV store. This API uses an asynchro | ----- | ------ | ---- | ----------------------- | | key | string | Yes |Key of the KV pair to add. It cannot be empty, and the length cannot exceed [MAX_KEY_LENGTH](#constants). | | value | Uint8Array \| string \| number \| boolean | Yes |Value of the KV pair to add. The value type can be Uint8Array, number, string, or boolean. A value of the Uint8Array or string type cannot exceed [MAX_VALUE_LENGTH](#constants). | -| callback | AsyncCallback<void> | Yes |Callback used to return the result. | +| callback | AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2229,7 +2212,7 @@ Deletes a KV pair from this KV store. This API uses an asynchronous callback to | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | key | string | Yes |Key of the KV pair to delete. It cannot be empty, and the length cannot exceed [MAX_KEY_LENGTH](#constants). | -| callback | AsyncCallback<void> | Yes |Callback used to return the result. | +| callback | AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2303,7 +2286,9 @@ try { delete(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<void>) -Deletes KV pairs that meet the specified predicates. This API uses an asynchronous callback to return the result. +Deletes KV pairs that meet the specified conditions. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2312,7 +2297,7 @@ Deletes KV pairs that meet the specified predicates. This API uses an asynchrono | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | predicates | [DataSharePredicates](js-apis-data-dataSharePredicates.md#datasharepredicates) | Yes |Conditions for deleting data. If this parameter is **null**, define the processing logic.| -| callback | AsyncCallback<void> | Yes |Callback used to return the result. | +| callback | AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2337,7 +2322,9 @@ try { delete(predicates: dataSharePredicates.DataSharePredicates): Promise<void> -Deletes KV pairs that meet the specified predicates. This API uses a promise to return the result. +Deletes KV pairs that meet the specified conditions. This API uses a promise to return the result. + +**System API**: This is a system API. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2352,7 +2339,7 @@ Deletes KV pairs that meet the specified predicates. This API uses a promise to | Type | Description | | ------ | ------- | -| Promise<void> |Promise used to return the result.| +| Promise<void> |Promise that returns no value.| **Example** @@ -2379,11 +2366,224 @@ try { ``` +### backup9+ + +backup(file:string, callback: AsyncCallback<void>):void + +Backs up an RDB store. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.DistributedDataManager.KVStore.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| file | string | Yes | Name of the RDB store. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants).| +| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. If the operation is successful, **err** is **undefined**. Otherwise, **err** is the error object.| + +**Example** + +```js +let kvStore; +let file = "BK001"; +try { + kvStore.backup(file, (err, data) => { + if (err) { + console.info("backup err : " + err); + } else { + console.info("backup data : " + data); + } + }); +} catch (e) { + console.log("An unexpected error occurred. Error : " + e); +} + +``` + +### backup9+ + +backup(file:string): Promise<void> + +Backs up an RDB store. This API uses a promise to return the result. + +**System capability**: SystemCapability.DistributedDataManager.KVStore.Core + +**Parameters** + +| Name| Type| Mandatory| Description | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| file | string | Yes | Name of the RDB store. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants).| + +**Return value** + +| Type | Description | +| ------------------- | ------------------------- | +| Promise<void> | Promise that returns no value.| + +**Example** + +```js +let kvStore; +let file = "BK001"; +try { + kvStore.backup(file).then((data) => { + console.info("backup data : " + data); + }).catch((err) => { + console.info("backup err : " + err); + }); +} catch (e) { + console.log("An unexpected error occurred. Error : " + e); +} + +``` + +### restore9+ + +restore(file:string, callback: AsyncCallback<void>):void + +Restores an RDB store from a database file. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.DistributedDataManager.KVStore.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| file | string | Yes | Name of the database file. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants).| +| callback | AsyncCallback<void> | Yes | Callback invoked to return the result. If the operation is successful, **err** is **undefined**. Otherwise, **err** is an error object.| + +**Example** + +```js +let kvStore; +let file = "BK001"; +try { + kvStore.restore(file, (err, data) => { + if (err) { + console.info("restore err : " + err); + } else { + console.info("restore data : " + data); + } + }); +} catch (e) { + console.log("An unexpected error occurred. Error : " + e); +} + +``` + +### restore9+ + +restore(file:string): Promise<void> + +Restores an RDB store from a database file. This API uses a promise to return the result. + +**System capability**: SystemCapability.DistributedDataManager.KVStore.Core + +**Parameters** + +| Name| Type| Mandatory| Description | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| file | string | Yes | Name of the database file. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants).| + +**Return value** + +| Type | Description | +| ------------------- | ------------------------- | +| Promise<void> | Promise that returns no value.| + +**Example** + +```js +let kvStore; +let file = "BK001"; +try { + kvStore.restore(file).then((data) => { + console.info("restore data : " + data); + }).catch((err) => { + console.info("restore err : " + err); + }); +} catch (e) { + console.log("An unexpected error occurred. Error : " + e); +} + +``` + +### deleteBackup9+ + +deleteBackup(files:Array<string>, callback: AsyncCallback<Array<[string, number]>>):void + +Deletes a backup file. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.DistributedDataManager.KVStore.Core + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | +| files | Array<string> | Yes | Name of the backup file to delete. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants). | +| callback | AsyncCallback<Array<[string, number]>> | Yes | Callback invoked to return the name of the backup file deleted and the operation result. | + +**Example** + +```js +let kvStore; +let files = ["BK001", "BK002"]; +try { + kvStore.deleteBackup(files, (err, data) => { + if (err) { + console.info("deleteBackup err : " + err); + } else { + console.info("deleteBackup data : " + data); + } + }); +} catch (e) { + console.log("An unexpected error occurred. Error : " + e); +} + +``` + +### deleteBackup9+ + +deleteBackup(files:Array<string>): Promise<Array<[string, number]>> + +Deletes a backup file. This API uses a promise to return the result. + +**System capability**: SystemCapability.DistributedDataManager.KVStore.Core + +**Parameters** + +| Name| Type| Mandatory| Description | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| files | Array<string> | Yes | Name of the backup file to delete. The value cannot be empty or exceed [MAX_KEY_LENGTH](#constants).| + +**Return value** + +| Type | Description | +| -------------------------------------------- | ----------------------------------------------- | +| Promise<Array<[string, number]>> | Promise used to return the name of the backup file deleted and the operation result.| + +**Example** + +```js +let kvStore; +let files = ["BK001", "BK002"]; +try { + kvStore.deleteBackup(files).then((data) => { + console.info("deleteBackup data : " + data); + }).catch((err) => { + console.info("deleteBackup err : " + err); + }) +} catch (e) { + console.log("An unexpected error occurred. Error : " + e); +} + +``` + ### on('dataChange') on(event: 'dataChange', type: SubscribeType, listener: Callback<ChangeNotification>): void -Subscribes to data change notifications of the specified type. +Subscribes to data changes of the specified type. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2391,9 +2591,9 @@ Subscribes to data change notifications of the specified type. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to subscribe to. The value is **dataChange**, which indicates data changes. | -| type |[SubscribeType](#subscribetype) | Yes |Type of data changes. | -| listener |Callback<[ChangeNotification](#changenotification)> | Yes |Callback used to return the data changes.| +| event |string | Yes |Event to subscribe to. The value is **dataChange**, which indicates a data change event. | +| type |[SubscribeType](#subscribetype) | Yes |Type of data change. | +| listener |Callback<[ChangeNotification](#changenotification)> | Yes |Callback invoked to return a data change event.| **Example** @@ -2409,7 +2609,7 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -Subscribes to data synchronization complete events. +Subscribes to synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2417,8 +2617,8 @@ Subscribes to data synchronization complete events. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to subscribe to. The value is **syncComplete**, which indicates completion of a data synchronization. | -| syncCallback |Callback<Array<[string, number]>> | Yes |Callback used to return the data synchronization result. | +| event |string | Yes |Event to subscribe to. The value is **syncComplete**, which indicates a synchronization complete event. | +| syncCallback |Callback<Array<[string, number]>> | Yes |Callback invoked to return a synchronization complete event.| **Example** @@ -2433,7 +2633,7 @@ kvStore.on('syncComplete', function (data) { off(event:'dataChange', listener?: Callback<ChangeNotification>): void -Unsubscribes from data change notifications. +Unsubscribes from data changes. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2441,26 +2641,35 @@ Unsubscribes from data change notifications. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to unsubscribe from. The value is **dataChange**, which indicates data changes. | -| listener |Callback<[ChangeNotification](#changenotification)> |No |Callback used to return the data changes.| +| event |string | Yes |Event to unsubscribe from. The value is **dataChange**, which indicates a data change event. | +| listener |Callback<[ChangeNotification](#changenotification)> |No |Callback for the data change event.| **Example** ```js let kvStore; -kvStore.on('dataChange', function (data) { - console.log("callback call data: " + data); -}); -kvStore.off('dataChange', function (data) { - console.log("callback call data: " + data); -}); +class KvstoreModel { + call(data) { + console.log("dataChange: " + data); + } + subscribeDataChange() { + if (kvStore != null) { + kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_REMOTE, this.call); + } + } + unsubscribeDataChange() { + if (kvStore != null) { + kvStore.off('dataChange', this.call); + } + } +} ``` ### off('syncComplete')9+ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -Unsubscribes from data change events. This API uses a synchronous callback to return the result. +Unsubscribes from the synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2468,21 +2677,27 @@ Unsubscribes from data change events. This API uses a synchronous callback to re | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to unsubscribe from. The value is **syncComplete**, which indicates completion of a data synchronization. | -| syncCallback |Callback<Array<[string, number]>> | No |Callback used to return the synchronization result. | +| event |string | Yes |Event to unsubscribe from. The value is **syncComplete**, which indicates a synchronization complete event. | +| syncCallback |Callback<Array<[string, number]>> | No |Callback for the synchronization complete event. | **Example** ```js let kvStore; -try { - const func = function (data) { - console.log('syncComplete ' + data) - }; - kvStore.on('syncComplete', func); - kvStore.off('syncComplete', func); -}catch(e) { - console.log('syncComplete e ' + e); +class KvstoreModel { + call(data) { + console.log("syncComplete: " + data); + } + subscribeSyncComplete() { + if (kvStore != null) { + kvStore.on('syncComplete', this.call); + } + } + unsubscribeSyncComplete() { + if (kvStore != null) { + kvStore.off('syncComplete', this.call); + } + } } ``` @@ -2500,7 +2715,7 @@ Inserts KV pairs in batches to this KV store. This API uses an asynchronous call | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | entries |[Entry](#entry)[] | Yes |KV pairs to insert in batches. | -| callback |Asyncallback<void> |Yes |Callback used to return the result.| +| callback |Asyncallback<void> |Yes |Callback invoked to return the result.| **Example** @@ -2592,7 +2807,9 @@ try { putBatch(value: Array<ValuesBucket>, callback: AsyncCallback<void>): void -Writes data to this KV store. This API uses an asynchronous callback to return the result. +Writes data to this KV store. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2601,7 +2818,7 @@ Writes data to this KV store. This API uses an asynchronous callback to return t | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | value |Array<[ValuesBucket](js-apis-data-ValuesBucket.md#valuesbucket)> | Yes |Data to write. | -| callback |Asyncallback<void> |Yes |Callback used to return the result.| +| callback |Asyncallback<void> |Yes |Callback invoked to return the result.| **Example** @@ -2631,7 +2848,9 @@ try { putBatch(value: Array<ValuesBucket>): Promise<void> -Writes data of the **valuesbucket** type to this KV store. This API uses a promise to return the result. +Write data to this KV store. This API uses a promise to return the result. + +**System API**: This is a system API. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -2645,7 +2864,7 @@ Writes data of the **valuesbucket** type to this KV store. This API uses a promi | Type | Description | | ------ | ------- | -| Promise<void> |Promise used to return the result.| +| Promise<void> |Promise that returns no value.| **Example** @@ -2685,7 +2904,7 @@ Deletes KV pairs in batches from this KV store. This API uses an asynchronous ca | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | keys |string[] | Yes |KV pairs to delete in batches. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2719,7 +2938,7 @@ try { ``` -### deleteBatch8+ ### +### deleteBatch8+ deleteBatch(keys: string[]): Promise<void> @@ -2775,7 +2994,7 @@ try { ``` -### startTransaction8+ ### +### startTransaction8+ startTransaction(callback: AsyncCallback<void>): void @@ -2787,7 +3006,7 @@ Starts the transaction in this KV store. This API uses an asynchronous callback | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2827,7 +3046,7 @@ try { ``` -### startTransaction8+ ### +### startTransaction8+ startTransaction(): Promise<void> @@ -2862,7 +3081,7 @@ try { ``` -### commit8+ ### +### commit8+ commit(callback: AsyncCallback<void>): void @@ -2874,7 +3093,7 @@ Commits the transaction in this KV store. This API uses an asynchronous callback | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2894,7 +3113,7 @@ try { ``` -### commit8+ ### +### commit8+ commit(): Promise<void> @@ -2924,7 +3143,7 @@ try { ``` -### rollback8+ ### +### rollback8+ rollback(callback: AsyncCallback<void>): void @@ -2936,7 +3155,7 @@ Rolls back the transaction in this KV store. This API uses an asynchronous callb | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -2956,7 +3175,7 @@ try { ``` -### rollback8+ ### +### rollback8+ rollback(): Promise<void> @@ -2986,7 +3205,7 @@ try { ``` -### enableSync8+ ### +### enableSync8+ enableSync(enabled: boolean, callback: AsyncCallback<void>): void @@ -2999,7 +3218,7 @@ Sets data synchronization, which can be enabled or disabled. This API uses an as | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | enabled |boolean | Yes |Whether to enable data synchronization. The value **true** means to enable data synchronization, and **false** means the opposite. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -3019,7 +3238,7 @@ try { ``` -### enableSync8+ ### +### enableSync8+ enableSync(enabled: boolean): Promise<void> @@ -3055,7 +3274,7 @@ try { ``` -### setSyncRange8+ ### +### setSyncRange8+ setSyncRange(localLabels: string[], remoteSupportLabels: string[], callback: AsyncCallback<void>): void @@ -3069,7 +3288,7 @@ Sets the data synchronization range. This API uses an asynchronous callback to r | ----- | ------ | ---- | ----------------------- | | localLabels |string[] | Yes |Synchronization labels set for the local device. | | remoteSupportLabels |string[] | Yes |Synchronization labels set for remote devices. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -3087,7 +3306,7 @@ try { ``` -### setSyncRange8+ ### +### setSyncRange8+ setSyncRange(localLabels: string[], remoteSupportLabels: string[]): Promise<void> @@ -3279,7 +3498,7 @@ try { } ``` -### getEntries8+ ### +### getEntries8+ getEntries(keyPrefix: string, callback: AsyncCallback<Entry[]>): void @@ -3325,7 +3544,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(keyPrefix: string): Promise<Entry[]> @@ -3383,7 +3602,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void @@ -3396,7 +3615,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses an | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | Yes |Key prefix to match. | -| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback used to return the KV pairs obtained. | +| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback invoked to return the KV pairs obtained. | **Example** @@ -3434,7 +3653,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(query: Query): Promise<Entry[]> @@ -3492,7 +3711,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>): void @@ -3541,7 +3760,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(keyPrefix: string): Promise<KvStoreResultSet> @@ -3601,7 +3820,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): void @@ -3649,7 +3868,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(query: Query): Promise<KvStoreResultSet> @@ -3705,12 +3924,14 @@ try { } ``` -### getResultSet9+ ### +### getResultSet9+ getResultSet(predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<KvStoreResultSet>): void Obtains a **KvStoreResultSet** object that matches the specified **DataSharePredicates** object. This API uses an asynchronous callback to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.KVStore.Core **Parameters** @@ -3740,12 +3961,14 @@ try { console.log('An unexpected error occurred. Error:' + e); } ``` -### getResultSet9+ ### +### getResultSet9+ getResultSet(predicates: dataSharePredicates.DataSharePredicates): Promise<KvStoreResultSet> Obtains a **KvStoreResultSet** object that matches the specified **DataSharePredicates** object. This API uses a promise to return the result. +**System API**: This is a system API. + **System capability**: SystemCapability.DistributedDataManager.KVStore.Core **Parameters** @@ -3758,7 +3981,7 @@ Obtains a **KvStoreResultSet** object that matches the specified **DataSharePred | Type | Description | | ------ | ------- | -|Promise<[KvStoreResultSet](#kvstoreresultset8)> |Promise used to return the **KvStoreResultSet** object obtained.| +|Promise<[KvStoreResultSet](#kvstoreresultset8)> |Promise that returns no value.| **Example** @@ -3780,7 +4003,7 @@ try { console.log('An unexpected error occurred. Error:' + e); } ``` -### closeResultSet8+ ### +### closeResultSet8+ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>): void @@ -3793,7 +4016,7 @@ Closes the **KvStoreResultSet** object obtained by [SingleKvStore.getResultSet]( | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | resultSet |[KvStoreResultSet](#kvstoreresultset8) | Yes |**KvStoreResultSet** object to close. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -3814,7 +4037,7 @@ try { ``` -### closeResultSet8+ ### +### closeResultSet8+ closeResultSet(resultSet: KvStoreResultSet): Promise<void> @@ -3851,7 +4074,7 @@ try { ``` -### getResultSize8+ ### +### getResultSize8+ getResultSize(query: Query, callback: AsyncCallback<number>): void @@ -3897,7 +4120,7 @@ try { ``` -### getResultSize8+ ### +### getResultSize8+ getResultSize(query: Query): Promise<number> @@ -3952,7 +4175,7 @@ try { ``` -### removeDeviceData8+ ### +### removeDeviceData8+ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void @@ -3965,7 +4188,7 @@ Deletes data of a device. This API uses an asynchronous callback to return the r | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes |ID of the target device. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -3994,7 +4217,7 @@ try { ``` -### removeDeviceData8+ ### +### removeDeviceData8+ removeDeviceData(deviceId: string): Promise<void> @@ -4043,11 +4266,11 @@ try { ``` -### on('syncComplete')8+ ### +### on('syncComplete')8+ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -Subscribes to the data synchronization complete events. +Subscribes to synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -4055,8 +4278,8 @@ Subscribes to the data synchronization complete events. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to subscribe to. The value is **syncComplete**, which indicates completion of a data synchronization. | -| syncCallback |Callback<Array<[string, number]>> | Yes |Callback called to return the synchronization result. | +| event |string | Yes |Event to subscribe to. The value is **syncComplete**, which indicates a synchronization complete event. | +| syncCallback |Callback<Array<[string, number]>> | Yes |Callback invoked to return a synchronization complete event. | **Example** @@ -4079,11 +4302,11 @@ try { ``` -### off('syncComplete')8+ ### +### off('syncComplete')8+ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -Unsubscribes from the data synchronization complete events. +Unsubscribes from synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -4091,25 +4314,31 @@ Unsubscribes from the data synchronization complete events. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to unsubscribe from. The value is **syncComplete**, which indicates completion of a data synchronization. | -| syncCallback |Callback<Array<[string, number]>> | No |Callback used to return the synchronization result. | +| event |string | Yes |Event to unsubscribe from. The value is **syncComplete**, which indicates a synchronization complete event. | +| syncCallback |Callback<Array<[string, number]>> | No |Callback for the synchronization complete event. | **Example** ```js let kvStore; -try { - const func = function (data) { - console.log('syncComplete ' + data) - }; - kvStore.on('syncComplete', func); - kvStore.off('syncComplete', func); -}catch(e) { - console.log('syncComplete e ' + e); +class KvstoreModel { + call(data) { + console.log("syncComplete: " + data); + } + subscribeSyncComplete() { + if (kvStore != null) { + kvStore.on('syncComplete', this.call); + } + } + unsubscribeSyncComplete() { + if (kvStore != null) { + kvStore.off('syncComplete', this.call); + } + } } ``` -### on('dataChange')9+ ### +### on('dataChange')9+ on(event: 'dataChange', type: SubscribeType, listener: Callback<ChangeNotification>): void @@ -4121,9 +4350,9 @@ Subscribes to data changes of the specified type. This API returns the result sy | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to subscribe to. The value is **dataChange**, which indicates data changes. | -| type |[SubscribeType](#subscribetype) | Yes |Subscription type. | -| listener |Callback<[ChangeNotification](#changenotification)> | Yes |Callback used to return the result.| +| event |string | Yes |Event to subscribe to. The value is **dataChange**, which indicates a data change event. | +| type |[SubscribeType](#subscribetype) | Yes |Type of data change. | +| listener |Callback<[ChangeNotification](#changenotification)> | Yes |Callback invoked to return a data change event.| **Example** @@ -4135,11 +4364,11 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun ``` -### off('dataChange')9+ ### +### off('dataChange')9+ off(event:'dataChange', listener?: Callback<ChangeNotification>): void -Unsubscribes from the data change events. This API returns the result synchronously. +Unsubscribes from data changes. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -4147,26 +4376,35 @@ Unsubscribes from the data change events. This API returns the result synchronou | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to unsubscribe from. The value is **dataChange**, which indicates data changes. | -| listener |Callback<[ChangeNotification](#changenotification)> |No |Callback used to return the result.| +| event |string | Yes |Event to unsubscribe from. The value is **dataChange**, which indicates a data change event. | +| listener |Callback<[ChangeNotification](#changenotification)> |No |Callback for the data change event.| **Example** ```js let kvStore; -kvStore.on('dataChange', function (data) { - console.log("callback call data: " + data); -}); -kvStore.off('dataChange', function (data) { - console.log("callback call data: " + data); -}); +class KvstoreModel { + call(data) { + console.log("dataChange: " + data); + } + subscribeDataChange() { + if (kvStore != null) { + kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_REMOTE, this.call); + } + } + unsubscribeDataChange() { + if (kvStore != null) { + kvStore.off('dataChange', this.call); + } + } +} ``` ### sync7+ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -4190,7 +4428,7 @@ kvStore.sync('deviceIds', distributedData.SyncMode.PULL_ONLY, 1000); ### sync9+ sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. This API returns the result synchronously. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. This API returns the result synchronously. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -4229,7 +4467,7 @@ try { } ``` -### setSyncParam8+ ### +### setSyncParam8+ setSyncParam(defaultAllowedDelayMs: number, callback: AsyncCallback<void>): void @@ -4242,7 +4480,7 @@ Sets the default delay allowed for KV store synchronization. This API uses an as | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | defaultAllowedDelayMs |number | Yes |Default delay allowed for database synchronization, in ms. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -4259,7 +4497,7 @@ try { ``` -### setSyncParam8+ ### +### setSyncParam8+ setSyncParam(defaultAllowedDelayMs: number): Promise<void> @@ -4297,7 +4535,7 @@ try { ``` -### getSecurityLevel8+ ### +### getSecurityLevel8+ getSecurityLevel(callback: AsyncCallback<SecurityLevel>): void @@ -4325,7 +4563,7 @@ try { ``` -### getSecurityLevel8+ ### +### getSecurityLevel8+ getSecurityLevel(): Promise<SecurityLevel> @@ -4365,7 +4603,7 @@ For example, a device KV store can be used to implement image sharing between de Before calling any method in **DeviceKVStore**, you must use [getKVStore](#getkvstore) to obtain a **DeviceKVStore** object. -### get8+ ### +### get8+ get(deviceId: string, key: string, callback: AsyncCallback<boolean|string|number|Uint8Array>): void @@ -4379,7 +4617,7 @@ Obtains a string value that matches the specified device ID and key. This API us | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes |ID of the target device. | | key |string | Yes |Key to match. | -| callback |AsyncCallback<boolean\|string\|number\|Uint8Array> | Yes |Callback used to return the value obtained. | +| callback |AsyncCallback<boolean\|string\|number\|Uint8Array> | Yes |Callback invoked to return the value obtained. | **Example** @@ -4400,7 +4638,7 @@ try{ ``` -### get8+ ### +### get8+ get(deviceId: string, key: string): Promise<boolean|string|number|Uint8Array> @@ -4444,7 +4682,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(deviceId: string, keyPrefix: string, callback: AsyncCallback<Entry[]>): void @@ -4458,7 +4696,7 @@ Obtains all KV pairs that match the specified device ID and key prefix. This API | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes |ID of the target device. | | keyPrefix |string | Yes |Key prefix to match. | -| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback used to return the KV pairs obtained. | +| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback invoked to return the KV pairs obtained. | **Example** @@ -4492,7 +4730,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(deviceId: string, keyPrefix: string): Promise<Entry[]> @@ -4551,7 +4789,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(query: Query, callback: AsyncCallback<Entry[]>): void @@ -4564,7 +4802,7 @@ Obtains the KV pairs that match the specified **Query** object. This API uses an | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | query |[Query](#query8) | Yes |**Query** object to match. | -| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback used to return the KV pairs obtained. | +| callback |AsyncCallback<[Entry](#entry)[]> | Yes |Callback invoked to return the KV pairs obtained. | **Example** @@ -4603,7 +4841,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(query: Query): Promise<Entry[]> @@ -4661,7 +4899,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(deviceId: string, query: Query, callback: AsyncCallback<Entry[]>): void @@ -4714,7 +4952,7 @@ try { ``` -### getEntries8+ ### +### getEntries8+ getEntries(deviceId: string, query: Query): Promise<Entry[]> @@ -4774,7 +5012,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(deviceId: string, keyPrefix: string, callback: AsyncCallback<KvStoreResultSet>): void @@ -4809,7 +5047,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(deviceId: string, keyPrefix: string): Promise<KvStoreResultSet> @@ -4853,7 +5091,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(query: Query, callback: AsyncCallback<KvStoreResultSet>): void @@ -4905,7 +5143,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(query: Query): Promise<KvStoreResultSet> @@ -4969,7 +5207,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(deviceId: string, query: Query, callback: AsyncCallback<KvStoreResultSet>): void @@ -5021,7 +5259,7 @@ try { ``` -### getResultSet8+ ### +### getResultSet8+ getResultSet(deviceId: string, query: Query): Promise<KvStoreResultSet> @@ -5087,7 +5325,7 @@ try { ``` -### closeResultSet8+ ### +### closeResultSet8+ closeResultSet(resultSet: KvStoreResultSet, callback: AsyncCallback<void>): void @@ -5100,7 +5338,7 @@ Closes the **KvStoreResultSet** object obtained by [DeviceKVStore.getResultSet]( | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | resultSet |[KvStoreResultSet](#getresultset8) | Yes |**KvStoreResultSet** object to close. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -5122,7 +5360,7 @@ try { ``` -### closeResultSet8+ ### +### closeResultSet8+ closeResultSet(resultSet: KvStoreResultSet): Promise<void> @@ -5160,7 +5398,7 @@ try { ``` -### getResultSize8+ ### +### getResultSize8+ getResultSize(query: Query, callback: AsyncCallback<number>): void @@ -5207,7 +5445,7 @@ try { ``` -### getResultSize8+ ### +### getResultSize8+ getResultSize(query: Query): Promise<number> @@ -5263,7 +5501,7 @@ try { ``` -### getResultSize8+ ### +### getResultSize8+ getResultSize(deviceId: string, query: Query, callback: AsyncCallback<number>): void; @@ -5310,7 +5548,7 @@ try { ``` -### getResultSize8+ ### +### getResultSize8+ getResultSize(deviceId: string, query: Query): Promise<number> @@ -5366,7 +5604,7 @@ try { ``` -### removeDeviceData8+ ### +### removeDeviceData8+ removeDeviceData(deviceId: string, callback: AsyncCallback<void>): void @@ -5379,7 +5617,7 @@ Deletes data of the specified device from this KV store. This API uses an asynch | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | | deviceId |string | Yes |ID of the target device. | -| callback |AsyncCallback<void> | Yes |Callback used to return the result. | +| callback |AsyncCallback<void> | Yes |Callback invoked to return the result. | **Example** @@ -5408,7 +5646,7 @@ try { ``` -### removeDeviceData8+ ### +### removeDeviceData8+ removeDeviceData(deviceId: string): Promise<void> @@ -5457,11 +5695,11 @@ try { ``` -### sync8+ ### +### sync8+ sync(deviceIds: string[], mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -5496,11 +5734,11 @@ try { } ``` -### sync9+ ### +### sync9+ sync(deviceIds: string[], query: Query, mode: SyncMode, delayMs?: number): void -Synchronizes the KV store manually. This API returns the result synchronously. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview] (../../database/database-mdds-overview.md). +Synchronizes the KV store manually. This API returns the result synchronously. For details about the synchronization modes of the distributed data service, see [Distributed Data Service Overview](../../database/database-mdds-overview.md). **Required permissions**: ohos.permission.DISTRIBUTED_DATASYNC @@ -5538,11 +5776,11 @@ try { } ``` -### on('syncComplete')8+ ### +### on('syncComplete')8+ on(event: 'syncComplete', syncCallback: Callback<Array<[string, number]>>): void -Subscribes to the data synchronization complete events. +Subscribes to synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -5550,8 +5788,8 @@ Subscribes to the data synchronization complete events. | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to subscribe to. The value is **syncComplete**, which indicates the data synchronization complete event.| -| syncCallback |Callback | Yes |Callback used to return the synchronization result. | +| event |string | Yes |Event to subscribe to. The value is **syncComplete**, which indicates a synchronization complete event.| +| syncCallback |Callback | Yes |Callback invoked to return a synchronization complete event. | **Example** @@ -5574,11 +5812,11 @@ try { ``` -### off('syncComplete')8+ ### +### off('syncComplete')8+ off(event: 'syncComplete', syncCallback?: Callback<Array<[string, number]>>): void -Unsubscribes from the synchronization complete events. This API returns the result synchronously. +Unsubscribes from synchronization complete events. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -5586,25 +5824,31 @@ Unsubscribes from the synchronization complete events. This API returns the resu | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to unsubscribe from. The value is **syncComplete**, which indicates the data synchronization complete event.| -| syncCallback |Callback9+ ### +### on('dataChange')9+ on(event: 'dataChange', type: SubscribeType, listener: Callback<ChangeNotification>): void @@ -5616,9 +5860,9 @@ Subscribes to data changes of the specified type. This API returns the result sy | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to subscribe to. The value is **dataChange**, which indicates data changes. | -| type |[SubscribeType](#subscribetype) | Yes |Subscription type. | -| listener |Callback<[ChangeNotification](#changenotification)> | Yes |Callback used to return the result.| +| event |string | Yes |Event to subscribe to. The value is **dataChange**, which indicates a data change event. | +| type |[SubscribeType](#subscribetype) | Yes |Type of data change. | +| listener |Callback<[ChangeNotification](#changenotification)> | Yes |Callback invoked to return a data change event.| **Example** @@ -5630,11 +5874,11 @@ kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_LOCAL, fun ``` -### off('dataChange')9+ ### +### off('dataChange')9+ off(event:'dataChange', listener?: Callback<ChangeNotification>): void -Unsubscribes from the data change events. This API returns the result synchronously. +Unsubscribes from data changes. This API returns the result synchronously. **System capability**: SystemCapability.DistributedDataManager.KVStore.Core @@ -5642,19 +5886,28 @@ Unsubscribes from the data change events. This API returns the result synchronou | Name | Type| Mandatory | Description | | ----- | ------ | ---- | ----------------------- | -| event |string | Yes |Event to unsubscribe from. The value is **dataChange**, which indicates data changes. | -| listener |Callback<[ChangeNotification](#changenotification)> |No |Callback used to return the result.| +| event |string | Yes |Event to unsubscribe from. The value is **dataChange**, which indicates a data change event. | +| listener |Callback<[ChangeNotification](#changenotification)> |No |Callback for the data change event.| **Example** ```js let kvStore; -kvStore.on('dataChange', function (data) { - console.log("callback call data: " + data); -}); -kvStore.off('dataChange', function (data) { - console.log("callback call data: " + data); -}); +class KvstoreModel { + call(data) { + console.log("dataChange: " + data); + } + subscribeDataChange() { + if (kvStore != null) { + kvStore.on('dataChange', distributedData.SubscribeType.SUBSCRIBE_TYPE_REMOTE, this.call); + } + } + unsubscribeDataChange() { + if (kvStore != null) { + kvStore.off('dataChange', this.call); + } + } +} ``` ## SyncMode @@ -5668,4 +5921,3 @@ Enumerates the synchronization modes. | PULL_ONLY |0 |Pull data from the peer end to the local end only.| | PUSH_ONLY |1 |Push data from the local end to the peer end only.| | PUSH_PULL |2 |Push data from the local end to the peer end and then pull data from the peer end to the local end.| - diff --git a/en/application-dev/reference/apis/js-apis-effectKit.md b/en/application-dev/reference/apis/js-apis-effectKit.md index 089bf96cb239204c4b52c3ce71848f15141d76a4..cf2bb656da8705ff8352e00a06ce9149980959a4 100644 --- a/en/application-dev/reference/apis/js-apis-effectKit.md +++ b/en/application-dev/reference/apis/js-apis-effectKit.md @@ -4,7 +4,7 @@ The **EffectKit** module provides basic image processing capabilities, including This module provides the following classes: -- [Filter](#filter): a class that provides the effect chain. +- [Filter](#filter): a class that provides the effect chain, which is a linked list of image processing effects. - [Color](#color): a class used to store the color picked. - [ColorPicker](#colorpicker): a smart color picker. @@ -40,13 +40,14 @@ Creates a **Filter** instance based on the pixel map. **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); -let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts) - .then((pixelMap) => { - let headFilter = effectKit.createEffect(pixelMap) - }) +let bufferArr = new Uint8Array(color); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } +image.createPixelMap(color, opts).then((pixelMap) => { + let headFilter = effectKit.createEffect(pixelMap); +}) ``` ## effectKit.createColorPicker @@ -67,19 +68,20 @@ Creates a **ColorPicker** instance based on the pixel map. This API uses a promi | Type | Description | | ---------------------- | -------------- | -| Promisse\<[ColorPicker](#colorpicker)> | Promise used to return the **ColorPicker** instance created.| +| Promise\<[ColorPicker](#colorpicker)> | Promise used to return the **ColorPicker** instance created.| **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); -let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts, (pixelMap) => { - effectKit.createColorPicker(pixelMap).then(colorPicker => { - console.info("color picker=" + colorPicker); - }) - .catch(ex => console.error(".error=" + ex.toString())) +let bufferArr = new Uint8Array(color); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } +image.createPixelMap(color, opts).then((pixelMap) => { + effectKit.createColorPicker(pixelMap).then(colorPicker => { + console.info("color picker=" + colorPicker); + }).catch(ex => console.error(".error=" + ex.toString())) }) ``` @@ -101,17 +103,19 @@ Creates a **ColorPicker** instance based on the pixel map. This API uses an asyn **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); -let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts, (pixelMap) => { - effectKit.createColorPicker(pixelMap, (error, colorPicker) => { - if(error) { - console.log('Failed to create color picker.'); - } else { - console.log('Succeeded in creating color picker.'); - } - }) +let bufferArr = new Uint8Array(color); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } +image.createPixelMap(color, opts).then((pixelMap) => { + effectKit.createColorPicker(pixelMap, (error, colorPicker) => { + if (error) { + console.log('Failed to create color picker.'); + } else { + console.log('Succeeded in creating color picker.'); + } + }) }) ``` @@ -150,8 +154,8 @@ Obtains the main color of the image and writes the result to a **[Color](#color) ```js colorPicker.getMainColor().then(color => { - console.log('Succeeded in getting main color.') - console.info("color[ARGB]=" + color.alpha + "," + color.red + "," + color.green + "," + color.blue); + console.log('Succeeded in getting main color.'); + console.info(`color[ARGB]=${color.alpha},${color.red},${color.green},${color.blue}`); }).catch(error => { console.log('Failed to get main color.'); }) @@ -205,17 +209,17 @@ Adds the blur effect to the filter linked list, and returns the head node of the **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts) - .then((pixelMap) => { - let radius = 5; - let headFilter = effectKit.createEffect(pixelMap) - if (headFilter != null) { - headFilter.blur(radius) - } - }) +image.createPixelMap(color, opts).then((pixelMap) => { + let radius = 5; + let headFilter = effectKit.createEffect(pixelMap); + if (headFilter != null) { + headFilter.blur(radius); + } +}) ``` ### brightness @@ -241,17 +245,17 @@ Adds the brightness effect to the filter linked list, and returns the head node **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts) - .then((pixelMap) => { - let bright = 0.5; - let headFilter = effectKit.createEffect(pixelMap) - if (headFilter != null) { - headFilter.brightness(bright) - } - }) +image.createPixelMap(color, opts).then((pixelMap) => { + let bright = 0.5; + let headFilter = effectKit.createEffect(pixelMap); + if (headFilter != null) { + headFilter.brightness(bright); + } +}) ``` ### grayscale @@ -271,16 +275,16 @@ Adds the grayscale effect to the filter linked list, and returns the head node o **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts) - .then((pixelMap) => { - let headFilter = effectKit.createEffect(pixelMap) - if (headFilter != null) { - headFilter.grayscale() - } - }) +image.createPixelMap(color, opts).then((pixelMap) => { + let headFilter = effectKit.createEffect(pixelMap); + if (headFilter != null) { + headFilter.grayscale(); + } +}) ``` ### getPixelMap @@ -300,11 +304,11 @@ Obtains **image.PixelMap** of the source image to which the filter linked list i **Example** ```js -import image from "@ohos.multimedia.image" +import image from "@ohos.multimedia.image"; + const color = new ArrayBuffer(96); let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }; -image.createPixelMap(color, opts) - .then((pixelMap) => { - let pixel = effectKit.createEffect(pixelMap).grayscale().getPixelMap() - }) +image.createPixelMap(color, opts).then((pixelMap) => { + let pixel = effectKit.createEffect(pixelMap).grayscale().getPixelMap(); +}) ``` diff --git a/en/application-dev/reference/apis/js-apis-errorManager.md b/en/application-dev/reference/apis/js-apis-errorManager.md index 69d3c3bf8240d370a364294d4089aa445f3809cc..4a39fdd6b0031be7e3fcbdfc7a570609ba217a1b 100644 --- a/en/application-dev/reference/apis/js-apis-errorManager.md +++ b/en/application-dev/reference/apis/js-apis-errorManager.md @@ -33,8 +33,7 @@ var observer = { console.log('onUnhandledException, errorMsg: ', errorMsg) } } -const registerErrorObserverNumber=errorManager.registerErrorObserver(observer) -console.info(registerErrorObserverNumber) +errorManager.registerErrorObserver(observer) ``` ## ErrorManager.unregisterErrorObserver @@ -123,11 +122,4 @@ var observer = { } } errorManager.registerErrorObserver(observer) - .then((data) => { - console.log('----------- registerErrorObserver success ----------', data); - }) - .catch((err) => { - console.log('----------- registerErrorObserver fail ----------', err); - }) - ``` diff --git a/en/application-dev/reference/apis/js-apis-eventhub.md b/en/application-dev/reference/apis/js-apis-eventhub.md index ca1b1500dcb8836b73abd13e837a0255a78a3a5f..9ae7db735cbc61fa55a764cb285801297452c5d8 100644 --- a/en/application-dev/reference/apis/js-apis-eventhub.md +++ b/en/application-dev/reference/apis/js-apis-eventhub.md @@ -9,10 +9,10 @@ The **EventHub** module provides APIs to subscribe to, unsubscribe from, and tri ## Usage -​Before using any APIs in the **EventHub**, you must obtain an **EventHub** instance through the member variable **context** of the **Ability** instance. +Before using any APIs in the **EventHub**, you must obtain an **EventHub** instance through the member variable **context** of the **Ability** instance. ```js -import Ability from '@ohos.application.Ability' +import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { func1(){ console.log("func1 is called"); @@ -34,15 +34,15 @@ Subscribes to an event. **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | event | string | Yes| Event name.| - | callback | Function | Yes| Callback invoked when the event is triggered.| +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| event | string | Yes| Event name.| +| callback | Function | Yes| Callback invoked when the event is triggered.| **Example** ```js - import Ability from '@ohos.application.Ability' + import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { onForeground() { @@ -72,15 +72,15 @@ Unsubscribes from an event. If **callback** is specified, this API unsubscribes **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | event | string | Yes| Event name.| - | callback | Function | No| Callback for the event. If **callback** is unspecified, all callbacks of the event are unsubscribed.| +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| event | string | Yes| Event name.| +| callback | Function | No| Callback for the event. If **callback** is unspecified, all callbacks of the event are unsubscribed.| **Example** ```js - import Ability from '@ohos.application.Ability' + import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { onForeground() { @@ -110,15 +110,15 @@ Triggers an event. **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | event | string | Yes| Event name.| - | ...args | Object[] | Yes| Variable parameters, which are passed to the callback when the event is triggered.| +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| event | string | Yes| Event name.| +| ...args | Object[] | Yes| Variable parameters, which are passed to the callback when the event is triggered.| **Example** ```js - import Ability from '@ohos.application.Ability' + import Ability from '@ohos.application.Ability'; export default class MainAbility extends Ability { onForeground() { diff --git a/en/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/en/application-dev/reference/apis/js-apis-extensionrunninginfo.md index 66b794234a41c9e57977946adbf02a9f35182b60..841f7755273489a570865b41c63c5103c3af0c9a 100644 --- a/en/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/en/application-dev/reference/apis/js-apis-extensionrunninginfo.md @@ -12,9 +12,9 @@ The **ExtensionRunningInfo** module provides running information and states for The Extension ability running information is obtained through an **abilityManager** instance. ```js -import abilitymanager from '@ohos.application.abilityManager'; +import abilityManager from '@ohos.application.abilityManager'; let upperLimit=1 -abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { +abilityManager.getExtensionRunningInfos(upperLimit, (err,data) => { console.log("getExtensionRunningInfos err: " + err + " data: " + JSON.stringify(data)); }); ``` diff --git a/en/application-dev/reference/apis/js-apis-filemanager.md b/en/application-dev/reference/apis/js-apis-filemanager.md index 9aa6294c56aed0d897ceecc46c4fd4ca6ecd48c6..b80660185cffaf10993bf9c54ba1f88a1f16b7f4 100644 --- a/en/application-dev/reference/apis/js-apis-filemanager.md +++ b/en/application-dev/reference/apis/js-apis-filemanager.md @@ -22,6 +22,7 @@ Obtains information about the root album or directory in asynchronous mode. This **System capability**: SystemCapability.FileManagement.UserFileService **Parameters** + | Name| Type| Mandatory| Description| | --- | --- | --- | -- | | options | Object | No| The options are as follows:
-  **dev**: See [DevInfo](#devinfo). It is **dev = {name: "local"}** by default if not specified. Currently, only 'local' is supported.| @@ -83,6 +84,7 @@ Obtains information about the second-level album or files in asynchronous mode. **System capability**: SystemCapability.FileManagement.UserFileService **Parameters** + | Name| Type| Mandatory| Description| | --- | --- | --- | -- | | path | string | Yes| URI of the directory to query.| @@ -169,6 +171,7 @@ Creates a file in the specified path in asynchronous mode. This API uses a promi **System capability**: SystemCapability.FileManagement.UserFileService **Parameters** + | Name| Type| Mandatory| Description| | --- | --- | --- | -- | | filename | string | Yes| Name of the file to create.| diff --git a/en/application-dev/reference/apis/js-apis-formInfo.md b/en/application-dev/reference/apis/js-apis-formInfo.md index eace629fc87a608f2235f9887c4b0e075ce38b4e..8acf0e5e3e1ccb81b2295b03c65ed8fd812efa8e 100644 --- a/en/application-dev/reference/apis/js-apis-formInfo.md +++ b/en/application-dev/reference/apis/js-apis-formInfo.md @@ -3,7 +3,7 @@ The **FormInfo** module provides widget information and state. > **NOTE** -> +> > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import @@ -105,7 +105,7 @@ Enumerates the widget parameters. | TEMPORARY_KEY | "ohos.extra.param.key.form_temporary" | Temporary widget. | | ABILITY_NAME_KEY9+ | "ohos.extra.param.key.ability_name" | Ability name. | | DEVICE_ID_KEY9+ | "ohos.extra.param.key.device_id" | Device ID.
This is a system API. | -| BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | Key that specifies the target bundle name.
This is a system API. | +| BUNDLE_NAME_KEY9+ | "ohos.extra.param.key.bundle_name" | Key that specifies the target bundle name.| ## FormDimension @@ -120,3 +120,14 @@ Enumerates the widget dimensions. | Dimension_2_49+ | 3 | 2 x 4. | | Dimension_4_49+ | 4 | 4 x 4. | | Dimension_2_19+ | 5 | 2 x 1. | + + +## FormInfoFilter + +Defines the widget information filter. Only the widget information that meets the filter is returned. + +**System capability**: SystemCapability.Ability.Form + +| Name | Yes | Description | +| ----------- | ---- | ------------ | +| moduleName9+ | No | Module name.| diff --git a/en/application-dev/reference/apis/js-apis-formprovider.md b/en/application-dev/reference/apis/js-apis-formprovider.md index fbe8907aed6b59d005f027af62ec4d0b0ec9a141..8ce539886e5460ffe712b486addf6e3813c44a90 100644 --- a/en/application-dev/reference/apis/js-apis-formprovider.md +++ b/en/application-dev/reference/apis/js-apis-formprovider.md @@ -3,7 +3,7 @@ The **FormProvider** module provides APIs related to the widget provider. You can use the APIs to update a widget, set the next refresh time for a widget, obtain widget information, and request a widget release. > **NOTE** -> +> > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. ## Modules to Import @@ -183,7 +183,7 @@ Obtains the application's widget information that meets a filter criterion on th | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------- | -| filter | formInfo.FormInfoFilter | Yes| Filter criterion.| +| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md#forminfofilter) | Yes| Filter criterion.| | callback | AsyncCallback<Array<[FormInfo](./js-apis-formInfo.md#forminfo-1)>> | Yes| Callback used to return the widget information.| **Example** @@ -214,7 +214,7 @@ Obtains the application's widget information on the device. This API uses a prom | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------- | -| filter | formInfo.FormInfoFilter | No| Filter criterion.| +| filter | [formInfo.FormInfoFilter](./js-apis-formInfo.md) | No| Filter criterion.| **Return value** diff --git a/en/application-dev/reference/apis/js-apis-hashmap.md b/en/application-dev/reference/apis/js-apis-hashmap.md index d1ac45e3bd10590be109ded2095405e4dee962de..5cf52af02dd7e1c36469882706ef2e0533cc5a5c 100644 --- a/en/application-dev/reference/apis/js-apis-hashmap.md +++ b/en/application-dev/reference/apis/js-apis-hashmap.md @@ -12,6 +12,10 @@ **Recommended use case**: Use **HashMap** when you need to quickly access, remove, and insert key-value pairs. +This topic uses the following to identify the use of generics: +- K: Key +- V: Value + ## Modules to Import ```ts @@ -90,9 +94,9 @@ Checks whether this container contains the specified key. ```ts let hashMap = new HashMap(); -let result = hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -let result1 = hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = hashMap.hasKey("squirrel"); +hashMap.set("squirrel", 123); +let result1 = hashMap.hasKey("squirrel"); ``` @@ -121,7 +125,7 @@ Checks whether this container contains the specified value. ```ts let hashMap = new HashMap(); let result = hashMap.hasValue(123); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); +hashMap.set("squirrel", 123); let result1 = hashMap.hasValue(123); ``` @@ -150,9 +154,9 @@ Obtains the value of the specified key in this container. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); -let result = hashMap.get("sdfs"); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); +let result = hashMap.get("sparrow"); ``` @@ -174,8 +178,8 @@ Adds all elements in a **HashMap** instance to this container. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); let newHashMap = new HashMap(); hashMap.setAll(newHashMap); ``` @@ -194,7 +198,7 @@ Adds an element to this container. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | K | Yes| Key of the target element.| -| value | V | Yes| Value of the element.| +| value | V | Yes| Value of the target element.| **Return value** @@ -206,7 +210,7 @@ Adds an element to this container. ```ts let hashMap = new HashMap(); -let result = hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); +let result = hashMap.set("squirrel", 123); ``` @@ -234,9 +238,9 @@ Removes an element with the specified key from this container. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); -let result = hashMap.remove("sdfs"); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); +let result = hashMap.remove("sparrow"); ``` @@ -252,8 +256,8 @@ Clears this container and sets its length to **0**. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); hashMap.clear(); ``` @@ -276,8 +280,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); let iter = hashMap.keys(); let temp = iter.next().value; while(temp != undefined) { @@ -305,8 +309,8 @@ Obtains an iterator that contains all the values in this container. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); let iter = hashMap.values(); let temp = iter.next().value; while(temp != undefined) { @@ -341,8 +345,8 @@ Replaces an element in this container. ```ts let hashMap = new HashMap(); -hashMap.set("sdfs", 123); -let result = hashMap.replace("sdfs", 357); +hashMap.set("sparrow", 123); +let result = hashMap.replace("sparrow", 357); ``` @@ -372,8 +376,8 @@ callbackfn ```ts let hashMap = new HashMap(); -hashMap.set("sdfs", 123); -hashMap.set("dfsghsf", 357); +hashMap.set("sparrow", 123); +hashMap.set("gull", 357); hashMap.forEach((value, key) => { console.log("value:" + value, key); }); @@ -398,8 +402,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); let iter = hashMap.entries(); let temp = iter.next().value; while(temp != undefined) { @@ -427,8 +431,8 @@ Obtains an iterator, each item of which is a JavaScript object. **Example** ```ts let hashMap = new HashMap(); -hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -hashMap.set("sdfs", 356); +hashMap.set("squirrel", 123); +hashMap.set("sparrow", 356); // Method 1: for (let item of hashMap) { diff --git a/en/application-dev/reference/apis/js-apis-hashset.md b/en/application-dev/reference/apis/js-apis-hashset.md index 85bbfa2719412099c1d051de61b3c39363872b27..6568c856e715a5f86da527aea4c5ce3888537bc5 100644 --- a/en/application-dev/reference/apis/js-apis-hashset.md +++ b/en/application-dev/reference/apis/js-apis-hashset.md @@ -10,6 +10,9 @@ Unlike [TreeSet](js-apis-treeset.md), which stores and accesses data in sorted o **Recommended use case**: Use **HashSet** when you need a set that has only unique elements or need to deduplicate a set. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -26,6 +29,17 @@ import HashSet from '@ohos.util.HashSet'; | -------- | -------- | -------- | -------- | -------- | | length | number | Yes| No| Number of elements in a hash set (called container later).| +**Example** + +```ts +let hashSet = new HashSet(); +hashSet.add(1); +hashSet.add(2); +hashSet.add(3); +hashSet.add(4); +hashSet.add(5); +let res = hashSet.length; +``` ### constructor @@ -88,9 +102,9 @@ Checks whether this container contains the specified element. ```ts let hashSet = new HashSet(); -let result = hashSet.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -let result1 = hashSet.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = hashSet.has("squirrel"); +hashSet.add("squirrel"); +let result1 = hashSet.has("squirrel"); ``` @@ -118,7 +132,7 @@ Adds an element to this container. ```ts let hashSet = new HashSet(); -let result = hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = hashSet.add("squirrel"); ``` @@ -146,9 +160,9 @@ Removes an element from this container. ```ts let hashSet = new HashSet(); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashSet.add("sdfs"); -let result = hashSet.remove("sdfs"); +hashSet.add("squirrel"); +hashSet.add("sparrow"); +let result = hashSet.remove("sparrow"); ``` @@ -164,8 +178,8 @@ Clears this container and sets its length to **0**. ```ts let hashSet = new HashSet(); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashSet.add("sdfs"); +hashSet.add("squirrel"); +hashSet.add("sparrow"); hashSet.clear(); ``` @@ -188,8 +202,8 @@ Obtains an iterator that contains all the values in this container. ```ts let hashSet = new HashSet(); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashSet.add("sdfs"); +hashSet.add("squirrel"); +hashSet.add("sparrow"); let iter = hashSet.values(); let temp = iter.next().value; while(temp != undefined) { @@ -225,8 +239,8 @@ callbackfn ```ts let hashSet = new HashSet(); -hashSet.add("sdfs"); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +hashSet.add("sparrow"); +hashSet.add("squirrel"); hashSet.forEach((value, key) => { console.log("value:" + value, key); }); @@ -250,8 +264,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let hashSet = new HashSet(); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashSet.add("sdfs"); +hashSet.add("squirrel"); +hashSet.add("sparrow"); let iter = hashSet.entries(); let temp = iter.next().value; while(temp != undefined) { @@ -280,8 +294,8 @@ Obtains an iterator, each item of which is a JavaScript object. ```ts let hashSet = new HashSet(); -hashSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -hashSet.add("sdfs"); +hashSet.add("squirrel"); +hashSet.add("sparrow"); // Method 1: for (let item of hashSet) { diff --git a/en/application-dev/reference/apis/js-apis-hisysevent.md b/en/application-dev/reference/apis/js-apis-hisysevent.md index 022682c82230162ebb586898aed0b54ac6a59e30..e3c08ce24cf92eda9534812d664aa466c4b7c1ef 100644 --- a/en/application-dev/reference/apis/js-apis-hisysevent.md +++ b/en/application-dev/reference/apis/js-apis-hisysevent.md @@ -89,7 +89,7 @@ Writes event information to the event file. This API uses a promise to return th | Name | Type | Mandatory| Description| | --------- | ----------------------- | ---- | --------------- | -| eventType | [EventType](#eventtype) | Yes | Application event type.| +| info | [SysEventInfo](#syseventinfo) | Yes | System event information.| **Return value** diff --git a/en/application-dev/reference/apis/js-apis-huks.md b/en/application-dev/reference/apis/js-apis-huks.md index 6cd14aeb285b3ec93581dbc7f425d06eda1907c5..2d66bc9c61a54f3bfa88d6e7f27aa93fabd49a2d 100644 --- a/en/application-dev/reference/apis/js-apis-huks.md +++ b/en/application-dev/reference/apis/js-apis-huks.md @@ -59,8 +59,8 @@ Enumerates the error codes. | HUKS_ERROR_NEW_ROOT_KEY_MATERIAL_EXIST | -36 |New root key material exists.| | HUKS_ERROR_UPDATE_ROOT_KEY_MATERIAL_FAIL | -37 |Failed to update the root key material.| | HUKS_ERROR_VERIFICATION_FAILED | -38 |Failed to verify the certificate chain.| -| HUKS_ERROR_GET_USERIAM_SECINFO_FAILED9+ | -40 |Failed to obtain the security attribute information of the current user.| -| HUKS_ERROR_GET_USERIAM_AUTHINFO_FAILED9+ | -41 |Failed to obtain the authentication information of the current user.| +| HUKS_ERROR_GET_USERIAM_SECINFO_FAILED9+ | -40 |Failed to obtain the security attribute information of the user.| +| HUKS_ERROR_GET_USERIAM_AUTHINFO_FAILED9+ | -41 |Failed to obtain the authentication information of the user.| | HUKS_ERROR_USER_AUTH_TYPE_NOT_SUPPORT9+ | -42 |The access control of the current authentication type is not supported.| | HUKS_ERROR_KEY_AUTH_FAILED9+ | -43 |The access control authentication has failed.| | HUKS_ERROR_DEVICE_NO_CREDENTIAL9+ | -44 |No credential has been enrolled for the device.| @@ -154,7 +154,7 @@ Enumerates the cipher modes. | Name | Value | Description | | ------------- | ---- | --------------------- | -| HUKS_MODE_ECB | 1 | Electronic Code bLock (ECB) mode| +| HUKS_MODE_ECB | 1 | Electronic Code BLock (ECB) mode| | HUKS_MODE_CBC | 2 | Cipher Block Chaining (CBC) mode| | HUKS_MODE_CTR | 3 | Counter (CTR) mode| | HUKS_MODE_OFB | 4 | Output Feedback (OFB) mode| @@ -297,7 +297,7 @@ Enumerates the user authentication types. ## HuksAuthAccessType9+ -Enumerates access control types. +Enumerates the access control types. **System capability**: SystemCapability.Security.Huks @@ -320,7 +320,7 @@ Enumerates the types of the challenges generated when a key is used. ## HuksChallengePosition9+ -Enumerates the positions of the 8-byte custom challenges. +Enumerates the positions of the 8-byte valid value in a custom challenge generated. **System capability**: SystemCapability.Security.Huks @@ -363,90 +363,90 @@ Enumerates the tags used to invoke parameters. **System capability**: SystemCapability.Security.Huks -| Name | Value | Description | -| -------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------ | -| HUKS_TAG_INVALID | HuksTagType.HUKS_TAG_TYPE_INVALID \| 0 | Invalid tag. | -| HUKS_TAG_ALGORITHM | HUKS_TAG_TYPE_UINT \| 1 | Algorithm. | -| HUKS_TAG_PURPOSE | HuksTagType.HUKS_TAG_TYPE_UINT \| 2 | Purpose of a key. | -| HUKS_TAG_KEY_SIZE | HuksTagType.HUKS_TAG_TYPE_UINT \| 3 | Key size. | -| HUKS_TAG_DIGEST | HuksTagType.HUKS_TAG_TYPE_UINT \| 4 | Digest algorithm. | -| HUKS_TAG_PADDING | HuksTagType.HUKS_TAG_TYPE_UINT \| 5 | Padding algorithm. | -| HUKS_TAG_BLOCK_MODE | HuksTagType.HUKS_TAG_TYPE_UINT \| 6 | Cipher mode. | -| HUKS_TAG_KEY_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 7 | Key type. | -| HUKS_TAG_ASSOCIATED_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 8 | Associated authentication data. | -| HUKS_TAG_NONCE | HuksTagType.HUKS_TAG_TYPE_BYTES \| 9 | Field for key encryption and decryption. | -| HUKS_TAG_IV | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10 | IV. | -| HUKS_TAG_INFO | HuksTagType.HUKS_TAG_TYPE_BYTES \| 11 | Information generated during key derivation. | -| HUKS_TAG_SALT | HuksTagType.HUKS_TAG_TYPE_BYTES \| 12 | Salt value used for key derivation. | -| HUKS_TAG_PWD | HuksTagType.HUKS_TAG_TYPE_BYTES \| 13 | Password used for key derivation. | -| HUKS_TAG_ITERATION | HuksTagType.HUKS_TAG_TYPE_UINT \| 14 | Number of iterations for key derivation. | -| HUKS_TAG_KEY_GENERATE_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 15 | Key generation type. | -| HUKS_TAG_DERIVE_MAIN_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES \| 16 | Main key for key derivation. | -| HUKS_TAG_DERIVE_FACTOR | HuksTagType.HUKS_TAG_TYPE_BYTES \| 17 | Factor for key derivation. | -| HUKS_TAG_DERIVE_ALG | HuksTagType.HUKS_TAG_TYPE_UINT \| 18 | Type of the algorithm used for key derivation. | -| HUKS_TAG_AGREE_ALG | HuksTagType.HUKS_TAG_TYPE_UINT \| 19 | Type of the algorithm used for key agreement. | -| HUKS_TAG_AGREE_PUBLIC_KEY_IS_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BOOL \| 20 | Public key alias used in key agreement. | -| HUKS_TAG_AGREE_PRIVATE_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BYTES \| 21 | Private key alias used in key agreement. | -| HUKS_TAG_AGREE_PUBLIC_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES \| 22 | Public key used in key agreement. | -| HUKS_TAG_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BYTES \| 23 | Key alias. | -| HUKS_TAG_DERIVE_KEY_SIZE | HuksTagType.HUKS_TAG_TYPE_UINT \| 24 | Size of the derived key. | -| HUKS_TAG_IMPORT_KEY_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 25 | Type of the imported key. | -| HUKS_TAG_UNWRAP_ALGORITHM_SUITE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 26 | Algorithm suite used when a wrapped key is imported. | -| HUKS_TAG_ACTIVE_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 201 | Reserved. | -| HUKS_TAG_ORIGINATION_EXPIRE_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 202 | Reserved. | -| HUKS_TAG_USAGE_EXPIRE_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 203 | Reserved. | -| HUKS_TAG_CREATION_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 204 | Reserved. | -| HUKS_TAG_ALL_USERS | ksTagType.HUKS_TAG_TYPE_BOOL \| 301 | Reserved. | -| HUKS_TAG_USER_ID | HuksTagType.HUKS_TAG_TYPE_UINT \| 302 | Reserved. | -| HUKS_TAG_NO_AUTH_REQUIRED | HuksTagType.HUKS_TAG_TYPE_BOOL \| 303 | Reserved. | -| HUKS_TAG_USER_AUTH_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 304 | User authentication type. For details, see [HuksUserAuthType](#huksuserauthtype9). This parameter must be set together with [HuksAuthAccessType](#huksauthaccesstype9). You can set a maximum of two user authentication types at a time. For example, if **HuksAuthAccessType** is **HKS_SECURE_ACCESS_INVALID_NEW_BIO_ENROLL**, you can set two of **HKS_USER_AUTH_TYPE_FACE**, **HKS_USER_AUTH_TYPE_FINGERPRINT**, and **HKS_USER_AUTH_TYPE_FACE**. | -| HUKS_TAG_AUTH_TIMEOUT | HuksTagType.HUKS_TAG_TYPE_UINT \| 305 | Reserved. | -| HUKS_TAG_AUTH_TOKEN | HuksTagType.HUKS_TAG_TYPE_BYTES \| 306 | Reserved. | -| HUKS_TAG_KEY_AUTH_ACCESS_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 307 | Access control type. For details, see [HuksAuthAccessType](#huksauthaccesstype9). This parameter must be set together with [HuksUserAuthType](#huksuserauthtype9). | -| HUKS_TAG_KEY_SECURE_SIGN_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 308 | Signature type of the key generated or imported. | -| HUKS_TAG_CHALLENGE_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 309 | Type of the challenge generated for a key. For details, see [HuksChallengeType](#hukschallengetype9). | -| HUKS_TAG_CHALLENGE_POS9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 310 | Position of the 8-bypte custom challenge. For details, see [HuksChallengePosition](#hukschallengeposition9). | -| HUKS_TAG_ATTESTATION_CHALLENGE | HuksTagType.HUKS_TAG_TYPE_BYTES \| 501 | Challenge value used in the attestation. | +| Name | Value | Description | +| -------------------------------------------- | ---------------------------------------- | -------------------------------------- | +| HUKS_TAG_INVALID | HuksTagType.HUKS_TAG_TYPE_INVALID \| 0 | Invalid tag. | +| HUKS_TAG_ALGORITHM | HUKS_TAG_TYPE_UINT \| 1 | Algorithm. | +| HUKS_TAG_PURPOSE | HuksTagType.HUKS_TAG_TYPE_UINT \| 2 | Purpose of a key. | +| HUKS_TAG_KEY_SIZE | HuksTagType.HUKS_TAG_TYPE_UINT \| 3 | Key size. | +| HUKS_TAG_DIGEST | HuksTagType.HUKS_TAG_TYPE_UINT \| 4 | Digest algorithm. | +| HUKS_TAG_PADDING | HuksTagType.HUKS_TAG_TYPE_UINT \| 5 | Padding algorithm. | +| HUKS_TAG_BLOCK_MODE | HuksTagType.HUKS_TAG_TYPE_UINT \| 6 | Cipher mode. | +| HUKS_TAG_KEY_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 7 | Key type. | +| HUKS_TAG_ASSOCIATED_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 8 | Associated authentication data. | +| HUKS_TAG_NONCE | HuksTagType.HUKS_TAG_TYPE_BYTES \| 9 | Field for key encryption and decryption. | +| HUKS_TAG_IV | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10 | IV. | +| HUKS_TAG_INFO | HuksTagType.HUKS_TAG_TYPE_BYTES \| 11 | Information generated during key derivation. | +| HUKS_TAG_SALT | HuksTagType.HUKS_TAG_TYPE_BYTES \| 12 | Salt value used for key derivation. | +| HUKS_TAG_PWD | HuksTagType.HUKS_TAG_TYPE_BYTES \| 13 | Password used for key derivation. | +| HUKS_TAG_ITERATION | HuksTagType.HUKS_TAG_TYPE_UINT \| 14 | Number of iterations for key derivation. | +| HUKS_TAG_KEY_GENERATE_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 15 | Key generation type. | +| HUKS_TAG_DERIVE_MAIN_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES \| 16 | Main key for key derivation. | +| HUKS_TAG_DERIVE_FACTOR | HuksTagType.HUKS_TAG_TYPE_BYTES \| 17 | Factor for key derivation. | +| HUKS_TAG_DERIVE_ALG | HuksTagType.HUKS_TAG_TYPE_UINT \| 18 | Type of the algorithm used for key derivation. | +| HUKS_TAG_AGREE_ALG | HuksTagType.HUKS_TAG_TYPE_UINT \| 19 | Type of the algorithm used for key agreement. | +| HUKS_TAG_AGREE_PUBLIC_KEY_IS_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BOOL \| 20 | Public key alias used in key agreement. | +| HUKS_TAG_AGREE_PRIVATE_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BYTES \| 21 | Private key alias used in key agreement. | +| HUKS_TAG_AGREE_PUBLIC_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES \| 22 | Public key used in key agreement. | +| HUKS_TAG_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BYTES \| 23 | Key alias. | +| HUKS_TAG_DERIVE_KEY_SIZE | HuksTagType.HUKS_TAG_TYPE_UINT \| 24 | Size of the derived key. | +| HUKS_TAG_IMPORT_KEY_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 25 | Type of the imported key. | +| HUKS_TAG_UNWRAP_ALGORITHM_SUITE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 26 | Algorithm suite used when a wrapped key is imported. | +| HUKS_TAG_ACTIVE_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 201 | Reserved. | +| HUKS_TAG_ORIGINATION_EXPIRE_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 202 | Reserved. | +| HUKS_TAG_USAGE_EXPIRE_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 203 | Reserved. | +| HUKS_TAG_CREATION_DATETIME | HuksTagType.HUKS_TAG_TYPE_ULONG \| 204 | Reserved. | +| HUKS_TAG_ALL_USERS | ksTagType.HUKS_TAG_TYPE_BOOL \| 301 | Reserved. | +| HUKS_TAG_USER_ID | HuksTagType.HUKS_TAG_TYPE_UINT \| 302 | Reserved. | +| HUKS_TAG_NO_AUTH_REQUIRED | HuksTagType.HUKS_TAG_TYPE_BOOL \| 303 | Reserved. | +| HUKS_TAG_USER_AUTH_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 304 | User authentication type. For details, see [HuksUserAuthType](#huksuserauthtype9). This parameter must be set together with [HuksAuthAccessType](#huksauthaccesstype9). You can set a maximum of two user authentication types at a time. For example, if **HuksAuthAccessType** is **HKS_SECURE_ACCESS_INVALID_NEW_BIO_ENROLL**, you can set the authentication type to **HKS_USER_AUTH_TYPE_FACE**, **HKS_USER_AUTH_TYPE_FINGERPRINT**, or their combination.| +| HUKS_TAG_AUTH_TIMEOUT | HuksTagType.HUKS_TAG_TYPE_UINT \| 305 | Reserved. | +| HUKS_TAG_AUTH_TOKEN | HuksTagType.HUKS_TAG_TYPE_BYTES \| 306 | Reserved. | +| HUKS_TAG_KEY_AUTH_ACCESS_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 307 | Access control type. For details, see [HuksAuthAccessType](#huksauthaccesstype9). This parameter must be set together with [HuksUserAuthType](#huksuserauthtype9).| +| HUKS_TAG_KEY_SECURE_SIGN_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 308 | Signature type of the key generated or imported.| +| HUKS_TAG_CHALLENGE_TYPE9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 309 | Type of the challenge generated for a key. For details, see [HuksChallengeType](#hukschallengetype9).| +| HUKS_TAG_CHALLENGE_POS9+ | HuksTagType.HUKS_TAG_TYPE_UINT \| 310 | Position of the 8-byte valid value in a custom challenge. For details, see [HuksChallengePosition](#hukschallengeposition9).| +| HUKS_TAG_ATTESTATION_CHALLENGE | HuksTagType.HUKS_TAG_TYPE_BYTES \| 501 | Challenge value used in the attestation. | | HUKS_TAG_ATTESTATION_APPLICATION_ID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 502 | Application ID used in the attestation. | -| HUKS_TAG_ATTESTATION_ID_BRAND | HuksTagType.HUKS_TAG_TYPE_BYTES \| 503 | Brand of the device. | -| HUKS_TAG_ATTESTATION_ID_DEVICE | HuksTagType.HUKS_TAG_TYPE_BYTES \| 504 | Device ID. | -| HUKS_TAG_ATTESTATION_ID_PRODUCT | HuksTagType.HUKS_TAG_TYPE_BYTES \| 505 | Product name of the device. | -| HUKS_TAG_ATTESTATION_ID_SERIAL | HuksTagType.HUKS_TAG_TYPE_BYTES \| 506 | Device SN. | -| HUKS_TAG_ATTESTATION_ID_IMEI | HuksTagType.HUKS_TAG_TYPE_BYTES \| 507 | Device IMEI. | -| HUKS_TAG_ATTESTATION_ID_MEID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 508 | Device MEID. | -| HUKS_TAG_ATTESTATION_ID_MANUFACTURER | HuksTagType.HUKS_TAG_TYPE_BYTES \| 509 | Device manufacturer. | -| HUKS_TAG_ATTESTATION_ID_MODEL | HuksTagType.HUKS_TAG_TYPE_BYTES \| 510 | Device model. | -| HUKS_TAG_ATTESTATION_ID_ALIAS | HuksTagType.HUKS_TAG_TYPE_BYTES \| 511 | Key alias used in the attestation. | -| HUKS_TAG_ATTESTATION_ID_SOCID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 512 | Device SOCID. | -| HUKS_TAG_ATTESTATION_ID_UDID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 513 | Device UDID. | -| HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO | HuksTagType.HUKS_TAG_TYPE_BYTES \| 514 | Security credential used in the attestation. | -| HUKS_TAG_ATTESTATION_ID_VERSION_INFO | HuksTagType.HUKS_TAG_TYPE_BYTES \| 515 | Version information used in the attestation. | -| HUKS_TAG_IS_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BOOL \| 1001 | Whether to use the alias passed in during key generation. | -| HUKS_TAG_KEY_STORAGE_FLAG | HuksTagType.HUKS_TAG_TYPE_UINT \| 1002 | Key storage mode. | -| HUKS_TAG_IS_ALLOWED_WRAP | HuksTagType.HUKS_TAG_TYPE_BOOL \| 1003 | Reserved. | -| HUKS_TAG_KEY_WRAP_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 1004 | Reserved. | -| HUKS_TAG_KEY_AUTH_ID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 1005 | Reserved. | -| HUKS_TAG_KEY_ROLE | HuksTagType.HUKS_TAG_TYPE_UINT \| 1006 | Reserved. | -| HUKS_TAG_KEY_FLAG | HuksTagType.HUKS_TAG_TYPE_UINT \| 1007 | Flag of the key. | -| HUKS_TAG_IS_ASYNCHRONIZED | HuksTagType.HUKS_TAG_TYPE_UINT \| 1008 | Reserved. | -| HUKS_TAG_SECURE_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BOOL \| 1009 | Reserved. | -| HUKS_TAG_SECURE_KEY_UUID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 1010 | Reserved. | -| HUKS_TAG_KEY_DOMAIN | HuksTagType.HUKS_TAG_TYPE_UINT \| 1011 | Reserved. | -| HUKS_TAG_PROCESS_NAME | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10001 | Process name. | -| HUKS_TAG_PACKAGE_NAME | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10002 | Reserved. | -| HUKS_TAG_ACCESS_TIME | HuksTagType.HUKS_TAG_TYPE_UINT \| 10003 | Reserved. | -| HUKS_TAG_USES_TIME | HuksTagType.HUKS_TAG_TYPE_UINT \| 10004 | Reserved. | -| HUKS_TAG_CRYPTO_CTX | HuksTagType.HUKS_TAG_TYPE_ULONG \| 10005 | Reserved. | -| HUKS_TAG_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10006 | Reserved. | -| HUKS_TAG_KEY_VERSION | HuksTagType.HUKS_TAG_TYPE_UINT \| 10007 | Key version. | -| HUKS_TAG_PAYLOAD_LEN | HuksTagType.HUKS_TAG_TYPE_UINT \| 10008 | Reserved. | -| HUKS_TAG_AE_TAG | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10009 | Reserved. | -| HUKS_TAG_IS_KEY_HANDLE | HuksTagType.HUKS_TAG_TYPE_ULONG \| 10010 | Reserved. | -| HUKS_TAG_OS_VERSION | HuksTagType.HUKS_TAG_TYPE_UINT \| 10101 | OS version. | -| HUKS_TAG_OS_PATCHLEVEL | HuksTagType.HUKS_TAG_TYPE_UINT \| 10102 | OS patch level. | -| HUKS_TAG_SYMMETRIC_KEY_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 20001 | Reserved. | -| HUKS_TAG_ASYMMETRIC_PUBLIC_KEY_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 20002 | Reserved. | -| HUKS_TAG_ASYMMETRIC_PRIVATE_KEY_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 20003 | Reserved. | +| HUKS_TAG_ATTESTATION_ID_BRAND | HuksTagType.HUKS_TAG_TYPE_BYTES \| 503 | Brand of the device. | +| HUKS_TAG_ATTESTATION_ID_DEVICE | HuksTagType.HUKS_TAG_TYPE_BYTES \| 504 | Device ID. | +| HUKS_TAG_ATTESTATION_ID_PRODUCT | HuksTagType.HUKS_TAG_TYPE_BYTES \| 505 | Product name of the device. | +| HUKS_TAG_ATTESTATION_ID_SERIAL | HuksTagType.HUKS_TAG_TYPE_BYTES \| 506 | Device SN. | +| HUKS_TAG_ATTESTATION_ID_IMEI | HuksTagType.HUKS_TAG_TYPE_BYTES \| 507 | Device IMEI. | +| HUKS_TAG_ATTESTATION_ID_MEID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 508 | Device MEID. | +| HUKS_TAG_ATTESTATION_ID_MANUFACTURER | HuksTagType.HUKS_TAG_TYPE_BYTES \| 509 | Device manufacturer. | +| HUKS_TAG_ATTESTATION_ID_MODEL | HuksTagType.HUKS_TAG_TYPE_BYTES \| 510 | Device model. | +| HUKS_TAG_ATTESTATION_ID_ALIAS | HuksTagType.HUKS_TAG_TYPE_BYTES \| 511 | Key alias used in the attestation. | +| HUKS_TAG_ATTESTATION_ID_SOCID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 512 | Device SOCID. | +| HUKS_TAG_ATTESTATION_ID_UDID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 513 | Device UDID. | +| HUKS_TAG_ATTESTATION_ID_SEC_LEVEL_INFO | HuksTagType.HUKS_TAG_TYPE_BYTES \| 514 | Security credential used in the attestation. | +| HUKS_TAG_ATTESTATION_ID_VERSION_INFO | HuksTagType.HUKS_TAG_TYPE_BYTES \| 515 | Version information used in the attestation. | +| HUKS_TAG_IS_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BOOL \| 1001 | Whether to use the alias passed in during key generation.| +| HUKS_TAG_KEY_STORAGE_FLAG | HuksTagType.HUKS_TAG_TYPE_UINT \| 1002 | Key storage mode. | +| HUKS_TAG_IS_ALLOWED_WRAP | HuksTagType.HUKS_TAG_TYPE_BOOL \| 1003 | Reserved. | +| HUKS_TAG_KEY_WRAP_TYPE | HuksTagType.HUKS_TAG_TYPE_UINT \| 1004 | Reserved. | +| HUKS_TAG_KEY_AUTH_ID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 1005 | Reserved. | +| HUKS_TAG_KEY_ROLE | HuksTagType.HUKS_TAG_TYPE_UINT \| 1006 | Reserved. | +| HUKS_TAG_KEY_FLAG | HuksTagType.HUKS_TAG_TYPE_UINT \| 1007 | Flag of the key. | +| HUKS_TAG_IS_ASYNCHRONIZED | HuksTagType.HUKS_TAG_TYPE_UINT \| 1008 | Reserved. | +| HUKS_TAG_SECURE_KEY_ALIAS | HuksTagType.HUKS_TAG_TYPE_BOOL \| 1009 | Reserved. | +| HUKS_TAG_SECURE_KEY_UUID | HuksTagType.HUKS_TAG_TYPE_BYTES \| 1010 | Reserved. | +| HUKS_TAG_KEY_DOMAIN | HuksTagType.HUKS_TAG_TYPE_UINT \| 1011 | Reserved. | +| HUKS_TAG_PROCESS_NAME | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10001 | Process name. | +| HUKS_TAG_PACKAGE_NAME | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10002 | Reserved. | +| HUKS_TAG_ACCESS_TIME | HuksTagType.HUKS_TAG_TYPE_UINT \| 10003 | Reserved. | +| HUKS_TAG_USES_TIME | HuksTagType.HUKS_TAG_TYPE_UINT \| 10004 | Reserved. | +| HUKS_TAG_CRYPTO_CTX | HuksTagType.HUKS_TAG_TYPE_ULONG \| 10005 | Reserved. | +| HUKS_TAG_KEY | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10006 | Reserved. | +| HUKS_TAG_KEY_VERSION | HuksTagType.HUKS_TAG_TYPE_UINT \| 10007 | Key version. | +| HUKS_TAG_PAYLOAD_LEN | HuksTagType.HUKS_TAG_TYPE_UINT \| 10008 | Reserved. | +| HUKS_TAG_AE_TAG | HuksTagType.HUKS_TAG_TYPE_BYTES \| 10009 | Reserved. | +| HUKS_TAG_IS_KEY_HANDLE | HuksTagType.HUKS_TAG_TYPE_ULONG \| 10010 | Reserved. | +| HUKS_TAG_OS_VERSION | HuksTagType.HUKS_TAG_TYPE_UINT \| 10101 | OS version. | +| HUKS_TAG_OS_PATCHLEVEL | HuksTagType.HUKS_TAG_TYPE_UINT \| 10102 | OS patch level. | +| HUKS_TAG_SYMMETRIC_KEY_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 20001 | Reserved. | +| HUKS_TAG_ASYMMETRIC_PUBLIC_KEY_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 20002 | Reserved. | +| HUKS_TAG_ASYMMETRIC_PRIVATE_KEY_DATA | HuksTagType.HUKS_TAG_TYPE_BYTES \| 20003 | Reserved. | ## huks.generateKey @@ -502,7 +502,7 @@ huks.generateKey(keyAlias, options, function (err, data){}); generateKey(keyAlias: string, options: HuksOptions) : Promise\ -Generates a key. This API uses a promise to return the result asynchronously. +Generates a key. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -580,7 +580,7 @@ huks.deleteKey(keyAlias, emptyOptions, function (err, data) {}); deleteKey(keyAlias: string, options: HuksOptions) : Promise\ -Deletes a key. This API uses a promise to return the result asynchronously. +Deletes a key. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -700,7 +700,7 @@ huks.importKey(keyAlias, options, function (err, data){}); importKey(keyAlias: string, options: HuksOptions) : Promise\ -Imports a key in plaintext. This API uses a promise to return the result asynchronously. +Imports a key in plaintext. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -773,7 +773,7 @@ Obtains the certificate used to verify a key. This API uses an asynchronous call | Name | Type | Mandatory| Description | | ---------------- | ----------------------------------------- | ---- | -------------------------------------------------- | -| keyAlias | string | Yes | Alias of the key. The certificate to be obtained stores the key. | +| keyAlias | string | Yes | Alias of the key. The certificate to be obtained stores the key. | | options | [HuksOptions](#huksoptions) | Yes | Parameters and data required for obtaining the certificate. | | callback | AsyncCallback\<[HuksResult](#huksresult)> | Yes | Callback used to return the result. If the operation is successful, **HUKS_SUCCESS** will be returned. If the operation fails, an error code will be returned.| @@ -798,6 +798,51 @@ function printLog(...data) { console.error(data.toString()); } +async function generateKey(alias) { + let properties = new Array(); + properties[0] = { + tag: huks.HuksTag.HUKS_TAG_ALGORITHM, + value: huks.HuksKeyAlg.HUKS_ALG_RSA + }; + properties[1] = { + tag: huks.HuksTag.HUKS_TAG_KEY_STORAGE_FLAG, + value: huks.HuksKeyStorageType.HUKS_STORAGE_PERSISTENT + }; + properties[2] = { + tag: huks.HuksTag.HUKS_TAG_KEY_SIZE, + value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048 + }; + properties[3] = { + tag: huks.HuksTag.HUKS_TAG_PURPOSE, + value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY + }; + properties[4] = { + tag: huks.HuksTag.HUKS_TAG_DIGEST, + value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256 + }; + properties[5] = { + tag: huks.HuksTag.HUKS_TAG_PADDING, + value: huks.HuksKeyPadding.HUKS_PADDING_PSS + }; + properties[6] = { + tag: huks.HuksTag.HUKS_TAG_KEY_GENERATE_TYPE, + value: huks.HuksKeyGenerateType.HUKS_KEY_GENERATE_TYPE_DEFAULT + }; + properties[7] = { + tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE, + value: huks.HuksCipherMode.HUKS_MODE_ECB + }; + let options = { + properties: properties + }; + + await huks.generateKey(alias, options).then(async (data) => { + console.error(`generateKey data ${JSON.stringify(data)}`); + }).catch((err) => { + console.error(`generateKey err: " + ${JSON.stringify(err)}`); + });; +} + async function attestKey() { let aliasString = keyAliasString; let aliasUint8 = stringToUint8Array(aliasString); @@ -821,7 +866,7 @@ async function attestKey() { let options = { properties: properties }; - generateKey(aliasString); + await generateKey(aliasString); huks.attestKey(aliasString, options, function (err, data) { printLog(`key attest result : ${JSON.stringify(data)}`); }); @@ -870,6 +915,51 @@ function printLog(...data) { console.error(data.toString()); } +async function generateKey(alias) { + let properties = new Array(); + properties[0] = { + tag: huks.HuksTag.HUKS_TAG_ALGORITHM, + value: huks.HuksKeyAlg.HUKS_ALG_RSA + }; + properties[1] = { + tag: huks.HuksTag.HUKS_TAG_KEY_STORAGE_FLAG, + value: huks.HuksKeyStorageType.HUKS_STORAGE_PERSISTENT + }; + properties[2] = { + tag: huks.HuksTag.HUKS_TAG_KEY_SIZE, + value: huks.HuksKeySize.HUKS_RSA_KEY_SIZE_2048 + }; + properties[3] = { + tag: huks.HuksTag.HUKS_TAG_PURPOSE, + value: huks.HuksKeyPurpose.HUKS_KEY_PURPOSE_VERIFY + }; + properties[4] = { + tag: huks.HuksTag.HUKS_TAG_DIGEST, + value: huks.HuksKeyDigest.HUKS_DIGEST_SHA256 + }; + properties[5] = { + tag: huks.HuksTag.HUKS_TAG_PADDING, + value: huks.HuksKeyPadding.HUKS_PADDING_PSS + }; + properties[6] = { + tag: huks.HuksTag.HUKS_TAG_KEY_GENERATE_TYPE, + value: huks.HuksKeyGenerateType.HUKS_KEY_GENERATE_TYPE_DEFAULT + }; + properties[7] = { + tag: huks.HuksTag.HUKS_TAG_BLOCK_MODE, + value: huks.HuksCipherMode.HUKS_MODE_ECB + }; + let options = { + properties: properties + }; + + await huks.generateKey(alias, options).then(async (data) => { + console.error(`generateKey data ${JSON.stringify(data)}`); + }).catch((err) => { + console.error(`generateKey err: " + ${JSON.stringify(err)}`); + });; +} + async function attestKey() { let aliasString = keyAliasString; let aliasUint8 = stringToUint8Array(aliasString); @@ -893,7 +983,7 @@ async function attestKey() { let options = { properties: properties }; - generateKey(aliasString); + await generateKey(aliasString); huks.attestKey(aliasString, options) .then((data) => { console.log(`test attestKey data: ${JSON.stringify(data)}`); @@ -1096,7 +1186,7 @@ function huksImportWrappedKey() { importWrappedKey(keyAlias: string, wrappingKeyAlias: string, options: HuksOptions) : Promise\ -Imports a wrapped key. This API uses a promise to return the result asynchronously. +Imports a wrapped key. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1159,7 +1249,7 @@ huks.exportKey(keyAlias, emptyOptions, function (err, data){}); exportKey(keyAlias: string, options: HuksOptions) : Promise\ -Exports a key. This API uses a promise to return the result asynchronously. +Exports a key. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1218,7 +1308,7 @@ huks.getKeyProperties(keyAlias, emptyOptions, function (err, data){}); getKeyProperties(keyAlias: string, options: HuksOptions) : Promise\ -Obtains key properties. This API uses a promise to return the result asynchronously. +Obtains key properties. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1277,7 +1367,7 @@ huks.isKeyExist(keyAlias, emptyOptions, function (err, data){}); isKeyExist(keyAlias: string, options: HuksOptions) : Promise\ -Checks whether a key exists. This API uses a promise to return the result asynchronously. +Checks whether a key exists. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1311,7 +1401,7 @@ var result = huks.isKeyExist(keyAlias, emptyOptions); init(keyAlias: string, options: HuksOptions, callback: AsyncCallback\) : void -Initializes a key. This API uses an asynchronous callback to return the result. +Initializes the data for a key operation. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Security.Huks @@ -1328,7 +1418,7 @@ Initializes a key. This API uses an asynchronous callback to return the result. init(keyAlias: string, options: HuksOptions) : Promise\ -Initializes a key. This API uses a promise to return the result asynchronously. +Initializes the data for a key operation. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1345,9 +1435,9 @@ Initializes a key. This API uses a promise to return the result asynchronously. update(handle: number, token?: Uint8Array, options: HuksOptions, callback: AsyncCallback\) : void -Updates a key. This API uses an asynchronous callback to return the result. +Updates the key operation data by segment. This API uses an asynchronous callback to return the result. -> **NOTE**
This API is discarded since API version 9. You are advised to use [huks.update9+]. +> **NOTE**
This API is deprecated since API version 9. You are advised to use [huks.update9+](#huksupdate9-1). **System capability**: SystemCapability.Security.Huks @@ -1364,9 +1454,9 @@ Updates a key. This API uses an asynchronous callback to return the result. update(handle: number, token?: Uint8Array, options: HuksOptions) : Promise\ -Updates a key. This API uses a promise to return the result asynchronously. +Updates the key operation data by segment. This API uses a promise to return the result. -> **NOTE**
This API is discarded since API version 9. You are advised to use [huks.update9+](#huksupdate9). +> **NOTE**
This API is discarded since API version 9. You are advised to use [huks.update9+](#huksupdate9-2). **System capability**: SystemCapability.Security.Huks @@ -1383,7 +1473,7 @@ Updates a key. This API uses a promise to return the result asynchronously. update(handle: number, options: HuksOptions, callback: AsyncCallback\) : void -Updates a key. This API uses an asynchronous callback to return the result. +Updates the key operation by segment. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Security.Huks @@ -1400,7 +1490,7 @@ Updates a key. This API uses an asynchronous callback to return the result. update(handle: number, options: HuksOptions, token: Uint8Array, callback: AsyncCallback\) : void -Updates a key. This API uses an asynchronous callback to return the result. +Updates the key operation by segment. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Security.Huks @@ -1417,7 +1507,7 @@ Updates a key. This API uses an asynchronous callback to return the result. update(handle: number, options: HuksOptions, token?: Uint8Array) : Promise\ -Updates a key. This API uses a promise to return the result asynchronously. +Updates the key operation by segment. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1451,7 +1541,7 @@ Completes the key operation and releases resources. This API uses an asynchronou finish(handle: number, options: HuksOptions) : Promise\ -Completes the key operation and releases resources. This API uses a promise to return the result asynchronously. +Completes the key operation and releases resources. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1485,7 +1575,7 @@ Completes the key operation and releases resources. This API uses an asynchronou finish(handle: number, options: HuksOptions, token?: Uint8Array) : Promise\ -Completes the key operation and releases resources. This API uses a promise to return the result asynchronously. +Completes the key operation and releases resources. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1722,7 +1812,7 @@ struct Index { abort(handle: number, options: HuksOptions) : Promise\; -Aborts the use of the key. This API uses a promise to return the result asynchronously. +Aborts the use of the key. This API uses a promise to return the result. **System capability**: SystemCapability.Security.Huks @@ -1976,7 +2066,7 @@ Defines the HUKS handle structure. | ---------- | ---------------- | ---- | -------- | | errorCode | number | Yes | Error code.| | handle | number | Yes| Value of the handle.| -| token | Uint8Array | No| Challenge information obtained after the [init](#huksinit) operation.| +| token | Uint8Array | No| Challenge obtained after the [init](#huksinit) operation.| ## HuksResult diff --git a/en/application-dev/reference/apis/js-apis-i18n.md b/en/application-dev/reference/apis/js-apis-i18n.md index b68a5b15487f310dd6b05058c68af75840098062..255c867d802b2f600c4792cd713a891b0e46e67e 100644 --- a/en/application-dev/reference/apis/js-apis-i18n.md +++ b/en/application-dev/reference/apis/js-apis-i18n.md @@ -1,10 +1,13 @@ # Internationalization – I18N +This module provides system-related or enhanced I18N capabilities, such as locale management, phone number formatting, and calendar, through supplementary I18N APIs that are not defined in ECMA 402. + +The [Intl](js-apis-intl.md) module provides basic I18N capabilities through the standard I18N APIs defined in ECMA 402. It works with the I18N module to provide a complete suite of I18N capabilities. + + > **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. -> -> - This module provides system-related or enhanced I18N capabilities, such as locale management, phone number formatting, and calendar, through supplementary I18N interfaces that are not defined in ECMA 402. For details about the basic I18N capabilities, see [Intl](js-apis-intl.md). +> 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 @@ -23,6 +26,7 @@ Obtains the localized script for the specified language. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------------ | ------- | ---- | ---------------- | | language | string | Yes | Specified language. | @@ -30,6 +34,7 @@ Obtains the localized script for the specified language. | sentenceCase | boolean | No | Whether to use sentence case for the localized script.| **Return value** + | Type | Description | | ------ | ------------- | | string | Localized script for the specified language.| @@ -50,6 +55,7 @@ Obtains the localized script for the specified country. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------------ | ------- | ---- | ---------------- | | country | string | Yes | Specified country. | @@ -57,6 +63,7 @@ Obtains the localized script for the specified country. | sentenceCase | boolean | No | Whether to use sentence case for the localized script.| **Return value** + | Type | Description | | ------ | ------------- | | string | Localized script for the specified country.| @@ -77,11 +84,13 @@ Checks whether the localized script for the specified language is displayed from **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Description | | ------ | ------ | ------- | | locale | string | Locale ID.| **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the localized script is displayed from right to left; returns **false** otherwise.| @@ -102,6 +111,7 @@ Obtains the system language. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------- | | string | System language ID.| @@ -125,11 +135,13 @@ This is a system API. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Description | | -------- | ------ | ----- | | language | string | Language ID.| **Return value** + | Type | Description | | ------- | ------------------------------------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -140,7 +152,7 @@ This is a system API. ``` -## i18n.getSystemLanguages +## i18n.getSystemLanguages9+ getSystemLanguages(): Array<string> @@ -151,6 +163,7 @@ Obtains the list of system languages. **System API**: This is a system API and cannot be called by third-party applications. **Return value** + | Type | Description | | ------------------- | ------------ | | Array<string> | List of the IDs of system languages.| @@ -161,7 +174,7 @@ Obtains the list of system languages. ``` -## i18n.getSystemCountries +## i18n.getSystemCountries9+ getSystemCountries(language: string): Array<string> @@ -172,11 +185,13 @@ Obtains the list of countries and regions supported for the specified language. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name | Type | Description | | -------- | ------ | ----- | | language | string | Language ID.| **Return value** + | Type | Description | | ------------------- | ------------ | | Array<string> | List of the IDs of the countries and regions supported for the specified language.| @@ -196,6 +211,7 @@ Obtains the system region. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------- | | string | System region ID.| @@ -219,11 +235,13 @@ This is a system API. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Description | | ------ | ------ | ----- | | region | string | Region ID.| **Return value** + | Type | Description | | ------- | ------------------------------------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -243,6 +261,7 @@ Obtains the system locale. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------- | | string | System locale ID.| @@ -266,11 +285,13 @@ This is a system API. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Description | | ------ | ------ | --------------- | | locale | string | System locale ID, for example, **zh-CN**.| **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -281,7 +302,7 @@ This is a system API. ``` -## i18n.isSuggested +## i18n.isSuggested9+ isSuggested(language: string, region?: string): boolean @@ -292,12 +313,14 @@ Checks whether the system language matches the specified region. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name | Type | Mandatory | Description | | -------- | ------ | ---- | ------------- | | language | string | Yes | Valid language ID, for example, **zh**.| | region | string | No | Valid region ID, for example, **CN**. | **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the system language matches the specified region; returns **false** otherwise.| @@ -317,12 +340,14 @@ Obtains a **Calendar** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------------------------------------- | | locale | string | Yes | Valid locale value, for example, **zh-Hans-CN**. | | type | string | No | Valid calendar type. Currently, the valid types are as follows: **buddhist**, **chinese**, **coptic**, **ethiopic**, **hebrew**, **gregory**, **indian**, **islamic\_civil**, **islamic\_tbla**, **islamic\_umalqura**, **japanese**, and **persian**. If this parameter is left unspecified, the default calendar type of the specified locale is used.| **Return value** + | Type | Description | | ---------------------- | ----- | | [Calendar](#calendar8) | **Calendar** object.| @@ -345,6 +370,7 @@ Sets the date for this **Calendar** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ---- | ---- | ----------------- | | date | Date | Yes | Date to be set for the **Calendar** object.| @@ -366,6 +392,7 @@ Sets the date and time for this **Calendar** object. The value is represented by **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ---------------------------------------- | | time | number | Yes | Number of milliseconds that have elapsed since the Unix epoch.| @@ -386,6 +413,7 @@ Sets the year, month, day, hour, minute, and second for this **Calendar** object **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ------ | | year | number | Yes | Year to set. | @@ -411,6 +439,7 @@ Sets the time zone of this **Calendar** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | -------- | ------ | ---- | ------------------------- | | timezone | string | Yes | Time zone, for example, **Asia/Shanghai**.| @@ -431,6 +460,7 @@ Obtains the time zone of this **Calendar** object. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ---------- | | string | Time zone of the **Calendar** object.| @@ -452,6 +482,7 @@ Obtains the start day of a week for this **Calendar** object. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | --------------------- | | number | Start day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday.| @@ -472,6 +503,7 @@ Sets the start day of a week for this **Calendar** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | --------------------- | | value | number | No | Start day of a week. The value **1** indicates Sunday, and the value **7** indicates Saturday.| @@ -492,6 +524,7 @@ Obtains the minimum number of days in the first week of a year. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------------ | | number | Minimum number of days in the first week of a year.| @@ -512,6 +545,7 @@ Sets the minimum number of days in the first week of a year. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | ------------ | | value | number | No | Minimum number of days in the first week of a year.| @@ -532,11 +566,13 @@ Obtains the value of the specified field in the **Calendar** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | ---------------------------------------- | | field | string | Yes | Value of the specified field in the **Calendar** object. Currently, a valid field can be any of the following: **era**, **year**, **month**, **week\_of\_year**, **week\_of\_month**, **date**, **day\_of\_year**, **day\_of\_week**, **day\_of\_week\_in\_month**, **hour**, **hour\_of\_day**, **minute**, **second**, **millisecond**, **zone\_offset**, **dst\_offset**, **year\_woy**, **dow\_local**, **extended\_year**, **julian\_day**, **milliseconds\_in\_day**, **is\_leap\_month**.| **Return value** + | Type | Description | | ------ | ---------------------------------------- | | number | Value of the specified field. For example, if the year in the internal date of this **Calendar** object is **1990**, the **get("year")** function will return **1990**.| @@ -558,11 +594,13 @@ Obtains the name of the **Calendar** object displayed for the specified locale. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------------------------------------- | | locale | string | Yes | Locale for which the name of the **Calendar** object is displayed. For example, if **locale** is **en-US**, the name of the Buddhist calendar will be **Buddhist Calendar**.| **Return value** + | Type | Description | | ------ | ------------------- | | string | Name of the **Calendar** object displayed for the specified locale.| @@ -583,11 +621,13 @@ Checks whether the specified date in this **Calendar** object is a weekend. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ---- | ---- | ---------------------------------------- | | date | Date | No | Specified date in this **Calendar** object. If this parameter is left unspecified, the system checks whether the current date in the **Calendar** object is a weekend.| **Return value** + | Type | Description | | ------- | ----------------------------------- | | boolean | Returns **true** if the date is a weekend; returns **false** if the date is a weekday.| @@ -617,7 +657,7 @@ Parameters | Name | Type | Mandatory | Description | | ------- | ---------------------------------------- | ---- | ---------------- | | country | string | Yes | Country or region to which the phone number to be formatted belongs.| -| options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | No | Options of the **PhoneNumberFormat** object. | +| options | [PhoneNumberFormatOptions](#phonenumberformatoptions9) | No | Options of the **PhoneNumberFormat** object. | **Example** ```js @@ -634,11 +674,13 @@ Checks whether the format of the specified phone number is valid. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | --------- | | number | string | Yes | Phone number to be checked.| **Return value** + | Type | Description | | ------- | ------------------------------------- | | boolean | Returns **true** if the phone number format is valid; returns **false** otherwise.| @@ -659,11 +701,13 @@ Formats a phone number. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------- | | number | string | Yes | Phone number to be formatted.| **Return value** + | Type | Description | | ------ | ---------- | | string | Formatted phone number.| @@ -683,12 +727,14 @@ Obtains the home location of a phone number. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------- | | number | string | Yes | Phone number.| | locale | string | Yes | Locale ID.| **Return value** + | Type | Description | | ------ | ---------- | | string | Home location of the phone number.| @@ -700,7 +746,7 @@ Obtains the home location of a phone number. ``` -## PhoneNumberFormatOptions8+ +## PhoneNumberFormatOptions9+ Defines the options for this PhoneNumberFormat object. @@ -723,18 +769,24 @@ Defines the measurement unit information. | measureSystem | string | Yes | Yes | Measurement system. The value can be **SI**, **US**, or **UK**.| -## Util8+ +## Util(deprecated) -### unitConvert8+ +### unitConvert(deprecated) static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string Converts one measurement unit into another and formats the unit based on the specified locale and style. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [unitConvert](#unitconvert9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | -------- | ---------------------- | ---- | ---------------------------------------- | | fromUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted. | @@ -744,37 +796,10 @@ Converts one measurement unit into another and formats the unit based on the spe | style | string | No | Style used for formatting. The value can be **long**, **short**, or **narrow**.| **Return value** -| Type | Description | -| ------ | ----------------------- | -| string | Character string obtained after formatting based on the measurement unit specified by **toUnit**.| - -**Example** - ```js - i18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); - ``` - -### getDateOrder9+ - -static getDateOrder(locale: string): string - -Obtains the sequence of the year, month, and day in the specified locale. - -**System capability**: SystemCapability.Global.I18n -**Parameters** -| Name | Type | Mandatory | Description | -| -------- | ---------------------- | ---- | ---------------------------------------- | -| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**. | - -**Return value** | Type | Description | | ------ | ----------------------- | -| string | Sequence of the year, month, and day.| - -**Example** - ``` - i18n.Util.getDateOrder("zh-CN"); - ``` +| string | Character string obtained after formatting based on the measurement unit specified by **toUnit**.| ## getInstance8+ @@ -786,11 +811,13 @@ Creates an **IndexUtil** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------------------------- | | locale | string | No | A string containing locale information, including the language, optional script, and region.| **Return value** + | Type | Description | | ------------------------ | --------------------- | | [IndexUtil](#indexutil8) | **IndexUtil** object mapping to the specified locale.| @@ -813,6 +840,7 @@ Obtains the index list for this **locale** object. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------------------- | ------------------ | | Array<string> | Index list for this **locale** object.| @@ -833,6 +861,7 @@ Adds the index of the new **locale** object to the index list. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------------------------- | | locale | string | Yes | A string containing locale information, including the language, optional script, and region.| @@ -853,11 +882,13 @@ Obtains the index of a text object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ------------ | | text | string | Yes | **text** object whose index is to be obtained.| **Return value** + | Type | Description | | ------ | ----------- | | string | Index of the **text** object.| @@ -869,223 +900,250 @@ Obtains the index of a text object. ``` -## Character8+ +## Character(deprecated) -### isDigit8+ +### isDigit(deprecated) static isDigit(char: string): boolean Checks whether the input character string is composed of digits. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isDigit](#isdigit9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | ------------------------------------ | | boolean | Returns **true** if the input character is a digit; returns **false** otherwise.| -**Example** - ```js - var isdigit = i18n.Character.isDigit("1"); // Return true. - ``` -### isSpaceChar8+ +### isSpaceChar(deprecated) static isSpaceChar(char: string): boolean Checks whether the input character is a space. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isSpaceChar](#isspacechar9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | -------------------------------------- | | boolean | Returns **true** if the input character is a space; returns **false** otherwise.| -**Example** - ```js - var isspacechar = i18n.Character.isSpaceChar("a"); // Return false. - ``` -### isWhitespace8+ +### isWhitespace(deprecated) static isWhitespace(char: string): boolean Checks whether the input character is a white space. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isWhitespace](#iswhitespace9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | -------------------------------------- | | boolean | Returns **true** if the input character is a white space; returns **false** otherwise.| -**Example** - ```js - var isspacechar = i18n.Character.isSpaceChar("a"); // Return false. - ``` -### isRTL8+ +### isRTL(deprecated) static isRTL(char: string): boolean Checks whether the input character is of the right to left (RTL) language. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isRTL](#isrtl9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the input character is of the RTL language; returns **false** otherwise.| -**Example** - ```js - var isrtl = i18n.Character.isRTL("a"); // Return false. - ``` -### isIdeograph8+ +### isIdeograph(deprecated) static isIdeograph(char: string): boolean Checks whether the input character is an ideographic character. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isIdeograph](#isideograph9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the input character is an ideographic character; returns **false** otherwise.| -**Example** - ```js - var isideograph = i18n.Character.isIdeograph("a"); // Return false. - ``` -### isLetter8+ +### isLetter(deprecated) static isLetter(char: string): boolean Checks whether the input character is a letter. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isLetter](#isletter9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | ------------------------------------ | | boolean | Returns **true** if the input character is a letter; returns **false** otherwise.| -**Example** - ```js - var isletter = i18n.Character.isLetter("a"); // Return true. - ``` -### isLowerCase8+ +### isLowerCase(deprecated) static isLowerCase(char: string): boolean Checks whether the input character is a lowercase letter. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isLowerCase](#islowercase9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the input character is a lowercase letter; returns **false** otherwise.| -**Example** - ```js - var islowercase = i18n.Character.isLowerCase("a"); // Return true. - ``` -### isUpperCase8+ +### isUpperCase(deprecated) static isUpperCase(char: string): boolean Checks whether the input character is an uppercase letter. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [isUpperCase](#isuppercase9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the input character is an uppercase letter; returns **false** otherwise.| -**Example** - ```js - var isuppercase = i18n.Character.isUpperCase("a"); // Return false. - ``` -### getType8+ +### getType(deprecated) static getType(char: string): string Obtains the type of the input character string. +> **NOTE** +> This API is deprecated since API version 9. You are advised to use [getType](#gettype9) instead. +> +> This API is supported since API version 8. + **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----- | | char | string | Yes | Input character.| **Return value** + | Type | Description | | ------ | ----------- | | string | Type of the input character.| -**Example** - ```js - var type = i18n.Character.getType("a"); - ``` ## i18n.getLineInstance8+ @@ -1097,11 +1155,13 @@ Obtains a [BreakIterator](#breakiterator8) object for text segmentation. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------------------------------------- | | locale | string | Yes | Valid locale value, for example, **zh-Hans-CN**. The [BreakIterator](#breakiterator8) object segments text according to the rules of the specified locale.| **Return value** + | Type | Description | | -------------------------------- | ----------- | | [BreakIterator](#breakiterator8) | [BreakIterator](#breakiterator8) object used for text segmentation.| @@ -1124,6 +1184,7 @@ Sets the text to be processed by the [BreakIterator](#breakiterator8) object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ----------------------- | | text | string | Yes | Text to be processed by the **BreakIterator** object.| @@ -1144,6 +1205,7 @@ Obtains the text being processed by the [BreakIterator](#breakiterator8) object. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ---------------------- | | string | Text being processed by the **BreakIterator** object.| @@ -1165,6 +1227,7 @@ Obtains the position of the [BreakIterator](#breakiterator8) object in the text **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | --------------------------- | | number | Position of the **BreakIterator** object in the text being processed.| @@ -1186,6 +1249,7 @@ Puts the [BreakIterator](#breakiterator8) object to the first text boundary, whi **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ----------------- | | number | Offset to the first text boundary of the processed text.| @@ -1207,6 +1271,7 @@ Puts the [BreakIterator](#breakiterator8) object to the last text boundary, whic **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------------------ | | number | Offset of the last text boundary of the processed text.| @@ -1228,11 +1293,13 @@ Moves the [BreakIterator](#breakiterator8) object backward by the specified numb **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | ---------------------------------------- | | index | number | No | Number of text boundaries by which the [BreakIterator](#breakiterator8) object is moved. A positive value indicates that the text boundary is moved backward, and a negative value indicates the opposite. If no index is specified, the index will be treated as **1**.| **Return value** + | Type | Description | | ------ | ---------------------------------------- | | number | Position of the [BreakIterator](#breakiterator8) object in the text after it is moved by the specified number of text boundaries. The value **-1** is returned if the position of the [BreakIterator](#breakiterator8) object is outside of the processed text after it is moved by the specified number of text boundaries.| @@ -1256,6 +1323,7 @@ Moves the [BreakIterator](#breakiterator8) object to the previous text boundary. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ---------------------------------------- | | number | Position of the [BreakIterator](#breakiterator8) object in the text after it is moved to the previous text boundary. The value **-1** is returned if the position of the [BreakIterator](#breakiterator8) object is outside of the processed text after it is moved by the specified number of text boundaries.| @@ -1279,11 +1347,13 @@ Moves the [BreakIterator](#breakiterator8) object to the text boundary after the **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---------------------------------------- | | offset | number | Yes | Offset to the position before the text boundary to which the [BreakIterator](#breakiterator8) object is moved.| **Return value** + | Type | Description | | ------ | ---------------------------------------- | | number | The value **-1** is returned if the text boundary to which the [BreakIterator](#breakiterator8) object is moved is outside of the processed text.| @@ -1307,11 +1377,13 @@ Checks whether the position specified by the offset is a text boundary. If **tru **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ----------- | | offset | number | Yes | Position to check.| **Return value** + | Type | Description | | ------- | ------------------------------- | | boolean | Returns **true** if the position specified by the offset is a text boundary; returns **false** otherwise.| @@ -1334,6 +1406,7 @@ Checks whether the 24-hour clock is used. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------- | ---------------------------------------- | | boolean | Returns **true** if the 24-hour clock is used; returns **false** otherwise.| @@ -1355,11 +1428,13 @@ Sets the 24-hour clock. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------- | ---- | ---------------------------------------- | | option | boolean | Yes | Whether to enable the 24-hour clock. The value **true** means to enable the 24-hour clock, and the value **false** means the opposite.| **Return value** + | Type | Description | | ------- | ----------------------------- | | boolean | Returns **true** if the 24-hour clock is enabled; returns **false** otherwise.| @@ -1382,12 +1457,14 @@ Adds a preferred language to the specified position on the preferred language li **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | -------- | ------ | ---- | ---------- | | language | string | Yes | Preferred language to add. | | index | number | No | Position to which the preferred language is added.| **Return value** + | Type | Description | | ------- | ----------------------------- | | boolean | Returns **true** if the preferred language is successfully added; returns **false** otherwise.| @@ -1412,11 +1489,13 @@ Deletes a preferred language from the specified position on the preferred langua **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | --------------------- | | index | number | Yes | Position of the preferred language to delete.| **Return value** + | Type | Description | | ------- | ----------------------------- | | boolean | Returns **true** if the preferred language is deleted; returns **false** otherwise.| @@ -1438,6 +1517,7 @@ Obtains the list of preferred languages. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------------------- | --------- | | Array<string> | List of preferred languages.| @@ -1457,6 +1537,7 @@ Obtains the first language in the preferred language list. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | -------------- | | string | First language in the preferred language list.| @@ -1476,6 +1557,7 @@ Obtains the preferred language of an application. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | -------------- | | string | Preferred language of the application.| @@ -1495,11 +1577,13 @@ Obtains the **TimeZone** object corresponding to the specified time zone ID. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ----- | | zondID | string | No | Time zone ID.| **Return value** + | Type | Description | | -------- | ------------ | | TimeZone | **TimeZone** object corresponding to the time zone ID.| @@ -1522,6 +1606,7 @@ Obtains the ID of the specified **TimeZone** object. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------------ | | string | Time zone ID corresponding to the **TimeZone** object.| @@ -1542,12 +1627,14 @@ Obtains the representation of a **TimeZone** object in the specified locale. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------- | ---- | -------------------- | | locale | string | No | System locale ID. | | isDST | boolean | No | Whether to consider DST when obtaining the representation of the **TimeZone** object.| **Return value** + | Type | Description | | ------ | ------------- | | string | Representation of the **TimeZone** object in the specified locale.| @@ -1568,6 +1655,7 @@ Obtains the offset between the time zone represented by a **TimeZone** object an **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------------------- | | number | Offset between the time zone represented by the **TimeZone** object and the UTC time zone.| @@ -1588,6 +1676,7 @@ Obtains the offset between the time zone represented by a **TimeZone** object an **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ----------------------- | | number | Offset between the time zone represented by the **TimeZone** object and the UTC time zone at a certain time point.| @@ -1607,6 +1696,7 @@ Obtains the list of time zone IDs supported by the system. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ----------------------- | | Array<string> | List of time zone IDs supported by the system.| @@ -1626,6 +1716,7 @@ Obtains the list of time zone city IDs supported by the system. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ----------------------- | | Array<string> | List of time zone city IDs supported by the system.| @@ -1645,12 +1736,14 @@ Obtains the localized display of a time zone city in the specified locale. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ----- | | cityID | string | Yes | Time zone city ID.| | locale | string | Yes | Locale ID.| **Return value** + | Type | Description | | ------ | ----------------------- | | string | Localized display of the time zone city in the specified locale.| @@ -1670,11 +1763,13 @@ Obtains the **TimeZone** object corresponding to the specified time zone city ID **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ----- | | cityID | string | Yes | Time zone city ID.| **Return value** + | Type | Description | | ------ | ----------------------- | | TimeZone | **TimeZone** object corresponding to the specified time zone city ID.| @@ -1697,11 +1792,13 @@ This is a system API. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ----- | | flag | boolean | Yes | Whether to turn on the local digit switch. The value **true** means to turn on the local digit switch, and the value **false** indicates the opposite.| **Return value** + | Type | Description | | -------- | ------------ | | boolean | Result indicating whether the local digit switch is successfully set. The value **true** indicates that the local digit switch is successfully set, and the value **false** indicates the opposite.| @@ -1721,6 +1818,7 @@ Checks whether the local digit switch is turned on. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | -------- | ------------ | | boolean | Result indicating whether the local digit switch is turned on. The value **true** indicates that the local digit switch is turned on, and the value **false** indicates the opposite.| @@ -1742,6 +1840,7 @@ Obtains a list of IDs supported by the **Transliterator** object. **System capability**: SystemCapability.Global.I18n **Return value** + | Type | Description | | ------ | ------------ | | string[] | List of IDs supported by the **Transliterator** object.| @@ -1761,11 +1860,13 @@ Creates a **Transliterator** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------- | ---- | -------------------- | | id | string | Yes | ID supported by the **Transliterator** object. | **Return value** + | Type | Description | | ------ | ------------- | | [Transliterator](#transliterator9) | **Transliterator** object.| @@ -1785,11 +1886,13 @@ Converts the input string from the source format to the target format. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------- | ---- | -------------------- | | text | string | Yes | Input string. | **Return value** + | Type | Description | | ------ | ------------- | | string | Target string.| @@ -1799,3 +1902,298 @@ Converts the input string from the source format to the target format. var transliterator = i18n.Transliterator.getInstance("Any-Latn"); transliterator.transform ("China"); ``` + +## Unicode9+ + + +### isDigit9+ + +static isDigit(char: string): boolean + +Checks whether the input character string is composed of digits. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | ------------------------------------ | +| boolean | Returns **true** if the input character is a digit; returns **false** otherwise.| + +**Example** + ```js + var isdigit = i18n.Unicode.isDigit("1"); // Return true. + ``` + + +### isSpaceChar9+ + +static isSpaceChar(char: string): boolean + +Checks whether the input character is a space. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | -------------------------------------- | +| boolean | Returns **true** if the input character is a space; returns **false** otherwise.| + +**Example** + ```js + var isspacechar = i18n.Unicode.isSpaceChar("a"); // Return false. + ``` + + +### isWhitespace9+ + +static isWhitespace(char: string): boolean + +Checks whether the input character is a white space. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | -------------------------------------- | +| boolean | Returns **true** if the input character is a white space; returns **false** otherwise.| + +**Example** + ```js + var iswhitespace = i18n.Unicode.isWhitespace("a"); // Return false. + ``` + + +### isRTL9+ + +static isRTL(char: string): boolean + +Checks whether the input character is of the right to left (RTL) language. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | ---------------------------------------- | +| boolean | Returns **true** if the input character is of the RTL language; returns **false** otherwise.| + +**Example** + ```js + var isrtl = i18n.Unicode.isRTL("a"); // Return false. + ``` + + +### isIdeograph9+ + +static isIdeograph(char: string): boolean + +Checks whether the input character is an ideographic character. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | ---------------------------------------- | +| boolean | Returns **true** if the input character is an ideographic character; returns **false** otherwise.| + +**Example** + ```js + var isideograph = i18n.Unicode.isIdeograph("a"); // Return false. + ``` + + +### isLetter9+ + +static isLetter(char: string): boolean + +Checks whether the input character is a letter. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | ------------------------------------ | +| boolean | Returns **true** if the input character is a letter; returns **false** otherwise.| + +**Example** + ```js + var isletter = i18n.Unicode.isLetter("a"); // Return true. + ``` + + +### isLowerCase9+ + +static isLowerCase(char: string): boolean + +Checks whether the input character is a lowercase letter. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | ---------------------------------------- | +| boolean | Returns **true** if the input character is a lowercase letter; returns **false** otherwise.| + +**Example** + ```js + var islowercase = i18n.Unicode.isLowerCase("a"); // Return true. + ``` + + +### isUpperCase9+ + +static isUpperCase(char: string): boolean + +Checks whether the input character is an uppercase letter. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------- | ---------------------------------------- | +| boolean | Returns **true** if the input character is an uppercase letter; returns **false** otherwise.| + +**Example** + ```js + var isuppercase = i18n.Unicode.isUpperCase("a"); // Return false. + ``` + + +### getType9+ + +static getType(char: string): string + +Obtains the type of the input character string. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ---- | ------ | ---- | ----- | +| char | string | Yes | Input character.| + +**Return value** + +| Type | Description | +| ------ | ----------- | +| string | Type of the input character.| + +**Example** + ```js + var type = i18n.Unicode.getType("a"); + ``` + + +## I18NUtil9+ + + +### unitConvert9+ + +static unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string + +Converts one measurement unit into another and formats the unit based on the specified locale and style. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ---------------------- | ---- | ---------------------------------------- | +| fromUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted. | +| toUnit | [UnitInfo](#unitinfo8) | Yes | Measurement unit to be converted to. | +| value | number | Yes | Value of the measurement unit to be converted. | +| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**. | +| style | string | No | Style used for formatting. The value can be **long**, **short**, or **narrow**.| + +**Return value** + +| Type | Description | +| ------ | ----------------------- | +| string | Character string obtained after formatting based on the measurement unit specified by **toUnit**.| + +**Example** + ```js + i18n.I18NUtil.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); + ``` + + +### getDateOrder9+ + +static getDateOrder(locale: string): string + +Obtains the sequence of the year, month, and day in the specified locale. + +**System capability**: SystemCapability.Global.I18n + +**Parameters** + +| Name | Type | Mandatory | Description | +| ------ | ------ | ---- | ------------------------- | +| locale | string | Yes | Locale used for formatting, for example, **zh-Hans-CN**.| + +**Return value** + +| Type | Description | +| ------ | ------------------- | +| string | Sequence of the year, month, and day.| + +**Example** + ```js + i18n.I18NUtil.getDateOrder("zh-CN"); + ``` diff --git a/en/application-dev/reference/apis/js-apis-image.md b/en/application-dev/reference/apis/js-apis-image.md index efd8277b83ac1cbe39a19ebad0fbf49cdf020190..866a5833b69feb01da451f2464fbdd7915f06172 100644 --- a/en/application-dev/reference/apis/js-apis-image.md +++ b/en/application-dev/reference/apis/js-apis-image.md @@ -92,7 +92,7 @@ Provides APIs to read or write image pixel map data and obtain image pixel map i readPixelsToBuffer(dst: ArrayBuffer): Promise\ -Reads image pixel map data and writes the data to an **ArrayBuffer**. This API uses a promise to return the result. If the pixel map is created in the BGRA_8888 format, the pixel map data read is the same as the original data. +Reads data of this pixel map and writes the data to an **ArrayBuffer**. This API uses a promise to return the result. If this pixel map is created in the BGRA_8888 format, the data read is the same as the original data. **System capability**: SystemCapability.Multimedia.Image.Core @@ -115,7 +115,7 @@ const readBuffer = new ArrayBuffer(96); pixelmap.readPixelsToBuffer(readBuffer).then(() => { console.log('Succeeded in reading image pixel data.'); // Called if the condition is met. }).catch(error => { - ('Failed to read image pixel data.'); // Called if no condition is met. + console.log('Failed to read image pixel data.'); // Called if no condition is met. }) ``` @@ -123,7 +123,7 @@ pixelmap.readPixelsToBuffer(readBuffer).then(() => { readPixelsToBuffer(dst: ArrayBuffer, callback: AsyncCallback\): void -Reads image pixel map data and writes the data to an **ArrayBuffer**. This API uses an asynchronous callback to return the result. If the pixel map is created in the BGRA_8888 format, the pixel map data read is the same as the original data. +Reads data of this pixel map and writes the data to an **ArrayBuffer**. This API uses an asynchronous callback to return the result. If this pixel map is created in the BGRA_8888 format, the data read is the same as the original data. **System capability**: SystemCapability.Multimedia.Image.Core @@ -170,7 +170,12 @@ Reads image pixel map data in an area. This API uses a promise to return the dat **Example** ```js -const area = new ArrayBuffer(400); +const area = { + pixels: new ArrayBuffer(8), + offset: 0, + stride: 8, + region: { size: { height: 1, width: 2 }, x: 0, y: 0 } +} pixelmap.readPixels(area).then(() => { console.log('Succeeded in reading the image data in the area.'); // Called if the condition is met. }).catch(error => { @@ -256,12 +261,7 @@ image.createPixelMap(color, opts) } pixelmap.writePixels(area).then(() => { - const readArea = { pixels: new ArrayBuffer(8), - offset: 0, - stride: 8, - // region.size.width + x < opts.width, region.size.height + y < opts.height - region: { size: { height: 1, width: 2 }, x: 0, y: 0 } - } + console.info('Succeeded to write pixelmap into the specified area.'); }) }).catch(error => { console.log('error: ' + error); @@ -286,17 +286,20 @@ Writes image pixel map data to an area. This API uses an asynchronous callback t **Example** ```js -const area = new ArrayBuffer(400); +const area = { pixels: new ArrayBuffer(8), + offset: 0, + stride: 8, + region: { size: { height: 1, width: 2 }, x: 0, y: 0 } +} +let bufferArr = new Uint8Array(area.pixels); +for (var i = 0; i < bufferArr.length; i++) { + bufferArr[i] = i + 1; +} pixelmap.writePixels(area, (error) => { if (error != undefined) { console.info('Failed to write pixelmap into the specified area.'); } else { - const readArea = { - pixels: new ArrayBuffer(20), - offset: 0, - stride: 8, - region: { size: { height: 1, width: 2 }, x: 0, y: 0 }, - } + console.info('Succeeded to write pixelmap into the specified area.'); } }) ``` @@ -325,9 +328,11 @@ Reads image data in an **ArrayBuffer** and writes the data to a **PixelMap** obj ```js const color = new ArrayBuffer(96); -const pixelMap = new ArrayBuffer(400); let bufferArr = new Uint8Array(color); -pixelMap.writeBufferToPixels(color).then(() => { +for (var i = 0; i < bufferArr.length; i++) { + bufferArr[i] = i + 1; +} +pixelmap.writeBufferToPixels(color).then(() => { console.log("Succeeded in writing data from a buffer to a PixelMap."); }).catch((err) => { console.error("Failed to write data from a buffer to a PixelMap."); @@ -353,9 +358,11 @@ Reads image data in an **ArrayBuffer** and writes the data to a **PixelMap** obj ```js const color = new ArrayBuffer(96); -const pixelMap = new ArrayBuffer(400); let bufferArr = new Uint8Array(color); -pixelMap.writeBufferToPixels(color, function(err) { +for (var i = 0; i < bufferArr.length; i++) { + bufferArr[i] = i + 1; +} +pixelmap.writeBufferToPixels(color, function(err) { if (err) { console.error("Failed to write data from a buffer to a PixelMap."); return; @@ -382,12 +389,22 @@ Obtains pixel map information of this image. This API uses a promise to return t **Example** ```js -const pixelMap = new ArrayBuffer(400); -pixelMap.getImageInfo().then(function(info) { - console.log("Succeeded in obtaining the image pixel map information."); -}).catch((err) => { - console.error("Failed to obtain the image pixel map information."); -}); +const color = new ArrayBuffer(96); +let opts = { editable: true, pixelFormat: 2, size: { height: 6, width: 8 } } +image.createPixelMap(color, opts).then(pixelmap => { + globalpixelmap = pixelmap; + if (pixelmap == undefined) { + console.error("Failed to obtain the image pixel map information."); + } + pixelmap.getImageInfo().then(imageInfo => { + if (imageInfo == undefined) { + console.error("Failed to obtain the image pixel map information."); + } + if (imageInfo.size.height == 4 && imageInfo.size.width == 6) { + console.log("Succeeded in obtaining the image pixel map information."); + } + }) +}) ``` ### getImageInfo7+ @@ -407,8 +424,21 @@ Obtains pixel map information of this image. This API uses an asynchronous callb **Example** ```js -pixelmap.getImageInfo((imageInfo) => { - console.log("Succeeded in obtaining the image pixel map information."); +const color = new ArrayBuffer(96); +let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } } +image.createPixelMap(color, opts, (err, pixelmap) => { + if (pixelmap == undefined) { + globalpixelmap = pixelmap; + console.error("Failed to obtain the image pixel map information."); + } + pixelmap.getImageInfo((err, imageInfo) => { + if (imageInfo == undefined) { + console.error("Failed to obtain the image pixel map information."); + } + if (imageInfo.size.height == 4 && imageInfo.size.width == 6) { + console.log("Succeeded in obtaining the image pixel map information."); + } + }) }) ``` @@ -495,9 +525,15 @@ Sets an opacity rate for this image pixel map. This API uses an asynchronous cal **Example** ```js -async function () { - await pixelMap.opacity(0.5); -} +var rate = 0.5; +pixelmap.opacity(rate, (err) => { + if (err) { + console.error("Failed to set opacity."); + return; + } else { + console.log("Succeeded in setting opacity."); + } +}) ``` ### opacity9+ @@ -524,7 +560,8 @@ Sets an opacity rate for this image pixel map. This API uses a promise to return ```js async function () { - await pixelMap.opacity(0.5); + var rate = 0.5; + await pixelmap.opacity(rate); } ``` @@ -545,12 +582,8 @@ Creates a **PixelMap** object that contains only the alpha channel information. **Example** ```js -pixelMap.createAlphaPixelmap(async (err, alphaPixelMap) => { - if (alphaPixelMap == undefined) { - console.info('Failed to obtain new pixel map.'); - } else { - console.info('Succeed in obtaining new pixel map.'); - } +async function () { + await pixelmap.createAlphaPixelmap(); }) ``` @@ -571,14 +604,13 @@ Creates a **PixelMap** object that contains only the alpha channel information. **Example** ```js -let pixelMap = await imageSource.createPixelMap(); -if (pixelMap != undefined) { - pixelMap.createAlphaPixelmap(async (err, alphaPixelMap) => { - console.info('Failed to obtain new pixel map.'); - }) -} else { - console.info('Succeed in obtaining new pixel map.'); -} +pixelmap.createAlphaPixelmap((err, alphaPixelMap) => { + if (alphaPixelMap == undefined) { + console.info('Failed to obtain new pixel map.'); + } else { + console.info('Succeed in obtaining new pixel map.'); + } +}) ``` ### scale9+ @@ -601,7 +633,7 @@ Scales this image based on the input width and height. This API uses an asynchro ```js async function () { - await pixelMap.scale(2.0, 1.0); + await pixelmap.scale(2.0, 1.0); } ``` @@ -630,7 +662,7 @@ Scales this image based on the input width and height. This API uses a promise t ```js async function () { - await pixelMap.scale(2.0, 1.0); + await pixelmap.scale(2.0, 1.0); } ``` @@ -654,7 +686,7 @@ Translates this image based on the input coordinates. This API uses an asynchron ```js async function () { - await pixelMap.translate(3.0, 1.0); + await pixelmap.translate(3.0, 1.0); } ``` @@ -683,7 +715,7 @@ Translates this image based on the input coordinates. This API uses a promise to ```js async function () { - await pixelMap.translate(3.0, 1.0); + await pixelmap.translate(3.0, 1.0); } ``` @@ -706,7 +738,7 @@ Rotates this image based on the input angle. This API uses an asynchronous callb ```js async function () { - await pixelMap.rotate(90.0); + await pixelmap.rotate(90.0); } ``` @@ -734,7 +766,7 @@ Rotates this image based on the input angle. This API uses a promise to return t ```js async function () { - await pixelMap.rotate(90.0); + await pixelmap.rotate(90.0); } ``` @@ -758,7 +790,7 @@ Flips this image horizontally or vertically, or both. This API uses an asynchron ```js async function () { - await pixelMap.flip(false, true); + await pixelmap.flip(false, true); } ``` @@ -787,7 +819,7 @@ Flips this image horizontally or vertically, or both. This API uses a promise to ```js async function () { - await pixelMap.flip(false, true); + await pixelmap.flip(false, true); } ``` @@ -810,7 +842,7 @@ Crops this image based on the input size. This API uses an asynchronous callback ```js async function () { - await pixelMap.crop(3x3); + await pixelmap.crop({ x: 0, y: 0, size: { height: 100, width: 100 } }); } ``` @@ -838,7 +870,7 @@ Crops this image based on the input size. This API uses a promise to return the ```js async function () { - await pixelMap.crop(3x3); + await pixelmap.crop({ x: 0, y: 0, size: { height: 100, width: 100 } }); } ``` @@ -910,7 +942,7 @@ Creates an **ImageSource** instance based on the URI. | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ---------------------------------- | -| uri | string | Yes | Image path. Currently, only the application sandbox path is supported.| +| uri | string | Yes | Image path. Currently, only the application sandbox path is supported.
Currently, the following raw formats are supported: .jpg, .png, .gif, .bmp, and .webp.| **Return value** @@ -937,7 +969,7 @@ Creates an **ImageSource** instance based on the URI. | Name | Type | Mandatory| Description | | ------- | ------------------------------- | ---- | ----------------------------------- | -| uri | string | Yes | Image path. Currently, only the application sandbox path is supported. | +| uri | string | Yes | Image path. Currently, only the application sandbox path is supported.
Currently, the following raw formats are supported: .jpg, .png, .gif, .bmp, and .webp.| | options | [SourceOptions](#sourceoptions9) | Yes | Image properties, including the image index and default property value.| **Return value** @@ -949,7 +981,8 @@ Creates an **ImageSource** instance based on the URI. **Example** ```js -const imageSourceApi = image.createImageSource('/sdcard/test.jpg'); +var sourceOptions = { sourceDensity: 120 }; +let imageSource = image.createImageSource('test.png', sourceOptions); ``` ## image.createImageSource7+ @@ -1002,7 +1035,8 @@ Creates an **ImageSource** instance based on the file descriptor. **Example** ```js -const imageSourceApi = image.createImageSource(fd); +var sourceOptions = { sourceDensity: 120 }; +const imageSourceApi = image.createImageSource(0, sourceOptions); ``` ## image.createImageSource9+ @@ -1054,9 +1088,9 @@ const data = new ArrayBuffer(112); const imageSourceApi = image.createImageSource(data); ``` -## image.CreateIncrementalSource9+ +## image.createIncrementalSource9+ -CreateIncrementalSource(buf: ArrayBuffer): ImageSource +createIncrementalSource(buf: ArrayBuffer): ImageSource Creates an **ImageSource** instance in incremental mode based on the buffers. @@ -1078,12 +1112,12 @@ Creates an **ImageSource** instance in incremental mode based on the buffers. ```js const buf = new ArrayBuffer(96); -const imageSourceApi = image.CreateIncrementalSource(buf); +const imageSourceIncrementalSApi = image.createIncrementalSource(buf); ``` -## image.CreateIncrementalSource9+ +## image.createIncrementalSource9+ -CreateIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource +createIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource Creates an **ImageSource** instance in incremental mode based on the buffers. @@ -1106,7 +1140,7 @@ Creates an **ImageSource** instance in incremental mode based on the buffers. ```js const buf = new ArrayBuffer(96); -const imageSourceApi = image.CreateIncrementalSource(buf); +const imageSourceIncrementalSApi = image.createIncrementalSource(buf); ``` ## ImageSource @@ -1119,7 +1153,7 @@ Provides APIs to obtain image information. Before calling any API in **ImageSour | Name | Type | Readable| Writable| Description | | ---------------- | -------------- | ---- | ---- | ------------------------------------------------------------ | -| supportedFormats | Array\ | Yes | No | Supported image formats, including png, jpeg, wbmp, bmp, gif, webp, and heif.| +| supportedFormats | Array\ | Yes | No | Supported image formats, including PNG, JPEG, BMP, GIF, WebP, and RAW.| ### getImageInfo @@ -1277,7 +1311,7 @@ Obtains the value of a property in this image. This API uses an asynchronous cal **Example** ```js -const property = new ArrayBuffer(400); +let property = { index: 0, defaultValue: '9999' } imageSourceApi.getImageProperty("BitsPerSample",property,(error,data) => { if(error) { console.log('Failed to get the value of the specified attribute key of the image.'); @@ -1472,7 +1506,15 @@ Creates a **PixelMap** object based on image decoding parameters. This API uses **Example** ```js -const decodingOptions = new ArrayBuffer(400); +let decodingOptions = { + sampleSize: 1, + editable: true, + desiredSize: { width: 1, height: 2 }, + rotate: 10, + desiredPixelFormat: 3, + desiredRegion: { size: { height: 1, width: 2 }, x: 0, y: 0 }, + index: 0 +}; imageSourceApi.createPixelMap(decodingOptions, pixelmap => { console.log('Succeeded in creating pixelmap object.'); }) @@ -1546,7 +1588,7 @@ const imagePackerApi = image.createImagePacker(); ## ImagePacker -Provide APIs to pack images. Before calling any API in **ImagePacker**, you must use **createImagePacker** to create an **ImagePacker** instance. +Provides APIs to pack images. Before calling any API in **ImagePacker**, you must use **createImagePacker** to create an **ImagePacker** instance. The image formats JPEG and WebP are supported. ### Attributes @@ -1569,14 +1611,13 @@ Packs an image. This API uses an asynchronous callback to return the result. | Name | Type | Mandatory| Description | | -------- | ---------------------------------- | ---- | ---------------------------------- | | source | [ImageSource](#imagesource) | Yes | Image to pack. | -| option | [PackingOption](#packingoption) | Yes | Option for image packing. | +| option | [PackingOption](#packingoption) | Yes | Option for image packing. | | callback | AsyncCallback\ | Yes | Callback used to return the packed data.| **Example** ```js let packOpts = { format:"image/jpeg", quality:98 }; -const imageSourceApi = new ArrayBuffer(400); imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ``` @@ -1605,7 +1646,6 @@ Packs an image. This API uses a promise to return the result. ```js let packOpts = { format:"image/jpeg", quality:98 } -const imageSourceApi = new ArrayBuffer(400); imagePackerApi.packing(imageSourceApi, packOpts) .then( data => { console.log('packing succeeded.'); @@ -2107,7 +2147,7 @@ Describes area information in an image. | ------ | ------------------ | ---- | ---- | ------------------------------------------------------------ | | pixels | ArrayBuffer | Yes | No | Pixels of the image. | | offset | number | Yes | No | Offset for data reading. | -| stride | number | Yes | No | Number of bytes from one row of pixels in memory to the next row of pixels in memory. The value of **stride** must be greater than or equal to the value of **region.size.width** multiplied by 4. | +| stride | number | Yes | No | Number of bytes from one row of pixels in memory to the next row of pixels in memory. The value of **stride** must be greater than or equal to the value of **region.size.width** multiplied by 4. | | region | [Region](#region7) | Yes | No | Region to read or write. The width of the region to write plus the X coordinate cannot be greater than the width of the original image. The height of the region to write plus the Y coordinate cannot be greater than the height of the original image.| ## ImageInfo @@ -2141,8 +2181,8 @@ Enumerates the pixel formats of images. | ---------------------- | ------ | ----------------- | | UNKNOWN | 0 | Unknown format. | | RGB_565 | 2 | RGB_565. | -| RGBA_8888 | 3 | RGBA_8888.| -| BGRA_88889+ | 4 | BGRA_8888.| +| RGBA_8888 | 3 | RGBA_8888. | +| BGRA_88889+ | 4 | BGRA_8888. | ## AlphaType9+ @@ -2154,8 +2194,8 @@ Enumerates the alpha types of images. | -------- | ------ | ----------------------- | | UNKNOWN | 0 | Unknown alpha type. | | OPAQUE | 1 | There is no alpha or the image is opaque.| -| PREMUL | 2 | Premultiplied alpha. | -| UNPREMUL | 3 | Unpremultiplied alpha, that is, straight alpha. | +| PREMUL | 2 | Premultiplied alpha. | +| UNPREMUL | 3 | Unpremultiplied alpha, that is, straight alpha. | ## ScaleMode9+ @@ -2166,7 +2206,7 @@ Enumerates the scale modes of images. | Name | Default Value| Description | | --------------- | ------ | -------------------------------------------------- | | CENTER_CROP | 1 | Scales the image so that it fills the requested bounds of the target and crops the extra.| -| FIT_TARGET_SIZE | 2 | Reduces the image size to the dimensions of the target. | +| FIT_TARGET_SIZE | 0 | Reduces the image size to the dimensions of the target. | ## SourceOptions9+ @@ -2231,7 +2271,7 @@ Defines the option for image packing. | Name | Type | Readable| Writable| Description | | ------- | ------ | ---- | ---- | --------------------------------------------------- | -| format | string | Yes | Yes | Format of the packed image. | +| format | string | Yes | Yes | Format of the packed image.
Currently, the JPEG and WebP formats are supported. | | quality | number | Yes | Yes | Quality of the output image during JPEG encoding. The value ranges from 1 to 100.| ## GetImagePropertyOptions7+ diff --git a/en/application-dev/reference/apis/js-apis-intl.md b/en/application-dev/reference/apis/js-apis-intl.md index 3060af2da4bd047461f0cce0d866753bd8caf36a..fcf2858aa7b4a1adda999a0e1bf0850495c0d00f 100644 --- a/en/application-dev/reference/apis/js-apis-intl.md +++ b/en/application-dev/reference/apis/js-apis-intl.md @@ -1,9 +1,13 @@ # Internationalization – Intl -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** -> - The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. -> -> - This module provides basic I18N capabilities, such as time and date formatting, number formatting, and string sorting, through the standard I18N interfaces defined in ECMA 402. For details about the enhanced I18N capabilities, see [I18N](js-apis-i18n.md). +This module provides basic I18N capabilities, such as time and date formatting, number formatting, and string sorting, through the standard I18N APIs defined in ECMA 402. + +The [I18N](js-apis-i18n.md) module provides enhanced I18N capabilities through supplementary APIs that are not defined in ECMA 402. It works with the Intl module to provide a complete suite of I18N capabilities. + +> **NOTE** +> +> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. + ## Modules to Import @@ -56,6 +60,7 @@ Creates a Locale object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------- | ------------- | ---- | ---------------------------- | | locale | string | Yes | A string containing locale information, including the language, optional script, and region.| @@ -76,6 +81,7 @@ Converts locale information to a string. **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ------ | ----------- | | string | String containing locale information.| @@ -96,6 +102,7 @@ Maximizes information of the **Locale** object. If the script and locale informa **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ----------------- | ---------- | | [Locale](#locale) | **Locale** object with the maximized information.| @@ -116,6 +123,7 @@ Minimizes information of the **Locale** object. If the script and locale informa **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ----------------- | ---------- | | [Locale](#locale) | **Locale** object with the minimized information.| @@ -127,7 +135,7 @@ Minimizes information of the **Locale** object. If the script and locale informa ``` -## LocaleOptions +## LocaleOptions9+ Represents the locale options. @@ -169,6 +177,7 @@ Creates a **DateTimeOptions** object for the specified locale. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------- | ----------------------------------- | ---- | ---------------------------- | | locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.| @@ -195,11 +204,13 @@ Formats the specified date and time. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ---- | ---- | ------- | | date | Date | Yes | Date and time to be formatted.| **Return Value** + | Type | Description | | ------ | ------------ | | string | A string containing the formatted date and time.| @@ -221,12 +232,14 @@ Formats the specified date range. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | --------- | ---- | ---- | -------- | | startDate | Date | Yes | Start date and time to be formatted.| | endDate | Date | Yes | End date and time to be formatted.| **Return Value** + | Type | Description | | ------ | -------------- | | string | A string containing the formatted date and time range.| @@ -249,6 +262,7 @@ Obtains the formatting options for **DateTimeFormat** object. **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ----------------------------------- | ----------------------------- | | [DateTimeOptions](#datetimeoptions) | Formatting options for **DateTimeFormat** objects.| @@ -260,7 +274,7 @@ Obtains the formatting options for **DateTimeFormat** object. ``` -## DateTimeOptions +## DateTimeOptions9+ Provides the options for the **DateTimeFormat** object. @@ -335,11 +349,13 @@ Formats a number. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ---- | | number | number | Yes | Number to be formatted.| **Return Value** + | Type | Description | | ------ | ---------- | | string | Formatted number.| @@ -361,6 +377,7 @@ Obtains the options of the **NumberFormat** object. **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ------------------------------- | --------------------------- | | [NumberOptions](#numberoptions) | Formatting options for **NumberFormat** objects.| @@ -373,7 +390,7 @@ Obtains the options of the **NumberFormat** object. ``` -## NumberOptions +## NumberOptions9+ Provides the device capability. @@ -449,12 +466,14 @@ Compares two strings based on the sorting policy of the **Collator** object. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ------ | ------ | ---- | ------------ | | first | string | Yes | First string to compare. | | second | string | Yes | Second string to compare.| **Return Value** + | Type | Description | | ------ | ---------------------------------------- | | number | Comparison result. If the value is a negative number, the first string is before the second string. If the value of number is **0**, the first string is equal to the second string. If the value of number is a positive number, the first string is after the second string.| @@ -475,6 +494,7 @@ Returns properties reflecting the locale and collation options of a **Collator** **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ----------------------------------- | ----------------- | | [CollatorOptions](#collatoroptions) | Properties of the **Collator** object.| @@ -486,7 +506,7 @@ Returns properties reflecting the locale and collation options of a **Collator** ``` -## CollatorOptions8+ +## CollatorOptions9+ Represents the properties of a **Collator** object. @@ -549,11 +569,13 @@ Obtains a string that represents the singular-plural type of the specified numbe **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ---- | ------ | ---- | ------------ | | n | number | Yes | Number for which the singular-plural type is to be obtained.| **Return Value** + | Type | Description | | ------ | ---------------------------------------- | | string | Singular-plural type. The value can be any of the following: **one**, **two**, **few**, **many**, **others**.| @@ -565,7 +587,7 @@ Obtains a string that represents the singular-plural type of the specified numbe ``` -## PluralRulesOptions8+ +## PluralRulesOptions9+ Represents the properties of a **PluralRules** object. @@ -607,7 +629,8 @@ Creates a **RelativeTimeFormat** object. **System capability**: SystemCapability.Global.I18n -Parameters +**Parameters** + | Name | Type | Mandatory | Description | | ------- | ---------------------------------------- | ---- | ---------------------------- | | locale | string \| Array<string> | Yes | A string containing locale information, including the language, optional script, and region.| @@ -628,12 +651,14 @@ Formats the value and unit based on the specified locale and formatting options. **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | ---------------------------------------- | | value | number | Yes | Value to format. | | unit | string | Yes | Unit to format. The value can be any of the following: **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, **second**.| **Return Value** + | Type | Description | | ------ | ---------- | | string | Relative time after formatting.| @@ -654,12 +679,14 @@ Returns an array of RelativeTimeFormat objects in parts for locale-aware formatt **System capability**: SystemCapability.Global.I18n **Parameters** + | Name | Type | Mandatory | Description | | ----- | ------ | ---- | ---------------------------------------- | | value | number | Yes | Value to format. | | unit | string | Yes | Unit to format. The value can be any of the following: **year**, **quarter**, **month**, **week**, **day**, **hour**, **minute**, **second**.| **Return Value** + | Type | Description | | ------------------- | --------------------------- | | Array<object> | An array of **RelativeTimeFormat** objects in parts.| @@ -680,6 +707,7 @@ Obtains the formatting options for **RelativeTimeFormat** objects. **System capability**: SystemCapability.Global.I18n **Return Value** + | Type | Description | | ---------------------------------------- | --------------------------------- | | [RelativeTimeFormatResolvedOptions](#relativetimeformatresolvedoptions) | Formatting options for **RelativeTimeFormat** objects.| @@ -691,7 +719,7 @@ Obtains the formatting options for **RelativeTimeFormat** objects. ``` -## RelativeTimeFormatInputOptions8+ +## RelativeTimeFormatInputOptions9+ Represents the properties of a **RelativeTimeFormat** object. diff --git a/en/application-dev/reference/apis/js-apis-lightweightmap.md b/en/application-dev/reference/apis/js-apis-lightweightmap.md index 5ac480761ba58f22e2f120aeaa0aca58faed366d..4ff765d9cf8cefcbd3682d7cd9dbd216400d21cb 100644 --- a/en/application-dev/reference/apis/js-apis-lightweightmap.md +++ b/en/application-dev/reference/apis/js-apis-lightweightmap.md @@ -12,6 +12,10 @@ Compared with **[HashMap](js-apis-hashmap.md)**, which can also store KV pairs, **Recommended use case**: Use LightWeightMap when you need to store and access **KV pairs**. +This topic uses the following to identify the use of generics: +- K: Key +- V: Value + ## Modules to Import ```ts @@ -92,10 +96,10 @@ Checks whether this container contains all elements of the specified **LightWeig ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let map = new LightWeightMap(); -map.set("sdfs", 356); +map.set("sparrow", 356); let result = lightWeightMap.hasAll(map); ``` @@ -125,9 +129,9 @@ Checks whether this container contains the specified key. ```ts let lightWeightMap = new LightWeightMap(); let result = lightWeightMap.hasKey; -lightWeightMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -let result1 = lightWeightMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +lightWeightMap.hasKey("squirrel"); +lightWeightMap.set("squirrel", 123); +let result1 = lightWeightMap.hasKey("squirrel"); ``` @@ -156,7 +160,7 @@ Checks whether this container contains the specified value. ```ts let lightWeightMap = new LightWeightMap(); let result = lightWeightMap.hasValue(123); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); +lightWeightMap.set("squirrel", 123); let result1 = lightWeightMap.hasValue(123); ``` @@ -207,9 +211,9 @@ Obtains the value of the specified key in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); -let result = lightWeightMap.get("sdfs"); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); +let result = lightWeightMap.get("sparrow"); ``` @@ -237,9 +241,9 @@ Obtains the index of the first occurrence of an element with the specified key i ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); -let result = lightWeightMap.getIndexOfKey("sdfs"); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); +let result = lightWeightMap.getIndexOfKey("sparrow"); ``` @@ -267,8 +271,8 @@ Obtains the index of the first occurrence of an element with the specified value ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let result = lightWeightMap.getIndexOfValue(123); ``` @@ -297,8 +301,8 @@ Obtains the key of an element at the specified position in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let result = lightWeightMap.getKeyAt(1); ``` @@ -321,8 +325,8 @@ Adds all elements in a **LightWeightMap** instance to this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let map = new LightWeightMap(); lightWeightMap.setAll(map); ``` @@ -352,7 +356,7 @@ Adds an element to this container. ```ts let lightWeightMap = new LightWeightMap(); -let result = lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); +let result = lightWeightMap.set("squirrel", 123); ``` @@ -380,9 +384,9 @@ Removes an element with the specified key from this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); -lightWeightMap.remove("sdfs"); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); +lightWeightMap.remove("sparrow"); ``` @@ -410,8 +414,8 @@ Removes an element at the specified position from this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let result = lightWeightMap.removeAt(1); ``` @@ -441,8 +445,8 @@ Sets a value for an element at the specified position in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); lightWeightMap.setValueAt(1, 3546); ``` @@ -471,8 +475,8 @@ Obtains the value of an element at the specified position in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let result = lightWeightMap.getValueAt(1); ``` @@ -489,8 +493,8 @@ Clears this container and sets its length to **0**. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); lightWeightMap.clear(); ``` @@ -513,8 +517,8 @@ Obtains an iterator that contains all the keys in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let iter = lightWeightMap.keys(); let temp = iter.next().value; while(temp != undefined) { @@ -542,8 +546,8 @@ Obtains an iterator that contains all the values in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let iter = lightWeightMap.values(); let temp = iter.next().value; while(temp != undefined) { @@ -579,8 +583,8 @@ callbackfn ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("sdfs", 123); -lightWeightMap.set("dfsghsf", 357); +lightWeightMap.set("sparrow", 123); +lightWeightMap.set("gull", 357); lightWeightMap.forEach((value, key) => { console.log("value:" + value, key); }); @@ -605,8 +609,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); let iter = lightWeightMap.entries(); let temp = iter.next().value; while(temp != undefined) { @@ -634,8 +638,8 @@ Concatenates the elements in this container into a string and returns the string ```ts let lightWeightMap = new LightWeightMap(); - lightWeightMap.set("A", 123); - lightWeightMap.set("sdfs", 356); + lightWeightMap.set("squirrel", 123); + lightWeightMap.set("sparrow", 356); let iter = lightWeightMap.toString(); ``` @@ -657,8 +661,8 @@ Obtains an iterator, each item of which is a JavaScript object. ```ts let lightWeightMap = new LightWeightMap(); -lightWeightMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -lightWeightMap.set("sdfs", 356); +lightWeightMap.set("squirrel", 123); +lightWeightMap.set("sparrow", 356); // Method 1: for (let item of lightWeightMap) { diff --git a/en/application-dev/reference/apis/js-apis-lightweightset.md b/en/application-dev/reference/apis/js-apis-lightweightset.md index 4a900d9f5476216ae7e98a0df9d762119753ad36..d64a40d1b65854d3f97ba399c6426b94b9c71bf0 100644 --- a/en/application-dev/reference/apis/js-apis-lightweightset.md +++ b/en/application-dev/reference/apis/js-apis-lightweightset.md @@ -14,6 +14,9 @@ Compared with **[HashSet](js-apis-hashset.md)**, which can also store values, ** **Recommended use case**: Use **LightWeightSet** when you need a set that has only unique elements or need to deduplicate a set. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -93,7 +96,7 @@ Adds an element to this container. ```ts let lightWeightSet = new LightWeightSet(); -let result = lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = lightWeightSet.add("squirrel"); ``` @@ -115,10 +118,10 @@ Adds all elements in a **LightWeightSet** instance to this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let set = new LightWeightSet(); -set.add("sfage"); +set.add("gull"); let result = lightWeightSet.addAll(set); ``` @@ -147,10 +150,10 @@ Checks whether this container contains all elements of the specified **LightWeig ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let set = new LightWeightSet(); -set.add("sdfs"); +set.add("sparrow"); let result = lightWeightSet.hasAll(set); ``` @@ -209,9 +212,9 @@ Checks whether this container contains objects of the same type as the specified ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); -let obj = ["Ahfbrgrbgnutfodgorrogorgrogofdfdf", "sdfs"]; +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); +let obj = ["squirrel", "sparrow"]; let result = lightWeightSet.equal(obj); ``` @@ -262,9 +265,9 @@ Obtains the position index of the element with the specified key in this contain ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); -let result = lightWeightSet.getIndexOf("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); +let result = lightWeightSet.getIndexOf("sparrow"); ``` @@ -292,9 +295,9 @@ Removes an element of the specified key from this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); -let result = lightWeightSet.remove("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); +let result = lightWeightSet.remove("sparrow"); ``` @@ -322,8 +325,8 @@ Removes the element at the specified position from this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let result = lightWeightSet.removeAt(1); ``` @@ -352,8 +355,8 @@ Obtains the value of the element at the specified position in this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let result = lightWeightSet.getValueAt(1); ``` @@ -370,8 +373,8 @@ Clears this container and sets its length to **0**. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); lightWeightSet.clear(); ``` @@ -394,8 +397,8 @@ Obtains a string that contains all elements in this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let result = lightWeightSet.toString(); ``` @@ -418,8 +421,8 @@ Obtains an array that contains all objects in this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let result = lightWeightSet.toArray(); ``` @@ -442,8 +445,8 @@ Obtains an iterator that contains all the values in this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let iter = lightWeightSet.values(); let index = 0; while(index < lightWeightSet.length) { @@ -479,8 +482,8 @@ callbackfn ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("sdfs"); -lightWeightSet.add("dfsghsf"); +lightWeightSet.add("sparrow"); +lightWeightSet.add("gull"); lightWeightSet.forEach((value, key) => { console.log("value:" + value, key); }); @@ -505,8 +508,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); let iter = lightWeightSet.entries(); let index = 0; while(index < lightWeightSet.length) { @@ -534,8 +537,8 @@ Obtains an iterator, each item of which is a JavaScript object. ```ts let lightWeightSet = new LightWeightSet(); -lightWeightSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -lightWeightSet.add("sdfs"); +lightWeightSet.add("squirrel"); +lightWeightSet.add("sparrow"); // Method 1: for (let item of lightWeightSet) { diff --git a/en/application-dev/reference/apis/js-apis-linkedlist.md b/en/application-dev/reference/apis/js-apis-linkedlist.md index 73737f14b6078445e1f67762ca43a86a22804dbe..3265367a954c1ce027591bc056827717e889339b 100644 --- a/en/application-dev/reference/apis/js-apis-linkedlist.md +++ b/en/application-dev/reference/apis/js-apis-linkedlist.md @@ -12,6 +12,9 @@ Unlike **[List](js-apis-list.md)**, which is a singly linked list, **LinkedList* **Recommended use case**: Use **LinkedList** for frequent insertion and removal operations. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -76,7 +79,7 @@ let result = linkedList.add("a"); let result1 = linkedList.add(1); let b = [1, 2, 3]; linkedList.add(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; let result3 = linkedList.add(false); ``` @@ -102,7 +105,7 @@ linkedList.addFirst("a"); linkedList.addFirst(1); let b = [1, 2, 3]; linkedList.addFirst(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; linkedList.addFirst(false); ``` @@ -154,9 +157,9 @@ Checks whether this container has the specified element. ```ts let linkedList = new LinkedList(); -let result1 = linkedList.has("Ahfbrgrbgnutfodgorrogorg"); -linkedList.add("Ahfbrgrbgnutfodgorrogorg"); -let result = linkedList.has("Ahfbrgrbgnutfodgorrogorg"); +let result1 = linkedList.has("squirrel"); +linkedList.add("squirrel"); +let result = linkedList.has("squirrel"); ``` ### get diff --git a/en/application-dev/reference/apis/js-apis-list.md b/en/application-dev/reference/apis/js-apis-list.md index 0b839a5a0baae3fa58e4592485c3b9e959183530..4534668591a447df0a1f36d4f8ca3866a3e31692 100644 --- a/en/application-dev/reference/apis/js-apis-list.md +++ b/en/application-dev/reference/apis/js-apis-list.md @@ -10,6 +10,9 @@ Unlike [LinkedList](js-apis-linkedlist.md), which is a doubly linked list, **Lis **Recommended use case**: Use **List** for frequent insertion and removal operations. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -72,7 +75,7 @@ let result = list.add("a"); let result1 = list.add(1); let b = [1, 2, 3]; list.add(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; let result3 = list.add(false); ``` @@ -124,9 +127,9 @@ Checks whether this container has the specified element. ```ts let list = new List(); -let result = list.has("Ahfbrgrbgnutfodgorrogorg"); -list.add("Ahfbrgrbgnutfodgorrogorg"); -let result1 = list.has("Ahfbrgrbgnutfodgorrogorg"); +let result = list.has("squirrel"); +list.add("squirrel"); +let result1 = list.has("squirrel"); ``` ### get @@ -181,7 +184,7 @@ Obtains the index of the last occurrence of the specified element in this contai | Value Type | Description| | -------- | -------- | -| number | Returns the position index if obtained; returns **-1** otherwise.| +| number | Returns the index if obtained; returns **-1** otherwise.| **Example** @@ -265,7 +268,7 @@ obj1.add(2); obj1.add(4); obj1.add(5); list.equal(obj1); -let obj2 = {name : "lala", age : "13"}; +let obj2 = {name : "Dylon", age : "13"}; let result = list.equal(obj2); ``` diff --git a/en/application-dev/reference/apis/js-apis-media.md b/en/application-dev/reference/apis/js-apis-media.md index 66af65d60b482342733fcc149c8b7b4078eeb851..fca68b5554d6239a03415892d68570dc1b4e8574 100644 --- a/en/application-dev/reference/apis/js-apis-media.md +++ b/en/application-dev/reference/apis/js-apis-media.md @@ -45,7 +45,7 @@ let audioPlayer = media.createAudioPlayer(); createVideoPlayer(callback: AsyncCallback\<[VideoPlayer](#videoplayer8)>): void -Creates a **VideoPlayer** instance in asynchronous mode. This API uses a callback to return the result. +Creates a **VideoPlayer** instance. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -53,7 +53,7 @@ Creates a **VideoPlayer** instance in asynchronous mode. This API uses a callbac | Name | Type | Mandatory| Description | | -------- | ------------------------------------------- | ---- | ------------------------------ | -| callback | AsyncCallback<[VideoPlayer](#videoplayer8)> | Yes | Callback used to return the **VideoPlayer** instance created.| +| callback | AsyncCallback<[VideoPlayer](#videoplayer8)> | Yes | Callback used to return the **VideoPlayer** instance, which can be used to manage and play video media.| **Example** @@ -65,7 +65,7 @@ media.createVideoPlayer((error, video) => { videoPlayer = video; console.info('video createVideoPlayer success'); } else { - console.info(`video createVideoPlayer fail, error:${error.message}`); + console.info(`video createVideoPlayer fail, error:${error}`); } }); ``` @@ -74,7 +74,7 @@ media.createVideoPlayer((error, video) => { createVideoPlayer(): Promise<[VideoPlayer](#videoplayer8)> -Creates a **VideoPlayer** instance in asynchronous mode. This API uses a promise to return the result. +Creates a **VideoPlayer** instance. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -82,7 +82,7 @@ Creates a **VideoPlayer** instance in asynchronous mode. This API uses a promise | Type | Description | | ------------------------------------- | ----------------------------------- | -| Promise<[VideoPlayer](#videoplayer8)> | Promise used to return the **VideoPlayer** instance created.| +| Promise<[VideoPlayer](#videoplayer8)> | Promise used to return the **VideoPlayer** instance, which can be used to manage and play video media.| **Example** @@ -97,7 +97,7 @@ media.createVideoPlayer().then((video) => { console.info('video createVideoPlayer fail'); } }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -126,7 +126,7 @@ let audioRecorder = media.createAudioRecorder(); createVideoRecorder(callback: AsyncCallback\<[VideoRecorder](#videorecorder9)>): void -Creates a **VideoRecorder** instance in asynchronous mode. This API uses a callback to return the result. +Creates a **VideoRecorder** instance. This API uses an asynchronous callback to return the result. Only one **AudioRecorder** instance can be created per device. **System capability**: SystemCapability.Multimedia.Media.VideoRecorder @@ -135,7 +135,7 @@ Only one **AudioRecorder** instance can be created per device. | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------- | ---- | ------------------------------ | -| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | Yes | Callback used to return the **VideoRecorder** instance created.| +| callback | AsyncCallback<[VideoRecorder](#videorecorder9)> | Yes | Callback used to return the **VideoRecorder** instance, which can be used to record video media.| **Example** @@ -147,7 +147,7 @@ media.createVideoRecorder((error, video) => { videoRecorder = video; console.info('video createVideoRecorder success'); } else { - console.info(`video createVideoRecorder fail, error:${error.message}`); + console.info(`video createVideoRecorder fail, error:${error}`); } }); ``` @@ -156,7 +156,7 @@ media.createVideoRecorder((error, video) => { createVideoRecorder(): Promise<[VideoRecorder](#videorecorder9)> -Creates a **VideoRecorder** instance in asynchronous mode. This API uses a promise to return the result. +Creates a **VideoRecorder** instance. This API uses a promise to return the result. Only one **AudioRecorder** instance can be created per device. **System capability**: SystemCapability.Multimedia.Media.VideoRecorder @@ -165,7 +165,7 @@ Only one **AudioRecorder** instance can be created per device. | Type | Description | | ----------------------------------------- | ----------------------------------- | -| Promise<[VideoRecorder](#videorecorder9)> | Promise used to return the **VideoRecorder** instance created.| +| Promise<[VideoRecorder](#videorecorder9)> | Promise used to return the **VideoRecorder** instance, which can be used to record video media.| **Example** @@ -180,7 +180,7 @@ media.createVideoRecorder().then((video) => { console.info('video createVideoRecorder fail'); } }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -275,15 +275,15 @@ For details about the audio playback demo, see [Audio Playback Development](../. **System capability**: SystemCapability.Multimedia.Media.AudioPlayer -| Name | Type | Readable| Writable| Description | -| ------------------------------- | ----------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| src | string | Yes | Yes | Audio file URI. The mainstream audio formats (M4A, AAC, MPEG-3, OGG, and WAV) are supported.
**Examples of supported URI schemes**:
1. FD: fd://xx
![](figures/en-us_image_url.png)
2. HTTP: http://xx
3. HTTPS: https://xx
4. HLS: http://xx or https://xx
**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.INTERNET (The latter is required only when online resources are used.)| -| fdSrc9+ | [AVFileDescriptor](#interruptmode9) | Yes | Yes | Description of the audio file. This attribute is required when audio resources of an application are continuously stored in a file.
**Example:**
Assume that a music file that stores continuous music resources consists of the following:
Music 1 (address offset: 0, byte length: 100)
Music 2 (address offset: 101; byte length: 50)
Music 3 (address offset: 151, byte length: 150)
1. To play music 1: AVFileDescriptor {fd = resource handle; offset = 0; length = 100; }
2. To play music 2: AVFileDescriptor {fd = resource handle; offset = 101; length = 50; }
3. To play music 3: AVFileDescriptor {fd = resource handle; offset = 151; length = 150; }
If the file is an independent music file, use **src=fd://xx**.

**Required permissions**: ohos.permission.READ_MEDIA| -| loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. | -| audioInterruptMode9+ | [InterruptMode](#interruptmode9) | Yes | Yes | Audio interruption mode. | -| currentTime | number | Yes | No | Current audio playback position, in ms. | -| duration | number | Yes | No | Audio duration, in ms. | -| state | [AudioState](#audiostate) | Yes | No | Audio playback state. This state cannot be used as the condition for triggering the call of **play()**, **pause()**, or **stop()**.| +| Name | Type | Readable| Writable| Description | +| ------------------------------- | ------------------------------------------------------ | ---- | ---- | ------------------------------------------------------------ | +| src | string | Yes | Yes | Audio file URI. The mainstream audio formats (M4A, AAC, MPEG-3, OGG, and WAV) are supported.
**Examples of supported URI schemes**:
1. FD: fd://xx
![](figures/en-us_image_url.png)
2. HTTP: http://xx
3. HTTPS: https://xx
4. HLS: http://xx or https://xx
**Required permissions**: ohos.permission.READ_MEDIA or ohos.permission.INTERNET| +| fdSrc9+ | [AVFileDescriptor](#avfiledescriptor9) | Yes | Yes | Description of the audio file. This attribute is required when audio resources of an application are continuously stored in a file.
**Example:**
Assume that a music file that stores continuous music resources consists of the following:
Music 1 (address offset: 0, byte length: 100)
Music 2 (address offset: 101; byte length: 50)
Music 3 (address offset: 151, byte length: 150)
1. To play music 1: AVFileDescriptor {fd = resource handle; offset = 0; length = 100; }
2. To play music 2: AVFileDescriptor {fd = resource handle; offset = 101; length = 50; }
3. To play music 3: AVFileDescriptor {fd = resource handle; offset = 151; length = 150; }
If the file is an independent music file, use **src=fd://xx**.
| +| loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. | +| audioInterruptMode9+ | [audio.InterruptMode](js-apis-audio.md#interruptmode9) | Yes | Yes | Audio interruption mode. | +| currentTime | number | Yes | No | Current audio playback position, in ms. | +| duration | number | Yes | No | Audio duration, in ms. | +| state | [AudioState](#audiostate) | Yes | No | Audio playback state. This state cannot be used as the condition for triggering the call of **play()**, **pause()**, or **stop()**.| ### play play(): void @@ -421,7 +421,7 @@ audioPlayer = undefined; getTrackDescription(callback: AsyncCallback>): void -Obtains the audio track information. This API uses a callback to return the result. It can be called only after the [dataLoad](#audioplayer_on) event is triggered. +Obtains the audio track information. This API uses an asynchronous callback to return the result. It can be called only after the [dataLoad](#audioplayer_on) event is triggered. **System capability**: SystemCapability.Multimedia.Media.AudioPlayer @@ -448,7 +448,7 @@ audioPlayer.getTrackDescription((error, arrlist) => { printfDescription(arrlist[i]); } } else { - console.log(`audio getTrackDescription fail, error:${error.message}`); + console.log(`audio getTrackDescription fail, error:${error}`); } }); ``` @@ -477,7 +477,7 @@ function printfDescription(obj) { console.info('audio value is ' + property); } } - +let arrayDescription = null audioPlayer.getTrackDescription().then((arrlist) => { if (arrlist != null) { arrayDescription = arrlist; @@ -485,7 +485,7 @@ audioPlayer.getTrackDescription().then((arrlist) => { console.log('audio getTrackDescription fail'); } }).catch((error) => { - console.info(`audio catchCallback, error:${error.message}`); + console.info(`audio catchCallback, error:${error}`); }); for (let i = 0; i < arrayDescription.length; i++) { @@ -529,12 +529,14 @@ Subscribes to the audio playback events. | Name | Type | Mandatory| Description | | -------- | ---------- | ---- | ------------------------------------------------------------ | -| type | string | Yes | Event type. The following events are supported:
- 'play': triggered when the [play()](#audioplayer_play) API is called and audio playback starts.
- 'pause': triggered when the [pause()](#audioplayer_pause) API is called and audio playback is paused.
- 'stop': triggered when the [stop()](#audioplayer_stop) API is called and audio playback stops.
- 'reset': triggered when the [reset()](#audioplayer_reset) API is called and audio playback is reset.
- 'dataLoad': triggered when the audio data is loaded, that is, when the **src** attribute is configured.
- 'finish': triggered when the audio playback is finished.
- 'volumeChange': triggered when the [setVolume()](#audioplayer_setvolume) API is called and the playback volume is changed. | +| type | string | Yes | Event type. The following events are supported:
- 'play': triggered when the [play()](#audioplayer_play) API is called and audio playback starts.
- 'pause': triggered when the [pause()](#audioplayer_pause) API is called and audio playback is paused.
- 'stop': triggered when the [stop()](#audioplayer_stop) API is called and audio playback stops.
- 'reset': triggered when the [reset()](#audioplayer_reset) API is called and audio playback is reset.
- 'dataLoad': triggered when the audio data is loaded, that is, when the **src** attribute is configured.
- 'finish': triggered when the audio playback is finished.
- 'volumeChange': triggered when the [setVolume()](#audioplayer_setvolume) API is called and the playback volume is changed.| | callback | () => void | Yes | Callback invoked when the event is triggered. | **Example** ```js +import fileio from '@ohos.fileio' + let audioPlayer = media.createAudioPlayer(); // Create an AudioPlayer instance. audioPlayer.on('dataLoad', () => { // Set the 'dataLoad' event callback, which is triggered when the src attribute is set successfully. console.info('audio set source success'); @@ -570,17 +572,15 @@ audioPlayer.on('finish', () => { // Set the 'finish' event callbac audioPlayer.stop(); // Stop the playback and trigger the 'stop' event callback. }); audioPlayer.on('error', (error) => { // Set the 'error' event callback. - console.info(`audio error called, errName is ${error.name}`); - console.info(`audio error called, errCode is ${error.code}`); - console.info(`audio error called, errMessage is ${error.message}`); + console.info(`audio error called, error: ${error}`); }); // Set the FD (local playback) of the video file selected by the user. -let fdPath = 'fd://' +let fdPath = 'fd://'; // The stream in the path can be pushed to the device by running the "hdc file send D:\xxx\01.mp3 /data/accounts/account_0/appdata" command. let path = '/data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3'; -fileIO.open(path).then(fdNumber) => { - fdPath = fdPath + '' + fdNumber; +fileio.open(path).then((fdValue) => { + fdPath = fdPath + '' + fdValue; console.info('open fd success fd is' + fdPath); }, (err) => { console.info('open fd failed err is' + err); @@ -602,20 +602,20 @@ Subscribes to the **'timeUpdate'** event. | Name | Type | Mandatory| Description | | -------- | ----------------- | ---- | ------------------------------------------------------------ | -| type | string | Yes | Event type, which is **'timeUpdate'** in this case.
The **'timeUpdate'** event is triggered when the [seek()](#audioplayer_seek) API is called.| -| callback | Callback\ | Yes | Callback invoked when the event is triggered. The input parameter of the callback is the time when the seek operation is successful. | +| type | string | Yes | Event type, which is **'timeUpdate'** in this case.
The **'timeUpdate'** event is triggered when the audio playback starts after an audio playback timestamp update.| +| callback | Callback\ | Yes | Callback invoked when the event is triggered. The input parameter is the updated timestamp. | **Example** ```js -audioPlayer.on('timeUpdate', (seekDoneTime) => { // Set the 'timeUpdate' event callback. - if (seekDoneTime == null) { - console.info('audio seek fail'); +audioPlayer.on('timeUpdate', (newTime) => { // Set the 'timeUpdate' event callback. + if (newTime == null) { + console.info('audio timeUpadate fail'); return; } - console.log('audio seek success. seekDoneTime: ' + seekDoneTime); + console.log('audio timeUpadate success. seekDoneTime: ' + newTime); }); -audioPlayer.seek(30000); // Seek to 30000 ms. +audioPlayer.play(); // The 'timeUpdate' event is triggered when the playback starts. ``` ### on('error') @@ -637,9 +637,7 @@ Subscribes to audio playback error events. After an error event is reported, you ```js audioPlayer.on('error', (error) => { // Set the 'error' event callback. - console.info(`audio error called, errName is ${error.name}`); // Print the error name. - console.info(`audio error called, errCode is ${error.code}`); // Print the error code. - console.info(`audio error called, errMessage is ${error.message}`);// Print the detailed description of the error type. + console.info(`audio error called, error: ${error}`); }); audioPlayer.setVolume(3); // Set volume to an invalid value to trigger the 'error' event. ``` @@ -650,21 +648,19 @@ Enumerates the audio playback states. You can obtain the state through the **sta **System capability**: SystemCapability.Multimedia.Media.AudioPlayer -| Name | Type | Description | -| ------------------ | ------ | ---------------------------------------------- | -| idle | string | No audio playback is in progress. The audio player is in this state after the **'dataload'** or **'reset'** event is triggered.| -| playing | string | Audio playback is in progress. The audio player is in this state after the **'play'** event is triggered. | -| paused | string | Audio playback is paused. The audio player is in this state after the **'pause'** event is triggered. | -| stopped | string | Audio playback is stopped. The audio player is in this state after the **'stop'** event is triggered. | -| error8+ | string | Audio playback is in the error state. | +| Name | Type | Description | +| ------- | ------ | ---------------------------------------------- | +| idle | string | No audio playback is in progress. The audio player is in this state after the **'dataload'** or **'reset'** event is triggered.| +| playing | string | Audio playback is in progress. The audio player is in this state after the **'play'** event is triggered. | +| paused | string | Audio playback is paused. The audio player is in this state after the **'pause'** event is triggered. | +| stopped | string | Audio playback is stopped. The audio player is in this state after the **'stop'** event is triggered. | +| error | string | Audio playback is in the error state. | ## AVFileDescriptor9+ Describes audio and video file resources. It is used to specify a particular resource for playback based on its offset and length within a file. -**System capability**: SystemCapability.Multimedia.Media.AudioPlayer - -**Parameters** +**System capability**: SystemCapability.Multimedia.Media.Core | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------------------------------------------------ | @@ -672,17 +668,6 @@ Describes audio and video file resources. It is used to specify a particular res | offset | number | Yes | Resource offset, which needs to be entered based on the preset resource information. An invalid value causes a failure to parse audio and video resources.| | length | number | Yes | Resource length, which needs to be entered based on the preset resource information. An invalid value causes a failure to parse audio and video resources.| -## InterruptMode9+ - -Describes the audio interruption mode. - -**System capability**: SystemCapability.Multimedia.Media.AudioPlayer - -| Name | Default Value| Description | -| ---------------------------- | ------ | ---------- | -| SHARE_MODE | 0 | Shared mode.| -| INDEPENDENT_MODE| 1 | Independent mode. | - ## VideoPlayer8+ Provides APIs to manage and play video. Before calling an API of **VideoPlayer**, you must call [createVideoPlayer()](#mediacreatevideoplayer8) to create a [VideoPlayer](#videoplayer8) instance. @@ -695,11 +680,11 @@ For details about the video playback demo, see [Video Playback Development](../. | Name | Type | Readable| Writable| Description | | ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| url8+ | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.
**Example of supported URIs**:
1. FD: fd://xx
![](figures/en-us_image_url.png)
2. HTTP: http://xx
3. HTTPS: https://xx
4. HLS: http://xx or https://xx
**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.INTERNET (The latter is required only when online resources are used.)| -| fdSrc9+ | [AVFileDescriptor](#interruptmode9) | Yes| Yes| Description of a video file. This attribute is required when video resources of an application are continuously stored in a file.
**Example:**
Assume that a music file that stores continuous music resources consists of the following:
Video 1 (address offset: 0, byte length: 100)
Video 2 (address offset: 101; byte length: 50)
Video 3 (address offset: 151, byte length: 150)
1. To play video 1: AVFileDescriptor {fd = resource handle; offset = 0; length = 100; }
2. To play video 2: AVFileDescriptor {fd = resource handle; offset = 101; length = 50; }
3. To play video 3: AVFileDescriptor {fd = resource handle; offset = 151; length = 150; }
To play an independent video file, use **src=fd://xx**.
**Note**:
**Required permissions**: ohos.permission.READ_MEDIA| +| url8+ | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.
**Example of supported URIs**:
1. FD: fd://xx
![](figures/en-us_image_url.png)
2. HTTP: http://xx
3. HTTPS: https://xx
4. HLS: http://xx or https://xx
| +| fdSrc9+ | [AVFileDescriptor](#avfiledescriptor9) | Yes| Yes| Description of a video file. This attribute is required when video resources of an application are continuously stored in a file.
**Example:**
Assume that a music file that stores continuous music resources consists of the following:
Video 1 (address offset: 0, byte length: 100)
Video 2 (address offset: 101; byte length: 50)
Video 3 (address offset: 151, byte length: 150)
1. To play video 1: AVFileDescriptor {fd = resource handle; offset = 0; length = 100; }
2. To play video 2: AVFileDescriptor {fd = resource handle; offset = 101; length = 50; }
3. To play video 3: AVFileDescriptor {fd = resource handle; offset = 151; length = 150; }
To play an independent video file, use **src=fd://xx**.
| | loop8+ | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. | | videoScaleType9+ | [VideoScaleType](#videoscaletype9) | Yes | Yes | Video scale type. | -| audioInterruptMode9+ | [InterruptMode](#interruptmode9) | Yes | Yes | Audio interruption mode. | +| audioInterruptMode9+ | [audio.InterruptMode](js-apis-audio.md#interruptmode9) | Yes | Yes | Audio interruption mode. | | currentTime8+ | number | Yes | No | Current video playback position, in ms. | | duration8+ | number | Yes | No | Video duration, in ms. The value **-1** indicates the live mode. | | state8+ | [VideoPlayState](#videoplaystate8) | Yes | No | Video playback state. | @@ -710,7 +695,7 @@ For details about the video playback demo, see [Video Playback Development](../. setDisplaySurface(surfaceId: string, callback: AsyncCallback\): void -Sets **SurfaceId**. This API uses a callback to return the result. +Sets **SurfaceId**. This API uses an asynchronous callback to return the result. *Note: **SetDisplaySurface** must be called between the URL setting and the calling of **prepare**. A surface must be set for video streams without audio. Otherwise, the calling of **prepare** fails. @@ -726,6 +711,7 @@ Sets **SurfaceId**. This API uses a callback to return the result. **Example** ```js +let surfaceId = null; videoPlayer.setDisplaySurface(surfaceId, (err) => { if (err == null) { console.info('setDisplaySurface success!'); @@ -760,10 +746,11 @@ Sets **SurfaceId**. This API uses a promise to return the result. **Example** ```js +let surfaceId = null; videoPlayer.setDisplaySurface(surfaceId).then(() => { console.info('setDisplaySurface success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -771,7 +758,7 @@ videoPlayer.setDisplaySurface(surfaceId).then(() => { prepare(callback: AsyncCallback\): void -Prepares for video playback. This API uses a callback to return the result. +Prepares for video playback. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -813,7 +800,7 @@ Prepares for video playback. This API uses a promise to return the result. videoPlayer.prepare().then(() => { console.info('prepare success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -821,7 +808,7 @@ videoPlayer.prepare().then(() => { play(callback: AsyncCallback\): void; -Starts to play video resources. This API uses a callback to return the result. +Starts to play video resources. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -863,7 +850,7 @@ Starts to play video resources. This API uses a promise to return the result. videoPlayer.play().then(() => { console.info('play success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -871,7 +858,7 @@ videoPlayer.play().then(() => { pause(callback: AsyncCallback\): void -Pauses video playback. This API uses a callback to return the result. +Pauses video playback. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -913,7 +900,7 @@ Pauses video playback. This API uses a promise to return the result. videoPlayer.pause().then(() => { console.info('pause success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -921,7 +908,7 @@ videoPlayer.pause().then(() => { stop(callback: AsyncCallback\): void -Stops video playback. This API uses a callback to return the result. +Stops video playback. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -963,7 +950,7 @@ Stops video playback. This API uses a promise to return the result. videoPlayer.stop().then(() => { console.info('stop success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -971,7 +958,7 @@ videoPlayer.stop().then(() => { reset(callback: AsyncCallback\): void -Switches the video resource to be played. This API uses a callback to return the result. +Switches the video resource to be played. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1013,7 +1000,7 @@ Switches the video resource to be played. This API uses a promise to return the videoPlayer.reset().then(() => { console.info('reset success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -1021,7 +1008,7 @@ videoPlayer.reset().then(() => { seek(timeMs: number, callback: AsyncCallback\): void -Seeks to the specified playback position. The next key frame at the specified position is played. This API uses a callback to return the result. +Seeks to the specified playback position. The next key frame at the specified position is played. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1049,7 +1036,7 @@ videoPlayer.seek(seekTime, (err, result) => { seek(timeMs: number, mode:SeekMode, callback: AsyncCallback\): void -Seeks to the specified playback position. This API uses a callback to return the result. +Seeks to the specified playback position. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1066,8 +1053,7 @@ Seeks to the specified playback position. This API uses a callback to return the ```js import media from '@ohos.multimedia.media' let seekTime = 5000; -let seekMode = media.SeekMode.SEEK_NEXT_SYNC; -videoPlayer.seek(seekTime, seekMode, (err, result) => { +videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC, (err, result) => { if (err == null) { console.info('seek success!'); } else { @@ -1100,17 +1086,18 @@ Seeks to the specified playback position. If **mode** is not specified, the next **Example** ```js +import media from '@ohos.multimedia.media' let seekTime = 5000; videoPlayer.seek(seekTime).then((seekDoneTime) => { // seekDoneTime indicates the position after the seek operation is complete. console.info('seek success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); -videoPlayer.seek(seekTime, seekMode).then((seekDoneTime) => { +videoPlayer.seek(seekTime, media.SeekMode.SEEK_NEXT_SYNC).then((seekDoneTime) => { console.info('seek success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -1118,7 +1105,7 @@ videoPlayer.seek(seekTime, seekMode).then((seekDoneTime) => { setVolume(vol: number, callback: AsyncCallback\): void -Sets the volume. This API uses a callback to return the result. +Sets the volume. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1166,10 +1153,10 @@ Sets the volume. This API uses a promise to return the result. ```js let vol = 0.5; -videoPlayer.setVolume(vol).then() => { +videoPlayer.setVolume(vol).then(() => { console.info('setVolume success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -1177,7 +1164,7 @@ videoPlayer.setVolume(vol).then() => { release(callback: AsyncCallback\): void -Releases the video playback resource. This API uses a callback to return the result. +Releases the video playback resource. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1216,10 +1203,10 @@ Releases the video playback resource. This API uses a promise to return the resu **Example** ```js -videoPlayer.release().then() => { +videoPlayer.release().then(() => { console.info('release success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -1227,7 +1214,7 @@ videoPlayer.release().then() => { getTrackDescription(callback: AsyncCallback>): void -Obtains the video track information. This API uses a callback to return the result. +Obtains the video track information. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1249,12 +1236,12 @@ function printfDescription(obj) { } videoPlayer.getTrackDescription((error, arrlist) => { - if (arrlist) != null) { + if ((arrlist) != null) { for (let i = 0; i < arrlist.length; i++) { printfDescription(arrlist[i]); } } else { - console.log(`video getTrackDescription fail, error:${error.message}`); + console.log(`video getTrackDescription fail, error:${error}`); } }); ``` @@ -1292,7 +1279,7 @@ videoPlayer.getTrackDescription().then((arrlist) => { console.log('video getTrackDescription fail'); } }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); for (let i = 0; i < arrayDescription.length; i++) { printfDescription(arrayDescription[i]); @@ -1303,7 +1290,7 @@ for (let i = 0; i < arrayDescription.length; i++) { setSpeed(speed:number, callback: AsyncCallback\): void -Sets the video playback speed. This API uses a callback to return the result. +Sets the video playback speed. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoPlayer @@ -1355,10 +1342,10 @@ Sets the video playback speed. This API uses a promise to return the result. import media from '@ohos.multimedia.media' let speed = media.PlaybackSpeed.SPEED_FORWARD_2_00_X; -videoPlayer.setSpeed(speed).then() => { +videoPlayer.setSpeed(speed).then(() => { console.info('setSpeed success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -1414,10 +1401,10 @@ Selects a bit rate from available ones, which can be obtained by calling [availa ```js let bitrate = 1024000; -videoPlayer.selectBitrate(bitrate).then() => { +videoPlayer.selectBitrate(bitrate).then(() => { console.info('selectBitrate success'); }).catch((error) => { - console.info(`video catchCallback, error:${error.message}`); + console.info(`video catchCallback, error:${error}`); }); ``` @@ -1534,9 +1521,7 @@ Subscribes to video playback error events. After an error event is reported, you ```js videoPlayer.on('error', (error) => { // Set the 'error' event callback. - console.info(`video error called, errName is ${error.name}`); // Print the error name. - console.info(`video error called, errCode is ${error.code}`); // Print the error code. - console.info(`video error called, errMessage is ${error.message}`);// Print the detailed description of the error type. + console.info(`video error called, error: ${error}`); }); videoPlayer.url = 'fd://error'; // Set an incorrect URL to trigger the 'error' event. ``` @@ -1619,33 +1604,27 @@ Enumerates the video scale modes. ## MediaDescription8+ -### [key : string] : Object - Defines media information in key-value mode. **System capability**: SystemCapability.Multimedia.Media.Core -| Name | Type | Description | -| ----- | ------ | ------------------------------------------------------------ | -| key | string | Key of the media information. For details about the keys, see [MediaDescriptionKey](#mediadescriptionkey8).| -| value | any | Value of the key. For details about the values, see [MediaDescriptionKey](#mediadescriptionkey8).| - **Example** ```js +import media from '@ohos.multimedia.media' function printfItemDescription(obj, key) { let property = obj[key]; - console.info('audio key is ' + key); - console.info('audio value is ' + property); + console.info('audio key is ' + key); // Specify a key. For details about the keys, see [MediaDescriptionKey]. + console.info('audio value is ' + property); // Obtain the value of the key. The value can be any type. For details about the types, see [MediaDescriptionKey]. } - +let audioPlayer = media.createAudioPlayer(); audioPlayer.getTrackDescription((error, arrlist) => { if (arrlist != null) { for (let i = 0; i < arrlist.length; i++) { - printfItemDescription(arrlist[i], MD_KEY_TRACK_TYPE); // Print the MD_KEY_TRACK_TYPE value of each track. + printfItemDescription(arrlist[i], media.MediaDescriptionKey.MD_KEY_TRACK_TYPE); // Print the MD_KEY_TRACK_TYPE value of each track. } } else { - console.log(`audio getTrackDescription fail, error:${error.message}`); + console.log(`audio getTrackDescription fail, error:${error}`); } }); ``` @@ -1808,15 +1787,15 @@ Subscribes to the audio recording events. | Name | Type | Mandatory| Description | | -------- | -------- | ---- | ------------------------------------------------------------ | -| type | string | Yes | Event type. The following events are supported:
- 'prepare': triggered when the [prepare](#audiorecorder_prepare) API is called and the audio recording parameters are set.
- 'start': triggered when the [start](#audiorecorder_start) API is called and audio recording starts.
- 'pause': triggered when the [pause](#audiorecorder_pause) API is called and audio recording is paused.
- 'resume': triggered when the [resume](#audiorecorder_resume) API is called and audio recording is resumed.
- 'stop': triggered when the [stop](#audiorecorder_stop) API is called and audio recording stops.
- 'release': triggered when the [release](#audiorecorder_release) API is called and the recording resource is released.
- 'reset': triggered when the [reset](#audiorecorder_reset) API is called and audio recording is reset. | +| type | string | Yes | Event type. The following events are supported:
- 'prepare': triggered when the [prepare](#audiorecorder_prepare) API is called and the audio recording parameters are set.
- 'start': triggered when the [start](#audiorecorder_start) API is called and audio recording starts.
- 'pause': triggered when the [pause](#audiorecorder_pause) API is called and audio recording is paused.
- 'resume': triggered when the [resume](#audiorecorder_resume) API is called and audio recording is resumed.
- 'stop': triggered when the [stop](#audiorecorder_stop) API is called and audio recording stops.
- 'release': triggered when the [release](#audiorecorder_release) API is called and the recording resource is released.
- 'reset': triggered when the [reset](#audiorecorder_reset) API is called and audio recording is reset.| | callback | ()=>void | Yes | Callback invoked when the event is triggered. | **Example** ```js -let audiorecorder = media.createAudioRecorder(); // Create an AudioRecorder instance. +let audioRecorder = media.createAudioRecorder(); // Create an AudioRecorder instance. let audioRecorderConfig = { - audioEncoder : media.AudioEncoder.AAC_LC, , + audioEncoder : media.AudioEncoder.AAC_LC, audioEncodeBitRate : 22050, audioSampleRate : 22050, numberOfChannels : 2, @@ -1825,9 +1804,7 @@ let audioRecorderConfig = { location : { latitude : 30, longitude : 130}, } audioRecorder.on('error', (error) => { // Set the 'error' event callback. - console.info(`audio error called, errName is ${error.name}`); - console.info(`audio error called, errCode is ${error.code}`); - console.info(`audio error called, errMessage is ${error.message}`); + console.info(`audio error called, error: ${error}`); }); audioRecorder.on('prepare', () => { // Set the 'prepare' event callback. console.log('prepare success'); @@ -1872,12 +1849,19 @@ Subscribes to audio recording error events. After an error event is reported, yo **Example** ```js +let audioRecorderConfig = { + audioEncoder : media.AudioEncoder.AAC_LC, + audioEncodeBitRate : 22050, + audioSampleRate : 22050, + numberOfChannels : 2, + format : media.AudioOutputFormat.AAC_ADTS, + uri : 'fd://xx', // The file must be created by the caller and granted with proper permissions. + location : { latitude : 30, longitude : 130}, +} audioRecorder.on('error', (error) => { // Set the 'error' event callback. - console.info(`audio error called, errName is ${error.name}`); // Print the error name. - console.info(`audio error called, errCode is ${error.code}`); // Print the error code. - console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type. + console.info(`audio error called, error: ${error}`); }); -audioRecorder.prepare(); // Do no set any parameter in prepare and trigger the 'error' event callback. +audioRecorder.prepare(audioRecorderConfig); // Do no set any parameter in prepare and trigger the 'error' event callback. ``` ## AudioRecorderConfig @@ -1951,7 +1935,7 @@ For details about the video recording demo, see [Video Recording Development](.. prepare(config: VideoRecorderConfig, callback: AsyncCallback\): void; -Sets video recording parameters in asynchronous mode. This API uses a callback to return the result. +Sets video recording parameters. This API uses an asynchronous callback to return the result. **Required permissions:** ohos.permission.MICROPHONE @@ -1990,36 +1974,20 @@ let videoConfig = { } // asyncallback -let videoRecorder = null; -let events = require('events'); -let eventEmitter = new events.EventEmitter(); - -eventEmitter.on('prepare', () => { - videoRecorder.prepare(videoConfig, (err) => { - if (err == null) { - console.info('prepare success'); - } else { - console.info('prepare failed and error is ' + err.message); - } - }); -}); - -media.createVideoRecorder((err, recorder) => { - if (err == null && recorder != null) { - videoRecorder = recorder; - console.info('createVideoRecorder success'); - eventEmitter.emit('prepare'); // Trigger the 'prepare' event. +videoRecorder.prepare(videoConfig, (err) => { + if (err == null) { + console.info('prepare success'); } else { - console.info('createVideoRecorder failed and error is ' + err.message); + console.info('prepare failed and error is ' + err.message); } -}); +}) ``` ### prepare9+ prepare(config: VideoRecorderConfig): Promise\; -Sets video recording parameters in asynchronous mode. This API uses a promise to return the result. +Sets video recording parameters. This API uses a promise to return the result. **Required permissions:** ohos.permission.MICROPHONE @@ -2063,18 +2031,6 @@ let videoConfig = { } // promise -let videoRecorder = null; -media.createVideoRecorder().then((recorder) => { - if (recorder != null) { - videoRecorder = recorder; - console.info('createVideoRecorder success'); - } else { - console.info('createVideoRecorder failed'); - } -}).catch((err) => { - console.info('catch err error message is ' + err.message); -}); - videoRecorder.prepare(videoConfig).then(() => { console.info('prepare success'); }).catch((err) => { @@ -2150,7 +2106,7 @@ videoRecorder.getInputSurface().then((surfaceId) => { start(callback: AsyncCallback\): void; -Starts video recording in asynchronous mode. This API uses a callback to return the result. +Starts video recording. This API uses an asynchronous callback to return the result. This API can be called only after [prepare()](#videorecorder_prepare1) and [getInputSurface()](#getinputsurface9) are called, because the data source must pass data to the surface first. @@ -2179,7 +2135,7 @@ videoRecorder.start((err) => { start(): Promise\; -Starts video recording in asynchronous mode. This API uses a promise to return the result. +Starts video recording. This API uses a promise to return the result. This API can be called only after [prepare()](#videorecorder_prepare1) and [getInputSurface()](#getinputsurface9) are called, because the data source must pass data to the surface first. @@ -2206,7 +2162,7 @@ videoRecorder.start().then(() => { pause(callback: AsyncCallback\): void; -Pauses video recording in asynchronous mode. This API uses a callback to return the result. +Pauses video recording. This API uses an asynchronous callback to return the result. This API can be called only after [start()](#videorecorder_start1) is called. You can resume recording by calling [resume()](#videorecorder_resume1). @@ -2235,7 +2191,7 @@ videoRecorder.pause((err) => { pause(): Promise\; -Pauses video recording in asynchronous mode. This API uses a promise to return the result. +Pauses video recording. This API uses a promise to return the result. This API can be called only after [start()](#videorecorder_start1) is called. You can resume recording by calling [resume()](#videorecorder_resume1). @@ -2262,7 +2218,7 @@ videoRecorder.pause().then(() => { resume(callback: AsyncCallback\): void; -Resumes video recording in asynchronous mode. This API uses a callback to return the result. +Resumes video recording. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoRecorder @@ -2289,7 +2245,7 @@ videoRecorder.resume((err) => { resume(): Promise\; -Resumes video recording in asynchronous mode. This API uses a promise to return the result. +Resumes video recording. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoRecorder @@ -2314,7 +2270,7 @@ videoRecorder.resume().then(() => { stop(callback: AsyncCallback\): void; -Stops video recording in asynchronous mode. This API uses a callback to return the result. +Stops video recording. This API uses an asynchronous callback to return the result. To start another recording, you must call [prepare()](#videorecorder_prepare1) and [getInputSurface()](#getinputsurface9) again. @@ -2343,7 +2299,7 @@ videoRecorder.stop((err) => { stop(): Promise\; -Stops video recording in asynchronous mode. This API uses a promise to return the result. +Stops video recording. This API uses a promise to return the result. To start another recording, you must call [prepare()](#videorecorder_prepare1) and [getInputSurface()](#getinputsurface9) again. @@ -2370,7 +2326,7 @@ videoRecorder.stop().then(() => { release(callback: AsyncCallback\): void; -Releases the video recording resource in asynchronous mode. This API uses a callback to return the result. +Releases the video recording resource. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoRecorder @@ -2397,7 +2353,7 @@ videoRecorder.release((err) => { release(): Promise\; -Releases the video recording resource in asynchronous mode. This API uses a promise to return the result. +Releases the video recording resource. This API uses a promise to return the result. **System capability**: SystemCapability.Multimedia.Media.VideoRecorder @@ -2422,7 +2378,7 @@ videoRecorder.release().then(() => { reset(callback: AsyncCallback\): void; -Resets video recording in asynchronous mode. This API uses a callback to return the result. +Resets video recording. This API uses an asynchronous callback to return the result. To start another recording, you must call [prepare()](#videorecorder_prepare1) and [getInputSurface()](#getinputsurface9) again. @@ -2451,7 +2407,7 @@ videoRecorder.reset((err) => { reset(): Promise\; -Resets video recording in asynchronous mode. This API uses a promise to return the result. +Resets video recording. This API uses a promise to return the result. To start another recording, you must call [prepare()](#videorecorder_prepare1) and [getInputSurface()](#getinputsurface9) again. @@ -2492,12 +2448,10 @@ Subscribes to video recording error events. After an error event is reported, yo **Example** ```js -videoRecorder.on('error', (error) => { // Set the 'error' event callback. - console.info(`audio error called, errName is ${error.name}`); // Print the error name. - console.info(`audio error called, errCode is ${error.code}`); // Print the error code. - console.info(`audio error called, errMessage is ${error.message}`); // Print the detailed description of the error type. -}); // This event is reported when an error occurs during the retrieval of videoRecordState. +videoRecorder.on('error', (error) => { // Set the 'error' event callback. + console.info(`audio error called, error: ${error}`); +}) ``` ## VideoRecordState9+ @@ -2528,7 +2482,7 @@ Describes the video recording parameters. | profile | [VideoRecorderProfile](#videorecorderprofile9) | Yes | Video recording profile. | | rotation | number | No | Rotation angle of the recorded video. | | location | [Location](#location) | No | Geographical location of the recorded video. | -| url | string | Yes | Video output URL. Supported: fd://xx (fd number)
![](figures/en-us_image_url.png)
**Required permissions**: ohos.permission.READ_MEDIA| +| url | string | Yes | Video output URL. Supported: fd://xx (fd number)
![](figures/en-us_image_url.png) | ## AudioSourceType9+ diff --git a/en/application-dev/reference/apis/js-apis-medialibrary.md b/en/application-dev/reference/apis/js-apis-medialibrary.md index b66eeec85c124ac083b27859849a86e1a5f1d4c2..2887044269488b47e2a4f434447b43d617a16f05 100644 --- a/en/application-dev/reference/apis/js-apis-medialibrary.md +++ b/en/application-dev/reference/apis/js-apis-medialibrary.md @@ -2,10 +2,10 @@ > **NOTE** > -> This component is supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version. +> The APIs of this module are supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version. ## Modules to Import -``` +```js import mediaLibrary from '@ohos.multimedia.mediaLibrary'; ``` @@ -33,17 +33,18 @@ This API can be used only in the stage model. **Example (from API version 9)** -``` -var media = mediaLibrary.getMediaLibrary(this.context); +```ts +const context = getContext(this); +let media = mediaLibrary.getMediaLibrary(context); ``` **Example (API version 8)** -``` +```js import featureAbility from '@ohos.ability.featureAbility'; -var context = featureAbility.getContext() -var media = mediaLibrary.getMediaLibrary(context); +let context = featureAbility.getContext(); +let media = mediaLibrary.getMediaLibrary(context); ``` ## mediaLibrary.getMediaLibrary @@ -68,7 +69,7 @@ This API can be used only in the FA model. **Example** ```js -var media = mediaLibrary.getMediaLibrary(); +let media = mediaLibrary.getMediaLibrary(); ``` ## MediaLibrary @@ -93,24 +94,45 @@ Obtains file assets (also called files). This API uses an asynchronous callback **Example** -``` -let fileKeyObj = mediaLibrary.FileKey -let imageType = mediaLibrary.MediaType.IMAGE -let imagesfetchOp = { +```js +let fileKeyObj = mediaLibrary.FileKey; +let imageType = mediaLibrary.MediaType.IMAGE; +let imagesFetchOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], }; -media.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { - if (fetchFileResult != undefined) { - console.info('mediaLibraryTest : ASSET_CALLBACK fetchFileResult success'); - fetchFileResult.getAllObject((err, fileAssetList) => { - if (fileAssetList != undefined) { - fileAssetList.forEach(function(getAllObjectInfo){ - console.info("getAllObjectInfo.displayName :" + getAllObjectInfo.displayName); - }); - } - }); +media.getFileAssets(imagesFetchOp, (error, fetchFileResult) => { + if (fetchFileResult == undefined) { + console.error('Failed to get fetchFileResult: ' + error); + return; } + const count = fetchFileResult.getCount(); + if (count < 0) { + console.error('Failed to get count from fetchFileResult: count: ' + count); + return; + } + if (count == 0) { + console.info('The count of fetchFileResult is zero'); + return; + } + + console.info('Get fetchFileResult success, count: ' + count); + fetchFileResult.getFirstObject((err, fileAsset) => { + if (fileAsset == undefined) { + console.error('Failed to get first object: ' + err); + return; + } + console.log('fileAsset.displayName ' + ': ' + fileAsset.displayName); + for (let i = 1; i < count; i++) { + fetchFileResult.getNextObject((err, fileAsset) => { + if (fileAsset == undefined) { + console.error('Failed to get next object: ' + err); + return; + } + console.log('fileAsset.displayName ' + i + ': ' + fileAsset.displayName); + }) + } + }); }); ``` ### getFileAssets7+ @@ -137,17 +159,38 @@ Obtains file assets. This API uses a promise to return the result. **Example** -``` -let fileKeyObj = mediaLibrary.FileKey -let imageType = mediaLibrary.MediaType.IMAGE -let imagesfetchOp = { +```js +let fileKeyObj = mediaLibrary.FileKey; +let imageType = mediaLibrary.MediaType.IMAGE; +let imagesFetchOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], }; -media.getFileAssets(imagesfetchOp).then(function(fetchFileResult){ - console.info("getFileAssets successfully: image number is "+ fetchFileResult.getCount()); +media.getFileAssets(imagesFetchOp).then(function(fetchFileResult) { + const count = fetchFileResult.getCount(); + if (count < 0) { + console.error('Failed to get count from fetchFileResult: count: ' + count); + return; + } + if (count == 0) { + console.info('The count of fetchFileResult is zero'); + return; + } + console.info('Get fetchFileResult success, count: ' + count); + fetchFileResult.getFirstObject().then(function(fileAsset) { + console.log('fileAsset.displayName ' + ': ' + fileAsset.displayName); + for (let i = 1; i < count; i++) { + fetchFileResult.getNextObject().then(function(fileAsset) { + console.log('fileAsset.displayName ' + ': ' + fileAsset.displayName); + }).catch(function(err) { + console.error('Failed to get next object: ' + err); + }) + } + }).catch(function(err) { + console.error('Failed to get first object: ' + err); + }); }).catch(function(err){ - console.info("getFileAssets failed with error:"+ err); + console.error("Failed to get file assets: " + err); }); ``` @@ -168,7 +211,7 @@ Subscribes to the media library changes. This API uses an asynchronous callback **Example** -``` +```js media.on('imageChange', () => { // image file had changed, do something }) @@ -190,13 +233,13 @@ Unsubscribes from the media library changes. This API uses an asynchronous callb **Example** -``` +```js media.off('imageChange', () => { // stop listening success }) ``` -### createAsset 8+ +### createAsset8+ createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void @@ -217,7 +260,7 @@ Creates a media asset. This API uses an asynchronous callback to return the resu **Example** -``` +```js async function example() { // Create an image file in callback mode. let mediaType = mediaLibrary.MediaType.IMAGE; @@ -259,7 +302,7 @@ Creates a media asset. This API uses a promise to return the result. **Example** -``` +```js let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; media.getPublicDirectory(DIR_CAMERA).then(function(dicResult){ console.info("getPublicDirectory successfully:"+ JSON.stringify(dicResult)); @@ -268,6 +311,101 @@ media.getPublicDirectory(DIR_CAMERA).then(function(dicResult){ }); ``` +### deleteAsset8+ + +deleteAsset(uri: string): Promise\ + +Deletes a file asset. This API uses a promise to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA + +**System capability**: SystemCapability.Multimedia.MediaLibrary.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ---------------------------- | ---- | --------------- | +| uri | string | Yes | URI of the file asset to delete.| + +**Return value** +| Type | Description | +| ------------------- | -------------------- | +| Promise<void> | Promise used to return the result.| + +**Example** + +```js +async function example() { + let fileKeyObj = mediaLibrary.FileKey; + let fileType = mediaLibrary.MediaType.FILE; + let option = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [fileType.toString()], + }; + const context = getContext(this); + var media = mediaLibrary.getMediaLibrary(context); + const fetchFileResult = await media.getFileAssets(option); + let asset = await fetchFileResult.getFirstObject(); + if (asset == undefined) { + console.error('asset not exist') + return + } + media.deleteAsset(asset.uri).then(() => { + console.info("deleteAsset successfully"); + }).catch((err) => { + console.info("deleteAsset failed with error:"+ err); + }); +} +``` + +### deleteAsset8+ +deleteAsset(uri: string, callback: AsyncCallback\): void + +Deletes a file asset. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA + +**System capability**: SystemCapability.Multimedia.MediaLibrary.Core + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ---------------------------- | ---- | --------------- | +| uri | string | Yes | URI of the file asset to delete.| +|callback |AsyncCallback\| Yes |Callback used to return the result.| + +**Example** + +```js +async function example() { + let fileKeyObj = mediaLibrary.FileKey; + let fileType = mediaLibrary.MediaType.FILE; + let option = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [fileType.toString()], + }; + const context = getContext(this); + var media = mediaLibrary.getMediaLibrary(context); + const fetchFileResult = await media.getFileAssets(option); + let asset = await fetchFileResult.getFirstObject(); + if (asset == undefined) { + console.error('asset not exist') + return + } + media.deleteAsset(asset.uri, (err) => { + if (err != undefined) { + console.info("deleteAsset successfully"); + } else { + console.info("deleteAsset failed with error:"+ err); + } + }); +} +``` + ### getPublicDirectory8+ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void @@ -285,7 +423,7 @@ Obtains a public directory. This API uses an asynchronous callback to return the **Example** -``` +```js let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => { if (dicResult == 'Camera/') { @@ -318,7 +456,7 @@ Obtains a public directory. This API uses a promise to return the result. **Example** -``` +```js async function example() { let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); @@ -349,7 +487,7 @@ Obtains the albums. This API uses an asynchronous callback to return the result. **Example** -``` +```js let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], @@ -389,7 +527,7 @@ Obtains the albums. This API uses a promise to return the result. **Example** -``` +```js let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], @@ -418,7 +556,7 @@ Call this API when you no longer need to use the APIs in the **MediaLibrary** in **Example** -``` +```js var media = mediaLibrary.getMediaLibrary(context); media.release((err) => { // do something @@ -442,7 +580,7 @@ Call this API when you no longer need to use the APIs in the **MediaLibrary** in **Example** -``` +```js media.release() ``` @@ -467,7 +605,7 @@ Stores a media asset. This API uses an asynchronous callback to return the URI t **Example** - ``` +```js let option = { src : "/data/storage/el2/base/haps/entry/image.png", mimeType : "image/*", @@ -481,7 +619,7 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => { console.log("Media asset stored."); // Obtain the URI that stores the media asset. }); - ``` +``` ### storeMediaAsset(deprecated) @@ -510,7 +648,7 @@ Stores a media asset. This API uses a promise to return the URI that stores the **Example** - ``` +```js let option = { src : "/data/storage/el2/base/haps/entry/image.png", mimeType : "image/*", @@ -522,7 +660,7 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => { }).catch((err) => { console.log("An error occurred when storing the media assets."); }); - ``` +``` ### startImagePreview(deprecated) @@ -547,7 +685,7 @@ Starts image preview, with the first image to preview specified. This API can be **Example** - ``` +```js let images = [ "dataability:///media/xxxx/2", "dataability:///media/xxxx/3" @@ -566,7 +704,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => { } console.log("Succeeded in previewing the images."); }); - ``` +``` ### startImagePreview(deprecated) @@ -590,7 +728,7 @@ Starts image preview. This API can be used to preview local images whose URIs st **Example** - ``` +```js let images = [ "dataability:///media/xxxx/2", "dataability:///media/xxxx/3" @@ -608,7 +746,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => { } console.log("Succeeded in previewing the images."); }); - ``` +``` ### startImagePreview(deprecated) @@ -638,7 +776,7 @@ Starts image preview, with the first image to preview specified. This API can be **Example** - ``` +```js let images = [ "dataability:///media/xxxx/2", "dataability:///media/xxxx/3" @@ -655,7 +793,7 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => { }).catch((err) => { console.log("An error occurred when previewing the images."); }); - ``` +``` ### startMediaSelect(deprecated) @@ -674,13 +812,13 @@ Starts media selection. This API uses an asynchronous callback to return the lis | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------------------------------ | -| option | [MediaSelectOption](#mediaselectoption) | Yes | Media selection option. | +| option | [MediaSelectOption](#mediaselectoptiondeprecated) | Yes | Media selection option. | | callback | AsyncCallback<Array<string>> | Yes | Callback used to return the list of URIs (starting with **dataability://**) that store the selected media assets.| **Example** - ``` -let option = { +```js +let option : mediaLibrary.MediaSelectOption = { type : "media", count : 2 }; @@ -692,7 +830,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => { console.log("Media asset selected."); // Obtain the media selection value. }); - ``` +``` ### startMediaSelect(deprecated) @@ -711,7 +849,7 @@ Starts media selection. This API uses a promise to return the list of URIs that | Name | Type | Mandatory | Description | | ------ | --------------------------------------- | ---- | ------- | -| option | [MediaSelectOption](#mediaselectoption) | Yes | Media selection option.| +| option | [MediaSelectOption](#mediaselectoptiondeprecated) | Yes | Media selection option.| **Return value** @@ -721,8 +859,8 @@ Starts media selection. This API uses a promise to return the list of URIs that **Example** - ``` -let option = { +```js +let option : mediaLibrary.MediaSelectOption = { type : "media", count : 2 }; @@ -733,7 +871,155 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { console.log("An error occurred when selecting the media assets."); }); - ``` +``` +### getActivePeers8+ + +getActivePeers(): Promise\>; + +Obtains information about online peer devices. This API uses a promise to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.READ_MEDIA + +**System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore + +**Return value** + +| Type | Description | +| ------------------- | -------------------- | +| Promise\> | Promise used to return the online peer devices, in an array of **PeerInfo** objects.| + +**Example** + +```js +async function example() { + const context = getContext(this); + var media = mediaLibrary.getMediaLibrary(context); + media.getActivePeers().then((devicesInfo) => { + if (devicesInfo != undefined) { + for (let i = 0; i < devicesInfo.length; i++) { + console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId); + } + } else { + console.info('get distributed info is undefined!') + } + }).catch((err) => { + console.info("get distributed info failed with error:" + err); + }); +} +``` + +### getActivePeers8+ + +getActivePeers(callback: AsyncCallback\>): void; + +Obtains information about online peer devices. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.READ_MEDIA + +**System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore + +**Return value** + +| Type | Description | +| ------------------- | -------------------- | +| callback: AsyncCallback\> | Promise used to return the online peer devices, in an array of **PeerInfo** objects.| + +**Example** + +```js +async function example() { + const context = getContext(this); + var media = mediaLibrary.getMediaLibrary(context); + media.getActivePeers((err, devicesInfo) => { + if (devicesInfo != undefined) { + for (let i = 0; i < devicesInfo.length; i++) { + console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId); + } + } else { + console.info('get distributed fail, message = ' + err) + } + }) +} +``` + + +### getAllPeers8+ + +getAllPeers(): Promise\>; + +Obtains information about all peer devices. This API uses a promise to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.READ_MEDIA + +**System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore + +**Return value** + +| Type | Description | +| ------------------- | -------------------- | +| Promise\> | Promise used to return all peer devices, in an array of **PeerInfo** objects.| + +**Example** + +```js +async function example() { + const context = getContext(this); + var media = mediaLibrary.getMediaLibrary(context); + media.getAllPeers().then((devicesInfo) => { + if (devicesInfo != undefined) { + for (let i = 0; i < devicesInfo.length; i++) { + console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId); + } + } else { + console.info('get distributed info is undefined!') + } + }).catch((err) => { + console.info("get distributed info failed with error:" + err); + }); +} +``` + +### getAllPeers8+ + +getAllPeers(callback: AsyncCallback\>): void; + +Obtains information about online peer devices. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. + +**Required permissions**: ohos.permission.READ_MEDIA + +**System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore + +**Return value** + +| Type | Description | +| ------------------- | -------------------- | +| callback: AsyncCallback\> | Promise used to return all peer devices, in an array of **PeerInfo** objects.| + +**Example** + +```js +async function example() { + const context = getContext(this); + var media = mediaLibrary.getMediaLibrary(context); + media.getAllPeers((err, devicesInfo) => { + if (devicesInfo != undefined) { + for (let i = 0; i < devicesInfo.length; i++) { + console.info('get distributed info ' + devicesInfo[i].deviceName + devicesInfo[i].networkId); + } + } else { + console.info('get distributed fail, message = ' + err) + } + }) +} +``` ## FileAsset7+ @@ -786,7 +1072,7 @@ Checks whether this file asset is a directory. This API uses an asynchronous cal **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -822,7 +1108,7 @@ Checks whether this file asset is a directory. This API uses a promise to return **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -860,7 +1146,7 @@ Commits the modification in this file asset to the database. This API uses an as **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -897,7 +1183,7 @@ Commits the modification in this file asset to the database. This API uses a pro **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -937,7 +1223,7 @@ Opens this file asset. This API uses an asynchronous callback to return the resu **Example** -``` +```js async function example() { let mediaType = mediaLibrary.MediaType.IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; @@ -981,7 +1267,7 @@ Opens this file asset. This API uses a promise to return the result. **Example** -``` +```js async function example() { let mediaType = mediaLibrary.MediaType.IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; @@ -1016,7 +1302,7 @@ Closes this file asset. This API uses an asynchronous callback to return the res **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -1032,7 +1318,7 @@ async function example() { console.info('File fd!' + fd); asset.close(fd, (closeErr) => { if (closeErr != undefined) { - console.info('mediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('mediaLibraryTest : close : FAIL ' + closeErr); console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL'); } else { console.info("=======asset.close success====>"); @@ -1069,7 +1355,7 @@ Closes this file asset. This API uses a promise to return the result. **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -1085,7 +1371,7 @@ async function example() { console.info('File fd!' + fd); asset.close(fd).then((closeErr) => { if (closeErr != undefined) { - console.info('mediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('mediaLibraryTest : close : FAIL ' + closeErr); console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL'); } else { @@ -1117,7 +1403,7 @@ Obtains the thumbnail of this file asset. This API uses an asynchronous callback **Example** -``` +```js async function example() { let fileKeyObj = mediaLibrary.FileKey let imageType = mediaLibrary.MediaType.IMAGE; @@ -1130,7 +1416,7 @@ async function example() { const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.getThumbnail((err, pixelmap) => { - console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap); + console.info('mediaLibraryTest : getThumbnail Successful '+ pixelmap); }); } ``` @@ -1154,9 +1440,9 @@ Obtains the thumbnail of this file asset, with the thumbnail size passed. This A **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1168,7 +1454,7 @@ async function example() { const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.getThumbnail(size, (err, pixelmap) => { - console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap); + console.info('mediaLibraryTest : getThumbnail Successful '+ pixelmap); }); } ``` @@ -1197,9 +1483,9 @@ Obtains the thumbnail of this file asset, with the thumbnail size passed. This A **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1212,7 +1498,7 @@ async function example() { const asset = await fetchFileResult.getFirstObject(); asset.getThumbnail(size) .then((pixelmap) => { - console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap); + console.info('mediaLibraryTest : getThumbnail Successful '+ pixelmap); }) .catch((err) => { console.info('mediaLibraryTest : getThumbnail fail'+ err); @@ -1239,9 +1525,9 @@ Favorites or unfavorites this file asset. This API uses an asynchronous callback **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1281,9 +1567,9 @@ Favorites or unfavorites this file asset. This API uses a promise to return the **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1319,9 +1605,9 @@ Checks whether this file asset is favorited. This API uses an asynchronous callb **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1359,9 +1645,9 @@ Checks whether this file asset is favorited. This API uses a promise to return t **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1400,9 +1686,9 @@ Files in the trash are not actually deleted. You can set **isTrash** to **false* **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1445,9 +1731,9 @@ Files in the trash are not actually deleted. You can set **isTrash** to **false* **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1483,9 +1769,9 @@ Checks whether this file asset is in the trash. This API uses an asynchronous ca **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1495,18 +1781,13 @@ async function example() { }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); - asset.isTrash(isTrashCallBack); - function isTrashCallBack(err, isTrash) { - if (isTrash == true) { - console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); - asset.trash(true, istrashCallBack); - - } else { - console.info('mediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); - console.info('mediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); - - } - } + asset.isTrash((err, isTrash) => { + if (isTrash == undefined) { + console.error('Failed to get trash state: ' + err); + return; + } + console.info('Get trash state success: ' + isTrash); + }); } ``` @@ -1528,22 +1809,21 @@ Checks whether this file asset is in the trash. This API uses a promise to retur **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], order: fileKeyObj.DATE_ADDED + " DESC", - extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.isTrash().then(function(isTrash){ - console.info("isTrash result:"+ isTrash); + console.info("isTrash result: " + isTrash); }).catch(function(err){ - console.info("isTrash failed with error:"+ err); + console.error("isTrash failed with error: " + err); }); } ``` @@ -1568,9 +1848,9 @@ Obtains the total number of files in the result set. **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let fileType = mediaLibrary.MediaType.FILE; let getFileCountOneOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1599,9 +1879,9 @@ Checks whether the cursor is in the last row of the result set. **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1637,9 +1917,9 @@ Releases and invalidates this **FetchFileResult** instance. Other APIs in this i **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1668,9 +1948,9 @@ Obtains the first file asset in the result set. This API uses an asynchronous ca **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1705,9 +1985,9 @@ Obtains the first file asset in the result set. This API uses a promise to retur **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1736,13 +2016,13 @@ Obtains the next file asset in the result set. This API uses an asynchronous cal | Name | Type | Mandatory| Description | | --------- | --------------------------------------------- | ---- | ----------------------------------------- | -| callbacke | AsyncCallback<[FileAsset](#fileasset7)> | Yes | Callback used to return the next file asset.| +| callback | AsyncCallback<[FileAsset](#fileasset7)> | Yes | Callback used to return the next file asset.| **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1777,9 +2057,9 @@ Obtains the next file asset in the result set. This API uses a promise to return **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1810,9 +2090,9 @@ Obtains the last file asset in the result set. This API uses an asynchronous cal **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1847,9 +2127,9 @@ Obtains the last file asset in the result set. This API uses a promise to return **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1879,9 +2159,9 @@ Obtains a file asset with the specified index in the result set. This API uses a **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1922,9 +2202,9 @@ Obtains a file asset with the specified index in the result set. This API uses a **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1934,9 +2214,9 @@ async function example() { }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getPositionObject(1) .then(function (fileAsset){ - console.log('[Demo] fileAsset.displayName : ' + fileAsset.displayName); + console.log('fileAsset.displayName : ' + fileAsset.displayName); }).catch(function (err) { - console.info("[Demo] getFileAssets failed with error:" + err); + console.info("getFileAssets failed with error:" + err); }); } ``` @@ -1957,9 +2237,9 @@ Obtains all the file assets in the result set. This API uses an asynchronous cal **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1969,11 +2249,13 @@ async function example() { }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getAllObject((err, fileAsset) => { - if (err) { + if (err) { console.error('Failed '); return; - } - console.log('fileAsset.displayName : ' + fileAsset.displayName); + } + for (let i = 0; i < fetchFileResult.getCount(); i++) { + console.log('fileAsset.displayName : ' + fileAsset[i].displayName); + } }) } ``` @@ -1994,9 +2276,9 @@ Obtains all the file assets in the result set. This API uses a promise to return **Example** -``` +```js async function example() { - let fileKeyObj = mediaLibrary.FileKey + let fileKeyObj = mediaLibrary.FileKey; let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -2045,7 +2327,7 @@ Commits the modification in the album attributes to the database. This API uses **Example** -``` +```js async function example() { let AlbumNoArgsfetchOp = { selections: '', @@ -2082,7 +2364,7 @@ Commits the modification in the album attributes to the database. This API uses **Example** -``` +```js async function example() { let AlbumNoArgsfetchOp = { selections: '', @@ -2118,7 +2400,7 @@ Obtains the file assets in this album. This API uses an asynchronous callback to **Example** -``` +```js async function example() { let AlbumNoArgsfetchOp = { selections: '', @@ -2161,7 +2443,7 @@ Obtains the file assets in this album. This API uses a promise to return the res **Example** -``` +```js async function example() { let AlbumNoArgsfetchOp = { selections: '', @@ -2170,7 +2452,7 @@ async function example() { let fileNoArgsfetchOp = { selections: '', selectionArgs: [], - } + }; const albumList = await media.getAlbums(AlbumNoArgsfetchOp); const album = albumList[0]; album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ @@ -2184,7 +2466,8 @@ async function example() { ## PeerInfo8+ Describes information about a registered device. -This is a system API. + +**System API**: This is a system API. **System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -2256,7 +2539,8 @@ Enumerates directory types. ## DeviceType8+ Enumerates device types. -This is a system API. + +**System API**: This is a system API. **System capability**: SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -2280,7 +2564,7 @@ Describes options for fetching media files. | ----------------------- | ------------------- | ---- | ---- | ---- | ------------------------------------------------------------ | | selections | string | Yes | Yes | Yes | Conditions for fetching files. The enumerated values in [FileKey](#filekey8) are used as the column names of the conditions. Example:
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR ' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?', | | selectionArgs | Array<string> | Yes | Yes | Yes | Value of the condition, which corresponds to the value of the condition column in **selections**.
Example:
selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], | -| order | string | Yes | Yes | No | Sorting mode of the search results, which can be ascending or descending. The enumerated values in [FileKey](#filekey8) are used as the columns for sorting the search results. Example:
Ascending: order: mediaLibrary.FileKey.DATE_ADDED + " ASC"
Descending: order: mediaLibrary.FileKey.DATE_ADDED + " DESC" | +| order | string | Yes | Yes | No | Sorting mode of the search results, which can be ascending or descending. The enumerated values in [FileKey](#filekey8) are used as the columns for sorting the search results. Example:
Ascending: order: mediaLibrary.FileKey.DATE_ADDED + " ASC"
Descending: order: mediaLibrary.FileKey.DATE_ADDED + " DESC"| | uri8+ | string | Yes | Yes | No | File URI. | | networkId8+ | string | Yes | Yes | No | Network ID of the registered device. | | extendArgs8+ | string | Yes | Yes | No | Extended parameters for fetching the files. Currently, no extended parameters are available. | @@ -2288,6 +2572,7 @@ Describes options for fetching media files. ## Size8+ Describes the image size. + **System capability**: SystemCapability.Multimedia.MediaLibrary.Core | Name | Type | Readable | Writable | Description | diff --git a/en/application-dev/reference/apis/js-apis-nfcTag.md b/en/application-dev/reference/apis/js-apis-nfcTag.md index 01315a62d6aecacea806cdecebc268ed1f571c84..5941d465a085a425ef7d10cb28d5fe4b621bc0b2 100644 --- a/en/application-dev/reference/apis/js-apis-nfcTag.md +++ b/en/application-dev/reference/apis/js-apis-nfcTag.md @@ -1,4 +1,4 @@ -# Standard NFC Tag +# NFC Tags The **nfcTag** module provides methods for managing Near-Field Communication (NFC) tags. diff --git a/en/application-dev/reference/apis/js-apis-nfctech.md b/en/application-dev/reference/apis/js-apis-nfctech.md index eb7d01dda3b5bcf8c88a45981d661aacf6d4e4f4..d471510aeec29a3fce389284a54866a55b1ca507 100644 --- a/en/application-dev/reference/apis/js-apis-nfctech.md +++ b/en/application-dev/reference/apis/js-apis-nfctech.md @@ -1,9 +1,8 @@ -# Standard NFC Tag Technologies +# NFC Tag Technologies -The **nfctech** module provides methods for reading and writing tags that use different Near-Field Communication (NFC) technologies. +The **nfctech** module provides APIs for reading and writing tags that use different Near-Field Communication (NFC) technologies. > **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** @@ -14,7 +13,7 @@ import tag from '@ohos.nfc.tag'; ## NfcATag -Provides access to NFC-A (ISO 14443-3A) properties and I/O operations. **NfcATag** inherits from **TagSession**. +Provides access to NFC-A (ISO 14443-3A) properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -74,7 +73,7 @@ console.log("atqa:" +atqa); ## NfcBTag -Provides access to NFC-B (ISO 14443-3B) properties and I/O operations. **NfcBTag** inherits from **TagSession**. +Provides access to NFC-B (ISO 14443-3B) properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -110,7 +109,7 @@ console.log("appData:" +appData); getRespProtocol(): number[] -Obtains protocol information of this NFC-B tag. +Obtains the protocol information of this NFC-B tag. **Required permissions**: ohos.permission.NFC_TAG @@ -134,7 +133,7 @@ console.log("appData:" +protocol); ## NfcFTag -Provides access to NFC-F(JIS 6319-4) properties and I/O operations. **NfcFTag** inherits from **TagSession**. +Provides access to NFC-F (JIS 6319-4) properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -144,7 +143,7 @@ The following describes the unique interfaces of **NfcFTag**. getSystemCode(): number[] -Obtains the system code from the tag instance. +Obtains the system code from this NFC-F tag. **Required permissions**: ohos.permission.NFC_TAG @@ -170,7 +169,7 @@ console.log("systemCode:" +systemCode); getPmm(): number[] -Obtains the PMm (consisting of the IC code and manufacturer parameters) information from the tag instance. +Obtains the PMm (consisting of the IC code and manufacturer parameters) information from this NFC-F tag. **Required permissions**: ohos.permission.NFC_TAG @@ -194,7 +193,7 @@ console.log("pmm:" +pmm); ## NfcVTag -Provides access to NFC-V (ISO 15693) properties and I/O operations. **NfcVTag** inherits from **TagSession**. +Provides access to NFC-V (ISO 15693) properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -204,7 +203,7 @@ The following describes the unique interfaces of **NfcVTag**. getResponseFlags(): number -Obtains the response flags from the tag instance. +Obtains the response flags from this NFC-V tag. **Required permissions**: ohos.permission.NFC_TAG @@ -230,7 +229,7 @@ console.log("flags:" +flags); getDsfId(): number -Obtains the data storage format identifier (DSFID) from the tag instance. +Obtains the data storage format identifier (DSFID) from this NFC-V tag. **Required permissions**: ohos.permission.NFC_TAG @@ -254,7 +253,7 @@ console.log("dsfId:" +dsfId); ## IsoDepTag9+ -Provides access to ISO-DEP (ISO 14443-4) properties and I/O operations. **IsoDepTag** inherits from **TagSession**. +Provides access to ISO-DEP (ISO 14443-4) properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -343,7 +342,7 @@ tag.getIsoDepTag(taginfo).isExtendedApduSupported().then(function (has) { isExtendedApduSupported(callback: AsyncCallback\): void -Checks whether an extended application protocol data unit (APDU) is supported. This API uses an asynchronous callback to return the result. +Checks whether an extended APDU is supported. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -367,7 +366,7 @@ tag.getIsoDepTag(taginfo).isExtendedApduSupported(function (error, has) { ## NdefTag9+ -Provides access to the tags in the NFC Data Exchange Format (NDEF). **NdefTag** inherits from **TagSession**. +Provides access to the tags in the NFC Data Exchange Format (NDEF). This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -596,7 +595,7 @@ Reads the NDEF message from this tag. This API uses a promise to return the resu | **Type**| **Description** | | ------------------ | --------------------------| -| Promise\<[NdefMessage](#ndefmessage9)> | Promise used to return the message read.| +| Promise\<[NdefMessage](#ndefmessage9)> | Promise used to return the NDEF message read.| **Example** @@ -641,7 +640,7 @@ tag.NdefTag(taginfo).readNdef(function (error, ndefMessage) { writeNdef(msg: NdefMessage): Promise\; -Write an NDEF message to this tag. This API uses a promise to return the result. +Writes an NDEF message to this tag. This API uses a promise to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -674,7 +673,7 @@ NdefTag.writeNdef(msg).then(function (netHandle) { writeNdef(msg: NdefMessage, callback: AsyncCallback\): void -Write an NDEF message to this tag. This API uses an asynchronous callback to return the result. +Writes an NDEF message to this tag. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -728,7 +727,7 @@ tag.NdefTag(taginfo).canSetReadOnly().then(function (has) { ### NdefTag.canSetReadOnly9+ -canSetReadOnly()(callback: AsyncCallback<boolean>): void; +canSetReadOnly(callback: AsyncCallback<boolean>): void; Checks whether this NDEF tag can be set to read-only. This API uses an asynchronous callback to return the result. @@ -813,7 +812,7 @@ tag.NdefTag(taginfo).setReadOnly(function (error, errcode) { getNdefTagTypeString(type: [NfcForumType](#nfcforumtype9)): string -Converts the NFC Forum Type to a byte array defined in the NFC Forum. +Converts an NFC Forum Type to a byte array defined in the NFC Forum. **Required permissions**: ohos.permission.NFC_TAG @@ -852,7 +851,7 @@ let ndefTypeString= tag.NdefTag(taginfo).getNdefTagTypeString(type); ## MifareClassicTag 9+ -Provides access to MIFARE Classic properties and I/O operations. **MifareClassicTag** inherits from **TagSession**. +Provides access to MIFARE Classic properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -928,7 +927,7 @@ tag.MifareClassicTag(taginfo).authenticateSector(sectorIndex, key, function (err readSingleBlock(blockIndex: number): Promise\ -Reads a block on the tag. The size of a block is 16 bytes. This API uses a promise to return the result. +Reads a block (16 bytes) on the tag. This API uses a promise to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -962,7 +961,7 @@ tag.MifareClassicTag(taginfo).readSingleBlock(blockIndex).then(function (data){ readSingleBlock(blockIndex: number, callback: AsyncCallback\): void -Reads a block on the tag. The size of a block is 16 bytes. This API uses an asynchronous callback to return the result. +Reads a block (16 bytes) on the tag. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -992,7 +991,7 @@ tag.MifareClassicTag(taginfo).readSingleBlock(blockIndex, function (error, data) writeSingleBlock(blockIndex: number, data: string): Promise\ -Writes data to a block on the tag. The size of a block is 16 bytes. This API uses a promise to return the result. +Writes data to a block on the tag. This API uses a promise to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -1027,7 +1026,7 @@ tag.MifareClassicTag(taginfo).writeSingleBlock(blockIndex, data).then(function ( writeSingleBlock(blockIndex: number, data: string, callback: AsyncCallback\): void -Writes data to a block on the tag. The size of a block is 16 bytes. This API uses an asynchronous callback to return the result. +Writes data to a block on the tag. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -1427,10 +1426,10 @@ let size = tag.MifareClassicTag(taginfo).getTagSize(); | **Name**| **Value**| **Description**| | -------- | -------- | -------- | -| MC_SIZE_MINI | 320 | Each tag has five sectors, and each sector has four blocks.| -| MC_SIZE_1K | 1024 | Each tag has 16 sectors, and each sector has four blocks.| -| MC_SIZE_2K | 2048 | Each tag has 32 sectors, and each sector has four blocks.| -| MC_SIZE_4K | 4096 | Each tag has 40 sectors, and each sector has four blocks.| +| MC_SIZE_MINI | 320 | Each tag has 5 sectors, and each sector has 4 blocks.| +| MC_SIZE_1K | 1024 | Each tag has 16 sectors, and each sector has 4 blocks.| +| MC_SIZE_2K | 2048 | Each tag has 32 sectors, and each sector has 4 blocks.| +| MC_SIZE_4K | 4096 | Each tag has 40 sectors, and each sector has 4 blocks.| ### MifareClassicTag.isEmulatedTag9+ @@ -1521,7 +1520,7 @@ let index = tag.MifareClassicTag(taginfo).getSectorIndex(blockIndex); ## MifareUltralightTag9+ -Provides access to MIFARE Ultralight properties and I/O operations. **MifareUltralightTag** inherits from **TagSession**. +Provides access to MIFARE Ultralight properties and I/O operations. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -1531,7 +1530,7 @@ The following describes the unique interfaces of **MifareUltralightTag**. readMultiplePages(pageIndex: number): Promise\ -Reads multiple pages. The size of each page is 4 bytes. This API uses a promise to return the result. +Reads multiple pages (4 bytes per page). This API uses a promise to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -1565,7 +1564,7 @@ tag.MifareUltralightTag(taginfo).readMultiplePages(pageIndex).then(function (dat readMultiplePages(pageIndex: number, callback: AsyncCallback\): void -Reads multiple pages. The size of each page is 4 bytes. This API uses an asynchronous callback to return the result. +Reads multiple pages (4 bytes per page). This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -1594,7 +1593,7 @@ tag.MifareUltralightTag(taginfo).readMultiplePages(pageIndex, function (error, d writeSinglePages(pageIndex: number, data: string): Promise\ -Writes a page of data. The size of each page is 4 bytes. This API uses a promise to return the result. +Writes a page of data. This API uses a promise to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -1628,7 +1627,7 @@ tag.MifareUltralightTag(taginfo).writeSinglePages(pageIndex, data).then(function writeSinglePages(pageIndex: number, data: string, callback: AsyncCallback\): void -Writes a page of data. The size of each page is 4 bytes. This API uses an asynchronous callback to return the result. +Writes a page of data. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.NFC_TAG @@ -1658,7 +1657,7 @@ tag.MifareUltralightTag(taginfo).writeSinglePages(pageIndex, data, function (err getType(): MifareUltralightType -Obtains the MIFARE Ultralight tag type, in bytes. For details, see [MifareUltralightType](#mifareultralighttype9). +Obtains the MIFARE Ultralight tag type, in bytes. **Required permissions**: ohos.permission.NFC_TAG @@ -1689,7 +1688,7 @@ let type = tag.MifareUltralightType(taginfo).getType(); ## NdefFormatableTag9+ -Provides methods for operating NDEF formattable tags. **NdefFormatableTag** inherits from **TagSession**. +Provides APIs for operating NDEF formattable tags. This class inherits from **TagSession**. **TagSession** is the base class of all NFC tag technologies. It provides common interfaces for establishing connections and transferring data. For more details, see [TagSession](js-apis-tagSession.md). @@ -1709,7 +1708,7 @@ Formats this tag as an NDEF tag, and writes an NDEF message to the tag. This API | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If it is **null**, the tag is formatted only and no data will be written.| +| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only (no data will be written).| **Return value** @@ -1742,8 +1741,8 @@ Formats this tag as an NDEF tag, and writes an NDEF message to the tag. This API | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If it is **null**, the tag is formatted only and no data will be written.| -| callback: AsyncCallback\ | Callback invoked to return the result.| +| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only.| +| callback | AsyncCallback\ |Yes|Callback invoked to return the result.| **Example** @@ -1771,7 +1770,7 @@ Formats this tag as an NDEF tag, writes an NDEF message to the NDEF tag, and the | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If it is **null**, the tag is formatted only and no data will be written.| +| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only (no data will be written).| **Return value** @@ -1804,8 +1803,8 @@ Formats this tag as an NDEF tag, writes an NDEF message to the NDEF tag, and the | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If it is **null**, the tag is formatted only and no data will be written.| -| callback: AsyncCallback\ | Callback invoked to return the result.| +| message | [NdefMessage](#ndefmessage9) | Yes | NDEF message to write when the formatting is successful. If this parameter is **null**, the tag is formatted only.| +| callback | AsyncCallback\ |Yes|Callback invoked to return the result.| **Example** diff --git a/en/application-dev/reference/apis/js-apis-osAccount.md b/en/application-dev/reference/apis/js-apis-osAccount.md index 58d29f74c3196918f08da1b8e12babc71efc5347..8320fceaa5601703f01f8fc8f4937bcd34d3b4d5 100644 --- a/en/application-dev/reference/apis/js-apis-osAccount.md +++ b/en/application-dev/reference/apis/js-apis-osAccount.md @@ -1,6 +1,6 @@ -# OS Account Management +# OS Account Management -The osAccount module provides basic capabilities for managing operating system (OS) accounts, including adding, deleting, querying, setting, subscribing to, and enabling an OS account, and storing OS account data to disks. +The **osAccount** module provides basic capabilities for managing operating system (OS) accounts, including adding, deleting, querying, setting, subscribing to, and enabling an OS account, and storing OS account data to disks. > **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. @@ -21,13 +21,14 @@ Obtains an **AccountManager** instance. **System capability**: SystemCapability.Account.OsAccount **Return value** + | Type | Description | | --------------------------------- | ------------------------ | | [AccountManager](#accountmanager) | Obtains an **AccountManager** instance.| **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); ``` ## OsAccountType @@ -67,10 +68,10 @@ This is a system API and cannot be called by third-party applications. **Example**: Activate OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.activateOsAccount(localId, (err)=>{ - console.log("activateOsAccount err:" + JSON.stringify(err)); + console.log('activateOsAccount err:' + JSON.stringify(err)); }); ``` @@ -100,12 +101,12 @@ This is a system API and cannot be called by third-party applications. **Example**: Activate OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.activateOsAccount(localId).then(() => { - console.log("activateOsAccount success"); + console.log('activateOsAccount success'); }).catch((err) => { - console.log("activateOsAccount err:" + JSON.stringify(err)); + console.log('activateOsAccount err:' + JSON.stringify(err)); }); ``` @@ -126,9 +127,9 @@ Checks whether multiple OS accounts are supported. This API uses an asynchronous **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isMultiOsAccountEnable((err, isEnabled) => { - console.log("isMultiOsAccountEnable err: " + JSON.stringify(err)); + console.log('isMultiOsAccountEnable err: ' + JSON.stringify(err)); console.log('isMultiOsAccountEnable isEnabled: ' + isEnabled); }); ``` @@ -150,11 +151,11 @@ Checks whether multiple OS accounts are supported. This API uses a promise to re **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isMultiOsAccountEnable().then((isEnabled) => { console.log('isMultiOsAccountEnable, isEnabled: ' + isEnabled); }).catch((err) => { - console.log("isMultiOsAccountEnable err: " + JSON.stringify(err)); + console.log('isMultiOsAccountEnable err: ' + JSON.stringify(err)); }); ``` @@ -178,11 +179,11 @@ Checks whether an OS account is activated. This API uses an asynchronous callbac **Example**: Check whether OS account 100 is activated. ```js - const accountManager = account_osAccount.getAccountManager(); - var osLocalId = 100; + let accountManager = account_osAccount.getAccountManager(); + let osLocalId = 100; accountManager.isOsAccountActived(osLocalId, (err, isActive)=>{ - console.log("isOsAccountActived err:" + JSON.stringify(err)); - console.log("isOsAccountActived isActive:" + isActive); + console.log('isOsAccountActived err:' + JSON.stringify(err)); + console.log('isOsAccountActived isActive:' + isActive); }); ``` @@ -211,12 +212,12 @@ Checks whether an OS account is activated. This API uses a promise to return the **Example**: Check whether OS account 100 is activated. ```js - const accountManager = account_osAccount.getAccountManager(); - var osLocalId = 100; + let accountManager = account_osAccount.getAccountManager(); + let osLocalId = 100; accountManager.isOsAccountActived(osLocalId).then((isActive) => { console.log('isOsAccountActived, isActive: ' + isActive); }).catch((err) => { - console.log("isOsAccountActived err: " + JSON.stringify(err)); + console.log('isOsAccountActived err: ' + JSON.stringify(err)); }); ``` @@ -241,11 +242,11 @@ Checks whether the specified constraint is enabled for an OS account. This API u **Example**: Check whether OS account 100 is forbidden to use Wi-Fi. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - accountManager.isOsAccountConstraintEnable(localId, "constraint.wifi", (err, isConstraintEnabled)=>{ - console.log("isOsAccountConstraintEnable err:" + JSON.stringify(err)); - console.log("isOsAccountConstraintEnable isConstraintEnabled:" + isConstraintEnabled); + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + accountManager.isOsAccountConstraintEnable(localId, 'constraint.wifi', (err, isConstraintEnabled)=>{ + console.log('isOsAccountConstraintEnable err:' + JSON.stringify(err)); + console.log('isOsAccountConstraintEnable isConstraintEnabled:' + isConstraintEnabled); }); ``` @@ -275,12 +276,12 @@ Checks whether the specified constraint is enabled for an OS account. This API u **Example**: Check whether OS account 100 is forbidden to use Wi-Fi. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - accountManager.isOsAccountConstraintEnable(localId, "constraint.wifi").then((isConstraintEnabled) => { + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + accountManager.isOsAccountConstraintEnable(localId, 'constraint.wifi').then((isConstraintEnabled) => { console.log('isOsAccountConstraintEnable, isConstraintEnabled: ' + isConstraintEnabled); }).catch((err) => { - console.log("isOsAccountConstraintEnable err: " + JSON.stringify(err)); + console.log('isOsAccountConstraintEnable err: ' + JSON.stringify(err)); }); ``` @@ -301,9 +302,9 @@ Checks whether this OS account is a test account. This API uses an asynchronous **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isTestOsAccount((err, isTest) => { - console.log("isTestOsAccount err: " + JSON.stringify(err)); + console.log('isTestOsAccount err: ' + JSON.stringify(err)); console.log('isTestOsAccount isTest: ' + isTest); }); ``` @@ -325,11 +326,11 @@ Checks whether this OS account is a test account. This API uses a promise to ret **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isTestOsAccount().then((isTest) => { console.log('isTestOsAccount, isTest: ' + isTest); }).catch((err) => { - console.log("isTestOsAccount err: " + JSON.stringify(err)); + console.log('isTestOsAccount err: ' + JSON.stringify(err)); }); ``` @@ -350,9 +351,9 @@ Checks whether this OS account has been verified. This API uses an asynchronous **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isOsAccountVerified((err, isVerified) => { - console.log("isOsAccountVerified err: " + JSON.stringify(err)); + console.log('isOsAccountVerified err: ' + JSON.stringify(err)); console.log('isOsAccountVerified isVerified: ' + isVerified); }); ``` @@ -377,9 +378,9 @@ Checks whether an OS account has been verified. This API uses an asynchronous ca **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isOsAccountVerified((err, isVerified) => { - console.log("isOsAccountVerified err: " + JSON.stringify(err)); + console.log('isOsAccountVerified err: ' + JSON.stringify(err)); console.log('isOsAccountVerified isVerified: ' + isVerified); }); ``` @@ -409,11 +410,11 @@ Checks whether an OS account has been verified. This API uses a promise to retur **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.isOsAccountVerified().then((isVerified) => { console.log('isOsAccountVerified, isVerified: ' + isVerified); }).catch((err) => { - console.log("isOsAccountVerified err: " + JSON.stringify(err)); + console.log('isOsAccountVerified err: ' + JSON.stringify(err)); }); ``` @@ -439,13 +440,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - var createIocalId; - osAccountManager.createOsAccount("testAccountName", osaccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ - createIocalId = osAccountInfo.localId; - }); - accountManager.removeOsAccount(createIocalId, (err)=>{ - console.log("removeOsAccount err:" + JSON.stringify(err)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo) => { + accountManager.removeOsAccount(osAccountInfo.localId, (err)=>{ + console.log('removeOsAccount err:' + JSON.stringify(err)); + }); }); ``` @@ -476,16 +475,13 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - var createIocalId; - osAccountManager.createOsAccount("testAccountName", osaccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ - createIocalId = osAccountInfo.localId; - }); - createIocalId = osAccount.localId; - accountManager.removeOsAccount(createIocalId).then(() => { - console.log('removeOsAccount Success'); - }).catch(() => { - console.log("removeOsAccount err: " + JSON.stringify(err)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ + accountManager.removeOsAccount(osAccountInfo.localId).then(() => { + console.log('removeOsAccount Success'); + }).catch(() => { + console.log('removeOsAccount err: ' + JSON.stringify(err)); + }); }); ``` @@ -513,10 +509,10 @@ This is a system API and cannot be called by third-party applications. **Example**: Disable Wi-Fi for OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - accountManager.setOsAccountConstraints(localId, ["constraint.wifi"], true, (err)=>{ - console.log("setOsAccountConstraints err:" + JSON.stringify(err)); + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + accountManager.setOsAccountConstraints(localId, ['constraint.wifi'], true, (err)=>{ + console.log('setOsAccountConstraints err:' + JSON.stringify(err)); }); ``` @@ -546,15 +542,15 @@ This is a system API and cannot be called by third-party applications. | :------------------ | :---------------------------------- | | Promise<void> | Promise used to return the result.| -**Example**: Remote the constraint on the use of Wi-Fi for OS account 100. +**Example**: Remove the constraint on the use of Wi-Fi for OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - accountManager.setOsAccountConstraints(localId, ["constraint.location.set"], false).then(() => { + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + accountManager.setOsAccountConstraints(localId, ['constraint.location.set'], false).then(() => { console.log('setOsAccountConstraints Success'); }).catch((err) => { - console.log("setOsAccountConstraints err: " + JSON.stringify(err)); + console.log('setOsAccountConstraints err: ' + JSON.stringify(err)); }); ``` @@ -581,11 +577,11 @@ This is a system API and cannot be called by third-party applications. **Example**: Set the name of OS account 100 to **demoName**. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - var newName = "demoName"; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + let newName = 'demoName'; accountManager.setOsAccountName(localId, newName, (err)=>{ - console.debug("setOsAccountName err:" + JSON.stringify(err)); + console.debug('setOsAccountName err:' + JSON.stringify(err)); }); ``` @@ -617,13 +613,13 @@ This is a system API and cannot be called by third-party applications. **Example**: Set the name of OS account 100 to **demoName**. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - var nameLimit = "demoName"; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + let nameLimit = 'demoName'; accountManager.setOsAccountName(localId, nameLimit).then(() => { console.log('setOsAccountName Success'); }).catch((err) => { - console.log("setOsAccountName err: " + JSON.stringify(err)); + console.log('setOsAccountName err: ' + JSON.stringify(err)); }); ``` @@ -646,10 +642,10 @@ Obtains the number of OS accounts created. This API uses an asynchronous callbac **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getCreatedOsAccountsCount((err, accountCnt)=>{ - console.log("obtains the number of all os accounts created err:" + JSON.stringify(err)); - console.log("obtains the number of all os accounts created accountCnt:" + accountCnt); + console.log('obtains the number of all os accounts created err:' + JSON.stringify(err)); + console.log('obtains the number of all os accounts created accountCnt:' + accountCnt); }); ``` @@ -672,11 +668,11 @@ Obtains the number of OS accounts created. This API uses a promise to return the **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getCreatedOsAccountsCount().then((accountCnt) => { console.log('getCreatedOsAccountsCount, accountCnt: ' + accountCnt); }).catch((err) => { - console.log("getCreatedOsAccountsCount err: " + JSON.stringify(err)); + console.log('getCreatedOsAccountsCount err: ' + JSON.stringify(err)); }); ``` @@ -697,9 +693,9 @@ Obtains the ID of the OS account to which the current process belongs. This API **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountLocalIdFromProcess((err, accountID) => { - console.log("getOsAccountLocalIdFromProcess err: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdFromProcess err: ' + JSON.stringify(err)); console.log('getOsAccountLocalIdFromProcess accountID: ' + accountID); }); ``` @@ -721,11 +717,11 @@ Obtains the ID of the OS account to which the current process belongs. This API **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountLocalIdFromProcess().then((accountID) => { console.log('getOsAccountLocalIdFromProcess, accountID: ' + accountID); }).catch((err) => { - console.log("getOsAccountLocalIdFromProcess err: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdFromProcess err: ' + JSON.stringify(err)); }); ``` @@ -747,10 +743,10 @@ Obtains the OS account ID based on the process UID. This API uses an asynchronou **Example**: Obtain the ID of the OS account whose process UID is **12345678**. ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); let uid = 12345678; accountManager.getOsAccountLocalIdFromUid(uid, (err, accountID) => { - console.log("getOsAccountLocalIdFromUid err: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdFromUid err: ' + JSON.stringify(err)); console.log('getOsAccountLocalIdFromUid: ' + accountID); }); ``` @@ -778,12 +774,12 @@ Obtains the OS account ID based on the process UID. This API uses a promise to r **Example**: Obtain the ID of the OS account whose process UID is **12345678**. ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); let uid = 12345678; accountManager.getOsAccountLocalIdFromUid(uid).then((accountID) => { console.log('getOsAccountLocalIdFromUid: ' + accountID); }).catch((err) => { - console.log("getOsAccountLocalIdFromUid err: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdFromUid err: ' + JSON.stringify(err)); }); ``` @@ -807,10 +803,10 @@ Obtains the OS account ID based on domain account information. This API uses an **Example** ```js - var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; - const accountManager = account_osAccount.getAccountManager(); + let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'}; + let accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountLocalIdFromDomain(domainInfo, (err, accountID) => { - console.log("getOsAccountLocalIdFromDomain: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdFromDomain: ' + JSON.stringify(err)); console.log('getOsAccountLocalIdFromDomain: ' + accountID); }); ``` @@ -840,12 +836,12 @@ Obtains the OS account ID based on domain account information. This API uses a p **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; + let accountManager = account_osAccount.getAccountManager(); + let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'}; accountManager.getOsAccountLocalIdFromDomain(domainInfo).then((accountID) => { console.log('getOsAccountLocalIdFromDomain: ' + accountID); }).catch((err) => { - console.log("getOsAccountLocalIdFromDomain err: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdFromDomain err: ' + JSON.stringify(err)); }); ``` @@ -868,10 +864,10 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryMaxOsAccountNumber((err, maxCnt)=>{ - console.log("queryMaxOsAccountNumber err:" + JSON.stringify(err)); - console.log("queryMaxOsAccountNumber maxCnt:" + maxCnt); + console.log('queryMaxOsAccountNumber err:' + JSON.stringify(err)); + console.log('queryMaxOsAccountNumber maxCnt:' + maxCnt); }); ``` @@ -894,11 +890,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryMaxOsAccountNumber().then((maxCnt) => { console.log('queryMaxOsAccountNumber, maxCnt: ' + maxCnt); }).catch((err) => { - console.log("queryMaxOsAccountNumber err: " + JSON.stringify(err)); + console.log('queryMaxOsAccountNumber err: ' + JSON.stringify(err)); }); ``` @@ -922,11 +918,11 @@ Obtains all constraints enabled for an OS account. This API uses an asynchronous **Example**: Obtain all constraints of OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.getOsAccountAllConstraints(localId, (err, constraints)=>{ - console.log("getOsAccountAllConstraints err:" + JSON.stringify(err)); - console.log("getOsAccountAllConstraints:" + JSON.stringify(constraints)); + console.log('getOsAccountAllConstraints err:' + JSON.stringify(err)); + console.log('getOsAccountAllConstraints:' + JSON.stringify(constraints)); }); ``` @@ -955,12 +951,12 @@ Obtains all constraints enabled for an OS account. This API uses a promise to re **Example**: Obtain all constraints of OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.getOsAccountAllConstraints(localId).then((constraints) => { - console.log("getOsAccountAllConstraints, constraints: " + constraints); + console.log('getOsAccountAllConstraints, constraints: ' + constraints); }).catch((err) => { - console.log("getOsAccountAllConstraints err: " + JSON.stringify(err)); + console.log('getOsAccountAllConstraints err: ' + JSON.stringify(err)); }); ``` @@ -985,10 +981,10 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryAllCreatedOsAccounts((err, accountArr)=>{ - console.log("queryAllCreatedOsAccounts err:" + JSON.stringify(err)); - console.log("queryAllCreatedOsAccounts accountArr:" + JSON.stringify(accountArr)); + console.log('queryAllCreatedOsAccounts err:' + JSON.stringify(err)); + console.log('queryAllCreatedOsAccounts accountArr:' + JSON.stringify(accountArr)); }); ``` @@ -1013,11 +1009,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryAllCreatedOsAccounts().then((accountArr) => { console.log('queryAllCreatedOsAccounts, accountArr: ' + JSON.stringify(accountArr)); }).catch((err) => { - console.log("queryAllCreatedOsAccounts err: " + JSON.stringify(err)); + console.log('queryAllCreatedOsAccounts err: ' + JSON.stringify(err)); }); ``` @@ -1038,12 +1034,12 @@ Obtains information about all activated OS accounts. This API uses an asynchrono **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryActivatedOsAccountIds((err, idArray)=>{ - console.log("queryActivatedOsAccountIds err:" + JSON.stringify(err)); - console.log("queryActivatedOsAccountIds idArray length:" + idArray.length); - for(var i=0;i { console.log('queryActivatedOsAccountIds, idArray: ' + idArray); }).catch((err) => { - console.log("queryActivatedOsAccountIds err: " + JSON.stringify(err)); + console.log('queryActivatedOsAccountIds err: ' + JSON.stringify(err)); }); ``` @@ -1096,10 +1092,10 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - accountManager.createOsAccount("testName", osaccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ - console.log("createOsAccount err:" + JSON.stringify(err)); - console.log("createOsAccount osAccountInfo:" + JSON.stringify(osAccountInfo)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.createOsAccount('testName', account_osAccount.OsAccountType.NORMAL, (err, osAccountInfo)=>{ + console.log('createOsAccount err:' + JSON.stringify(err)); + console.log('createOsAccount osAccountInfo:' + JSON.stringify(osAccountInfo)); }); ``` @@ -1131,11 +1127,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - accountManager.createOsAccount("testAccountName", osaccount.OsAccountType.NORMAL).then((accountInfo) => { - console.log("createOsAccount, accountInfo: " + JSON.stringify(accountInfo)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.createOsAccount('testAccountName', account_osAccount.OsAccountType.NORMAL).then((accountInfo) => { + console.log('createOsAccount, accountInfo: ' + JSON.stringify(accountInfo)); }).catch((err) => { - console.log("createOsAccount err: " + JSON.stringify(err)); + console.log('createOsAccount err: ' + JSON.stringify(err)); }); ``` @@ -1162,11 +1158,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; - accountManager.createOsAccountForDomain(osaccount.OsAccountType.NORMAL, domainInfo, (err, osAccountInfo)=>{ - console.log("createOsAccountForDomain err:" + JSON.stringify(err)); - console.log("createOsAccountForDomain osAccountInfo:" + JSON.stringify(osAccountInfo)); + let accountManager = account_osAccount.getAccountManager(); + let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'}; + accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo, (err, osAccountInfo)=>{ + console.log('createOsAccountForDomain err:' + JSON.stringify(err)); + console.log('createOsAccountForDomain osAccountInfo:' + JSON.stringify(osAccountInfo)); }); ``` @@ -1198,12 +1194,12 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); - var domainInfo = {domain: "testDomain", accountName: "testAccountName"}; - accountManager.createOsAccountForDomain(osaccount.OsAccountType.NORMAL, domainInfo).then((accountInfo) => { - console.log("createOsAccountForDomain, account info: " + JSON.stringify(accountInfo)); + let accountManager = account_osAccount.getAccountManager(); + let domainInfo = {domain: 'testDomain', accountName: 'testAccountName'}; + accountManager.createOsAccountForDomain(account_osAccount.OsAccountType.NORMAL, domainInfo).then((accountInfo) => { + console.log('createOsAccountForDomain, account info: ' + JSON.stringify(accountInfo)); }).catch((err) => { - console.log("createOsAccountForDomain err: " + JSON.stringify(err)); + console.log('createOsAccountForDomain err: ' + JSON.stringify(err)); }); ``` @@ -1226,10 +1222,10 @@ Obtains information about the OS account to which the current process belongs. T **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryCurrentOsAccount((err, curAccountInfo)=>{ - console.log("queryCurrentOsAccount err:" + JSON.stringify(err)); - console.log("queryCurrentOsAccount curAccountInfo:" + JSON.stringify(curAccountInfo)); + console.log('queryCurrentOsAccount err:' + JSON.stringify(err)); + console.log('queryCurrentOsAccount curAccountInfo:' + JSON.stringify(curAccountInfo)); }); ``` @@ -1252,11 +1248,11 @@ Obtains information about the OS account to which the current process belongs. T **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.queryCurrentOsAccount().then((accountInfo) => { - console.log("queryCurrentOsAccount, accountInfo: " + JSON.stringify(accountInfo)); + console.log('queryCurrentOsAccount, accountInfo: ' + JSON.stringify(accountInfo)); }).catch((err) => { - console.log("queryCurrentOsAccount err: " + JSON.stringify(err)); + console.log('queryCurrentOsAccount err: ' + JSON.stringify(err)); }); ``` @@ -1282,11 +1278,11 @@ This is a system API and cannot be called by third-party applications. **Example**: Query information about OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.queryOsAccountById(localId, (err, accountInfo)=>{ - console.log("queryOsAccountById err:" + JSON.stringify(err)); - console.log("queryOsAccountById accountInfo:" + JSON.stringify(accountInfo)); + console.log('queryOsAccountById err:' + JSON.stringify(err)); + console.log('queryOsAccountById accountInfo:' + JSON.stringify(accountInfo)); }); ``` @@ -1317,12 +1313,12 @@ This is a system API and cannot be called by third-party applications. **Example**: Query information about OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.queryOsAccountById(localId).then((accountInfo) => { - console.log("queryOsAccountById, accountInfo: " + JSON.stringify(accountInfo)); + console.log('queryOsAccountById, accountInfo: ' + JSON.stringify(accountInfo)); }).catch((err) => { - console.log("queryOsAccountById err: " + JSON.stringify(err)); + console.log('queryOsAccountById err: ' + JSON.stringify(err)); }); ``` @@ -1343,9 +1339,9 @@ Obtains the type of the OS account to which the current process belongs. This AP **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountTypeFromProcess((err, accountType) => { - console.log("getOsAccountTypeFromProcess err: " + JSON.stringify(err)); + console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err)); console.log('getOsAccountTypeFromProcess accountType: ' + accountType); }); ``` @@ -1367,11 +1363,11 @@ Obtains the type of the OS account to which the current process belongs. This AP **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getOsAccountTypeFromProcess().then((accountType) => { console.log('getOsAccountTypeFromProcess, accountType: ' + accountType); }).catch((err) => { - console.log("getOsAccountTypeFromProcess err: " + JSON.stringify(err)); + console.log('getOsAccountTypeFromProcess err: ' + JSON.stringify(err)); }); ``` @@ -1394,9 +1390,9 @@ Obtains the ID of this distributed virtual device. This API uses an asynchronous **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getDistributedVirtualDeviceId((err, virtualID) => { - console.log("getDistributedVirtualDeviceId err: " + JSON.stringify(err)); + console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err)); console.log('getDistributedVirtualDeviceId virtualID: ' + virtualID); }); ``` @@ -1420,11 +1416,11 @@ Obtains the ID of this distributed virtual device. This API uses a promise to re **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); accountManager.getDistributedVirtualDeviceId().then((virtualID) => { console.log('getDistributedVirtualDeviceId, virtualID: ' + virtualID); }).catch((err) => { - console.log("getDistributedVirtualDeviceId err: " + JSON.stringify(err)); + console.log('getDistributedVirtualDeviceId err: ' + JSON.stringify(err)); }); ``` @@ -1450,11 +1446,11 @@ This is a system API and cannot be called by third-party applications. **Example**: Obtain the profile photo of OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.getOsAccountProfilePhoto(localId, (err, photo)=>{ - console.log("getOsAccountProfilePhoto err:" + JSON.stringify(err)); - console.log("get photo:" + photo + " by localId: " + localId); + console.log('getOsAccountProfilePhoto err:' + JSON.stringify(err)); + console.log('get photo:' + photo + ' by localId: ' + localId); }); ``` @@ -1485,12 +1481,12 @@ This is a system API and cannot be called by third-party applications. **Example**: Obtain the profile photo of OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.getOsAccountProfilePhoto(localId).then((photo) => { - console.log("getOsAccountProfilePhoto: " + photo); + console.log('getOsAccountProfilePhoto: ' + photo); }).catch((err) => { - console.log("getOsAccountProfilePhoto err: " + JSON.stringify(err)); + console.log('getOsAccountProfilePhoto err: ' + JSON.stringify(err)); }); ``` @@ -1517,14 +1513,14 @@ This is a system API and cannot be called by third-party applications. **Example**: Set a profile photo for OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - var photo = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA"+ - "Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y"+ - "q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo"+ - "+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg==" - osAccountManager.setOsAccountProfilePhoto(localId, photo, (err)=>{ - console.log("setOsAccountProfilePhoto err:" + JSON.stringify(err)); + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+ + 'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+ + 'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+ + '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg==' + accountManager.setOsAccountProfilePhoto(localId, photo, (err)=>{ + console.log('setOsAccountProfilePhoto err:' + JSON.stringify(err)); }); ``` @@ -1556,16 +1552,16 @@ This is a system API and cannot be called by third-party applications. **Example**: Set a profile photo for OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; - var photo = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA"+ - "Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y"+ - "q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo"+ - "+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg==" + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; + let photo = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAAPCAYAAAA/I0V3AAAAAXNSR0IArs4c6QAAAARnQU1BAA'+ + 'Cxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACwSURBVDhPvZLBDYMwDEV/ugsXRjAT0EHCOuFIBwkbdIRewi6unbiAyoGgSn1SFH85+Y'+ + 'q/4ljARW62X+LHS8uIzjm4dXUYF+utzBikB52Jo5e5iEPKqpACk7R9NM2RvWm5tIkD2czLCUFNKLD6IjdMHFHDzws285MgGrT0xCtp3WOKHo'+ + '+7q0mP0DZW9pNmoEFUzrQjp5cCnaen2kSJXLFD8ghbXyZCMQf/8e8Ns1XVAG/XAgqKzVnJFAAAAABJRU5ErkJggg==' accountManager.setOsAccountProfilePhoto(localId, photo).then(() => { - console.log("setOsAccountProfilePhoto success"); + console.log('setOsAccountProfilePhoto success'); }).catch((err) => { - console.log("setOsAccountProfilePhoto err: " + JSON.stringify(err)); + console.log('setOsAccountProfilePhoto err: ' + JSON.stringify(err)); }); ``` @@ -1584,14 +1580,14 @@ Obtains the OS account ID based on the SN. This API uses an asynchronous callbac | serialNumber | number | Yes | Account SN. | | callback | AsyncCallback<number> | Yes | Callback used to return the OS account ID obtained.| -**Example**: Obtain the ID of the OS account whose SN is **12345**. +**Example**: Obtain the ID of the OS account whose SN is 12345. ```js - const accountManager = account_osAccount.getAccountManager(); - var serialNumber = 12345; + let accountManager = account_osAccount.getAccountManager(); + let serialNumber = 12345; accountManager.getOsAccountLocalIdBySerialNumber(serialNumber, (err, localId)=>{ - console.log("ger localId err:" + JSON.stringify(err)); - console.log("get localId:" + localId + " by serialNumber: " + serialNumber); + console.log('ger localId err:' + JSON.stringify(err)); + console.log('get localId:' + localId + ' by serialNumber: ' + serialNumber); }); ``` @@ -1615,15 +1611,15 @@ Obtains the OS account ID based on the SN. This API uses a promise to return the | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the OS account ID obtained.| -**Example**: Obtain the ID of the OS account whose SN is **12345**. +**Example**: Obtain the ID of the OS account whose SN is 12345. ```js - const accountManager = account_osAccount.getAccountManager(); - var serialNumber = 12345; + let accountManager = account_osAccount.getAccountManager(); + let serialNumber = 12345; accountManager.getOsAccountLocalIdBySerialNumber(serialNumber).then((localId) => { - console.log("getOsAccountLocalIdBySerialNumber localId: " + localId); + console.log('getOsAccountLocalIdBySerialNumber localId: ' + localId); }).catch((err) => { - console.log("getOsAccountLocalIdBySerialNumber err: " + JSON.stringify(err)); + console.log('getOsAccountLocalIdBySerialNumber err: ' + JSON.stringify(err)); }); ``` @@ -1642,14 +1638,14 @@ Obtains the SN of an OS account based on the account ID. This API uses an asynch | localId | number | Yes | ID of the target OS account. | | callback | AsyncCallback<number> | Yes | Callback used to return the account SN obtained.| -**Example**: Obtain the SN of OS account 100. +**Example**: Obtain the SN of the OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.getSerialNumberByOsAccountLocalId(localId, (err, serialNumber)=>{ - console.log("ger serialNumber err:" + JSON.stringify(err)); - console.log("get serialNumber:" + serialNumber + " by localId: " + localId); + console.log('ger serialNumber err:' + JSON.stringify(err)); + console.log('get serialNumber:' + serialNumber + ' by localId: ' + localId); }); ``` @@ -1673,15 +1669,15 @@ Obtains the SN of an OS account based on the account ID. This API uses a promise | :-------------------- | :----------------------------------------------------------- | | Promise<number> | Promise used to return the account SN obtained.| -**Example**: Obtain the SN of OS account 100. +**Example**: Obtain the SN of the OS account 100. ```js - const accountManager = account_osAccount.getAccountManager(); - var localId = 100; + let accountManager = account_osAccount.getAccountManager(); + let localId = 100; accountManager.getSerialNumberByOsAccountLocalId(localId).then((serialNumber) => { - console.log("getSerialNumberByOsAccountLocalId serialNumber: " + serialNumber); + console.log('getSerialNumberByOsAccountLocalId serialNumber: ' + serialNumber); }).catch((err) => { - console.log("getSerialNumberByOsAccountLocalId err: " + JSON.stringify(err)); + console.log('getSerialNumberByOsAccountLocalId err: ' + JSON.stringify(err)); }); ``` @@ -1708,11 +1704,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); function onCallback(receiveLocalId){ - console.log("receive localId:" + receiveLocalId); + console.log('receive localId:' + receiveLocalId); } - accountManager.on("activating", "osAccountOnOffNameA", onCallback); + accountManager.on('activating', 'osAccountOnOffNameA', onCallback); ``` ### off @@ -1738,11 +1734,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - const accountManager = account_osAccount.getAccountManager(); + let accountManager = account_osAccount.getAccountManager(); function offCallback(){ - console.log("off enter") + console.log('off enter') } - accountManager.off("activating", "osAccountOnOffNameA", offCallback); + accountManager.off('activating', 'osAccountOnOffNameA', offCallback); ``` ### getBundleIdFromUid9+ @@ -1765,10 +1761,11 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var testUid = 1000000; - osAccountManager.getBundleIdFromUid(testUid,(err,bundleId)=>{ - console.info("getBundleIdFromUid errInfo:" + JSON.stringify(err)); - console.info("getBundleIdFromUid bundleId:" + JSON.stringify(bundleId)); + let accountManager = account_osAccount.getAccountManager(); + let testUid = 1000000; + accountManager.getBundleIdFromUid(testUid, (err, bundleId) => { + console.info('getBundleIdFromUid errInfo:' + JSON.stringify(err)); + console.info('getBundleIdFromUid bundleId:' + JSON.stringify(bundleId)); }); ``` ### getBundleIdFromUid9+ @@ -1796,10 +1793,13 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var testUid = 1000000; - var bundleIdInfo = await osAccountManager.getBundleIdFromUid(testUid).catch((err)=>{ - console.info("getBundleIdFromUid errInfo:" + JSON.stringify(err));}) - console.info("getBundleIdFromUid bundleId:" + JSON.stringify(bundleIdInfo)); + let accountManager = account_osAccount.getAccountManager(); + let testUid = 1000000; + accountManager.getBundleIdFromUid(testUid).then((result) => { + console.info('getBundleIdFromUid bundleId:' + JSON.stringify(result)); + }).catch((err)=>{ + console.info('getBundleIdFromUid errInfo:' + JSON.stringify(err)); + }); ``` ### isMainOsAccount9+ @@ -1810,6 +1810,8 @@ Checks whether the current process belongs to the main OS account. This API uses This is a system API and cannot be called by third-party applications. +**Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS + **System capability**: SystemCapability.Account.OsAccount **Parameters** @@ -1821,9 +1823,10 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - osAccountManager.isMainOsAccount((err,result)=>{ - console.info("isMainOsAccount errInfo:" + JSON.stringify(err)); - console.info("isMainOsAccount result:" + JSON.stringify(result)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.isMainOsAccount((err,result)=>{ + console.info('isMainOsAccount errInfo:' + JSON.stringify(err)); + console.info('isMainOsAccount result:' + JSON.stringify(result)); }); ``` ### isMainOsAccount9+ @@ -1834,6 +1837,8 @@ Checks whether the current process belongs to the main OS account. This API uses This is a system API and cannot be called by third-party applications. +**Required permissions**: ohos.permission.MANAGE_LOCAL_ACCOUNTS + **System capability**: SystemCapability.Account.OsAccount **Return value** @@ -1845,10 +1850,12 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var result = await osAccountManager.isMainOsAccount().catch((err)=>{ - console.info("isMainOsAccount errInfo:" + JSON.stringify(err)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.isMainOsAccount().then((result) => { + console.info('isMainOsAccount result:' + JSON.stringify(result)); + }).catch((err)=>{ + console.info('isMainOsAccount errInfo:' + JSON.stringify(err)); }); - console.info("isMainOsAccount result:" + JSON.stringify(result)); ``` ### queryOsAccountConstraintSourceTypes9+ @@ -1873,9 +1880,10 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - osAccountManager.queryOsAccountConstraintSourceTypes(100, "constraint.wifi",(err,sourceTypeInfos)=>{ - console.info("queryOsAccountConstraintSourceType errInfo:" + JSON.stringify(err)); - console.info("queryOsAccountConstraintSourceType sourceTypeInfos:" + JSON.stringify(sourceTypeInfos)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.queryOsAccountConstraintSourceTypes(100, 'constraint.wifi',(err,sourceTypeInfos)=>{ + console.info('queryOsAccountConstraintSourceType errInfo:' + JSON.stringify(err)); + console.info('queryOsAccountConstraintSourceType sourceTypeInfos:' + JSON.stringify(sourceTypeInfos)); }); ``` @@ -1907,27 +1915,33 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var sourceTypeInfos = await osAccountManager.queryOsAccountConstraintSourceTypes(100, "constraint.wifi").catch((err)=>{ - console.info("queryOsAccountConstraintSourceType errInfo:" + JSON.stringify(err));}) - console.info("queryOsAccountConstraintSourceType sourceTypeInfos:" + JSON.stringify(sourceTypeInfos)); + let accountManager = account_osAccount.getAccountManager(); + accountManager.queryOsAccountConstraintSourceTypes(100, 'constraint.wifi').then((result) => { + console.info('queryOsAccountConstraintSourceType sourceTypeInfos:' + JSON.stringify(result)); + }).catch((err)=>{ + console.info('queryOsAccountConstraintSourceType errInfo:' + JSON.stringify(err)); + }); ``` ## UserAuth8+ Provides APIs for user authentication. +This is a system API and cannot be called by third-party applications. + ### constructor8+ constructor() A constructor used to create an instance for user authentication. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount -**Example** +**Example** ```js - let userAuth = new osAccount.UserAuth(); - console.info('====>test for examples constructor success'); + let userAuth = new account_osAccount.UserAuth(); ``` @@ -1947,19 +1961,18 @@ This is a system API and cannot be called by third-party applications. | :----- | :----------- | | number | Version information obtained.| -**Example** +**Example** ```js - let userAuth = new osAccount.UserAuth(); - console.info('====>test for examples constructor success'); - var version = userAuth.getVersion(); - console.info('====>test for examples version is : ' + JSON.stringify(version)); + let userAuth = new account_osAccount.UserAuth(); + let version = userAuth.getVersion(); + console.log('getVersion version = ' + version); ``` ### getAvailableStatus8+ getAvailableStatus(authType: AuthType, authTrustLevel: AuthTrustLevel): number; -Checks whether the identity authentication function is available. +Checks whether the identity authentication feature is available. This is a system API and cannot be called by third-party applications. @@ -1971,23 +1984,22 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | --------------- | -----------------------------------------------| ---- | ------------------------- | -| authType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| authTrustLevel | [AuthTrustLevel](#AuthTrustLevel8+) | Yes | Trust level of the authentication result.| +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Trust level of the authentication result.| **Return value** | Type | Description | | :----- | :---------------------------------------- | -| number | Result code(#ResultCode8+).| +| number | [Result code](#resultcode8).| -**Example** +**Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let authTrustLevel = osAccount.AuthTrustLevel.ATL1; - console.info('====>test for examples constructor success'); - let availableStatus = userAuth.getAvailableStatus(authType, authTrustLevel); - console.info('====>test for examples AvailabeStatus is : ' + JSON.stringify(availableStatus)); + let userAuth = new account_osAccount.UserAuth(); + let authType = account_osAccount.AuthType.PIN; + let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1; + let status = userAuth.getAvailableStatus(authType, authTrustLevel); + console.log('getAvailableStatus status = ' + status); ``` ### getProperty8+ @@ -2006,26 +2018,30 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------------------------- | ---- | ---------------------------------- | -| request | [GetPropertyRequest](#GetPropertyRequest8+) | Yes | Request information, including the authentication credential type and property list.| -| callback | AsyncCallback<[ExecutorProperty](#ExecutorProperty8+)> | Yes | Callback invoked to return the executor property obtained. | +| request | [GetPropertyRequest](#getpropertyrequest8) | Yes | Request information, including the authentication credential type and property list.| +| callback | AsyncCallback<[ExecutorProperty](#executorproperty8)> | Yes | Callback invoked to return the executor property obtained. | **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let keys = new Array(); - keys[0] = osAccount.GetPropertyType.AUTH_SUB_TYPE; - keys[1] = osAccount.GetPropertyType.REMAIN_TIMES; - keys[2] = osAccount.GetPropertyType.FREEZING_TIME; - let getPropertyRequest = {authType, keys}; - userAuth.getProperty(getPropertyRequest,function (propReq) { - console.log("====>test for examples getallAuthInfo AsyncCallback = " + JSON.stringify(propReq)); - }) + let userAuth = new account_osAccount.UserAuth(); + let keys = [ + account_osAccount.GetPropertyType.AUTH_SUB_TYPE, + account_osAccount.GetPropertyType.REMAIN_TIMES, + account_osAccount.GetPropertyType.FREEZING_TIME + ]; + let request = { + authType: account_osAccount.AuthType.PIN, + keys: keys + }; + userAuth.getProperty(request, (err, result) => { + console.log('getProperty err = ' + JSON.stringify(err)); + console.log('getProperty result = ' + JSON.stringify(result)); + }); ``` ### getProperty8+ -getProperty(request: GetPropertyRequest): Promise; +getProperty(request: GetPropertyRequest): Promise<ExecutorProperty>; Obtains the executor property based on the request. This API uses a promise to return the result. @@ -2039,31 +2055,36 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------ | ---- | ---------------------------------- | -| request | [GetPropertyRequest](#GetPropertyRequest8+) | Yes | Request information, including the authentication credential type and property list.| +| request | [GetPropertyRequest](#getpropertyrequest8) | Yes | Request information, including the authentication credential type and property list.| **Return value** | Type | Description | | :---------------------------------------------------------------- | :-------------------------------------------------- | -| Promise<[ExecutorProperty](#ExecutorProperty8+)> | Promise used to return the executor property obtained.| - -**Example** - ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let keys = new Array(); - keys[0] = osAccount.GetPropertyType.AUTH_SUB_TYPE; - keys[1] = osAccount.GetPropertyType.REMAIN_TIMES; - keys[2] = osAccount.GetPropertyType.FREEZING_TIME; - let getPropertyRequest = {authType, keys}; - userAuth.getProperty(getPropertyRequest).then((propReq) => { - console.log("====>test for examples getallAuthInfo AsyncCallback = " + JSON.stringify(propReq)); +| Promise<[ExecutorProperty](#executorproperty8)> | Promise used to return the executor property obtained.| + +**Example** + ```js + let userAuth = new account_osAccount.UserAuth(); + let keys = [ + account_osAccount.GetPropertyType.AUTH_SUB_TYPE, + account_osAccount.GetPropertyType.REMAIN_TIMES, + account_osAccount.GetPropertyType.FREEZING_TIME + ]; + let request = { + authType: account_osAccount.AuthType.PIN, + keys: keys + }; + userAuth.getProperty(request).then((result) => { + console.log('getProperty result = ' + JSON.stringify(result)); + }).catch((err) => { + console.log('getProperty error = ' + JSON.stringify(err)); }); ``` ### setProperty8+ -setProperty(request: SetPropertyRequest, callback: AsyncCallback): void; +setProperty(request: SetPropertyRequest, callback: AsyncCallback<number>): void; Sets the property for the initialization algorithm. This API uses an asynchronous callback to return the result. @@ -2077,24 +2098,26 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | -------- | ----------------------------------------------------- | ---- | ---------------------------------------------------------------------- | -| request | [SetPropertyRequest](#SetPropertyRequest8+)| Yes | Request information, including the authentication credential type and key value to set. | -| callback | AsyncCallback<number> | Yes | Callback invoked to return the [result code](#ResultCode8+).| +| request | [SetPropertyRequest](#setpropertyrequest8)| Yes | Request information, including the authentication credential type and key value to set. | +| callback | AsyncCallback<number> | Yes | Callback invoked to return the [result](#resultcode8).| **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let key = osAccount.SetPropertyType.INIT_ALGORITHM; - let setInfo = new Uint8Array(); - let setPropertyRequest = {authType, key, setInfo}; - userAuth.setProperty(setPropertyRequest,function (setProp) { - console.log("====>test for examples setProperty AsyncCallback = " + JSON.stringify(setProp)); + let userAuth = new account_osAccount.UserAuth(); + let request = { + authType: account_osAccount.AuthType.PIN, + key: account_osAccount.SetPropertyType.INIT_ALGORITHM, + setInfo: new Uint8Array([0]) + }; + userAuth.setProperty(request, (err, result) => { + console.log('setProperty error = ' + JSON.stringify(err)); + console.log('setProperty result = ' + JSON.stringify(result)); }); ``` ### setProperty8+ -setProperty(request: SetPropertyRequest): Promise; +setProperty(request: SetPropertyRequest): Promise<number>; Sets the property for the initialization algorithm. This API uses a promise to return the result. @@ -2108,23 +2131,26 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------ | ---- | ---------------------------------------- | -| request | [SetPropertyRequest](#SetPropertyRequest8+) | Yes | Request information, including the authentication credential type and the key value to set.| +| request | [SetPropertyRequest](#setpropertyrequest8) | Yes | Request information, including the authentication credential type and the key value to set.| **Return value** | Type | Description | | :-------------------- | :-------------------------------------------------------------------------------------------- | -| Promise<number> | Promise used to return the [result code](#ResultCode8+).| +| Promise<number> | Promise used to return the [result](#resultcode8).| **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let key = osAccount.SetPropertyType.INIT_ALGORITHM; - let setInfo = new Uint8Array(); - let setPropertyRequest = {authType, key, setInfo}; - userAuth.setProperty(setPropertyRequest).then((setProp) => { - console.log("====>test for examples setProperty AsyncCallback = " + JSON.stringify(setProp)); + let userAuth = new account_osAccount.UserAuth(); + let request = { + authType: account_osAccount.AuthType.PIN, + key: account_osAccount.SetPropertyType.INIT_ALGORITHM, + setInfo: new Uint8Array([0]) + }; + userAuth.setProperty(request).then((result) => { + console.log('setProperty result = ' + JSON.stringify(result)); + }).catch((err) => { + console.log('setProperty error = ' + JSON.stringify(err)); }); ``` @@ -2145,9 +2171,9 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | --------------- | ---------------------------------------------------- | --- | ------------------------------------ | | challenge | Uint8Array | Yes | Challenge value, which is a random number used to improve security.| -| authType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| authTrustLevel | [AuthTrustLevel](#AuthTrustLevel8+) | Yes | Trust level of the authentication result. | -| callback | [IUserAuthCallback](#IUserAuthCallback8+) | Yes | Callback invoked to return the authentication result and obtained information. | +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Trust level of the authentication result. | +| callback | [IUserAuthCallback](#iuserauthcallback8) | Yes | Callback invoked to return the authentication result and obtained information. | **Return value** @@ -2158,22 +2184,15 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let challenge = 1; - let authTrustLevel = osAccount.AuthTrustLevel.ATL1; - let onresult = { - authresult: null, - authextr: null, - } - userAuth.auth(challenge, authType,authTrustLevel,{ - onResult: function(result,extraInfo){ - console.log("====>test for examples auth result = " + result); - onresult.authresult = result; - console.log("====>test for examples auth extraInfo = " + JSON.stringify(extraInfo)); - onresult.authextr = extraInfo; - console.info('====>test for examples auth onResult = ' + JSON.stringify(onresult)); - } + let userAuth = new account_osAccount.UserAuth(); + let challenge = new Uint8Array([0]); + let authType = account_osAccount.AuthType.PIN; + let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1; + userAuth.auth(challenge, authType, authTrustLevel, { + onResult: function(result,extraInfo){ + console.log('auth result = ' + result); + console.log('auth extraInfo = ' + JSON.stringify(extraInfo)); + } }); ``` @@ -2195,9 +2214,9 @@ This is a system API and cannot be called by third-party applications. | --------------- | ---------------------------------------------------- | --- | ------------------------------------ | | userId | number | Yes | User ID. | | challenge | Uint8Array | Yes | Challenge value, which is a random number used to improve security. | -| authType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| authTrustLevel | [AuthTrustLevel](#AuthTrustLevel8+) | Yes | Trust level of the authentication result. | -| callback | [IUserAuthCallback](#IUserAuthCallback8+) | Yes | Callback invoked to return the authentication result and obtained information. | +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| authTrustLevel | [AuthTrustLevel](#authtrustlevel8) | Yes | Trust level of the authentication result. | +| callback | [IUserAuthCallback](#iuserauthcallback8) | Yes | Callback invoked to return the authentication result and obtained information. | **Return value** @@ -2208,23 +2227,16 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let challenge = 1; - let authTrustLevel = osAccount.AuthTrustLevel.ATL1; + let userAuth = new account_osAccount.UserAuth(); let userID = 100; - let onresult = { - authresult: null, - authextr: null, - } + let challenge = new Uint8Array([0]); + let authType = account_osAccount.AuthType.PIN; + let authTrustLevel = account_osAccount.AuthTrustLevel.ATL1; userAuth.authUser(userID, challenge, authType, authTrustLevel, { - onResult: function(result,extraInfo){ - console.log("====>test for examples authUser result = " + result); - onresult.authresult = result; - console.log("====>test for examples authUser extraInfo = " + JSON.stringify(extraInfo)); - onresult.authextr = extraInfo; - console.info('====>test for examples authUser onResult = ' + JSON.stringify(onresult)); - } + onResult: function(result,extraInfo){ + console.log('authUser result = ' + result); + console.log('authUser extraInfo = ' + JSON.stringify(extraInfo)); + } }); ``` @@ -2250,20 +2262,28 @@ This is a system API and cannot be called by third-party applications. | Type | Description | | :----- | :-------------------------------------------------------- | -| number | [Result code](#ResultCode8+).| +| number | [Result code](#resultcode8).| **Example** ```js - let userAuth = new osAccount.UserAuth(); - let contextID = null; - let cancelAuthresult = null; - cancelAuthresult = userAuth.cancelAuth(contextID); - console.log("====>test for examples cancelAuthresult result = " + JSON.stringify(cancelAuthresult)); + let userAuth = new account_osAccount.UserAuth(); + let pinAuth = new account_osAccount.PINAuth(); + let challenge = new Uint8Array([0]); + let contextID = userAuth.auth(challenge, account_osAccount.AuthType.PIN, account_osAccount.AuthTrustLevel.ATL1, { + onResult: (result, extraInfo) => { + console.log('auth result = ' + result); + console.log('auth extraInfo = ' + JSON.stringify(extraInfo)); + } + }); + let result = userAuth.cancelAuth(contextID); + console.log('cancelAuth result = ' + result); ``` ## PINAuth8+ -Provides methods for PIN authentication. +Provides APIs for PIN authentication. + +This is a system API and cannot be called by third-party applications. ### constructor8+ @@ -2271,12 +2291,13 @@ constructor() A constructor used to create an instance for PIN authentication. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount -**Example** +**Example** ```js - var pinAuth = new osAccount.PINAuth(); - console.info('====>test for examples constructor success'); + let pinAuth = new account_osAccount.PINAuth(); ``` ### registerInputer @@ -2295,7 +2316,7 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | ----------| ----------------------------------- | --- | ------------------ | -| inputer | [IInputer](#IInputer8+) | Yes | Callback invoked to obtain the PIN.| +| inputer | [IInputer](#iinputer8) | Yes | Callback invoked to obtain the PIN.| **Return value** @@ -2305,20 +2326,14 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var pinAuth = new osAccount.PINAuth(); - var GetAuthSubType = 0; - var AuthSubType = osAccount.AuthSubType.PIN_SIX; - var Inputerdata = [0,1,3]; - var registerresult = pinAuth.registerInputer({ - onGetData: (GetAuthSubType, IInputData) => { - if (GetAuthSubType == 0) { - IInputData.onSetData(AuthSubType, Inputerdata) - } else { - IInputData.onSetData(GetAuthSubType, Inputerdata); - } + let pinAuth = new account_osAccount.PINAuth(); + let password = new Uint8Array([0, 0, 0, 0, 0]); + let result = pinAuth.registerInputer({ + onGetData: (pinSubType, callback) => { + callback.onSetData(pinSubType, password); } - }) - console.log("====>test for examples RegisterInputer result is: " + registerresult); + }); + console.log('registerInputer result = ' + result); ``` ### unregisterInputer @@ -2335,13 +2350,15 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var pinAuth = new osAccount.PinAuth(); + let pinAuth = new account_osAccount.PINAuth(); pinAuth.unregisterInputer(); ``` ## UserIdentityManager8+ -Provides methods for user identity management. +Provides APIs for user identity management. + +This is a system API and cannot be called by third-party applications. ### constructor8+ @@ -2349,12 +2366,13 @@ constructor() A constructor used to create an instance for user authentication. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount -**Example** +**Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - console.info('====>test for examples constructor success'); + let userIDM = new account_osAccount.UserIdentityManager(); ``` ### openSession8+ @@ -2373,23 +2391,14 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | -------- | -------------------------------- | ---- | -------------------------------- | -| callback | AsyncCallback<Uint8Array> | Yes | Callback invoked to return the result. If **0** is returned, the operation failed. If the operation is successful, the challenge value (a non-zero value) will be returned.| +| callback | AsyncCallback<Uint8Array> | Yes | Callback invoked to return the challenge value. If **0** is returned, the operation failed.| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - var challenge; - userIDM.openSession(function(err, data){ - try{ - console.log("====>test for examples before get challenge"); - console.log("====>test for examples + " + data); - challenge = data; - console.log("====>test for examples end "); - console.log("====>test for examples after get challenge"); - } - catch(e) { - console.info('====>test for examples openSession error = ' + JSON.stringify(e)); - } + let userIDM = new account_osAccount.UserIdentityManager(); + userIDM.openSession((err, challenge) => { + console.log('openSession error = ' + JSON.stringify(err)); + console.log('openSession challenge = ' + JSON.stringify(challenge)); }); ``` @@ -2409,27 +2418,16 @@ This is a system API and cannot be called by third-party applications. | Type | Description | | :------------------------ | :------------------------------------------------------- | -| Promise<Uint8Array> | Promise used to return the result. If **0** is returned, the operation failed. If the operation is successful, the challenge value (a non-zero value) will be returned.| +| Promise<Uint8Array> | Promise used to return the challenge value. If **0** is returned, the operation failed.| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - var challenge; - userIDM.openSession().then((data) => { - try{ - console.log("====>test for examples before get challenge"); - console.log("====>test for examples + " + data); - challenge = data; - console.log("====>test for examples end "); - console.log("====>test for examples after get challenge"); - } - catch(err) { - console.info('====>test for examples faceDemo openSession error1 = ' + JSON.stringify(err)); - } - }) - .catch((err) => { - console.info('====>test for examples faceDemo openSession error2 = ' + JSON.stringify(err)); - }) + let userIDM = new account_osAccount.UserIdentityManager(); + userIDM.openSession().then((challenge) => { + console.info('openSession challenge = ' + JSON.stringify(challenge)); + }).catch((err) => { + console.info('openSession error = ' + JSON.stringify(err)); + }); ``` ### addCredential8+ @@ -2448,31 +2446,32 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | --------------- | ------------------------------------------------ | --- | -------------------------------- | -| credentialInfo | [CredentialInfo](#CredentialInfo8+) | Yes | Credential information to add. | -| callback | [IIdmCallback](#IIdmCallback8+) | Yes | Callback invoked to return the result and obtained information. | +| credentialInfo | [CredentialInfo](#credentialinfo8) | Yes | Credential information to add. | +| callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result and obtained information. | **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - let CredentialInfo = null; - let onresult = { - addCredresult: null, - credentialId: null, - } - userIDM.addCredential(CredentialInfo, { - onResult: function(result,extraInfo){ - console.info('====>test for examples aaaaaaaaaaaaa'); - console.info("====>test for examples addCredential result = " + result); - console.info("====>test for examples addCredential extraInfo = " + JSON.stringify(extraInfo)); - console.log(result) - onresult.addCredresult= result; - if(extraInfo != undefined) { - onresult.credentialId = extraInfo.credentialId - } else { - onresult.credentialId = null; - } + let password = new Uint8Array([0, 0, 0, 0, 0, 0]); + let pinAuth = new account_osAccount.PINAuth(); + pinAuth.registerInputer({ + onGetData: (pinSubType, callback) => { + callback.onSetData(pinSubType, password); + } + }); + let credentialInfo = { + credType: account_osAccount.AuthType.PIN, + credSubType: account_osAccount.AuthSubType.PIN_SIX, + token: null + }; + let userIDM = new account_osAccount.UserIdentityManager(); + userIDM.openSession((err, challenge) => { + userIDM.addCredential(credentialInfo, { + onResult: (result, extraInfo) => { + console.log('updateCredential result = ' + result); + console.log('updateCredential extraInfo = ' + extraInfo); } - }) + }); + }); ``` ### updateCredential8+ @@ -2491,30 +2490,41 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | --------------- | ------------------------------------------------- | --- | -------------------------------- | -| credentialInfo | [CredentialInfo](#CredentialInfo8+) | Yes | New credential information. | -| callback | [IIdmCallback](#IIdmCallback8+) | Yes | Callback invoked to return the result and obtained information. | - -**Example** - ```js - var userIDM = new osAccount.UserIdentityManager(); - let CredentialInfo = null; - let onresult = { - addCredresult: null, - credentialId: null, - } - userIDM.updateCredential(CredentialInfo, { - onResult: function(result,extraInfo){ - console.log("====>test for examples faceDemo updateCredential result = " + result) - onresult.updateCredresult = result - console.log("====>test for examples faceDemo updateCredential credentialId = " + extraInfo.credentialId) - if(extraInfo != undefined) { - onresult.CredentialId = extraInfo.credentialId - } else { - onresult.CredentialId = null; +| credentialInfo | [CredentialInfo](#credentialinfo8) | Yes | New credential information. | +| callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result and obtained information. | + +**Example** + ```js + let userIDM = new account_osAccount.UserIdentityManager(); + let userAuth = new account_osAccount.UserAuth(); + let pinAuth = new account_osAccount.PINAuth(); + let password = new Uint8Array([0, 0, 0, 0, 0, 0]); + let credentialInfo = { + credType: account_osAccount.AuthType.PIN, + credSubType: account_osAccount.AuthSubType.PIN_SIX, + token: null + }; + pinAuth.registerInputer({ + onGetData: (pinSubType, callback) => { + callback.onSetData(pinSubType, password); + } + }); + userIDM.openSession((err, challenge) => { + userAuth.auth(challenge, credentialInfo.credType, account_osAccount.AuthTrustLevel.ATL1, { + onResult: (result, extraInfo) => { + if (result != account_osAccount.ResultCode.SUCCESS) { + return; + } + credentialInfo.token = extraInfo.token; + userIDM.updateCredential(credentialInfo, { + onResult: (result, extraInfo) => { + console.log('updateCredential result = ' + result); + console.log('updateCredential extraInfo = ' + extraInfo); } - console.info('====>test for examples publicupdateCred updateCredential onResult = ' + JSON.stringify(onresult)); + }); } - }) + }); + }); ``` ### closeSession8+ @@ -2531,7 +2541,7 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); + let userIDM = new account_osAccount.UserIdentityManager(); userIDM.closeSession(); ``` @@ -2557,13 +2567,14 @@ This is a system API and cannot be called by third-party applications. | Type | Description | | :----- | :-------------------------------------------------------- | -| number | [Result code](#ResultCode8+).| +| number | [Result code](#resultcode8).| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - let challenge = 1; - let cancelresult = userIDM.cancel(challenge); + let userIDM = new account_osAccount.UserIdentityManager(); + let challenge = new Uint8Array([0]); + let result = userIDM.cancel(challenge); + console.log('cancel result: ' + result); ``` ### delUser8+ @@ -2583,28 +2594,18 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | -------- | ------------------------------------------ | --- | ------------------------- | | token | Uint8Array | Yes | Authentication token. | -| callback | [IIdmCallback](#IIdmCallback8+) | Yes | Callback invoked to return the result.| +| callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result.| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - let onresult = { - delUserresult: null, - CredentialId: null, - } - let token = null; + let userIDM = new account_osAccount.UserIdentityManager(); + let token = new Uint8Array([0]); userIDM.delUser(token, { - onResult: function(result,extraInfo){ - console.log("====>test for examples delUser result = " + result) - onresult.delUserresult = result - if(extraInfo != undefined) { - onresult.CredentialId = extraInfo.credentialId - } else { - onresult.CredentialId = null; - } - console.info('====>test for examples publicdelUser delUser = ' + JSON.stringify(onresult)); - } - }) + onResult: (result, extraInfo) => { + console.log('delUser result = ' + result); + console.log('delUser extraInfo = ' + JSON.stringify(extraInfo)); + } + }); ``` ### delCred8+ @@ -2625,35 +2626,24 @@ This is a system API and cannot be called by third-party applications. | --------------- | ----------------------------------------------- | --- | ---------------------------| | credentialId | Uint8Array | Yes | Credential ID. | | token | Uint8Array | Yes | Authentication token. | -| callback | [IIdmCallback](#IIdmCallback8+) | Yes | Callback invoked to return the result.| +| callback | [IIdmCallback](#iidmcallback8) | Yes | Callback invoked to return the result.| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - let onresult = { - delUserresult: null, - CredentialId: null, - } - let credentialId = 1; - let token = null; - userIDM.delCred(credentialId, token,{ - onResult: function(result,extraInfo){ - console.log("====>test for examples delCred result = " + result) - onresult.delCredresult = result - console.log("====>test for examples delCred extraInfo = " + extraInfo) - if(extraInfo != undefined) { - onresult.CredentialId = extraInfo.credentialId - } else { - onresult.CredentialId = null; - } - console.log("====>test for examples delCred onresult = " + JSON.stringify(onresult)); - } - }) + let userIDM = new account_osAccount.UserIdentityManager(); + let credentialId = new Uint8Array([0]); + let token = new Uint8Array([0]); + userIDM.delCred(credentialId, token, { + onResult: (result, extraInfo) => { + console.log('delCred result = ' + result); + console.log('delCred extraInfo = ' + JSON.stringify(extraInfo)); + } + }); ``` ### getAuthInfo8+ -getAuthInfo(callback: AsyncCallback<Array<EnrolledCredInfo>>, authType?: AuthType): void; +getAuthInfo(callback: AsyncCallback<Array<EnrolledCredInfo>>): void; Obtains authentication information. This API uses asynchronous callback to return the result. @@ -2661,22 +2651,50 @@ This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount -**Required permissions**: ohos.permission.MANAGE_USER_IDM +**Required permissions**: ohos.permission.USE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | -------------------------------------------------- | ---- | -------------------------------------------------- | -| callback | AsyncCallback<Array<[EnrolledCredInfo](#EnrolledCredInfo8+)>> | Yes | Callback invoked to return information about all enrolled credentials of the specified type of the user.| -| authType | [AuthType](#AuthType8+) | No | Authentication credential type. | +| callback | AsyncCallback<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | Yes | Callback invoked to return information about all the user's enrolled credentials of the specified type.| + **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - var authType = osAccount.AuthType.PIN; - userIDM.getAuthInfo(authType, function (authInfo) { - console.log("====>test for examples getAuthInfo AsyncCallback = " + JSON.stringify(authInfo)) - }) + let userIDM = new account_osAccount.UserIdentityManager(); + userIDM.getAuthInfo((err, result) => { + console.log('getAuthInfo err = ' + JSON.stringify(err)); + console.log('getAuthInfo result = ' + JSON.stringify(result)); + }); + ``` + +### getAuthInfo8+ + +getAuthInfo(authType: AuthType, callback: AsyncCallback<Array<EnrolledCredInfo>>): void; + +Obtains authentication information of the specified type. This API uses an asynchronous callback to return the result. + +This is a system API and cannot be called by third-party applications. + +**System capability**: SystemCapability.Account.OsAccount + +**Required permissions**: ohos.permission.USE_USER_IDM + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | -------------------------------------------------- | ---- | -------------------------------------------------- | +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| callback | AsyncCallback<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | Yes | Callback invoked to return information about all the user's enrolled credentials of the specified type.| + +**Example** + ```js + let userIDM = new account_osAccount.UserIdentityManager(); + userIDM.getAuthInfo(account_osAccount.AuthType.PIN, (err, result) => { + console.log('getAuthInfo err = ' + JSON.stringify(err)); + console.log('getAuthInfo result = ' + JSON.stringify(result)); + }); ``` ### getAuthInfo8+ @@ -2689,37 +2707,42 @@ This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount -**Required permissions**: ohos.permission.MANAGE_USER_IDM +**Required permissions**: ohos.permission.USE_USER_IDM **Parameters** | Name | Type | Mandatory| Description | | -------- | ----------------------------------- | ---- | -------- | -| authType | [AuthType](#AuthType8+) | No | Authentication credential type.| +| authType | [AuthType](#authtype8) | No | Authentication credential type.| **Return value** | Type | Description | | :------------------------------------------- | :------------------------------------------------------------------------ | -| Promise<Array<[EnrolledCredInfo](#EnrolledCredInfo8+)>> | Promise used to return information about all enrolled credentials of the specified type of the user.| +| Promise<Array<[EnrolledCredInfo](#enrolledcredinfo8)>> | Promise used to return information about all the user's enrolled credentials of the specified type.| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - var authType = osAccount.AuthType.PIN; - userIDM.getAuthInfo(authType).then((authInfo) => { - console.log("====>test for examples getAuthInfo AsyncCallback = " + JSON.stringify(authInfo)) - }) + let userIDM = new account_osAccount.UserIdentityManager(); + userIDM.getAuthInfo(account_osAccount.AuthType.PIN).then((result) => { + console.log('getAuthInfo result = ' + JSON.stringify(result)) + }).catch((err) => { + console.log('getAuthInfo error = ' + JSON.stringify(err)); + }); ``` ## IInputData8+ Provides callbacks for PIN operations. +This is a system API and cannot be called by third-party applications. + ### onSetData8+ onSetData: (pinSubType: AuthSubType, data: Uint8Array) => void; +This is a system API and cannot be called by third-party applications. + Called to set data. **System capability**: SystemCapability.Account.OsAccount @@ -2728,85 +2751,78 @@ Called to set data. | Name | Type | Mandatory| Description | | ---------- | ---------------------------------------- | ---- | ----------------------------------------------- | -| pinSubType | [AuthSubType](#AuthSubType8+) | Yes | Credential subtype. | +| pinSubType | [AuthSubType](#authsubtype8) | Yes | Credential subtype. | | data | Uint8Array | Yes | Data (credential) to set. The data is used for authentication and operations for adding and modifying credentials.| **Example** ```js - console.log("====>test for examples onCreate start "); - var pinAuth = new osAccount.PINAuth(); - var GetAuthSubType = 0; - var AuthSubType = osAccount.AuthSubType.PIN_SIX; - console.log("====>test for examples GetAuthSubType " + GetAuthSubType); - console.log("====>test for examples AuthSubType " + AuthSubType); - var Inputerdata = [0,1,3]; - var registerresult = pinAuth.registerInputer({ - onGetData: (GetAuthSubType, IInputData) => { - console.log("====>test for examples by GetAuthSubType " +GetAuthSubType ); - if (GetAuthSubType == 0) { - console.log("====>test for examples GetAuthSubType == 0 "); - IInputData.onSetData(AuthSubType, Inputerdata) - } else { - console.log("====>test for examples GetAuthSubType == 1 "); - IInputData.onSetData(GetAuthSubType, Inputerdata); - } - } - }) - console.log("====>test for examples RegisterInputer result is: " + registerresult); + let password = new Uint8Array([0, 0, 0, 0, 0, 0]); + let passwordNumber = new Uint8Array([1, 2, 3, 4]); + let inputer = { + onGetData: (pinSubType, callback) => { + if (pinSubType == account_osAccount.AuthSubType.PIN_NUMBER) { + callback.onSetData(pinSubType, passwordNumber); + } else { + callback.onSetData(pinSubType, password); + } + } + }; ``` ## IInputer8+ Provides callbacks for the PIN input box. +This is a system API and cannot be called by third-party applications. + ### onGetData8+ -onGetData: (callback: IInputData) => void; +onGetData: (pinSubType: AuthSubType, callback: IInputData) => void; Called to obtain data. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount **Parameters** | Name | Type | Mandatory| Description | | ---------- | --------------------------------------- | ---- | --------------- | -| callback | [IInputData](#IInputData8+) | Yes | Called to input the PIN.| - -**Example** - ```js - console.log("====>test for examples onCreate start "); - var pinAuth = new osAccount.PINAuth(); - var GetAuthSubType = 0; - var AuthSubType = osAccount.AuthSubType.PIN_SIX; - console.log("====>test for examples GetAuthSubType " + GetAuthSubType); - console.log("====>test for examples AuthSubType " + AuthSubType); - var Inputerdata = [0,1,3]; - var registerresult = pinAuth.registerInputer({ - onGetData: (GetAuthSubType, IInputData) => { - console.log("====>test for examples by GetAuthSubType " +GetAuthSubType ); - if (GetAuthSubType == 0) { - console.log("====>test for examples GetAuthSubType == 0 "); - IInputData.onSetData(AuthSubType, Inputerdata) - } else { - console.log("====>test for examples GetAuthSubType == 1 "); - IInputData.onSetData(GetAuthSubType, Inputerdata); - } - } - }) - console.log("====>test for examples RegisterInputer result is: " + registerresult); +| callback | [IInputData](#iinputdata8) | Yes | Called to input the PIN.| + +**Example** + ```js + let password = new Uint8Array([0, 0, 0, 0, 0, 0]); + let passwordNumber = new Uint8Array([1, 2, 3, 4]); + let inputer = { + onGetData: (pinSubType, callback) => { + if (pinSubType == account_osAccount.AuthSubType.PIN_NUMBER) { + callback.onSetData(pinSubType, passwordNumber); + } else { + callback.onSetData(pinSubType, password); + } + } + }; + let pinAuth = new account_osAccount.PINAuth(); + let result = pinAuth.registerInputer(inputer); + console.log('registerInputer result: ' + result); ``` ## IUserAuthCallback8+ Provides callbacks for user authentication. +This is a system API and cannot be called by third-party applications. + ### onResult8+ onResult: (result: number, extraInfo: AuthResult) => void; Called to return the authentication result code. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount **Parameters** @@ -2814,27 +2830,16 @@ Called to return the authentication result code. | Name | Type | Mandatory| Description | | --------- | --------------------------------------- | ---- | ------------------- | | result | number | Yes | Authentication result code.| -| extraInfo | [AuthResult](#AuthResult8+) | Yes | Specific authentication result information. If the authentication is successful, the authentication token is returned in **extrainfo**. If the authentication fails, the remaining authentication time is returned. If the authentication executor is locked, the freezing time is returned.| +| extraInfo | [AuthResult](#authresult8) | Yes | Specific authentication result information. If the authentication is successful, the authentication token is returned in **extrainfo**. If the authentication fails, the remaining authentication time is returned. If the authentication executor is locked, the freezing time is returned.| **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let challenge = 1; - let authTrustLevel = osAccount.AuthTrustLevel.ATL1; - let onresult = { - authresult: null, - authextr: null, - } - userAuth.auth(challenge, authType,authTrustLevel,{ - onResult: function(result,extraInfo){ - console.log("====>test for examples auth result = " + result); - onresult.authresult = result; - console.log("====>test for examples auth extraInfo = " + JSON.stringify(extraInfo)); - onresult.authextr = extraInfo; - console.info('====>test for examples auth onResult = ' + JSON.stringify(onresult)); - } - }); + let authCallback = { + onResult: (result, extraInfo) => { + console.log('auth result = ' + result); + console.log('auth extraInfo = ' + JSON.stringify(extraInfo)); + } + }; ``` ### onAcquireInfo?8+ @@ -2857,45 +2862,28 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - let userAuth = new osAccount.UserAuth(); - let authType = osAccount.AuthType.PIN; - let challenge = 1; - let authTrustLevel = osAccount.AuthTrustLevel.ATL1; - let onresult = { - authresult: null, - authextr: null, - } - let onacquireinfo = { - authmodule : null, - authacquire : null, - authextr : null - } - userAuth.auth(challenge, authType,authTrustLevel,{ - onResult: function(result,extraInfo){ - console.log("====>test for examples auth result = " + result) - onresult.authresult = result - console.log("====>test for examples auth extraInfo = " + JSON.stringify(extraInfo)); - onresult.authextr = extraInfo; - console.info('====>test for examples auth onResult = ' + JSON.stringify(onresult)); - }, - onAcquireInfo:function (modulea,acquire,extr){ - console.info('====>test for examples publicauth auth onAcquireInfo in'); - onacquireinfo.authmodule = modulea; - onacquireinfo.authacquire = acquire; - onacquireinfo.authextr = extr; - console.log("====>test for examples auth module = " + JSON.stringify(modulea)); - console.info('====>test for examples publicauth auth onAcquireInfo = ' + JSON.stringify(onacquireinfo)); - } - }); + let authCallback = { + onResult: (result, extraInfo) => { + console.log('auth result = ' + result) + console.log('auth extraInfo = ' + JSON.stringify(extraInfo)); + }, + onAcquireInfo: (module, acquire, extraInfo) => { + console.log('auth module = ' + module); + console.log('auth acquire = ' + acquire); + console.info('auth extraInfo = ' + JSON.stringify(extraInfo)); + } + }; ``` ## IIdmCallback8+ Provides callbacks for IDM. +This is a system API and cannot be called by third-party applications. + ### onResult8+ -onResult: (result: number, extraInfo: AuthResult) => void; +onResult: (result: number, extraInfo: RequestResult) => void; Called to return the authentication result code. @@ -2908,29 +2896,16 @@ This is a system API and cannot be called by third-party applications. | Name | Type | Mandatory| Description | | --------- | --------------------------------------- | ---- | ----------------------- | | result | number | Yes | Authentication result code. | -| extraInfo | [AuthResult](#AuthResult8+) | Yes | Specific information to be transferred.| +| extraInfo | [AuthResult](#authresult8) | Yes | Specific information to be transferred.| **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - let CredentialInfo = null; - let onresult = { - addCredresult: null, - credentialId: null, - } - userIDM.updateCredential(CredentialInfo, { - onResult: function(result,extraInfo){ - console.log("====>test for examples updateCredential result = " + result) - onresult.updateCredresult = result - console.log("====>test for examples updateCredential credentialId = " + extraInfo.credentialId) - if(extraInfo != undefined) { - onresult.CredentialId = extraInfo.credentialId - } else { - onresult.CredentialId = null; - } - console.info('====>test for examples publicupdateCred updateCredential onResult = ' + JSON.stringify(onresult)); - } - }) + let idmCallback = { + onResult: (result, extraInfo) => { + console.log('callback result = ' + result) + console.info('callback extraInfo = ' + JSON.stringify(extraInfo)); + } + }; ``` ### onAcquireInfo?8+ @@ -2953,73 +2928,58 @@ This is a system API and cannot be called by third-party applications. **Example** ```js - var userIDM = new osAccount.UserIdentityManager(); - let CredentialInfo = null; - let onresult = { - addCredresult: null, - credentialId: null, - } - let onacquireinfo = { - updateCredmodule : null, - updateCredacquire : null, - updateCredextr : null - } - userIDM.updateCredential(CredentialInfo, { - onResult: function(result,extraInfo){ - console.log("====>test for examples updateCredential result = " + result) - onresult.updateCredresult = result - console.log("====>test for examples updateCredential credentialId = " + extraInfo.credentialId) - if(extraInfo != undefined) { - onresult.CredentialId = extraInfo.credentialId - } else { - onresult.CredentialId = null; - } - console.info('====>test for examples publicupdateCred updateCredential onResult = ' + JSON.stringify(onresult)); - }, - onAcquireInfo:function (modulea,acquire,extr){ - console.info('====>test for examples publicupdateCred updateCredential onAcquireInfo in '); - onacquireinfo.updateCredmodule = modulea - onacquireinfo.updateCredacquire = acquire - onacquireinfo.updateCredextr = extr - console.info('====>test for examples updateCredential onacquireinfo = ' + JSON.stringify(onacquireinfo)); - console.log("====>test for examples updateCredential module = " + modulea) - } - }) + let idmCallback = { + onResult: (result, extraInfo) => { + console.log('callback result = ' + result) + console.log('callback onResult = ' + JSON.stringify(extraInfo)); + }, + onAcquireInfo: (module, acquire, extraInfo) => { + console.log('callback module = ' + module); + console.log('callback acquire = ' + acquire); + console.log('callback onacquireinfo = ' + JSON.stringify(extraInfo)); + } + }; ``` ## GetPropertyRequest8+ Defines the request for obtaining property information. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | -------- | ------------------------------------------------------------- | ----- | ----------------------- | -| authType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| keys | Array<[GetPropertyType](#GetPropertyType8+)> | Yes | An array of the types of the properties to obtain.| +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| keys | Array<[GetPropertyType](#getpropertytype8)> | Yes | An array of the types of the properties to obtain.| ## SetPropertyRequest8+ Defines the request for setting property information. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | -------- | ------------------------------------------------ | ----- | -------------------- | -| authType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| keys | [SetPropertyType](#SetPropertyType8+) | Yes | Type of the property to be set.| +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| key | [SetPropertyType](#setpropertytype8) | Yes | Type of the property to set.| | setInfo | Uint8Array | Yes | Information to set. | ## ExecutorProperty8+ Defines the executor property. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ---------------------------------------- | ----- | ----------------- | | result | number | Yes | Result. | -| authSubType | [AuthSubType](#AuthSubType8+) | Yes | Authentication credential subtype.| +| authSubType | [AuthSubType](#authsubtype8) | Yes | Authentication credential subtype.| | remainTimes | number | No | Remaining time. | | freezingTime | number | No | Freezing time. | @@ -3027,6 +2987,8 @@ Defines the executor property. Defines the authentication result information. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | @@ -3039,18 +3001,22 @@ Defines the authentication result information. Defines the credential information. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ---------------------------------------- | ----- | ----------------- | -| credType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| credSubType | [AuthSubType](#AuthSubType8+) | Yes | Credential subtype. | +| credType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| credSubType | [AuthSubType](#authsubtype8) | Yes | Authentication credential subtype. | | token | Uint8Array | Yes | Authentication token. | ## RequestResult8+ Defines the request result information. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | @@ -3061,24 +3027,28 @@ Defines the request result information. Defines enrolled credential information. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Type | Mandatory | Description | | ------------ | ---------------------------------------- | ----- | ------------------- | | credentialId | Uint8Array | Yes | Credential ID. | -| authType | [AuthType](#AuthType8+) | Yes | Authentication credential type. | -| authSubType | [AuthSubType](#AuthSubType8+) | Yes | Credential subtype.| -| templateId | Uint8Array | Yes | Credential template ID. | +| authType | [AuthType](#authtype8) | Yes | Authentication credential type. | +| authSubType | [AuthSubType](#authsubtype8) | Yes | Credential subtype.| +| templateId | Uint8Array | Yes | Authentication credential template ID. | ## GetPropertyType8+ Enumerates the types of the properties to obtain. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ------------- | ------ | --------- | -| AUTH_SUB_TYPE | 1 | Authentication subtype.| +| AUTH_SUB_TYPE | 1 | Authentication credential subtype.| | REMAIN_TIMES | 2 | Remaining time. | | FREEZING_TIME | 3 | Freezing time. | @@ -3086,6 +3056,8 @@ Enumerates the types of the properties to obtain. Enumerates the types of the properties to set. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | @@ -3094,7 +3066,9 @@ Enumerates the types of the properties to set. ## AuthType8+ -Enumerates the credential types. +Enumerates the authentication credential types. + +This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount @@ -3105,7 +3079,9 @@ Enumerates the credential types. ## AuthSubType8+ -Enumerates the credential subtypes. +Enumerates the authentication credential subtypes. + +This is a system API and cannot be called by third-party applications. **System capability**: SystemCapability.Account.OsAccount @@ -3121,6 +3097,8 @@ Enumerates the credential subtypes. Enumerates the trust levels of the authentication result. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | @@ -3134,28 +3112,32 @@ Enumerates the trust levels of the authentication result. Enumerates the modules from which information is obtained. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | --------- | ------ | ------------------------ | -| FACE_AUTH | 1 | Information obtained from the face authentication module.| +| FACE_AUTH | 1 | Face authentication module.| ## ResultCode8+ Enumerates the authentication result codes. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | | ----------------------- | ----- | ---------------------------------------- | -| SUCCESS | 0 | The authentication is successful or the authentication function is supported. | +| SUCCESS | 0 | The authentication is successful or the authentication feature is supported. | | FAIL | 1 | The authentication executor failed to identify the user. | | GENERAL_ERROR | 2 | Other errors. | | CANCELED | 3 | The authentication is canceled. | | TIMEOUT | 4 | The authentication timed out. | | TYPE_NOT_SUPPORT | 5 | The authentication credential type is not supported. | | TRUST_LEVEL_NOT_SUPPORT | 6 | The authentication trust level is not supported. | -| BUSY | 7 | The authentication task is not available. Try again after a few seconds.| +| BUSY | 7 | The authentication executor is busy. Try again after a few seconds.| | INVALID_PARAMETERS | 8 | Incorrect parameters are detected. | | LOCKED | 9 | The authentication executor is locked. | | NOT_ENROLLED | 10 | The authentication executor is not enrolled. | @@ -3164,6 +3146,8 @@ Enumerates the authentication result codes. Enumerates the tip codes for facial authentication. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | @@ -3180,10 +3164,12 @@ Enumerates the tip codes for facial authentication. | FACE_AUTH_TIP_POOR_GAZE | 10 | The face is not facing the device. | | FACE_AUTH_TIP_NOT_DETECTED | 11 | No face is detected. | -## ingerprintTips8+ +## FingerprintTips8+ Enumerates the tip codes for fingerprint authentication. +This is a system API and cannot be called by third-party applications. + **System capability**: SystemCapability.Account.OsAccount | Name | Default Value| Description | @@ -3232,8 +3218,8 @@ Domain account information. | Constraint | Description | | ------------------------------------- | ------------------------------ | -| constraint.wifi | A user is not allowed to use Wi-Fi. | -| constraint.wifi.set | A user is not allowed to change Wi-Fi settings. | +| constraint.wifi | A user is not allowed to use Wi-Fi. | +| constraint.wifi.set | A user is not allowed to set Wi-Fi. | | constraint.locale.set | A user is not allowed to change the device language. | | constraint.app.accounts | A user is not allowed to add or delete app accounts. | | constraint.apps.install | A user is not allowed to install apps. | diff --git a/en/application-dev/reference/apis/js-apis-plainarray.md b/en/application-dev/reference/apis/js-apis-plainarray.md index 4af1fc423938baa39a4ea5771202b0013a65aaec..568a479679c9457babba38a8da53e9a082f74f40 100644 --- a/en/application-dev/reference/apis/js-apis-plainarray.md +++ b/en/application-dev/reference/apis/js-apis-plainarray.md @@ -12,6 +12,9 @@ Both **PlainArray** and **[LightWeightMap](js-apis-lightweightmap.md)** are used **Recommended use case**: Use **PlainArray** when you need to store KV pairs whose keys are of the **number** type. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -93,7 +96,7 @@ Checks whether this container contains the specified key. ```ts let plainArray = new PlainArray(); plainArray.has(1); -plainArray.add(1, "sddfhf"); +plainArray.add(1, "squirrel"); let result1 = plainArray.has(1); ``` @@ -122,8 +125,8 @@ Obtains the value of the specified key in this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); let result = plainArray.get(1); ``` @@ -152,8 +155,8 @@ Obtains the index of the first occurrence of an element with the specified key i ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); let result = plainArray.getIndexOfKey(2); ``` @@ -182,9 +185,9 @@ Obtains the index of the first occurrence of an element with the specified value ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); -let result = plainArray.getIndexOfValue("sddfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); +let result = plainArray.getIndexOfValue("squirrel"); ``` @@ -212,8 +215,8 @@ Obtains the key of the element at the specified position in this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); let result = plainArray.getKeyAt(1); ``` @@ -241,8 +244,8 @@ Obtains the value of an element at the specified position in this container. ```ts let plainArray = new PlainArray(); - plainArray.add(1, "sddfhf"); - plainArray.add(2, "sffdfhf"); + plainArray.add(1, "squirrel"); + plainArray.add(2, "sparrow"); let result = plainArray.getKeyAt(1); ``` @@ -264,8 +267,8 @@ Clones this container and returns a copy. The modification to the copy does not ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); let newPlainArray = plainArray.clone(); ``` @@ -289,7 +292,7 @@ Adds an element to this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); +plainArray.add(1, "squirrel"); ``` @@ -317,8 +320,8 @@ Removes an element with the specified key from this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); plainArray.remove(2); let result = plainArray.remove(2); ``` @@ -348,8 +351,8 @@ Removes an element at the specified position from this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); plainArray.removeAt(1); let result = plainArray.removeAt(1); ``` @@ -380,8 +383,8 @@ Removes elements in a specified range from this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); let result = plainArray.removeRangeFrom(1, 3); ``` @@ -405,8 +408,8 @@ Sets a value for an element at the specified position in this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); plainArray.setValueAt(1, 3546); ``` @@ -429,8 +432,8 @@ Obtains a string that contains all elements in this container. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); let result = plainArray.toString(); ``` @@ -447,8 +450,8 @@ Clears this container and sets its length to **0**. ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); plainArray.clear(); ``` @@ -479,8 +482,8 @@ callbackfn ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); plainArray.forEach((value, index) => { console.log("value:" + value, index); }); @@ -505,8 +508,8 @@ Obtains an iterator object that contains key-value pairs, where the key is of th ```ts let plainArray = new PlainArray(); -plainArray.add(1, "sddfhf"); -plainArray.add(2, "sffdfhf"); +plainArray.add(1, "squirrel"); +plainArray.add(2, "sparrow"); // Method 1: for (let item of plainArray) { diff --git a/en/application-dev/reference/apis/js-apis-process.md b/en/application-dev/reference/apis/js-apis-process.md index 8420e6055aadb9d2e7d45567d25b5fee9c21b795..a05b509b3c5072c28129c1d58a6d2974a4d2a01b 100755 --- a/en/application-dev/reference/apis/js-apis-process.md +++ b/en/application-dev/reference/apis/js-apis-process.md @@ -64,8 +64,8 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var child = process.runCmd('ls'); -var result = child.wait(); +let child = process.runCmd('ls'); +let result = child.wait(); result.then(val=>{ console.log("result = " + val); }) @@ -91,8 +91,8 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var child = process.runCmd('ls'); -var result = child.wait(); +let child = process.runCmd('ls'); +let result = child.wait(); child.getOutput().then(val=>{ console.log("child.getOutput = " + val); }) @@ -118,8 +118,8 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var child = process.runCmd('madir test.text'); -var result = child.wait(); +let child = process.runCmd('madir test.text'); +let result = child.wait(); child.getErrorOutput().then(val=>{ console.log("child.getErrorOutput= " + val); }) @@ -139,7 +139,7 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var child = process.runCmd('sleep 5; ls'); +let child = process.runCmd('sleep 5; ls'); child.close(); ``` @@ -163,7 +163,7 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var child = process.runCmd('sleep 5; ls'); +let child = process.runCmd('sleep 5; ls'); child.kill(9); ``` @@ -185,7 +185,7 @@ Checks whether this process is isolated. **Example** ```js -var result = process.isIsolatedProcess(); +let result = process.isIsolatedProcess(); ``` @@ -212,7 +212,7 @@ Checks whether a UID belongs to this app. **Example** ```js -var result = process.isAppUid(688); +let result = process.isAppUid(688); ``` @@ -233,7 +233,7 @@ Checks whether this process is running in a 64-bit environment. **Example** ```js -var result = process.is64Bit(); +let result = process.is64Bit(); ``` @@ -260,7 +260,7 @@ Obtains the process UID based on the process name. **Example** ```js -var pres = process.getUidForName("tool") +let pres = process.getUidForName("tool") ``` @@ -287,8 +287,8 @@ Obtains the thread priority based on the specified TID. **Example** ```js -var tid = process.tid; -var pres = process.getThreadPriority(tid); +let tid = process.tid; +let pres = process.getThreadPriority(tid); ``` @@ -309,7 +309,7 @@ Obtains the duration, in milliseconds, from the time the system starts to the ti **Example** ```js -var realtime = process.getStartRealtime(); +let realtime = process.getStartRealtime(); ``` ## process.getPastCpuTime8+ @@ -329,7 +329,7 @@ Obtains the CPU time (in milliseconds) from the time the process starts to the c **Example** ```js -var result = process.getPastCpuTime() ; +let result = process.getPastCpuTime() ; ``` @@ -356,8 +356,8 @@ Obtains the system configuration. **Example** ```js -var _SC_ARG_MAX = 0 -var pres = process.getSystemConfig(_SC_ARG_MAX) +let _SC_ARG_MAX = 0 +let pres = process.getSystemConfig(_SC_ARG_MAX) ``` @@ -384,7 +384,7 @@ Obtains the value of an environment variable. **Example** ```js -var pres = process.getEnvironmentVar("PATH") +let pres = process.getEnvironmentVar("PATH") ``` @@ -422,8 +422,8 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var child = process.runCmd('ls', { maxBuffer : 2 }); -var result = child.wait(); +let child = process.runCmd('ls', { maxBuffer : 2 }); +let result = child.wait(); child.getOutput.then(val=>{ console.log("child.getOutput = " + val); }) @@ -505,7 +505,7 @@ This is a system API and cannot be called by third-party applications. process.on("data", (e)=>{ console.log("data callback"); }) -var result = process.off("data"); +let result = process.off("data"); ``` @@ -545,7 +545,7 @@ This is a system API and cannot be called by third-party applications. **Example** ```js -var path = process.cwd(); +let path = process.cwd(); ``` @@ -589,7 +589,7 @@ Obtains the running time of this process. **Example** ```js -var time = process.uptime(); +let time = process.uptime(); ``` @@ -617,6 +617,6 @@ Sends a signal to the specified process to terminate it. **Example** ```js -var pres = process.pid -var result = process.kill(28, pres) +let pres = process.pid +let result = process.kill(28, pres) ``` diff --git a/en/application-dev/reference/apis/js-apis-processrunninginfo.md b/en/application-dev/reference/apis/js-apis-processrunninginfo.md index e26e01dc8f8d7fbb6472d11217f1156ceb1b41b8..f08032456915595af5da869b74aa0ab1888ffb6b 100644 --- a/en/application-dev/reference/apis/js-apis-processrunninginfo.md +++ b/en/application-dev/reference/apis/js-apis-processrunninginfo.md @@ -1,10 +1,10 @@ -# ProcessRunningInfo +# ProcessRunningInfo(deprecated) The **ProcessRunningInfo** module provides process running information. > **NOTE** -> -> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> - The APIs provided by this module are deprecated since API version 9. You are advised to use [ProcessRunningInformation9+](js-apis-processrunninginformation.md) instead. +> - The initial APIs of this module are supported since API version 8. ## Usage @@ -19,9 +19,9 @@ appManager.getProcessRunningInfos((error,data) => { ## Attributes -**System capability**: SystemCapability.Ability.AbilityRuntime.Core +**System capability**: SystemCapability.Ability.AbilityRuntime.Mission - | Name| Type| Readable| Writable| Description| +| Name| Type| Readable| Writable| Description| | -------- | -------- | -------- | -------- | -------- | | pid | number | Yes| No| Process ID.| | uid | number | Yes| No| User ID.| diff --git a/en/application-dev/reference/apis/js-apis-processrunninginformation.md b/en/application-dev/reference/apis/js-apis-processrunninginformation.md new file mode 100644 index 0000000000000000000000000000000000000000..a5add77380e1a9173f9d1d1b1e44b2dfee5be38c --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-processrunninginformation.md @@ -0,0 +1,29 @@ +# ProcessRunningInformation9+ + +The **ProcessRunningInformation** module provides process running information. + +> **NOTE** +> +> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. + +## Usage Guidelines + +The process running information is obtained through [appManager](js-apis-appmanager.md#appmanagergetprocessrunninginformation9). + +```js +import appManager from '@ohos.application.appManager'; +appManager.getProcessRunningInformation((error,data) => { + console.log("getProcessRunningInformation error: " + error.code + " data: " + JSON.stringify(data)); +}); +``` + +## Attributes + +**System capability**: SystemCapability.Ability.AbilityRuntime.Core + +| Name| Type| Readable| Writable| Description| +| -------- | -------- | -------- | -------- | -------- | +| pid | number | Yes| No| Process ID.| +| uid | number | Yes| No| User ID.| +| processName | string | Yes| No| Process name.| +| bundleNames | Array<string> | Yes| No| Names of all running bundles in the process.| diff --git a/en/application-dev/reference/apis/js-apis-prompt.md b/en/application-dev/reference/apis/js-apis-prompt.md index 971b3408c9a9fdd616fe1133ca3cab3844ee7fd1..e88c899e36745869e6009616b1c8581c3fa37b49 100644 --- a/en/application-dev/reference/apis/js-apis-prompt.md +++ b/en/application-dev/reference/apis/js-apis-prompt.md @@ -21,28 +21,31 @@ Shows a toast. **System capability**: SystemCapability.ArkUI.ArkUI.Full **Parameters** + | Name | Type | Mandatory | Description | | ------- | ------------------------------------- | ---- | ------- | | options | [ShowToastOptions](#showtoastoptions) | Yes | Toast options.| **Example** - ```js + +```js prompt.showToast({ message: 'Message Info', duration: 2000, }); - ``` +``` + ## ShowToastOptions Describes the options for showing the toast. **System capability**: SystemCapability.ArkUI.ArkUI.Full -| Name | Type | Mandatory | Description | -| -------- | ---------------------------------------- | ------ | ---------------------------------------- | -| message | string\| [Resource](.../ui/ts-types.md#resource-type)9+| Yes | Text to display. | -| duration | number | No | Duration that the toast will remain on the screen. The default value is 1500 ms. The recommended value range is 1500 ms to 10000 ms. If a value less than 1500 ms is set, the default value is used.| -| bottom | string\| number | No | Distance between the toast border and the bottom of the screen. | +| Name | Type | Mandatory | Description | +| -------- | ---------------------------------------- | ---- | ---------------------------------------- | +| message | string\| [Resource](../../ui/ts-types.md#resource-type)9+| Yes | Text to display. | +| duration | number | No | Duration that the toast will remain on the screen. The default value is 1500 ms. The value range is 1500 ms to 10000 ms. If a value less than 1500 ms is set, the default value is used. If the value greater than 10000 ms is set, the upper limit 10000 ms is used.| +| bottom | string\| number | No | Distance between the toast border and the bottom of the screen. | ## prompt.showDialog @@ -53,6 +56,7 @@ Shows a dialog box. This API uses a promise to return the result synchronously. **System capability**: SystemCapability.ArkUI.ArkUI.Full **Parameters** + | Name | Type | Mandatory | Description | | ------- | --------------------------------------- | ---- | ------ | | options | [ShowDialogOptions](#showdialogoptions) | Yes | Dialog box options.| @@ -65,7 +69,7 @@ Shows a dialog box. This API uses a promise to return the result synchronously. **Example** - ```js +```js prompt.showDialog({ title: 'Title Info', message: 'Message Info', @@ -86,7 +90,7 @@ prompt.showDialog({ .catch(err => { console.info('showDialog error: ' + err); }) - ``` +``` ## prompt.showDialog @@ -96,15 +100,16 @@ Shows a dialog box. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.ArkUI.ArkUI.Full - **Parameters** + | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | ------------ | | options | [ShowDialogOptions](#showdialogoptions) | Yes | Dialog box options.| | callback | AsyncCallback<[ShowDialogSuccessResponse](#showdialogsuccessresponse)> | Yes | Callback used to return the dialog box response result. | **Example** - ```js + +```js prompt.showDialog({ title: 'showDialog Title Info', message: 'Message Info', @@ -125,7 +130,7 @@ prompt.showDialog({ } console.info('showDialog success callback, click button: ' + data.index); }); - ``` +``` ## ShowDialogOptions @@ -135,8 +140,8 @@ Describes the options for showing the dialog box. | Name | Type | Mandatory | Description | | ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](.../ui/ts-types.md#resource-type)9+| No | Title of the dialog box. | -| message | string\| [Resource](.../ui/ts-types.md#resource-type)9+| No | Text body. | +| title | string\| [Resource](../../ui/ts-types.md#resource-type)9+| No | Title of the dialog box. | +| message | string\| [Resource](../../ui/ts-types.md#resource-type)9+| No | Text body. | | buttons | Array | No | Array of buttons in the dialog box. The array structure is **{text:'button', color: '\#666666'}**. Up to three buttons are supported. The first button is of the **positiveButton** type, the second is of the **negativeButton** type, and the third is of the **neutralButton** type.| ## ShowDialogSuccessResponse @@ -159,6 +164,7 @@ Shows an action menu. This API uses a callback to return the result asynchronous **System capability**: SystemCapability.ArkUI.ArkUI.Full **Parameters** + | Name | Type | Mandatory | Description | | -------- | ---------------------------------------- | ---- | --------- | | options | [ActionMenuOptions](#actionmenuoptions) | Yes | Action menu options. | @@ -166,7 +172,8 @@ Shows an action menu. This API uses a callback to return the result asynchronous **Example** - ```js + +```js prompt.showActionMenu({ title: 'Title Info', buttons: [ @@ -186,7 +193,7 @@ prompt.showActionMenu({ } console.info('showActionMenu success callback, click button: ' + data.index); }) - ``` +``` ## prompt.showActionMenu @@ -197,17 +204,20 @@ Shows an action menu. This API uses a promise to return the result synchronously **System capability**: SystemCapability.ArkUI.ArkUI.Full **Parameters** + | Name | Type | Mandatory | Description | | ------- | --------------------------------------- | ---- | ------- | | options | [ActionMenuOptions](#actionmenuoptions) | Yes | Action menu options.| **Return value** + | Type | Description | | ---------------------------------------- | ------- | | Promise<[ActionMenuSuccessResponse](#actionmenusuccessresponse)> | Promise used to return the action menu response result.| **Example** - ```js + +```js prompt.showActionMenu({ title: 'showActionMenu Title Info', buttons: [ @@ -227,7 +237,7 @@ prompt.showActionMenu({ .catch(err => { console.info('showActionMenu error: ' + err); }) - ``` +``` ## ActionMenuOptions Describes the options for showing the action menu. @@ -236,7 +246,7 @@ Describes the options for showing the action menu. | Name | Type | Mandatory | Description | | ------- | ---------------------------------------- | ---- | ---------------------------------------- | -| title | string\| [Resource](.../ui/ts-types.md#resource-type)9+| No | Title of the text to display. | +| title | string\| [Resource](../../ui/ts-types.md#resource-type)9+| No | Title of the text to display. | | buttons | Array<[Button](#button)> | Yes | Array of menu item buttons. The array structure is **{text:'button', color: '\#666666'}**. Up to six buttons are supported. If there are more than six buttons, extra buttons will not be displayed.| ## ActionMenuSuccessResponse @@ -257,5 +267,5 @@ Describes the menu item button in the action menu. | Name | Type | Mandatory | Description | | ----- | ---------------------------------------- | ---- | ------- | -| text | string\| [Resource](.../ui/ts-types.md#resource-type)9+| Yes | Button text.| -| color | string\| [Resource](.../ui/ts-types.md#resource-type)9+| Yes | Text color of the button.| +| text | string\| [Resource](../../ui/ts-types.md#resource-type)9+| Yes | Button text.| +| color | string\| [Resource](../../ui/ts-types.md#resource-type)9+| Yes | Text color of the button.| diff --git a/en/application-dev/reference/apis/js-apis-queue.md b/en/application-dev/reference/apis/js-apis-queue.md index a31a72649d0e0ede56771f3fa6c9bf4d25bbefe7..13ae6256d81a27c3fe53466ac175c74486051ee2 100644 --- a/en/application-dev/reference/apis/js-apis-queue.md +++ b/en/application-dev/reference/apis/js-apis-queue.md @@ -10,6 +10,9 @@ Unlike **[Deque](js-apis-deque.md)**, which supports insertion and removal at bo **Recommended use case**: Use **Queue** in FIFO scenarios. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -72,7 +75,7 @@ let result1 = queue.add(1); queue.add(1); let b = [1, 2, 3]; queue.add(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; let result3 = queue.add(c); ``` @@ -180,6 +183,7 @@ Obtains an iterator, each item of which is a JavaScript object. | IterableIterator<T> | Iterator obtained.| **Example** + ```ts let queue = new Queue(); queue.add(2); diff --git a/en/application-dev/reference/apis/js-apis-radio.md b/en/application-dev/reference/apis/js-apis-radio.md index ee61f71f78a97411006f72225f5ac4a65e09e300..d094a5c7e3abd27ebc042ab377543a3d2898b1e1 100644 --- a/en/application-dev/reference/apis/js-apis-radio.md +++ b/en/application-dev/reference/apis/js-apis-radio.md @@ -70,7 +70,7 @@ let promise = radio.getRadioTech(slotId); promise.then(data => { console.log(`getRadioTech success, data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getRadioTech fail, err->${JSON.stringify(err)}`); + console.log(`getRadioTech failed, err->${JSON.stringify(err)}`); }); ``` @@ -157,7 +157,7 @@ let promise = radio.getNetworkState(slotId); promise.then(data => { console.log(`getNetworkState success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getNetworkState fail, promise: err->${JSON.stringify(err)}`); + console.log(`getNetworkState failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -215,7 +215,7 @@ let promise = radio.getNetworkSelectionMode(slotId); promise.then(data => { console.log(`getNetworkSelectionMode success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getNetworkSelectionMode fail, promise: err->${JSON.stringify(err)}`); + console.log(`getNetworkSelectionMode failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -273,7 +273,7 @@ let promise = radio.getISOCountryCodeForNetwork(slotId); promise.then(data => { console.log(`getISOCountryCodeForNetwork success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getISOCountryCodeForNetwork fail, promise: err->${JSON.stringify(err)}`); + console.log(`getISOCountryCodeForNetwork failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -322,7 +322,7 @@ let promise = radio.getPrimarySlotId(); promise.then(data => { console.log(`getPrimarySlotId success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getPrimarySlotId fail, promise: err->${JSON.stringify(err)}`); + console.error(`getPrimarySlotId failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -380,7 +380,7 @@ let promise = radio.getSignalInformation(slotId); promise.then(data => { console.log(`getSignalInformation success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getSignalInformation fail, promise: err->${JSON.stringify(err)}`); + console.error(`getSignalInformation failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -496,7 +496,7 @@ let promise = radio.isRadioOn(slotId); promise.then(data => { console.log(`isRadioOn success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`isRadioOn fail, promise: err->${JSON.stringify(err)}`); + console.error(`isRadioOn failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -554,7 +554,7 @@ let promise = radio.getOperatorName(slotId); promise.then(data => { console.log(`getOperatorName success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getOperatorName fail, promise: err->${JSON.stringify(err)}`); + console.log(`getOperatorName failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -564,7 +564,7 @@ setPrimarySlotId(slotId: number, callback: AsyncCallback): void Sets the ID of the slot in which the primary card is located. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -593,7 +593,7 @@ setPrimarySlotId\(slotId: number\): Promise\ Sets the ID of the slot in which the primary card is located. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -619,7 +619,7 @@ let promise = radio.setPrimarySlotId(slotId); promise.then(data => { console.log(`setPrimarySlotId success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`setPrimarySlotId fail, promise: err->${JSON.stringify(err)}`); + console.log(`setPrimarySlotId failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -629,7 +629,7 @@ getIMEI(callback: AsyncCallback): void Obtains the IMEI of the SIM card in a card slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -656,7 +656,7 @@ getIMEI(slotId: number, callback: AsyncCallback): void Obtains the IMEI of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -685,7 +685,7 @@ getIMEI(slotId?: number): Promise Obtains the IMEI of the SIM card in a card slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -711,7 +711,7 @@ let promise = radio.getIMEI(slotId); promise.then(data => { console.log(`getIMEI success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getIMEI fail, promise: err->${JSON.stringify(err)}`); + console.error(`getIMEI failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -721,7 +721,7 @@ getMEID(callback: AsyncCallback): void Obtains the MEID of the SIM card in a card slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -748,7 +748,7 @@ getMEID(slotId: number, callback: AsyncCallback): void Obtains the MEID of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -777,7 +777,7 @@ getMEID(slotId?: number): Promise Obtains the MEID of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -803,7 +803,7 @@ let promise = radio.getMEID(slotId); promise.then(data => { console.log(`getMEID success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getMEID fail, promise: err->${JSON.stringify(err)}`); + console.error(`getMEID failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -813,7 +813,7 @@ getUniqueDeviceId(callback: AsyncCallback): void Obtains the unique device ID of the SIM card in a card slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -840,7 +840,7 @@ getUniqueDeviceId(slotId: number, callback: AsyncCallback): void Obtains the unique device ID of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -869,7 +869,7 @@ getUniqueDeviceId(slotId?: number): Promise Obtains the unique device ID of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -895,7 +895,7 @@ let promise = radio.getUniqueDeviceId(slotId); promise.then(data => { console.log(`getUniqueDeviceId success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getUniqueDeviceId fail, promise: err->${JSON.stringify(err)}`); + console.error(`getUniqueDeviceId failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -905,7 +905,7 @@ sendUpdateCellLocationRequest\(callback: AsyncCallback\): void Sends a cell location update request. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -929,7 +929,7 @@ sendUpdateCellLocationRequest\(slotId: number, callback: AsyncCallback\): Sends a cell location update request for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -955,7 +955,7 @@ sendUpdateCellLocationRequest\(slotId?: number): Promise Sends a cell location update request for the SIM card in the specified slot.This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -979,7 +979,7 @@ let promise = radio.sendUpdateCellLocationRequest(slotId); promise.then(data => { console.log(`sendUpdateCellLocationRequest success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`sendUpdateCellLocationRequest fail, promise: err->${JSON.stringify(err)}`); + console.log(`sendUpdateCellLocationRequest failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -989,7 +989,7 @@ getCellInformation(callback: AsyncCallback>): void Obtains cell information. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permissions**: ohos.permission.LOCATION @@ -1016,7 +1016,7 @@ getCellInformation(slotId: number, callback: AsyncCallback\> Obtains cell information for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permissions**: ohos.permission.LOCATION @@ -1071,7 +1071,7 @@ let promise = radio.getCellInformation(slotId); promise.then(data => { console.log(`getCellInformation success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getCellInformation fail, promise: err->${JSON.stringify(err)}`); + console.error(`getCellInformation failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1081,7 +1081,7 @@ setNetworkSelectionMode\(options: NetworkSelectionModeOptions, callback: AsyncCa Sets the network selection mode. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1120,7 +1120,7 @@ setNetworkSelectionMode\(options: NetworkSelectionModeOptions\): Promise Sets the network selection mode. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1157,7 +1157,7 @@ let promise = radio.setNetworkSelectionMode(networkSelectionModeOptions); promise.then(data => { console.log(`setNetworkSelectionMode success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`setNetworkSelectionMode fail, promise: err->${JSON.stringify(err)}`); + console.log(`setNetworkSelectionMode failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1167,7 +1167,7 @@ getNetworkSearchInformation\(slotId: number, callback: AsyncCallback Obtains network search information for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1219,7 +1219,7 @@ let promise = radio.getNetworkSearchInformation(0); promise.then(data => { console.log(`getNetworkSearchInformation success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getNetworkSearchInformation fail, promise: err->${JSON.stringify(err)}`); + console.log(`getNetworkSearchInformation failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1229,7 +1229,7 @@ getNrOptionMode(callback: AsyncCallback): void Obtains the NR option mode. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1254,7 +1254,7 @@ getNrOptionMode(slotId: number, callback: AsyncCallback): void Obtains the NR option mode for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1281,7 +1281,7 @@ getNrOptionMode(slotId?: number): Promise Obtains the NR option mode for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1305,7 +1305,7 @@ let promise = radio.getNrOptionMode(slotId); promise.then(data => { console.log(`getNrOptionMode success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getNrOptionMode fail, promise: err->${JSON.stringify(err)}`); + console.error(`getNrOptionMode failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1315,7 +1315,7 @@ turnOnRadio(callback: AsyncCallback): void Turns on the radio function. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1342,7 +1342,7 @@ turnOnRadio(slotId: number, callback: AsyncCallback): void Turns on the radio function for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1371,7 +1371,7 @@ turnOnRadio(slotId?: number): Promise Turns on the radio function for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1397,7 +1397,7 @@ let promise = radio.turnOnRadio(slotId); promise.then(data => { console.log(`turnOnRadio success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`turnOnRadio fail, promise: err->${JSON.stringify(err)}`); + console.error(`turnOnRadio failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1407,7 +1407,7 @@ turnOffRadio(callback: AsyncCallback): void Turns off the radio function. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1434,7 +1434,7 @@ turnOffRadio(slotId: number, callback: AsyncCallback): void Turns off the radio function for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1463,7 +1463,7 @@ turnOffRadio(slotId?: number): Promise Turns off the radio function for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1489,7 +1489,7 @@ let promise = radio.turnOffRadio(slotId); promise.then(data => { console.log(`turnOffRadio success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`turnOffRadio fail, promise: err->${JSON.stringify(err)}`); + console.error(`turnOffRadio failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1499,7 +1499,7 @@ setPreferredNetwork\(slotId: number, networkMode: PreferredNetworkMode, callback Sets the preferred network for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1527,7 +1527,7 @@ setPreferredNetwork(slotId: number, networkMode: PreferredNetworkMode): Promise< Sets the preferred network for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1553,7 +1553,7 @@ let promise = radio.setPreferredNetwork(0, 1); promise.then(data => { console.log(`setPreferredNetwork success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`setPreferredNetwork fail, promise: err->${JSON.stringify(err)}`); + console.log(`setPreferredNetwork failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1563,7 +1563,7 @@ getPreferredNetwork\(slotId: number, callback: AsyncCallback Obtains the preferred network for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1615,7 +1615,7 @@ let promise = radio.getPreferredNetwork(0); promise.then(data => { console.log(`getPreferredNetwork success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getPreferredNetwork fail, promise: err->${JSON.stringify(err)}`); + console.log(`getPreferredNetwork failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1625,7 +1625,7 @@ getImsRegInfo(slotId: number, imsType: ImsServiceType, callback: AsyncCallback Obtains the IMS registration status of the specified IMS service type for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1679,7 +1679,7 @@ let promise = radio.getImsRegInfo(0, 1); promise.then(data => { console.log(`getImsRegInfo success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.log(`getImsRegInfo fail, promise: err->${JSON.stringify(err)}`); + console.log(`getImsRegInfo failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1689,7 +1689,7 @@ on(type: 'imsRegStateChange', slotId: number, imsType: ImsServiceType, callback: Enables listening for **imsRegStateChange** events for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1718,7 +1718,7 @@ off(type: 'imsRegStateChange', slotId: number, imsType: ImsServiceType, callback Disables listening for **imsRegStateChange** events for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1857,7 +1857,7 @@ Enumerates network selection modes. Enumerates preferred network modes. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1902,7 +1902,7 @@ This is a system API. Defines the cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1918,7 +1918,7 @@ This is a system API. Defines the CDMA cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1934,7 +1934,7 @@ This is a system API. Defines the GSM cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1951,7 +1951,7 @@ This is a system API. Defines the LTE cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1970,7 +1970,7 @@ This is a system API. Defines the NR cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1987,7 +1987,7 @@ This is a system API. Defines the TD-SCDMA cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2004,7 +2004,7 @@ This is a system API. Defines the WCDMA cell information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2021,7 +2021,7 @@ This is a system API. Enumerates NR selection modes. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2036,7 +2036,7 @@ This is a system API. Defines the network search result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2049,7 +2049,7 @@ This is a system API. Defines the network information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2064,7 +2064,7 @@ This is a system API. Enumerates network information states. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2079,7 +2079,7 @@ This is a system API. Defines the network selection mode. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2094,7 +2094,7 @@ This is a system API. Enumerates IMS registration states. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2107,7 +2107,7 @@ This is a system API. Enumerates IMS registration technologies. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2122,7 +2122,7 @@ This is a system API. Defines the IMS registration information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2135,7 +2135,7 @@ This is a system API. Enumerates IMS service types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService diff --git a/en/application-dev/reference/apis/js-apis-rpc.md b/en/application-dev/reference/apis/js-apis-rpc.md index 60cd08a08e0baf3853bf11f2628230a402805900..d1b4506837068ac88f3821befed6a673726fd327 100644 --- a/en/application-dev/reference/apis/js-apis-rpc.md +++ b/en/application-dev/reference/apis/js-apis-rpc.md @@ -16,7 +16,7 @@ import rpc from '@ohos.rpc'; ## MessageParcel -Provides methods for reading and writing basic data types and arrays, inter-process communication (IPC) objects, interface tokens, and sequenceable objects. +Provides APIs for reading and writing data in specific format. During RPC, the sender can use the **write()** method provided **MessageParcel** to write data to a **MessageParcel** object in specific format. The receiver can use the **read()** method provided by **MessageParcel** to read data in specific format from a **MessageParcel** object. The data formats include basic data types and arrays, IPC objects, interface tokens, and custom sequenceable objects. ### create @@ -28,7 +28,8 @@ Creates a **MessageParcel** object. This method is a static method. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | MessageParcel | **MessageParcel** object created.| @@ -65,12 +66,14 @@ writeRemoteObject(object: [IRemoteObject](#iremoteobject)): boolean **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | object | [IRemoteObject](#iremoteobject) | Yes| Remote object to serialize and write to the **MessageParcel** object.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -111,7 +114,8 @@ Reads the remote object from this **MessageParcel** object. You can use this met **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | [IRemoteObject](#iremoteobject) | Remote object obtained.| @@ -148,17 +152,19 @@ Reads the remote object from this **MessageParcel** object. You can use this met writeInterfaceToken(token: string): boolean -Writes an interface token to this **MessageParcel** object. +Writes an interface token to this **MessageParcel** object. The remote object can use this interface token to verify the communication. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | token | string | Yes| Interface token to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -175,12 +181,13 @@ Writes an interface token to this **MessageParcel** object. 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. +Reads the interface token from this **MessageParcel** object. The interface token is read in the sequence in which it is written to the **MessageParcel** object. The local object can use it to verify the communication. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | Interface token obtained.| @@ -206,7 +213,8 @@ Obtains the data size of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Size of the **MessageParcel** object obtained, in bytes.| @@ -228,7 +236,8 @@ Obtains the capacity of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | **MessageParcel** capacity obtained, in bytes.| @@ -250,12 +259,14 @@ Sets the size of data contained in this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | size | number | Yes| Data size to set, in bytes.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -277,12 +288,14 @@ Sets the storage capacity of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | size | number | Yes| Storage capacity to set, in bytes.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -304,7 +317,8 @@ Obtains the writable capacity of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | **MessageParcel** writable capacity obtained, in bytes.| @@ -330,7 +344,8 @@ Obtains the readable capacity of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | **MessageParcel** object readable capacity, in bytes.| @@ -356,7 +371,8 @@ Obtains the read position of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Current read position of the **MessageParcel** object.| @@ -378,7 +394,8 @@ Obtains the write position of this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Current write position of the **MessageParcel** object.| @@ -401,12 +418,14 @@ Moves the read pointer to the specified position. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | pos | number | Yes| Position from which data is to read.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the read position changes; returns **false** otherwise.| @@ -433,12 +452,14 @@ Moves the write pointer to the specified position. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | pos | number | Yes| Position from which data is to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the write position changes; returns **false** otherwise.| @@ -463,12 +484,14 @@ Writes a Byte value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Byte value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -490,7 +513,8 @@ Reads the Byte value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Byte value read.| @@ -514,12 +538,14 @@ Writes a Short int value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Short int value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -541,7 +567,8 @@ Reads the Short int value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Short int value read.| @@ -565,12 +592,14 @@ Writes an Int value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Int value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -592,7 +621,8 @@ Reads the Int value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Int value read.| @@ -616,12 +646,14 @@ Writes a Long int value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Long int value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -643,7 +675,8 @@ Reads the Long int value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Long int value read.| @@ -667,12 +700,14 @@ Writes a Float value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Float value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -694,7 +729,8 @@ Reads the Float value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Float value read.| @@ -718,12 +754,14 @@ Writes a Double value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Double value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -745,7 +783,8 @@ Reads the Double value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Double value read.| @@ -769,12 +808,14 @@ Writes a Boolean value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | boolean | Yes| Boolean value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -796,7 +837,8 @@ Reads the Boolean value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Boolean value read.| @@ -820,12 +862,14 @@ Writes a Char value to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | number | Yes| Char value to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -847,7 +891,8 @@ Reads the Char value from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Char value read.| @@ -871,12 +916,14 @@ Writes a string to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | string | Yes| String to write. The length of the string must be less than 40960 bytes.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -898,7 +945,8 @@ Reads a string from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | String read.| @@ -922,12 +970,14 @@ Writes a sequenceable object to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | val | [Sequenceable](#sequenceable) | Yes| Sequenceable object to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -968,12 +1018,14 @@ Reads member variables from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | [Sequenceable](#sequenceable) | Yes| Object that reads member variables from the **MessageParcel** object.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1017,12 +1069,14 @@ Writes a byte array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | byteArray | number[] | Yes| Byte array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1045,7 +1099,8 @@ Reads a byte array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| Byte array to read.| @@ -1070,7 +1125,8 @@ Reads the byte array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Byte array read.| @@ -1095,12 +1151,14 @@ Writes a short array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | shortArray | number[] | Yes| Short array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1122,7 +1180,8 @@ Reads a short array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| Short array to read.| @@ -1146,7 +1205,8 @@ Reads the short array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Short array read.| @@ -1170,12 +1230,14 @@ Writes an integer array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | intArray | number[] | Yes| Integer array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1197,7 +1259,8 @@ Reads an integer array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| Integer array to read.| @@ -1221,7 +1284,8 @@ Reads the integer array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Integer array read.| @@ -1245,12 +1309,14 @@ Writes a long array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | longArray | number[] | Yes| Long array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1272,7 +1338,8 @@ Reads a long array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| Long array to read.| @@ -1296,7 +1363,8 @@ Reads the long array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Long array read.| @@ -1320,12 +1388,14 @@ Writes a FloatArray to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | floatArray | number[] | Yes| FloatArray to write. The system processes Float data as that of the Double type. Therefore, the total number of bytes occupied by a FloatArray must be calculated as the Double type.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1347,7 +1417,8 @@ Reads a FloatArray from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| FloatArray to read. The system processes Float data as that of the Double type. Therefore, the total number of bytes occupied by a FloatArray must be calculated as the Double type.| @@ -1372,7 +1443,8 @@ Reads the FloatArray from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | FloatArray read.| @@ -1396,12 +1468,14 @@ Writes a DoubleArray to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | doubleArray | number[] | Yes| DoubleArray to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1423,7 +1497,8 @@ Reads a DoubleArray from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| DoubleArray to read.| @@ -1447,7 +1522,8 @@ Reads the DoubleArray from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | DoubleArray read.| @@ -1471,12 +1547,14 @@ Writes a Boolean array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | booleanArray | boolean[] | Yes| Boolean array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1498,7 +1576,8 @@ Reads a Boolean array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | boolean[] | Yes| Boolean array to read.| @@ -1522,7 +1601,8 @@ Reads the Boolean array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean[] | Boolean array read.| @@ -1545,12 +1625,14 @@ Writes a character array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | charArray | number[] | Yes| Character array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1572,7 +1654,8 @@ Reads a character array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | number[] | Yes| Character array to read.| @@ -1596,7 +1679,8 @@ Reads the character array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Character array read.| @@ -1620,12 +1704,14 @@ Writes a string array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | stringArray | string[] | Yes| String array to write. The length of a single element in the array must be less than 40960 bytes.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1647,7 +1733,8 @@ Reads a string array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | string[] | Yes| String array to read.| @@ -1671,7 +1758,8 @@ Reads the string array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string[] | String array read.| @@ -1793,12 +1881,14 @@ Writes a sequenceable array to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | sequenceableArray | Sequenceable[] | Yes| Sequenceable array to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -1842,7 +1932,8 @@ Reads a sequenceable array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | sequenceableArray | Sequenceable[] | Yes| Sequenceable array to read.| @@ -1888,12 +1979,14 @@ Writes an array of **IRemoteObject** objects to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | objectArray | IRemoteObject[] | Yes| Array of **IRemoteObject** objects to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** if the operation fails or if the **IRemoteObject** array is null.| @@ -1939,7 +2032,8 @@ Reads an **IRemoteObject** array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | objects | IRemoteObject[] | Yes| **IRemoteObject** array to read.| @@ -1986,7 +2080,8 @@ Reads the **IRemoteObject** array from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | IRemoteObject[] | **IRemoteObject** object array obtained.| @@ -2034,7 +2129,8 @@ Closes a file descriptor. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | fd | number | Yes| File descriptor to close.| @@ -2057,12 +2153,14 @@ Duplicates a file descriptor. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | fd | number | Yes| File descriptor to duplicate.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | New file descriptor.| @@ -2085,7 +2183,8 @@ Checks whether this **MessageParcel** object contains a file descriptor. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the **MessageParcel** object contains a file descriptor; returns **false** otherwise.| @@ -2113,12 +2212,14 @@ Writes a file descriptor to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | fd | number | Yes| File descriptor to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -2143,7 +2244,8 @@ Reads the file descriptor from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | File descriptor read.| @@ -2169,12 +2271,14 @@ Writes an anonymous shared object to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | ashmem | Ashmem | Yes| Anonymous shared object to write.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -2197,7 +2301,8 @@ Reads the anonymous shared object from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Ashmem | Anonymous share object obtained.| @@ -2222,7 +2327,8 @@ Obtains the maximum amount of raw data that can be held by this **MessageParcel* **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | 128 MB, which is the maximum amount of raw data that can be held by this **MessageParcel** object.| @@ -2244,13 +2350,15 @@ Writes raw data to this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | rawData | number[] | Yes| Raw data to write.| | size | number | Yes| Size of the raw data, in bytes.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -2273,12 +2381,14 @@ Reads raw data from this **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | size | number | Yes| Size of the raw data to read.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Raw data obtained, in bytes.| @@ -2307,12 +2417,14 @@ Marshals the sequenceable object into a **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataOut | [MessageParcel](#messageparcel) | Yes| **MessageParcel** object to which the sequenceable object is to be marshaled.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -2356,12 +2468,14 @@ Unmarshals this sequenceable object from a **MessageParcel** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | dataIn | [MessageParcel](#messageparcel) | Yes| **MessageParcel** object in which the sequenceable object is to be unmarshaled.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -2405,12 +2519,13 @@ Provides the holder of a remote proxy object. asObject(): IRemoteObject -Obtains a proxy or remote object. This method must be implemented by its derived classes. +Obtains a proxy or remote object. This API must be implemented by its derived classes. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | [IRemoteObject](#iremoteobject) | Returns the [RemoteObject](#ashmem8) if it is the caller; returns the [IRemoteObject](#iremoteobject), the holder of this **RemoteProxy** object, if the caller is a [RemoteProxy](#remoteproxy) object.| @@ -2491,29 +2606,32 @@ Obtains the interface. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | descriptor | string | Yes| Interface descriptor.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | IRemoteBroker | **IRemoteBroker** object bound to the specified interface descriptor.| ### sendRequest(deprecated) +sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean + > **NOTE**
> This API is deprecated since API version 8. You are advised to use [sendRequestAsync9+](#sendrequestasync9). -sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean - Sends a **MessageParcel** message to the remote process in synchronous or asynchronous mode. If **options** is the asynchronous mode, a promise will be fulfilled immediately and the reply message does not contain any content. If **options** is the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2521,24 +2639,26 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ### sendRequest8+(deprecated) -> **NOTE**
-> This API is deprecated since API Version 9. You are advised to use [sendRequestAsync9+](#sendrequestasync9). - sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult> +> **NOTE**
+> This API is deprecated since API version 9. You are advised to use [sendRequestAsync9+](#sendrequestasync9). + Sends a **MessageParcel** message to the remote process in synchronous or asynchronous mode. If **options** is the asynchronous mode, a promise will be fulfilled immediately and the reply message does not contain any content. If **options** is the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2546,7 +2666,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Promise<SendRequestResult> | Promise used to return the **sendRequestResult** object.| @@ -2559,7 +2680,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2567,7 +2689,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Promise<SendRequestResult> | Promise used to return the **sendRequestResult** object.| @@ -2580,7 +2703,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2598,13 +2722,15 @@ Adds a callback for receiving death notifications of the remote object. This met **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | recipient | [DeathRecipient](#deathrecipient) | Yes| Callback to add.| | flags | number | Yes| Flag of the death notification.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the callback is added successfully; returns **false** otherwise.| @@ -2618,13 +2744,15 @@ Removes the callback used to receive death notifications of the remote object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | recipient | [DeathRecipient](#deathrecipient) | Yes| Callback to remove.| | flags | number | Yes| Flag of the death notification.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the callback is removed successfully; returns **false** otherwise.| @@ -2638,7 +2766,8 @@ Obtains the interface descriptor of this object. The interface descriptor is a s **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | Interface descriptor obtained.| @@ -2652,7 +2781,8 @@ Checks whether this object is dead. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the object is dead; returns **false** otherwise.| @@ -2676,17 +2806,18 @@ Provides methods to implement **IRemoteObject**. ### sendRequest(deprecated) -> **NOTE**
-> This API is deprecated since API Version 8. You are advised to use [sendRequestAsync9+](#sendrequestasync9-1). - sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean +> **NOTE**
+> This API is deprecated since API version 8. You are advised to use [sendRequestAsync9+](#sendrequestasync9-1). + Sends a **MessageParcel** message to the remote process in synchronous or asynchronous mode. If **options** is the asynchronous mode, a promise will be fulfilled immediately and the reply message does not contain any content. If **options** is the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2694,7 +2825,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -2741,17 +2873,18 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch ### sendRequest8+(deprecated) -> **NOTE**
-> This API is deprecated since API Version 9. You are advised to use [sendRequestAsync9+](#sendrequestasync9-1). - sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult> +> **NOTE**
+> This API is deprecated since API version 9. You are advised to use [sendRequestAsync9+](#sendrequestasync9-1). + Sends a **MessageParcel** message to the remote process in synchronous or asynchronous mode. If **options** is the asynchronous mode, a promise will be fulfilled immediately and the reply message does not contain any content. If **options** is the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2759,7 +2892,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Promise<SendRequestResult> | Promise used to return the **sendRequestResult** object.| @@ -2818,7 +2952,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2826,7 +2961,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Promise<SendRequestResult> | Promise used to return the **sendRequestResult** object.| @@ -2885,7 +3021,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -2946,12 +3083,14 @@ Obtains the **LocalInterface** object of an interface descriptor. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | interface | string | Yes| Interface descriptor.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | IRemoteBroker | Returns **Null** by default, which indicates a proxy interface.| @@ -2991,13 +3130,15 @@ Adds a callback for receiving the death notifications of the remote object, incl **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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 value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the callback is added successfully; returns **false** otherwise.| @@ -3042,13 +3183,15 @@ Removes the callback used to receive death notifications of the remote object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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 value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the callback is removed successfully; returns **false** otherwise.| @@ -3094,7 +3237,8 @@ Obtains the interface descriptor of this proxy object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | Interface descriptor obtained.| @@ -3134,7 +3278,8 @@ Checks whether the **RemoteObject** is dead. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the **RemoteObject** is dead; returns **false** otherwise.| @@ -3188,7 +3333,8 @@ A constructor used to create a **MessageOption** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | syncFlags | number | No| Call flag, which can be synchronous or asynchronous. The default value is **synchronous**.| | waitTime | number | No| Maximum wait time for an RPC call. The default value is **TF_WAIT_TIME**.| @@ -3203,7 +3349,8 @@ Obtains the call flag, which can be synchronous or asynchronous. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Call mode obtained.| @@ -3217,7 +3364,8 @@ Sets the call flag, which can be synchronous or asynchronous. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | flags | number | Yes| Call flag to set.| @@ -3231,7 +3379,8 @@ Obtains the maximum wait time for this RPC call. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Maximum wait time obtained.| @@ -3245,7 +3394,8 @@ Sets the maximum wait time for this RPC call. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | waitTime | number | Yes| Maximum wait time to set.| @@ -3264,7 +3414,8 @@ Obtains the system capability manager. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | [IRemoteObject](#iremoteobject) | System capability manager obtained.| @@ -3285,7 +3436,8 @@ Obtains the PID of the caller. This method is invoked by the **RemoteObject** ob **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | PID of the caller.| @@ -3311,7 +3463,8 @@ Obtains the UID of the caller. This method is invoked by the **RemoteObject** ob **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | UID of the caller.| @@ -3363,7 +3516,8 @@ Obtains the ID of the device hosting the caller's process. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | Device ID obtained.| @@ -3389,7 +3543,8 @@ Obtains the local device ID. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | Local device ID obtained.| @@ -3415,7 +3570,8 @@ Checks whether the remote process is a process of the local device. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the local and remote processes are on the same device; returns **false** otherwise.| @@ -3441,13 +3597,15 @@ Flushes all suspended commands from the specified **RemoteProxy** to the corresp **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | object | [IRemoteObject](#iremoteobject) | Yes| **RemoteProxy** specified. | **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | Returns **0** if the operation is successful; returns an error code if the input object is null or a **RemoteObject**, or if the operation fails.| @@ -3488,7 +3646,8 @@ Changes the UID and PID of the remote user to the UID and PID of the local user. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | String containing the UID and PID of the remote user.| @@ -3514,12 +3673,14 @@ Restores the UID and PID of the remote user. It is usually called when the UID a **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | identity | string | Yes| String containing the remote user UID and PID, which are returned by **resetCallingIdentity**.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -3556,24 +3717,26 @@ A constructor used to create a **RemoteObject** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | descriptor | string | Yes| Interface descriptor.| ### sendRequest(deprecated) -> **NOTE**
-> This API is deprecated since API Version 8. You are advised to use [sendRequestAsync9+](#sendrequestasync9-2). - sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): boolean +> **NOTE**
+> This API is deprecated since API version 8. You are advised to use [sendRequestAsync9+](#sendrequestasync9-2). + Sends a **MessageParcel** message to the remote process in synchronous or asynchronous mode. If **options** is the asynchronous mode, a promise will be fulfilled immediately and the reply message does not contain any content. If **options** is the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -3581,7 +3744,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -3630,17 +3794,18 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch ### sendRequest8+(deprecated) -> **NOTE**
-> This API is deprecated since API Version 9. You are advised to use [sendRequestAsync9+](#sendrequestasync9-2). - sendRequest(code : number, data : MessageParcel, reply : MessageParcel, options : MessageOption): Promise<SendRequestResult> +> **NOTE**
+> This API is deprecated since API version 9. You are advised to use [sendRequestAsync9+](#sendrequestasync9-2). + Sends a **MessageParcel** message to the remote process in synchronous or asynchronous mode. If **options** is the asynchronous mode, a promise will be fulfilled immediately and the reply message does not contain any content. If **options** is the synchronous mode, a promise will be fulfilled when the response to **sendRequest** is returned, and the reply message contains the returned information. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -3648,7 +3813,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Promise<SendRequestResult> | Promise used to return the **sendRequestResult** object.| @@ -3709,7 +3875,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -3717,7 +3884,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch | options | [MessageOption](#messageoption) | Yes| Request sending mode, which can be synchronous (default) or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Promise<SendRequestResult> | Promise used to return the **sendRequestResult** object.| @@ -3777,7 +3945,8 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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.| @@ -3831,16 +4000,21 @@ Sends a **MessageParcel** message to the remote process in synchronous or asynch ``` -### onRemoteRequest +### onRemoteRequest8+(deprecated) + onRemoteRequest(code : number, data : MessageParcel, reply: MessageParcel, options : MessageOption): boolean +> **NOTE**
+> This API is deprecated since API version 9. You are advised to use [onRemoteRequestEx9+](#onremoterequestex9). + Provides a response to **sendRequestAsync()**. The server processes the request and returns a response in this function. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | code | number | Yes| Service request code sent by the remote end.| | data | [MessageParcel](#messageparcel) | Yes| **MessageParcel** object that holds the parameters called by the client.| @@ -3848,14 +4022,15 @@ Provides a response to **sendRequestAsync()**. The server processes the request | option | [MessageOption](#messageoption) | Yes| Whether the operation is synchronous or asynchronous.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| **Example** - ``` + ```ets class MyDeathRecipient { onRemoteDied() { console.log("server died"); @@ -3886,8 +4061,190 @@ Provides a response to **sendRequestAsync()**. The server processes the request } } ``` +### onRemoteRequestEx9+ + +onRemoteRequestEx(code : number, data : MessageParcel, reply: MessageParcel, options : MessageOption): boolean | Promise + +> **NOTE**
+>- You are advised to overload **onRemoteRequestEx** preferentially, which implements synchronous and asynchronous message processing. +>- If both **onRemoteRequest** and **onRemoteRequestEx** are overloaded, only **onRemoteRequestEx** takes effect. + +Provides a response to **sendRequestAsync()**. The server processes the request synchronously or asynchronously and returns the result in this API. + +**System capability**: SystemCapability.Communication.IPC.Core + +**Parameters** + + | Name| Type| Mandatory| Description| + | -------- | -------- | -------- | -------- | + | code | number | Yes| Service request code sent by the remote 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 value** + + | Type| Description| + | -------- | -------- | + | boolean | Returns a Boolean value if the request is processed synchronously in **onRemoteRequestEx**. If the operation is successful, **true** is returned. Otherwise, **false** is returned.| + | Promise | Returns a promise object if the request is processed asynchronously in **onRemoteRequestEx**.| + + +**Example**: Overload **onRemoteRequestEx** to process a request synchronously. + + ```ets + class MyDeathRecipient { + onRemoteDied() { + console.log("server died"); + } + } + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + isObjectDead(): boolean { + return false; + } + onRemoteRequestEx(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: sync onRemoteRequestEx is called"); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + } + ``` + **Example**: Overload **onRemoteRequestEx** to process a request asynchronously. + ```ets + class MyDeathRecipient { + onRemoteDied() { + console.log("server died"); + } + } + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + isObjectDead(): boolean { + return false; + } + async onRemoteRequestEx(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: async onRemoteRequestEx is called"); + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + await new Promise((resolve) => { + setTimeout(resolve, 100); + }) + return true; + } + } + ``` +**Example**: Overload **onRemoteRequestEx** and **onRemoteRequest** to process requests synchronously. + ```ets + class MyDeathRecipient { + onRemoteDied() { + console.log("server died"); + } + } + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + isObjectDead(): boolean { + return false; + } + onRemoteRequest(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: sync onRemoteRequestEx is called"); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + // Only onRemoteRequestEx is executed when onRemoteRequestEx and onRemoteRequest are called. + onRemoteRequestEx(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: async onRemoteRequestEx is called"); + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + + return true; + } + } + ``` + **Example**: Overload **onRemoteRequestEx** and **onRemoteRequest** to process requests asynchronously. + + ```ets + class MyDeathRecipient { + onRemoteDied() { + console.log("server died"); + } + } + class TestRemoteObject extends rpc.RemoteObject { + constructor(descriptor) { + super(descriptor); + } + addDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + removeDeathRecipient(recipient: MyDeathRecipient, flags: number): boolean { + return true; + } + isObjectDead(): boolean { + return false; + } + onRemoteRequest(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: sync onRemoteRequestEx is called"); + return true; + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + } + // Only onRemoteRequestEx is executed when onRemoteRequestEx and onRemoteRequest are called. + async onRemoteRequestEx(code, data, reply, option) { + if (code === 1) { + console.log("RpcServer: async onRemoteRequestEx is called"); + } else { + console.log("RpcServer: unknown code: " + code); + return false; + } + await new Promise((resolve) => { + setTimeout(resolve, 100); + }) + return true; + } + } + ``` ### getCallingUid getCallingUid(): number @@ -3897,7 +4254,8 @@ Obtains the UID of the remote process. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | UID of the remote process obtained.| @@ -3938,7 +4296,8 @@ Obtains the PID of the remote process. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | PID of the remote process obtained.| @@ -3979,12 +4338,14 @@ Checks whether the remote object corresponding to the specified interface descri **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | descriptor | string | Yes| Interface descriptor.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | IRemoteBroker | Returns the remote object if a match is found; returns **Null** otherwise.| @@ -4025,7 +4386,8 @@ Obtains the interface descriptor. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | string | Interface descriptor obtained.| @@ -4067,7 +4429,8 @@ Binds an interface descriptor to an **IRemoteBroker** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | localInterface | IRemoteBroker | Yes| **IRemoteBroker** object.| | descriptor | string | Yes| Interface descriptor.| @@ -4128,13 +4491,15 @@ Creates an **Ashmem** object with the specified name and size. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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 value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Ashmem | Returns the **Ashmem** object if it is created successfully; returns null otherwise.| @@ -4157,12 +4522,14 @@ Creates an **Ashmem** object by copying the file descriptor (FD) of an existing **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | ashmem | Ashmem | Yes| Existing **Ashmem** object.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | Ashmem | **Ashmem** object created.| @@ -4218,7 +4585,8 @@ Obtains the memory size of this **Ashmem** object. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number | **Ashmem** size obtained.| @@ -4240,12 +4608,14 @@ Creates the shared file mapping on the virtual address space of this process. Th **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | mapType | number | Yes| Protection level of the memory region to which the shared file is mapped.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -4267,7 +4637,8 @@ Maps the shared file to the readable and writable virtual address space of the p **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -4289,7 +4660,8 @@ Maps the shared file to the read-only virtual address space of the process. **System capability**: SystemCapability.Communication.IPC.Core **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -4311,12 +4683,14 @@ Sets the protection level of the memory region to which the shared file is mappe **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | protectionType | number | Yes| Protection type to set.| **Return value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -4338,14 +4712,16 @@ Writes data to the shared file associated with this **Ashmem** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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 value** - | Type| Description| + + | Type| Description| | -------- | -------- | | boolean | Returns **true** is the data is written successfully; returns **false** otherwise.| @@ -4370,13 +4746,15 @@ Reads data from the shared file associated with this **Ashmem** object. **System capability**: SystemCapability.Communication.IPC.Core **Parameters** - | Name| Type| Mandatory| Description| + + | 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 value** - | Type| Description| + + | Type| Description| | -------- | -------- | | number[] | Data read.| diff --git a/en/application-dev/reference/apis/js-apis-screen-lock.md b/en/application-dev/reference/apis/js-apis-screen-lock.md index bc42373a4589e4ab2fa4b268d1472a1c7bb60ad2..d2dcd1fdd0b4dd88d4a6917d260f052aa9198eca 100644 --- a/en/application-dev/reference/apis/js-apis-screen-lock.md +++ b/en/application-dev/reference/apis/js-apis-screen-lock.md @@ -24,9 +24,10 @@ Checks whether the screen is locked. This API uses an asynchronous callback to r **System capability**: SystemCapability.MiscServices.ScreenLock **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | Yes| Returns **true** if the screen is locked; returns **false** otherwise.| +| callback | AsyncCallback<boolean> | Yes| Callback used to return the result. Returns **true** if the screen is locked; returns **false** otherwise.| **Example** @@ -50,6 +51,7 @@ Checks whether the screen is locked. This API uses a promise to return the resul **System capability**: SystemCapability.MiscServices.ScreenLock **Return value** + | Type| Description| | -------- | -------- | | Promise<boolean> | Promise used to return the result.| @@ -77,9 +79,10 @@ Checks whether a device is in secure mode. This API uses an asynchronous callbac **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | Yes| Returns **true** if the device is in secure mode; returns **false** otherwise.| +| callback | AsyncCallback<boolean> | Yes| Callback used to return the result. Returns **true** if the device is in secure mode; returns **false** otherwise.| **Example** @@ -103,6 +106,7 @@ Checks whether a device is in secure mode. This API uses a promise to return the **System capability**: SystemCapability.MiscServices.ScreenLock **Return value** + | Type| Description| | -------- | -------- | | Promise<boolean> | Promise used to return the result.| @@ -130,9 +134,10 @@ Unlocks the screen. This API uses an asynchronous callback to return the result. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation failed, an error message is returned.| +| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation fails, an error message is returned.| **Example** @@ -156,6 +161,7 @@ Unlocks the screen. This API uses a promise to return the result. **System capability**: SystemCapability.MiscServices.ScreenLock **Return value** + | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| @@ -173,7 +179,7 @@ Unlocks the screen. This API uses a promise to return the result. ## screenlock.lockScreen9+ -lockScreen(callback: AsyncCallback<void>): void +lockScreen(callback: AsyncCallback<boolean>): void Locks the screen. This API uses an asynchronous callback to return the result. @@ -184,9 +190,10 @@ Locks the screen. This API uses an asynchronous callback to return the result. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation failed, an error message is returned.| +| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation fails, an error message is returned.| **Example** @@ -202,7 +209,7 @@ Locks the screen. This API uses an asynchronous callback to return the result. ## screenlock.lockScreen9+ -lockScreen(): Promise<void> +lockScreen(): Promise<boolean> Locks the screen. This API uses a promise to return the result. @@ -238,6 +245,7 @@ Subscribes to screen lock status changes. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Event type.
- **"beginWakeUp"**: Wakeup starts.
- **"endWakeUp"**: Wakeup ends.
- **"beginScreenOn"**: Screen turn-on starts.
- **"endScreenOn"**: Screen turn-on ends.
- **"beginScreenOff"**: Screen turn-off starts.
- **"endScreenOff"**: Screen turn-off ends.
- **"unlockScreen"**: The screen is unlocked.
- **"beginExitAnimation"**: Animation starts to exit.| @@ -262,6 +270,7 @@ Subscribes to screen lock status changes. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Event type.
- **"beginSleep"**: The screen enters sleep mode.
- **"endSleep"**: The screen exits sleep mode.
- **"changeUser"**: The user is switched.| @@ -285,6 +294,7 @@ Subscribes to screen lock status changes. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Event type.
- **"screenlockEnabled"**: Screen lock is enabled.| @@ -310,6 +320,7 @@ Unsubscribes from screen lock status changes. **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | type | string | Yes| Event type.
- **"beginWakeUp"**: Wakeup starts.
- **"endWakeUp"**: Wakeup ends.
- **"beginScreenOn"**: Screen turn-on starts.
- **"endScreenOn"**: Screen turn-on ends.
- **"beginScreenOff"**: Screen turn-off starts.
- **"endScreenOff"**: Screen turn-off ends.
- **"unlockScreen"**: The screen is unlocked.
- **"beginExitAnimation"**: Animation starts to exit.
- **"screenlockEnabled"**: Screen lock is enabled.
- **"beginSleep"**: The screen enters sleep mode.
- **"endSleep"**: The screen exits sleep mode.
- **"changeUser"**: The user is switched.| @@ -334,6 +345,7 @@ Sends an event to the screen lock service. This API uses an asynchronous callbac **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | event | String | Yes| Event type.
- **"unlockScreenResult"**: Screen unlock result.
- **"screenDrawDone"**: Screen drawing is complete.| @@ -359,12 +371,14 @@ Sends an event to the screen lock service. This API uses a promise to return the **System API**: This is a system API and cannot be called by third-party applications. **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | event | String | Yes| Event type.
- **"unlockScreenResult"**: Screen unlock result.
- **"screenDrawDone"**: Screen drawing is complete.| | parameter | number | Yes| Screen unlock status.
- **0**: The unlock is successful.
- **1**: The unlock failed.
- **2**: The unlock was canceled.| **Return value** + | Type| Description| | -------- | -------- | | Promise\ | Promise used to return the result.| diff --git a/en/application-dev/reference/apis/js-apis-screen.md b/en/application-dev/reference/apis/js-apis-screen.md index 94f5f3cb5e532f3e28f221addb164358589b1754..73ea5d3c915d2ba91c129ed8d7c8ed80efe8170d 100644 --- a/en/application-dev/reference/apis/js-apis-screen.md +++ b/en/application-dev/reference/apis/js-apis-screen.md @@ -99,7 +99,7 @@ Unsubscribes from events related to the screen state. **Example** ```js var callback = (data) => { - console.info('Unegister the callback for screen changes. Data: ' + JSON.stringify(data)) + console.info('Unregister the callback for screen changes. Data: ' + JSON.stringify(data)) }; screen.off("connect", callback); ``` diff --git a/en/application-dev/reference/apis/js-apis-screenshot.md b/en/application-dev/reference/apis/js-apis-screenshot.md index 8f88d00f0d246628e3669ae376da04191efedb92..550b62ed355d0a09eb57d17c5473c37cd7e45899 100644 --- a/en/application-dev/reference/apis/js-apis-screenshot.md +++ b/en/application-dev/reference/apis/js-apis-screenshot.md @@ -55,7 +55,7 @@ Describes the size of the screen region to capture. ## screenshot.save -save(options?: ScreenshotOptions, callback: AsyncCallback<image.PixelMap>): void +save(options: ScreenshotOptions, callback: AsyncCallback<image.PixelMap>): void Takes a screenshot and saves it as a **PixelMap** object. This API uses an asynchronous callback to return the result. @@ -67,7 +67,7 @@ Takes a screenshot and saves it as a **PixelMap** object. This API uses an async | Name | Type | Mandatory| Description | | -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | -| options | [ScreenshotOptions](#screenshotoptions) | No | Screenshot settings consist of **screenRect**, **imageSize**, **rotation**, and **displayId**. You can set the parameters separately.| +| options | [ScreenshotOptions](#screenshotoptions) | Yes | Screenshot settings consist of **screenRect**, **imageSize**, **rotation**, and **displayId**. You can set the parameters separately.| | callback | AsyncCallback<[image.PixelMap](js-apis-image.md#pixelmap7)> | Yes | Callback used to return a **PixelMap** object. | **Example** @@ -97,6 +97,35 @@ Takes a screenshot and saves it as a **PixelMap** object. This API uses an async ## screenshot.save +save(callback: AsyncCallback<image.PixelMap>): void + +Takes a screenshot and saves it as a **PixelMap** object. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.WindowManager.WindowManager.Core + +**Required permissions**: ohos.permission.CAPTURE_SCREEN (available only to system applications) + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| callback | AsyncCallback<[image.PixelMap](js-apis-image.md#pixelmap7)> | Yes | Callback used to return a **PixelMap** object. | + +**Example** + + ```js + screenshot.save((err, pixelMap) => { + if (err) { + console.log('Failed to save screenshot: ' + JSON.stringify(err)); + return; + } + console.log('Succeeded in saving sreenshot. Pixel bytes number: ' + pixelMap.getPixelBytesNumber()); + pixelMap.release(); // Release the memory in time after the PixelMap is used. + }); + ``` + +## screenshot.save + save(options?: ScreenshotOptions): Promise<image.PixelMap> Takes a screenshot and saves it as a **PixelMap** object. This API uses a promise to return the result. diff --git a/en/application-dev/reference/apis/js-apis-sensor.md b/en/application-dev/reference/apis/js-apis-sensor.md index 52ffdfc66d3fd0880602eccf574ec3b1b310904d..5b9107af6a142f762171272278e3ea543bb93b81 100644 --- a/en/application-dev/reference/apis/js-apis-sensor.md +++ b/en/application-dev/reference/apis/js-apis-sensor.md @@ -89,7 +89,6 @@ on(type: SensorType.SENSOR_TYPE_ID_LINEAR_ACCELEROMETER,callback:Callback<Lin Subscribes to data changes of the linear acceleration sensor. If this API is called multiple times for the same application, the last call takes effect. - **Required permissions**: ohos.permission.ACCELEROMETER (a system permission) **System capability**: SystemCapability.Sensors.Sensor @@ -1811,7 +1810,7 @@ sensor.off(sensor.SensorType.SENSOR_TYPE_ID_WEAR_DETECTION, accCallback); transformCoordinateSystem(inRotationVector: Array<number>, coordinates: CoordinatesOptions, callback: AsyncCallback<Array<number>>): void -Rotates a rotation vector so that it can represent the coordinate system in different ways. This API uses a callback to return the result. +Rotates a rotation vector so that it can represent the coordinate system in different ways. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -1876,16 +1875,16 @@ const promise = sensor.transformCoordinateSystem([1, 0, 0, 0, 1, 0, 0, 0, 1], {x getGeomagneticField(locationOptions: LocationOptions, timeMillis: number, callback: AsyncCallback<GeomagneticResponse>): void -Obtains the geomagnetic field of a geographic location. This API uses a callback to return the result. +Obtains the geomagnetic field of a geographic location. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor **Parameters** -| Name | Type | Mandatory | Description | -| --------------- | ---------------------------------------- | ---- | ----------------- | -| locationOptions | [LocationOptions](#locationoptions) | Yes | Geographic location. | -| timeMillis | number | Yes | Time for obtaining the magnetic declination, in milliseconds.| -| callback | AsyncCallback<[GeomagneticResponse](#geomagneticresponse)> | Yes | Callback used to return the geomagnetic field. | +| Name | Type | Mandatory| Description | +| --------------- | ------------------------------------------------------------ | ---- | ---------------------------------- | +| locationOptions | [LocationOptions](#locationoptions) | Yes | Geographic location. | +| timeMillis | number | Yes | Time for obtaining the magnetic declination, in milliseconds.| +| callback | AsyncCallback<[GeomagneticResponse](#geomagneticresponse)> | Yes | Callback used to return the geomagnetic field. | **Example** ```js @@ -1934,7 +1933,7 @@ Obtains the geomagnetic field of a geographic location. This API uses a promise getAltitude(seaPressure: number, currentPressure: number, callback: AsyncCallback<number>): void -Obtains the altitude at which the device is located based on the sea-level atmospheric pressure and the current atmospheric pressure. This API uses a callback to return the result. +Obtains the altitude at which the device is located based on the sea-level atmospheric pressure and the current atmospheric pressure. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -1996,7 +1995,7 @@ Obtains the altitude at which the device is located based on the sea-level atmos getGeomagneticDip(inclinationMatrix: Array<number>, callback: AsyncCallback<number>): void -Obtains the magnetic dip based on the inclination matrix. This API uses a callback to return the result. +Obtains the magnetic dip based on the inclination matrix. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -2055,7 +2054,7 @@ Obtains the magnetic dip based on the inclination matrix. This API uses a promis getAngleModify(currentRotationMatrix: Array<number>, preRotationMatrix: Array<number>, callback: AsyncCallback<Array<number>>): void -Obtains the angle change between two rotation matrices. This API uses a callback to return the result. +Obtains the angle change between two rotation matrices. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -2123,7 +2122,7 @@ Obtains the angle change between two rotation matrices. This API uses a promise createRotationMatrix(rotationVector: Array<number>, callback: AsyncCallback<Array<number>>): void -Converts a rotation vector into a rotation matrix. This API uses a callback to return the result. +Converts a rotation vector into a rotation matrix. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -2189,7 +2188,7 @@ Converts a rotation vector into a rotation matrix. This API uses a promise to re createQuaternion(rotationVector: Array<number>, callback: AsyncCallback<Array<number>>): void -Converts a rotation vector into a quaternion. This API uses a callback to return the result. +Converts a rotation vector into a quaternion. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -2255,7 +2254,7 @@ Converts a rotation vector into a quaternion. This API uses a promise to return getDirection(rotationMatrix: Array<number>, callback: AsyncCallback<Array<number>>): void -Obtains the device direction based on the rotation matrix. This API uses a callback to return the result. +Obtains the device direction based on the rotation matrix. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -2322,7 +2321,7 @@ Obtains the device direction based on the rotation matrix. This API uses a promi createRotationMatrix(gravity: Array<number>, geomagnetic: Array<number>, callback: AsyncCallback<RotationMatrixResponse>): void -Creates a rotation matrix based on the gravity vector and geomagnetic vector. This API uses a callback to return the result. +Creates a rotation matrix based on the gravity vector and geomagnetic vector. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Sensors.Sensor @@ -2385,6 +2384,118 @@ Creates a rotation matrix based on the gravity vector and geomagnetic vector. Th }) ``` +## sensor.getSensorLists9+ + + getSensorLists(callback: AsyncCallback): void + +Obtains information about all sensors on the device. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Sensors.Sensor + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------------- | ---- | ---------------- | +| callback | AsyncCallback | Yes | Callback used to return the sensor list.| + +**Example** + +```js +sensor.getSensorList((error, data) => { + if (error) { + console.error('getSensorList failed'); + } else { + console.info("getSensorList callback in" + data.length); + for (var i = 0; i < data.length; i++) { + console.info("getSensorList " + JSON.stringify(data[i])); + } + } +}); +``` + +## sensor.getSensorLists9+ + + getSensorLists(): Promise< Array<Sensor>> + +Obtains information about all sensors on the device. This API uses a promise to return the result. + +**System capability**: SystemCapability.Sensors.Sensor + +**Return value** + +| Name | Type | Mandatory| Description | +| ------- | --------------------------------------- | ---- | ---------------- | +| promise | Promise | Yes | Promise used to return the sensor list.| + +**Example** + +```js +sensor.getSensorList().then((data) => { + console.info("getSensorList promise in" + data.length); + for (var i = 0; i < data.length; i++) { + console.info("getSensorList " + JSON.stringify(data[i])); + } +}, (error)=>{ + console.error('getSensorList failed'); +}); +``` + +## sensor.getSingleSensor9+ + +getSingleSensor(type: SensorType, callback: AsyncCallback<sensor>): void + +Obtains information about the sensor of a specific type. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.Sensors.Sensor + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | -------------------------------------- | ---- | ---------------- | +| type | SensorType | Yes | Sensor type. | +| callback | AsyncCallback<[Sensor](#sensor)> | Yes | Callback used to return the sensor information.| + +**Example** + +```js + sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER, (error, data) => { + if (error) { + console.error('getSingleSensor failed'); + } else { + console.info("getSingleSensor " + JSON.stringify(data)); + } +}); +``` + +## sensor.getSingleSensor9+ + + getSingleSensor(type: SensorType,): Promise<Sensor> + +Obtains information about the sensor of a specific type. This API uses a promise to return the result. + +**System capability**: SystemCapability.Sensors.Sensor + +**Parameters** + +| Name| Type | Mandatory| Description | +| ------ | ---------- | ---- | ------------ | +| type | SensorType | Yes | Sensor type.| + +**Return value** + +| Name | Type | Mandatory| Description | +| ------- | -------------------------------- | ---- | ---------------- | +| promise | Promise<[Sensor](#sensor)> | Yes | Promise used to return the sensor information.| + +**Example** + +```js +sensor.getSingleSensor(sensor.SensorType.SENSOR_TYPE_ID_ACCELEROMETER).then((data) => { + console.info("getSingleSensor " + JSON.stringify(data)); +}, (error)=>{ + console.error('getSingleSensor failed'); +}); +``` ## SensorType @@ -2426,10 +2537,26 @@ Describes the timestamp of the sensor data. **System capability**: SystemCapability.Sensors.Sensor -| Name | Type | Readable | Writable | Description | -| --------- | ------ | ---- | ---- | ------------ | -| timestamp | number | Yes | Yes | Timestamp when the sensor reports data.| +| Name | Type| Readable| Writable| Description | +| --------- | -------- | ---- | ---- | ------------------------ | +| timestamp | number | Yes | Yes | Timestamp when the sensor reports data.| + +## Sensor + +Describes the sensor information. + +**System capability**: SystemCapability.Sensors.Sensor +| Name | Type| Description | +| --------------- | -------- | ---------------------- | +| sensorName | string | Sensor name. | +| venderName | string | Vendor of the sensor. | +| firmwareVersion | string | Firmware version of the sensor. | +| hardwareVersion | string | Hardware version of the sensor. | +| sensorTypeId | number | Sensor type ID. | +| maxRange | number | Maximum measurement range of the sensor.| +| precision | number | Precision of the sensor. | +| power | number | Power supply of the sensor. | ## AccelerometerResponse diff --git a/en/application-dev/reference/apis/js-apis-service-extension-context.md b/en/application-dev/reference/apis/js-apis-service-extension-context.md index 5a521ffca5fcefb393551effd6b02bc69a9d64aa..7ed184b2a61aaaf781a37b9137e8f510a2ffbc2f 100644 --- a/en/application-dev/reference/apis/js-apis-service-extension-context.md +++ b/en/application-dev/reference/apis/js-apis-service-extension-context.md @@ -724,15 +724,17 @@ Disconnects this ability from the Service ability. This API uses a promise to re startAbilityByCall(want: Want): Promise<Caller>; -Starts an ability in the background and obtains the caller interface for communication. +Starts an ability in the foreground or background and obtains the caller object for communicating with the ability. **System capability**: SystemCapability.Ability.AbilityRuntime.Core +**System API**: This is a system API and cannot be called by third-party applications. + **Parameters** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| want | [Want](js-apis-application-Want.md) | Yes| Information about the target ability, including the ability name, module name, bundle name, and device ID. If the device ID is left blank or the default value is used, the local ability will be started.| +| want | [Want](js-apis-application-Want.md) | Yes| Information about the ability to start, including **abilityName**, **moduleName**, **bundleName**, **deviceId** (optional), and **parameters** (optional). If **deviceId** is left blank or null, the local ability is started. If **parameters** is left blank or null, the ability is started in the background.| **Return value** @@ -744,16 +746,38 @@ Starts an ability in the background and obtains the caller interface for communi ```js let caller = undefined; - this.context.startAbilityByCall({ + + // Start an ability in the background by not passing parameters. + var wantBackground = { bundleName: "com.example.myservice", moduleName: "entry", abilityName: "MainAbility", deviceId: "" - }).then((obj) => { - caller = obj; - console.log('Caller GetCaller Get ' + caller); - }).catch((e) => { - console.log('Caller GetCaller error ' + e); - }); + }; + this.context.startAbilityByCall(wantBackground) + .then((obj) => { + caller = obj; + console.log('GetCaller Success'); + }).catch((error) => { + console.log(`GetCaller failed with ${error}`); + }); + + // Start an ability in the foreground with ohos.aafwk.param.callAbilityToForeground in parameters set to true. + var wantForeground = { + bundleName: "com.example.myservice", + moduleName: "entry", + abilityName: "MainAbility", + deviceId: "", + parameters: { + "ohos.aafwk.param.callAbilityToForeground": true + } + }; + this.context.startAbilityByCall(wantForeground) + .then((obj) => { + caller = obj; + console.log('GetCaller success'); + }).catch((error) => { + console.log(`GetCaller failed with ${error}`); + }); ``` diff --git a/en/application-dev/reference/apis/js-apis-sim.md b/en/application-dev/reference/apis/js-apis-sim.md index f9475d2e7d76b6ccf20f6b0f32d01969fdccfbbb..a2d761225c3169bd6d9f5a7603232d4050c0342b 100644 --- a/en/application-dev/reference/apis/js-apis-sim.md +++ b/en/application-dev/reference/apis/js-apis-sim.md @@ -511,7 +511,7 @@ getSimAccountInfo(slotId: number, callback: AsyncCallback): voi Obtains account information of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -539,7 +539,7 @@ getSimAccountInfo(slotId: number): Promise Obtains account information of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -574,7 +574,7 @@ getActiveSimAccountInfoList(callback: AsyncCallback>): vo Obtains the account information list of the active SIM card. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -601,7 +601,7 @@ getActiveSimAccountInfoList(): Promise>; Obtains the account information list of the active SIM card. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -630,7 +630,7 @@ setDefaultVoiceSlotId(slotId: number, callback: AsyncCallback): void Sets the default slot ID of the SIM card that provides voice services. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -658,7 +658,7 @@ setDefaultVoiceSlotId(slotId: number): Promise\ Sets the default slot ID of the SIM card that provides voice services. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -693,7 +693,7 @@ setShowName\(slotId: number, name: string,callback: AsyncCallback\): void Sets a display name for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -722,7 +722,7 @@ setShowName\(slotId: number, name: string\): Promise\ Sets a display name for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -759,7 +759,7 @@ getShowName(slotId: number, callback: AsyncCallback): void Obtains the name of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -787,7 +787,7 @@ getShowName(slotId: number): Promise Obtains the name of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -822,7 +822,7 @@ setShowNumber\(slotId: number, number: string,callback: AsyncCallback\): Sets a display number for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -852,7 +852,7 @@ setShowNumber\(slotId: number,number: string\): Promise\ Sets a display number for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -889,7 +889,7 @@ getShowNumber(slotId: number,callback: AsyncCallback): void Obtains the display number of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -917,7 +917,7 @@ getShowNumber(slotId: number): Promise Obtains the display number of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -952,7 +952,7 @@ activateSim(slotId: number, callback: AsyncCallback): void Activates the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -980,7 +980,7 @@ activateSim(slotId: number): Promise\ Activates the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1015,7 +1015,7 @@ deactivateSim(slotId: number, callback: AsyncCallback): void Deactivates the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1043,7 +1043,7 @@ deactivateSim(slotId: number): Promise\ Deactivates the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1078,7 +1078,7 @@ setLockState(slotId: number, options: LockInfo, callback: AsyncCallback Sets the lock status of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1153,7 +1153,7 @@ getLockState(slotId: number, lockType: LockType, callback: AsyncCallback Obtains the lock status of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -1214,7 +1214,7 @@ alterPin(slotId: number, newPin: string, oldPin: string, callback: AsyncCallback Changes the PIN of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1244,7 +1244,7 @@ alterPin(slotId: number, newPin: string, oldPin: string): Promise Unlocks the PIN of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1415,7 +1415,7 @@ unlockPuk(slotId: number,newPin: string,puk: string ,callback: AsyncCallback Unlocks PIN 2 of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1553,7 +1553,7 @@ unlockPuk2(slotId: number, newPin2: string, puk2: string, callback: AsyncCallbac Unlocks PUK 2 of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1585,7 +1585,7 @@ unlockPuk2(slotId: number, newPin2: string, puk2: string): Promise<LockStatus Unlocks PUK 2 of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1644,7 +1644,7 @@ getSimIccId(slotId: number, callback: AsyncCallback): void Obtains the IC card identity (ICCID) of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1672,7 +1672,7 @@ getSimIccId(slotId: number): Promise Obtains the ICCID of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1707,7 +1707,7 @@ getVoiceMailIdentifier(slotId: number, callback: AsyncCallback): void Obtains the voice mailbox alpha identifier of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1735,7 +1735,7 @@ getVoiceMailIdentifier(slotId: number): Promise Obtains the voice mailbox alpha identifier of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1770,7 +1770,7 @@ getVoiceMailNumber(slotId: number, callback: AsyncCallback): void Obtains the voice mailbox number of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1798,7 +1798,7 @@ getVoiceMailNumber(slotId: number): Promise Obtains the voice mailbox number of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1833,7 +1833,7 @@ setVoiceMailInfo(slotId: number, mailName: string, mailNumber: string, callback: Sets voice mailbox information for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1863,7 +1863,7 @@ setVoiceMailInfo(slotId: number, mailName: string, mailNumber: string): Promise< Sets voice mailbox information for the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -1900,7 +1900,7 @@ getSimTelephoneNumber(slotId: number, callback: AsyncCallback): void Obtains the mobile subscriber ISDN number (MSISDN) of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1928,7 +1928,7 @@ getSimTelephoneNumber(slotId: number): Promise Obtains the MSISDN of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1963,7 +1963,7 @@ getSimGid1(slotId: number, callback: AsyncCallback): void Obtains the group identifier level 1 (GID1) of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -1991,7 +1991,7 @@ getSimGid1(slotId: number): Promise Obtains the GID1 of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -2026,7 +2026,7 @@ getIMSI(slotId: number, callback: AsyncCallback): void Obtains the international mobile subscriber identity (IMSI) of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -2054,7 +2054,7 @@ getIMSI(slotId: number): Promise Obtains the IMSI of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -2089,7 +2089,7 @@ getOperatorConfigs(slotId: number, callback: AsyncCallback> Obtains the carrier configuration of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE @@ -2152,7 +2152,7 @@ queryIccDiallingNumbers(slotId: number, type: ContactType, callback: AsyncCallba Queries contact numbers of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Permission required**: ohos.permission.READ_CONTACTS @@ -2181,7 +2181,7 @@ queryIccDiallingNumbers(slotId: number, type: ContactType): Promise): vo Sends an envelope command to the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -2483,7 +2483,7 @@ sendEnvelopeCmd(slotId: number, cmd: string): Promise Sends an envelope command to the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -2519,7 +2519,7 @@ sendTerminalResponseCmd(slotId: number, cmd: string, callback: AsyncCallback Sends a terminal response command to the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -2584,7 +2584,7 @@ unlockSimLock(slotId: number, lockInfo: PersoLockInfo, callback: AsyncCallback): void Obtains the opkey of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2683,7 +2683,7 @@ getOpKey(slotId: number): Promise Obtains the opkey of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2716,7 +2716,7 @@ getOpName(slotId: number, callback: AsyncCallback): void Obtains the OpName of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2742,7 +2742,7 @@ getOpName(slotId: number): Promise Obtains the OpName of the SIM card in the specified slot. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2807,7 +2807,7 @@ Enumerates SIM card types. Enumerates lock types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2820,7 +2820,7 @@ This is a system API. Enumerates lock states. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2833,7 +2833,7 @@ This is a system API. Enumerates personalized lock types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2854,7 +2854,7 @@ This is a system API. Defines the lock status response. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2867,7 +2867,7 @@ This is a system API. Defines the lock information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2881,7 +2881,7 @@ This is a system API. Defines the personalized lock information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2894,7 +2894,7 @@ This is a system API. Defines the ICC account information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2912,7 +2912,7 @@ This is a system API. Defines the carrier configuration. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2925,7 +2925,7 @@ This is a system API. Defines the contact number information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService @@ -2940,7 +2940,7 @@ This is a system API. Enumerates contact types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.CoreService diff --git a/en/application-dev/reference/apis/js-apis-sms.md b/en/application-dev/reference/apis/js-apis-sms.md index 9039fb774527e9ed6bbd43c95b0996afdc94780d..5443e18d1bd7e01ca1bbe74f62fdd9cce061e343 100644 --- a/en/application-dev/reference/apis/js-apis-sms.md +++ b/en/application-dev/reference/apis/js-apis-sms.md @@ -71,7 +71,7 @@ let promise = sms.createMessage(pdu, specification); promise.then(data => { console.log(`createMessage success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`createMessage fail, promise: err->${JSON.stringify(err)}`); + console.error(`createMessage failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -154,7 +154,7 @@ let promise = sms.getDefaultSmsSlotId(); promise.then(data => { console.log(`getDefaultSmsSlotId success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getDefaultSmsSlotId fail, promise: err->${JSON.stringify(err)}`); + console.error(`getDefaultSmsSlotId failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -164,7 +164,7 @@ setDefaultSmsSlotId\(slotId: number,callback: AsyncCallback<void>\): void Sets the default slot of the SIM card used to send SMS messages. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -192,7 +192,7 @@ setDefaultSmsSlotId\(slotId: number\): Promise<void> Sets the default slot of the SIM card used to send SMS messages. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE @@ -217,7 +217,7 @@ let promise = sms.setDefaultSmsSlotId(0); promise.then(data => { console.log(`setDefaultSmsSlotId success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`setDefaultSmsSlotId fail, promise: err->${JSON.stringify(err)}`); + console.error(`setDefaultSmsSlotId failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -227,7 +227,7 @@ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback\): Sets the short message service center (SMSC) address. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE (a system permission) @@ -258,7 +258,7 @@ setSmscAddr\(slotId: number, smscAddr: string\): Promise\ Sets the SMSC address. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SET_TELEPHONY_STATE (a system permission) @@ -286,7 +286,7 @@ let promise = sms.setSmscAddr(slotId, smscAddr); promise.then(data => { console.log(`setSmscAddr success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`setSmscAddr fail, promise: err->${JSON.stringify(err)}`); + console.error(`setSmscAddr failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -297,7 +297,7 @@ getSmscAddr\(slotId: number, callback: AsyncCallback\): void Obtains the SMSC address. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE (a system permission) @@ -326,7 +326,7 @@ getSmscAddr\(slotId: number\): Promise Obtains the SMSC address. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.GET_TELEPHONY_STATE (a system permission) @@ -352,7 +352,7 @@ let promise = sms.getSmscAddr(slotId); promise.then(data => { console.log(`getSmscAddr success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getSmscAddr fail, promise: err->${JSON.stringify(err)}`); + console.error(`getSmscAddr failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -381,7 +381,7 @@ splitMessage(content: string, callback: AsyncCallback>): void Splits an SMS message into multiple segments. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SEND_MESSAGES @@ -410,7 +410,7 @@ splitMessage(content: string): Promise> Splits an SMS message into multiple segments. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.SEND_MESSAGES @@ -436,7 +436,7 @@ let promise = sms.splitMessage(content); promise.then(data => { console.log(`splitMessage success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`splitMessage fail, promise: err->${JSON.stringify(err)}`); + console.error(`splitMessage failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -446,7 +446,7 @@ addSimMessage(options: SimMessageOptions, callback: AsyncCallback): void Adds a SIM message. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS,ohos.permission.SEND_MESSAGES @@ -480,7 +480,7 @@ addSimMessage(options: SimMessageOptions): Promise Adds a SIM message. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS,ohos.permission.SEND_MESSAGES @@ -511,7 +511,7 @@ let promise = sms.addSimMessage(simMessageOptions); promise.then(data => { console.log(`addSimMessage success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`addSimMessage fail, promise: err->${JSON.stringify(err)}`); + console.error(`addSimMessage failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -521,7 +521,7 @@ delSimMessage(slotId: number, msgIndex: number, callback: AsyncCallback): Deletes a SIM message. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS,ohos.permission.SEND_MESSAGES @@ -552,7 +552,7 @@ delSimMessage(slotId: number, msgIndex: number): Promise Deletes a SIM message. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS,ohos.permission.SEND_MESSAGES @@ -580,7 +580,7 @@ let promise = sms.delSimMessage(slotId, msgIndex); promise.then(data => { console.log(`delSimMessage success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`delSimMessage fail, promise: err->${JSON.stringify(err)}`); + console.error(`delSimMessage failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -590,7 +590,7 @@ updateSimMessage(options: UpdateSimMessageOptions, callback: AsyncCallback Updates a SIM message. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS,ohos.permission.SEND_MESSAGES @@ -657,7 +657,7 @@ let promise = sms.updateSimMessage(updateSimMessageOptions); promise.then(data => { console.log(`updateSimMessage success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`updateSimMessage fail, promise: err->${JSON.stringify(err)}`); + console.error(`updateSimMessage failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -667,7 +667,7 @@ getAllSimMessages(slotId: number, callback: AsyncCallback> Obtains all SIM card messages. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS @@ -722,7 +722,7 @@ let promise = sms.getAllSimMessages(slotId); promise.then(data => { console.log(`getAllSimMessages success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getAllSimMessages fail, promise: err->${JSON.stringify(err)}`); + console.error(`getAllSimMessages failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -732,7 +732,7 @@ setCBConfig(options: CBConfigOptions, callback: AsyncCallback): void Sets the cell broadcast configuration. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS @@ -766,7 +766,7 @@ setCBConfig(options: CBConfigOptions): Promise Sets the cell broadcast configuration. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **Required permission**: ohos.permission.RECEIVE_SMS @@ -797,7 +797,7 @@ let promise = sms.setCBConfig(cbConfigOptions); promise.then(data => console.log(`setCBConfig success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`setCBConfig fail, promise: err->${JSON.stringify(err)}`); + console.error(`setCBConfig failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -807,7 +807,7 @@ getSmsSegmentsInfo(slotId: number, message: string, force7bit: boolean, callback Obtains SMS message segment information. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -836,7 +836,7 @@ getSmsSegmentsInfo(slotId: number, message: string, force7bit: boolean): Promise Obtains SMS message segment information. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -862,7 +862,7 @@ let promise = sms.getSmsSegmentsInfo(slotId, "message", false); promise.then(data => console.log(`getSmsSegmentsInfo success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getSmsSegmentsInfo fail, promise: err->${JSON.stringify(err)}`); + console.error(`getSmsSegmentsInfo failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -872,7 +872,7 @@ isImsSmsSupported(callback: AsyncCallback): void Checks whether SMS is supported on IMS. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -897,7 +897,7 @@ isImsSmsSupported(): Promise Checks whether SMS is supported on IMS. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -914,7 +914,7 @@ let promise = sms.isImsSmsSupported(); promise.then(data => { console.log(`isImsSmsSupported success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`isImsSmsSupported fail, promise: err->${JSON.stringify(err)}`); + console.error(`isImsSmsSupported failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -924,7 +924,7 @@ getImsShortMessageFormat(callback: AsyncCallback): void Obtains the SMS format supported by the IMS. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -949,7 +949,7 @@ getImsShortMessageFormat(): Promise Obtains the SMS format supported by the IMS. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -966,7 +966,7 @@ let promise = sms.getImsShortMessageFormat(); promise.then(data => { console.log(`getImsShortMessageFormat success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`getImsShortMessageFormat fail, promise: err->${JSON.stringify(err)}`); + console.error(`getImsShortMessageFormat failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -976,7 +976,7 @@ decodeMms(mmsFilePathName: string | Array, callback: AsyncCallback): Promise Decodes MMS messages. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1027,7 +1027,7 @@ let promise = sms.getSmscAddr(mmsFilePathName); promise.then(data => { console.log(`decodeMms success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`decodeMms fail, promise: err->${JSON.stringify(err)}`); + console.error(`decodeMms failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1037,7 +1037,7 @@ encodeMms(mms: MmsInformation, callback: AsyncCallback>): void Encodes MMS messages. This API uses an asynchronous callback to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1072,7 +1072,7 @@ encodeMms(mms: MmsInformation): Promise> Encodes MMS messages. This API uses a promise to return the result. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1104,7 +1104,7 @@ let promise = sms.encodeMms(mmsInformation); promise.then(data => { console.log(`encodeMms success, promise: data->${JSON.stringify(data)}`); }).catch(err => { - console.error(`encodeMms fail, promise: err->${JSON.stringify(err)}`); + console.error(`encodeMms failed, promise: err->${JSON.stringify(err)}`); }); ``` @@ -1203,7 +1203,7 @@ Enumerates SMS message sending results. Defines the MMS message information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1217,7 +1217,7 @@ This is a system API. Defines an MMS message sending request. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1243,7 +1243,7 @@ This is a system API. Defines the MMS message sending configuration. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1258,7 +1258,7 @@ This is a system API. Defines an MMS notification index. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1279,7 +1279,7 @@ This is a system API. Defines an MMS confirmation index. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1293,7 +1293,7 @@ This is a system API. Defines the MMS message retrieval configuration. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1318,7 +1318,7 @@ This is a system API. Defines the original MMS message reading index. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1336,7 +1336,7 @@ This is a system API. Defines the MMS message reading index. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1354,7 +1354,7 @@ This is a system API. Defines the attachment of an MMS message. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1375,7 +1375,7 @@ This is a system API. Defines an MMSC address. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1388,7 +1388,7 @@ This is a system API. Enumerates message types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1408,7 +1408,7 @@ This is a system API. Enumerates MMS message priorities. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1422,7 +1422,7 @@ This is a system API. Enumerates MMS versions. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1437,7 +1437,7 @@ This is a system API. Enumerates MMS character sets. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1462,7 +1462,7 @@ This is a system API. Enumerates disposition types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1476,7 +1476,7 @@ This is a system API. Enumerates report types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1489,7 +1489,7 @@ This is a system API. Defines the cell broadcast configuration options. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1505,7 +1505,7 @@ This is a system API. Defines the SIM message status. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1521,7 +1521,7 @@ This is a system API. Enumerates RAN types. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1534,7 +1534,7 @@ This is a system API. Enumerates SMS encoding schemes. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1549,7 +1549,7 @@ This is a system API. Defines the SIM message options. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1564,7 +1564,7 @@ This is a system API. Defines the updating SIM message options. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1580,7 +1580,7 @@ This is a system API. Defines a SIM message. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1594,7 +1594,7 @@ This is a system API. Defines an MMS message delivery index. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1610,7 +1610,7 @@ This is a system API. Defines an MMS response index. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms @@ -1625,7 +1625,7 @@ This is a system API. Defines the SMS message segment information. -This is a system API. +**System API**: This is a system API. **System capability**: SystemCapability.Telephony.SmsMms diff --git a/en/application-dev/reference/apis/js-apis-socket.md b/en/application-dev/reference/apis/js-apis-socket.md index b590efb7ca3455c95c3d217b86e741848c5ac547..77dd0bc0560d11837a5cfbb68f38fd3f39075310 100644 --- a/en/application-dev/reference/apis/js-apis-socket.md +++ b/en/application-dev/reference/apis/js-apis-socket.md @@ -1041,7 +1041,7 @@ promise1.then(() => { console.log('connect success'); let promise2 = tcp.getRemoteAddress(); promise2.then(() => { - console.log('getRemoteAddress success:' + JSON.stringify(data)); + console.log('getRemoteAddress success'); }).catch(err => { console.log('getRemoteAddressfail'); }); @@ -1120,7 +1120,7 @@ promise.then(() => { console.log('connect success'); let promise1 = tcp.getState(); promise1.then(() => { - console.log('getState success:' + JSON.stringify(data)); + console.log('getState success'); }).catch(err => { console.log('getState fail'); }); diff --git a/en/application-dev/reference/apis/js-apis-stack.md b/en/application-dev/reference/apis/js-apis-stack.md index b1e10e9478bc3335b30cd85498f9feb81b07bfd1..a55afd6a634b5cb284741507140f9a35cf38a527 100644 --- a/en/application-dev/reference/apis/js-apis-stack.md +++ b/en/application-dev/reference/apis/js-apis-stack.md @@ -10,6 +10,9 @@ Unlike **[Queue](js-apis-queue.md)**, which is implemented based on the queue da **Recommended use case**: Use **Stack** in LOFI scenarios. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -73,7 +76,7 @@ let result = stack.push("a"); let result1 = stack.push(1); let b = [1, 2, 3]; stack.push(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; let result3 = stack.push(c); ``` diff --git a/en/application-dev/reference/apis/js-apis-statfs.md b/en/application-dev/reference/apis/js-apis-statfs.md index fc9109b25611afe452ea32255267b036e71a45b0..b9cf5106d4369769056d0ad19ed0b4a37a75f553 100644 --- a/en/application-dev/reference/apis/js-apis-statfs.md +++ b/en/application-dev/reference/apis/js-apis-statfs.md @@ -18,26 +18,26 @@ Obtains the number of free bytes of the specified file system in asynchronous mo **System capability**: SystemCapability.FileManagement.File.FileIO -- **Parameters** +**Parameters** | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ---------------------------- | | path | string | Yes | File path of the file system.| -- Return value +**Return value** | Type | Description | | --------------------- | -------------- | | Promise<number> | Promise used to return the number of free bytes obtained.| -- Example +**Example** ```js let path = "/dev"; - statfs.getFreeBytes(path).then(function (number){ - console.info("getFreeBytes promise successfully:"+ number); - }).catch(function(err){ - console.info("getFreeBytes failed with error:"+ err); + statfs.getFreeBytes(path).then(function (number) { + console.info("getFreeBytes promise successfully:" + number); + }).catch(function (err) { + console.info("getFreeBytes failed with error:" + err); }); ``` @@ -49,21 +49,21 @@ Obtains the number of free bytes of the specified file system in asynchronous mo **System capability**: SystemCapability.FileManagement.File.FileIO -- **Parameters** +**Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ---------------------------- | | path | string | Yes | File path of the file system.| | callback | AsyncCallback<number> | Yes | Callback invoked to return the number of free bytes obtained.| -- Example +**Example** ```js - import featureAbility from '@ohos.ability.featureAbility'; + import featureAbility from '@ohos.ability.featureAbility'; let context = featureAbility.getContext(); context.getFilesDir().then(function (path) { - statfs.getFreeBytes(path, function(err, number){ - console.info("Got free bytes successfully:"+ number); + statfs.getFreeBytes(path, function (err, number) { + console.info("getFreeBytes callback successfully:" + number); }); }); ``` @@ -76,26 +76,26 @@ Obtains the total number of bytes of the specified file system in asynchronous m **System capability**: SystemCapability.FileManagement.File.FileIO -- **Parameters** +**Parameters** | Name| Type | Mandatory| Description | | ---- | ------ | ---- | ---------------------------- | | path | string | Yes | File path of the file system.| -- Return value +**Return value** | Type | Description | | --------------------- | ------------ | | Promise<number> | Promise used to return the total number of bytes obtained.| -- Example +**Example** ```js let path = "/dev"; - statfs.getTotalBytes(path).then(function (number){ - console.info("getTotalBytes promise successfully:"+ number); - }).catch(function(err){ - console.info("getTotalBytes failed with error:"+ err); + statfs.getTotalBytes(path).then(function (number) { + console.info("getTotalBytes promise successfully:" + number); + }).catch(function (err) { + console.info("getTotalBytes failed with error:" + err); }); ``` @@ -107,21 +107,21 @@ Obtains the total number of bytes of the specified file system in asynchronous m **System capability**: SystemCapability.FileManagement.File.FileIO -- **Parameters** +**Parameters** | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ---------------------------- | | path | string | Yes | File path of the file system.| | callback | AsyncCallback<number> | Yes | Callback invoked to return the total number of bytes obtained. | -- Example +**Example** ```js import featureAbility from '@ohos.ability.featureAbility'; let context = featureAbility.getContext(); context.getFilesDir().then(function (path) { - statfs.getTotalBytes(path, function(err, number){ - console.info("Got total bytes successfully:"+ number); + statfs.getTotalBytes(path, function(err, number) { + console.info("getTotalBytes callback successfully:" + number); }); }); ``` diff --git a/en/application-dev/reference/apis/js-apis-system-cipher.md b/en/application-dev/reference/apis/js-apis-system-cipher.md index cd4100d455e6f47f6d2600562a4d0522c885284a..82be7501dfcef800ba7bd6db6fc9e3759ac05bfa 100644 --- a/en/application-dev/reference/apis/js-apis-system-cipher.md +++ b/en/application-dev/reference/apis/js-apis-system-cipher.md @@ -25,7 +25,7 @@ Encrypts or decrypts data using RSA. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| action | string | Yes| Action to perform. The options are as follows:
- encrypt
- decrypt| +| action | string | Yes| Action to perform. The options are as follows:
- encrypt
- decrypt | | text | string | Yes| Text to be encrypted or decrypted.
The text to be encrypted must be common text that meets the following requirement:
Maximum text length = Key length/8 - 66
For example, if the key is of 1024 bytes, the text to be encrypted cannot exceed 62 bytes (1024/8 -66 = 62).
The text to be decrypted must be binary text encoded in Base64. The default format is used for Base64 encoding.| | key | string | Yes| RSA key. The key is used as a public key in encryption and a private key in decryption.| | transformation | string | No| RSA padding. The default value is **RSA/None/OAEPWithSHA256AndMGF1Padding**.| @@ -109,7 +109,7 @@ Encrypts or decrypts data using AES. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| action | string | Yes| Action to perform. The options are as follows:
- encrypt
- decrypt| +| action | string | Yes| Action to perform. The options are as follows:
- encrypt
- decrypt | | text | string | Yes| Text to be encrypted or decrypted.
The text to be encrypted must be common text. The text to be decrypted must be binary text encoded in Base64. The default format is used for Base64 encoding.| | key | string | Yes| Key used for encryption or decryption. It is a string encoded in Base64.| | transformation | string | No| Encryption mode and padding of the AES algorithm. The default value is **AES/CBC/PKCS5Padding**.| @@ -165,7 +165,6 @@ export default { console.log(`operation complete!`); } }); - }); } } diff --git a/en/application-dev/reference/apis/js-apis-system-sensor.md b/en/application-dev/reference/apis/js-apis-system-sensor.md index a551dea9a8f79c5d153649ce69dc912f93ddd4b6..7df5f6675bb53168935ada36ca1d0675e49da978 100644 --- a/en/application-dev/reference/apis/js-apis-system-sensor.md +++ b/en/application-dev/reference/apis/js-apis-system-sensor.md @@ -21,9 +21,9 @@ import sensor from '@system.sensor'; ## Error Codes -| Error Code | Description | -| ---- | -------------- | -| 900 | The current device does not support the corresponding sensor.| +| Error Code | Description | +| ---------- | ---------------------------------------- | +| 900 | The current device does not support the corresponding sensor. | ## sensor.subscribeAccelerometer @@ -37,19 +37,19 @@ Subscribes to data changes of the acceleration sensor. If this API is called mul **Parameters** -| Name | Type | Mandatory | Description | -| -------- | -------- | ---- | ---------------------------------------- | -| interval | string | Yes | Execution frequency of the callback for returning the acceleration sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios.| -| success | Function | Yes | Called when the acceleration sensor data changes. | -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | ---------------------------------------- | +| interval | string | Yes | Execution frequency of the callback for returning the acceleration sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios. | +| success | Function | Yes | Called when the acceleration sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| ---- | ------ | ------- | -| x | number | Acceleration on the x-axis.| -| y | number | Acceleration on the y-axis.| -| z | number | Acceleration on the z-axis.| +| Name | Type | Description | +| ---- | ------ | --------------------------- | +| x | number | Acceleration on the x-axis. | +| y | number | Acceleration on the y-axis. | +| z | number | Acceleration on the z-axis. | **Example** @@ -97,16 +97,16 @@ Subscribes to data changes of the compass sensor. If this API is called multiple **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | --------------- | -| success | Function | Yes | Called when the compass sensor data changes.| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the compass sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| --------- | ------ | ---------- | -| direction | number | Direction of the device, in degrees.| +| Name | Type | Description | +| --------- | ------ | ------------------------------------ | +| direction | number | Direction of the device, in degrees. | **Example** @@ -149,16 +149,16 @@ Subscribes to data changes of the proximity sensor. If this API is called multip **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | ----------------- | -| success | Function | Yes | Called when the proximity sensor data changes.| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the proximity sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| -------- | ------ | --------------------- | -| distance | number | Distance between a visible object and the device screen.| +| Name | Type | Description | +| -------- | ------ | ---------------------------------------- | +| distance | number | Distance between a visible object and the device screen. | **Example** @@ -201,16 +201,16 @@ Subscribes to data changes of the ambient light sensor. If this API is called mu **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | --------------- | -| success | Function | Yes | Called when the ambient light sensor data changes| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the ambient light sensor data changes | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| --------- | ------ | ------------ | -| intensity | number | Light intensity, in lux.| +| Name | Type | Description | +| --------- | ------ | ------------------------ | +| intensity | number | Light intensity, in lux. | **Example** @@ -255,16 +255,16 @@ Subscribes to data changes of the step counter sensor. If this API is called mul **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | ---------------- | -| success | Function | Yes | Called when the step counter sensor data changes.| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the step counter sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| ----- | ------ | --------------------- | -| steps | number | Number of counted steps after the sensor is restarted.
| +| Name | Type | Description | +| ----- | ------ | ---------------------------------------- | +| steps | number | Number of counted steps after the sensor is restarted.
| **Example** @@ -302,7 +302,7 @@ sensor.unsubscribeStepCounter(); ## sensor.subscribeBarometer -subcribeBarometer(Object): void +subscribeBarometer(Object): void Subscribes to data changes of the barometer sensor. If this API is called multiple times for the same application, the last call takes effect. @@ -310,16 +310,16 @@ Subscribes to data changes of the barometer sensor. If this API is called multip **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | ---------------- | -| success | Function | Yes | Called when the barometer sensor data changes.| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the barometer sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| -------- | ------ | ----------- | -| pressure | number | Pressure, in pascal.| +| Name | Type | Description | +| -------- | ------ | -------------------- | +| pressure | number | Pressure, in pascal. | **Example** @@ -366,16 +366,16 @@ Subscribes to data changes of the heart rate sensor. If this API is called multi **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | ------------------------- | -| success | Function | Yes | Called when the heart rate sensor data changes. This callback is invoked every five seconds.| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | ---------------------------------------- | +| success | Function | Yes | Called when the heart rate sensor data changes. This callback is invoked every five seconds. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| --------- | ------ | ---- | -| heartRate | number | Heart rate.| +| Name | Type | Description | +| --------- | ------ | ----------- | +| heartRate | number | Heart rate. | **Example** @@ -421,16 +421,16 @@ Subscribes to changes of the wearing state of a wearable device. If this API is **Parameters** -| Name | Type | Mandatory | Description | -| ------- | -------- | ---- | ------------- | -| success | Function | Yes | Called when the wearing state changes.| -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| ------- | -------- | --------- | -------------------------------------- | +| success | Function | Yes | Called when the wearing state changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| ----- | ------- | ------ | -| value | boolean | Whether the wearable device is worn.| +| Name | Type | Description | +| ----- | ------- | ------------------------------------ | +| value | boolean | Whether the wearable device is worn. | **Example** @@ -473,17 +473,17 @@ Obtains the wearing state of a wearable device. **Parameters** -| Name | Type | Mandatory | Description | -| -------- | -------- | ---- | ------------ | -| success | Function | No | Callback upon success.| -| fail | Function | No | Callback upon failure.| -| complete | Function | No | Called when the execution is complete.| +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | -------------------------------------- | +| success | Function | No | Callback upon success. | +| fail | Function | No | Callback upon failure. | +| complete | Function | No | Called when the execution is complete. | Return values of the success callback -| Name | Type | Description | -| ----- | ------- | ------ | -| value | boolean | Whether the wearable device is worn.| +| Name | Type | Description | +| ----- | ------- | ------------------------------------ | +| value | boolean | Whether the wearable device is worn. | **Example** @@ -510,18 +510,18 @@ If this API is called multiple times for the same application, the last call tak **Parameters** -| Name | Type | Mandatory | Description | -| -------- | -------- | ---- | ---------------------------------------- | -| interval | string | Yes | Interval at which the callback is invoked to return the device orientation sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios.| -| success | Function | Yes | Called when the device orientation sensor data changes. | -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | ---------------------------------------- | +| interval | string | Yes | Interval at which the callback is invoked to return the device orientation sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios. | +| success | Function | Yes | Called when the device orientation sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | +| Name | Type | Description | | ----- | ------ | ---------------------------------------- | -| alpha | number | Rotation angle around the Z axis when the X/Y axis of the device coincides with the X/Y axis of the earth.| -| beta | number | Rotation angle around the X axis when the Y/Z axis of the device coincides with the Y/Z axis of the earth.| -| gamma | number | Rotation angle around the Y axis when the X/Z axis of the device coincides with the X/Z axis of the earth.| +| alpha | number | Rotation angle around the Z axis when the X/Y axis of the device coincides with the X/Y axis of the earth. | +| beta | number | Rotation angle around the X axis when the Y/Z axis of the device coincides with the Y/Z axis of the earth. | +| gamma | number | Rotation angle around the Y axis when the X/Z axis of the device coincides with the X/Z axis of the earth. | **Example** @@ -571,19 +571,19 @@ If this API is called multiple times for the same application, the last call tak **Parameters** -| Name | Type | Mandatory | Description | -| -------- | -------- | ---- | ---------------------------------------- | -| interval | string | Yes | Interval at which the callback is invoked to return the gyroscope sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios.| -| success | Function | Yes | Called when the gyroscope sensor data changes. | -| fail | Function | No | Callback upon failure. | +| Name | Type | Mandatory | Description | +| -------- | -------- | --------- | ---------------------------------------- | +| interval | string | Yes | Interval at which the callback is invoked to return the gyroscope sensor data.
The default value is **normal**. The options are as follows:
- **game**: called at an interval of 20 ms, which is applicable to gaming scenarios.
- **ui**: called at an interval of 60 ms, which is applicable to UI updating scenarios.
- **normal**: called at an interval of 200 ms, which is applicable to power-saving scenarios. | +| success | Function | Yes | Called when the gyroscope sensor data changes. | +| fail | Function | No | Callback upon failure. | Return values of the success callback -| Name | Type | Description | -| ---- | ------ | --------- | -| x | number | Rotation angular velocity of the X axis.| -| y | number | Rotation angular velocity of the Y axis.| -| z | number | Rotation angular velocity of the Z axis.| +| Name | Type | Description | +| ---- | ------ | ---------------------------------------- | +| x | number | Rotation angular velocity of the X axis. | +| y | number | Rotation angular velocity of the Y axis. | +| z | number | Rotation angular velocity of the Z axis. | **Example** diff --git a/en/application-dev/reference/apis/js-apis-tagSession.md b/en/application-dev/reference/apis/js-apis-tagSession.md index 5ed3760a0cf3664cc6991a73489dd7f53ab9d83b..e6073f2dca4b101454fbdf14dd9bdd406a8eaade 100644 --- a/en/application-dev/reference/apis/js-apis-tagSession.md +++ b/en/application-dev/reference/apis/js-apis-tagSession.md @@ -1,9 +1,8 @@ -# Standard NFC Tag Session +# NFC Tag Session The **tagSession** module provides common APIs for establishing connections and transferring data. -> **NOTE** -> +> **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** @@ -18,7 +17,7 @@ Provides common APIs for establishing connections and transferring data. **tagSe A child class instance is required to access the following interfaces. You can use **get**XX**Tag()** to obtain a child class instance. -The specific method varies with the NFC tag technology in use. For details, see [nfcTag](js-apis-nfcTag.md). +The specific API varies with the NFC tag technology in use. For details, see [NFC Tags](js-apis-nfcTag.md). ### tagSession.connectTag @@ -26,7 +25,7 @@ connectTag(): boolean; Connects to this tag. -Call this method to set up a connection before reading data from or writing data to a tag. +Call this API to set up a connection before reading data from or writing data to a tag. **Required permissions**: ohos.permission.NFC_TAG @@ -95,7 +94,7 @@ Checks whether the tag is connected. ```js import tag from '@ohos.nfc.tag'; -// tagInfo is an Object given by nfc service when tag is dispatched. +// tagInfo is an object given by the NFC service when a tag is dispatched. let isTagConnected = tag.getXXXTag(taginfo).isTagConnected(); console.log("isTagConnected:" +isTagConnected); ``` diff --git a/en/application-dev/reference/apis/js-apis-testRunner.md b/en/application-dev/reference/apis/js-apis-testRunner.md index bc65de36ea0283d025deb74006dd428d7adefbd7..c82668961c8cf23f5b523024842a786dc4d0979f 100644 --- a/en/application-dev/reference/apis/js-apis-testRunner.md +++ b/en/application-dev/reference/apis/js-apis-testRunner.md @@ -29,7 +29,7 @@ export default class UserTestRunner implements TestRunner { onPrepare() { console.log("Trigger onPrepare") } -onRun(){} + onRun(){} }; ``` @@ -50,6 +50,6 @@ export default class UserTestRunner implements TestRunner { onPrepare() { console.log("Trigger onRun") } -onRun(){} + onRun(){} }; ``` diff --git a/en/application-dev/reference/apis/js-apis-treemap.md b/en/application-dev/reference/apis/js-apis-treemap.md index 7914e5bd409d29b3bcae14653aaa6bd8dd5f6f9c..001b08610c59f25b384c9fc3ada4c74f152b9313 100644 --- a/en/application-dev/reference/apis/js-apis-treemap.md +++ b/en/application-dev/reference/apis/js-apis-treemap.md @@ -12,6 +12,10 @@ Recommended use case: Use **TreeMap** when you need to store KV pairs in sorted order. +This topic uses the following to identify the use of generics: +- K: Key +- V: Value + ## Modules to Import ```ts @@ -96,9 +100,9 @@ Checks whether this container has the specified key. ```ts let treeMap = new TreeMap(); -let result = treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -let result1 = treeMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = treeMap.hasKey("squirrel"); +treeMap.set("squirrel", 123); +let result1 = treeMap.hasKey("squirrel"); ``` @@ -127,7 +131,7 @@ Checks whether this container has the specified value. ```ts let treeMap = new TreeMap(); let result = treeMap.hasValue(123); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); +treeMap.set("squirrel", 123); let result1 = treeMap.hasValue(123); ``` @@ -156,9 +160,9 @@ Obtains the value of the specified key in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); -let result = treeMap.get("sdfs"); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); +let result = treeMap.get("sparrow"); ``` @@ -180,8 +184,8 @@ Obtains the first key in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); let result = treeMap.getFirstKey(); ``` @@ -204,8 +208,8 @@ Obtains the last key in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); let result = treeMap.getLastKey(); ``` @@ -228,8 +232,8 @@ Adds all elements in a **TreeMap** instance to this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); let map = new TreeMap(); treeMap.setAll(map); ``` @@ -260,7 +264,7 @@ Adds an element to this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); +treeMap.set("squirrel", 123); ``` @@ -288,9 +292,9 @@ Removes the element with the specified key from this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); -treeMap.remove("sdfs"); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); +treeMap.remove("sparrow"); ``` @@ -318,10 +322,10 @@ Obtains the key that is placed in front of the input key in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); -treeMap.set("zdfgsd", 356); -let result = treeMap.getLowerKey("sdfs"); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); +treeMap.set("gander", 356); +let result = treeMap.getLowerKey("sparrow"); ``` @@ -349,10 +353,10 @@ Obtains the key that is placed next to the input key in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); -treeMap.set("zdfgsd", 356); -let result = treeMap.getHigherKey("sdfs"); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); +treeMap.set("gander", 356); +let result = treeMap.getHigherKey("sparrow"); ``` ### replace @@ -380,8 +384,8 @@ Replaces an element in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("sdfs", 123); -let result = treeMap.replace("sdfs", 357); +treeMap.set("sparrow", 123); +let result = treeMap.replace("sparrow", 357); ``` @@ -397,8 +401,8 @@ Clears this container and sets its length to **0**. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); treeMap.clear(); ``` @@ -421,8 +425,8 @@ Obtains an iterator that contains all the keys in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); let iter = treeMap.keys(); let temp = iter.next().value; while(temp != undefined) { @@ -450,8 +454,8 @@ Obtains an iterator that contains all the values in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); let iter = treeMap.values(); let temp = iter.next().value; while(temp != undefined) { @@ -487,8 +491,8 @@ callbackfn ```ts let treeMap = new TreeMap(); -treeMap.set("sdfs", 123); -treeMap.set("dfsghsf", 357); +treeMap.set("sparrow", 123); +treeMap.set("gull", 357); treeMap.forEach((value, key) => { console.log("value:" + value, key); }); @@ -513,8 +517,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); let iter = treeMap.entries(); let temp = iter.next().value; while(temp != undefined) { @@ -542,8 +546,8 @@ Obtains an iterator, each item of which is a JavaScript object. ```ts let treeMap = new TreeMap(); -treeMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123); -treeMap.set("sdfs", 356); +treeMap.set("squirrel", 123); +treeMap.set("sparrow", 356); // Method 1: for (let item of treeMap) { diff --git a/en/application-dev/reference/apis/js-apis-treeset.md b/en/application-dev/reference/apis/js-apis-treeset.md index 6e50abcf23c7cf2c3a77e6029244a0078edd1562..9391eb15c944bfa5170c28e4bd1976c346a3356a 100644 --- a/en/application-dev/reference/apis/js-apis-treeset.md +++ b/en/application-dev/reference/apis/js-apis-treeset.md @@ -10,6 +10,9 @@ Recommended use case: Use **TreeSet** when you need to store data in sorted order. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -29,7 +32,7 @@ import TreeSet from '@ohos.util.TreeSet'; ### constructor -constructor(comparator?:(firstValue: T, secondValue: T) => boolean) +constructor(comparator?: (firstValue: T, secondValue: T) => boolean) A constructor used to create a **TreeSet** instance. @@ -118,8 +121,8 @@ Obtains the value of the first element in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); let result = treeSet.getFirstValue(); ``` @@ -142,8 +145,8 @@ Obtains the value of the last element in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); let result = treeSet.getLastValue(); ``` @@ -172,7 +175,7 @@ Adds an element to this container. ```ts let treeSet = new TreeSet(); -let result = treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = treeSet.add("squirrel"); ``` @@ -200,9 +203,9 @@ Removes the element with the specified key from this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); -let result = treeSet.remove("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); +let result = treeSet.remove("sparrow"); ``` @@ -230,10 +233,10 @@ Obtains the value that is placed in front of the input key in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); -treeSet.add("zdfgsd"); -let result = treeSet.getLowerValue("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); +treeSet.add("gander"); +let result = treeSet.getLowerValue("sparrow"); ``` @@ -261,10 +264,10 @@ Obtains the value that is placed next to the input key in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); -treeSet.add("zdfgsd"); -let result = treeSet.getHigherValue("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); +treeSet.add("gander"); +let result = treeSet.getHigherValue("sparrow"); ``` @@ -286,8 +289,8 @@ Removes the first element in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); let result = treeSet.popFirst(); ``` @@ -310,8 +313,8 @@ Removes the last element in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); let result = treeSet.popLast(); ``` @@ -328,8 +331,8 @@ Clears this container and sets its length to **0**. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); treeSet.clear(); ``` @@ -352,8 +355,8 @@ Obtains an iterator that contains all the values in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); let iter = treeSet.values(); let temp = iter.next().value; while(temp != undefined) { @@ -389,8 +392,8 @@ callbackfn ```ts let treeSet = new TreeSet(); -treeSet.add("sdfs"); -treeSet.add("dfsghsf"); +treeSet.add("sparrow"); +treeSet.add("gull"); treeSet.forEach((value, key) => { console.log("value:" + value, key) }); @@ -415,8 +418,8 @@ Obtains an iterator that contains all the elements in this container. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); let iter = treeSet.entries(); let temp = iter.next().value; while(temp != undefined) { @@ -445,8 +448,8 @@ Obtains an iterator, each item of which is a JavaScript object. ```ts let treeSet = new TreeSet(); -treeSet.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -treeSet.add("sdfs"); +treeSet.add("squirrel"); +treeSet.add("sparrow"); // Method 1: for (let item of treeSet) { diff --git a/en/application-dev/reference/apis/js-apis-update.md b/en/application-dev/reference/apis/js-apis-update.md index ab8fc8e866ae68175f6ddabc0be83ac1f2803b5f..91013f97245cf0b63073b88c51af91705324038a 100644 --- a/en/application-dev/reference/apis/js-apis-update.md +++ b/en/application-dev/reference/apis/js-apis-update.md @@ -7,7 +7,7 @@ There are two types of updates: SD card update and over the air (OTA) update. - The SD card update depends on the update packages and SD cards. - The OTA update depends on the server deployed by the device manufacturer for managing update packages. The OTA server IP address is passed by the caller. The request interface is fixed and developed by the device manufacturer. -> **Note:** +> **NOTE** > > The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > @@ -239,7 +239,7 @@ var versionDigestInfo = { // Options of the description file var descriptionOptions = { - format: DescriptionFormat.STANDARD, // Standard format + format: update.DescriptionFormat.STANDARD, // Standard format language: "zh-cn" // Chinese } @@ -282,7 +282,7 @@ var versionDigestInfo = { // Options of the description file var descriptionOptions = { - format: DescriptionFormat.STANDARD, // Standard format + format: update.DescriptionFormat.STANDARD, // Standard format language: "zh-cn" // Chinese } @@ -369,7 +369,7 @@ Obtains the description file of the current version. This API uses an asynchrono ```ts // Options of the description file var descriptionOptions = { - format: DescriptionFormat.STANDARD, // Standard format + format: update.DescriptionFormat.STANDARD, // Standard format language: "zh-cn" // Chinese } @@ -406,7 +406,7 @@ Obtains the description file of the current version. This API uses a promise to ```ts // Options of the description file var descriptionOptions = { - format: DescriptionFormat.STANDARD, // Standard format + format: update.DescriptionFormat.STANDARD, // Standard format language: "zh-cn" // Chinese } @@ -1580,7 +1580,7 @@ Represents an update file. ## UpgradeTaskCallback -### (eventInfo: [EventInfo](#eventinfo)): void +(eventInfo: EventInfo): void Represents an event callback. diff --git a/en/application-dev/reference/apis/js-apis-uri.md b/en/application-dev/reference/apis/js-apis-uri.md index 60fd45f98209c718374e4a2633b074a531aa719c..faeb4f766d6c1417728f540fcab71551ee688abf 100644 --- a/en/application-dev/reference/apis/js-apis-uri.md +++ b/en/application-dev/reference/apis/js-apis-uri.md @@ -47,7 +47,7 @@ A constructor used to create a URI instance. **Example** ```js -var mm = 'http://username:password@host:8080/directory/file?foo=1&bar=2#fragment'; +let mm = 'http://username:password@host:8080/directory/file?foo=1&bar=2#fragment'; new uri.URI(mm); // Output 'http://username:password@host:8080/directory/file?foo=1&bar=2#fragment'; ``` ```js diff --git a/en/application-dev/reference/apis/js-apis-url.md b/en/application-dev/reference/apis/js-apis-url.md index 55694ec1cb024a25affa93feca40b2a73ef38234..c060118f7e466da51f2ee5b7fdd6ad20f7e256ca 100755 --- a/en/application-dev/reference/apis/js-apis-url.md +++ b/en/application-dev/reference/apis/js-apis-url.md @@ -26,16 +26,16 @@ Creates a **URLSearchParams** instance. | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| init | string[][] \| Record<string, string> \| string \| URLSearchParams | No| Input parameter objects, which include the following:
- **string[][]**: two-dimensional string array
- **Record<string, string>**: list of objects
- **string**: string
- **URLSearchParams**: object| +| init | string[][] \| Record<string, string> \| string \| URLSearchParams | No| Input parameter objects, which include the following:
- **string[][]**: two-dimensional string array
- **Record<string, string>**: list of objects
- **string**: string
- **URLSearchParams**: object| **Example** ```js -var objectParams = new Url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]); -var objectParams1 = new Url.URLSearchParams({"fod" : '1' , "bard" : '2'}); -var objectParams2 = new Url.URLSearchParams('?fod=1&bard=2'); -var urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2'); -var params = new Url.URLSearchParams(urlObject.search); +let objectParams = new Url.URLSearchParams([ ['user1', 'abc1'], ['query2', 'first2'], ['query3', 'second3'] ]); +let objectParams1 = new Url.URLSearchParams({"fod" : '1' , "bard" : '2'}); +let objectParams2 = new Url.URLSearchParams('?fod=1&bard=2'); +let urlObject = new Url.URL('https://developer.mozilla.org/?fod=1&bard=2'); +let params = new Url.URLSearchParams(urlObject.search); ``` @@ -133,7 +133,7 @@ Obtains an ES6 iterator. Each item of the iterator is a JavaScript array, and th **Example** ```js -var searchParamsObject = new Url.URLSearchParams("keyName1=valueName1&keyName2=valueName2"); +let searchParamsObject = new Url.URLSearchParams("keyName1=valueName1&keyName2=valueName2"); for (var pair of searchParamsObject .entries()) { // Show keyName/valueName pairs console.log(pair[0]+ ', '+ pair[1]); } @@ -197,9 +197,9 @@ Obtains the value of the first key-value pair based on the specified key. **Example** ```js -var paramsOject = new Url.URLSearchParams('name=Jonathan&age=18'); -var name = paramsOject.get("name"); // is the string "Jonathan" -var age = parseInt(paramsOject.get("age"), 10); // is the number 18 +let paramsObject = new Url.URLSearchParams('name=Jonathan&age=18'); +let name = paramsObject.get("name"); // is the string "Jonathan" +let age = parseInt(paramsObject.get("age"), 10); // is the number 18 ``` @@ -267,7 +267,7 @@ Sorts all key-value pairs contained in this object based on the Unicode code poi **Example** ```js -var searchParamsObject = new Url.URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object +let searchParamsObject = new Url.URLSearchParams("c=3&a=9&b=4&d=2"); // Create a test URLSearchParams object searchParamsObject.sort(); // Sort the key/value pairs console.log(searchParamsObject.toString()); // Display the sorted query string // Output a=9&b=2&c=3&d=4 ``` @@ -290,7 +290,7 @@ Obtains an ES6 iterator that contains the keys of all the key-value pairs. **Example** ```js -var searchParamsObject = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing +let searchParamsObject = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing for (var key of searchParamsObject .keys()) { // Output key-value pairs console.log(key); } @@ -314,8 +314,8 @@ Obtains an ES6 iterator that contains the values of all the key-value pairs. **Example** ```js -var searchParams = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing -for (var value of searchParams.values()) { +let searchParams = new Url.URLSearchParams("key1=value1&key2=value2"); // Create a URLSearchParamsObject object for testing +for (var value of searchParams.values()) { console.log(value); } ``` @@ -339,7 +339,7 @@ Obtains an ES6 iterator. Each item of the iterator is a JavaScript array, and th ```js const paramsObject = new Url.URLSearchParams('fod=bay&edg=bap'); -for (const [name, value] of paramsObject) { +for (const [name, value] of paramsObject) { console.log(name, value); } ``` @@ -409,11 +409,11 @@ Creates a URL. **Example** ```js -var mm = 'http://username:password@host:8080'; -var a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/'; -var b = new Url.URL(mm); // Output 'http://username:password@host:8080/'; +let mm = 'http://username:password@host:8080'; +let a = new Url.URL("/", mm); // Output 'http://username:password@host:8080/'; +let b = new Url.URL(mm); // Output 'http://username:password@host:8080/'; new Url.URL('path/path1', b); // Output 'http://username:password@host:8080/path/path1'; -var c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; +let c = new Url.URL('/path/path1', b); // Output 'http://username:password@host:8080/path/path1'; new Url.URL('/path/path1', c); // Output 'http://username:password@host:8080/path/path1'; new Url.URL('/path/path1', a); // Output 'http://username:password@host:8080/path/path1'; new Url.URL('/path/path1', "https://www.exampleUrl/fr-FR/toto"); // Output https://www.exampleUrl/path/path1 diff --git a/en/application-dev/reference/apis/js-apis-usb.md b/en/application-dev/reference/apis/js-apis-usb.md index 8979bdeefaaebbd77e0e17bd094313025155527b..d21f6372b5fe26f6e8aeded00e3245b2def23428 100644 --- a/en/application-dev/reference/apis/js-apis-usb.md +++ b/en/application-dev/reference/apis/js-apis-usb.md @@ -94,14 +94,16 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | device | [USBDevice](#usbdevice) | Yes| USB device information.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| device | [USBDevice](#usbdevice) | Yes| USB device information.| **Return value** - | Type| Description| - | -------- | -------- | - | Readonly<[USBDevicePipe](#usbdevicepipe)> | USB device pipe for data transfer.| + +| Type| Description| +| -------- | -------- | +| Readonly<[USBDevicePipe](#usbdevicepipe)> | USB device pipe for data transfer.| **Example** @@ -119,14 +121,16 @@ Checks whether the application has the permission to access the device. **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | deviceName | string | Yes| Device name to set.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| deviceName | string | Yes| Device name.| **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the application has the permission to access the device; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | The value **true** indicates that the application has the permission to access the device, and the value **false** indicates the opposite.| **Example** @@ -140,19 +144,21 @@ console.log(bool); requestRight(deviceName: string): Promise<boolean> -Requests the temporary permission for the application to access the USB device. +Requests the temporary permission for the application to access the USB device. This API uses a promise to return the result. **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | deviceName | string | Yes| Device name to set.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| deviceName | string | Yes| Device name.| **Return value** - | Type| Description| - | -------- | -------- | - | Promise<boolean> | Returns **true** if the temporary device access permissions are granted; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| Promise<boolean> | Promise used to return the result. The value **true** indicates that the temporary device access permissions are granted, and the value **false** indicates the opposite.| **Example** @@ -174,16 +180,18 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| - | iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to claim.| - | force | boolean | No| Whether to forcibly claim the USB interface. The default value is **false**, indicating not to forcibly claim the USB interface.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| +| iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to claim.| +| force | boolean | No| Whether to forcibly claim the USB interface. The default value is **false**, indicating not to forcibly claim the USB interface.| **Return value** - | Type| Description| - | -------- | -------- | - | number | Returns **0** if the USB interface is successfully claimed; returns an error code otherwise.| + +| Type| Description| +| -------- | -------- | +| number | The value **0** indicates that the USB interface is successfully claimed, and an error code indicates the opposite.| **Example** @@ -203,15 +211,17 @@ Before you do this, ensure that you have claimed the interface by calling [usb.c **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| - | iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to release.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| +| iface | [USBInterface](#usbinterface) | Yes| USB interface, which is used to determine the index of the interface to release.| **Return value** - | Type| Description| - | -------- | -------- | - | number | Returns **0** if the USB interface is successfully released; returns an error code otherwise.| + +| Type| Description| +| -------- | -------- | +| number | The value **0** indicates that the USB interface is successfully released, and an error code indicates the opposite.| **Example** @@ -231,15 +241,17 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| - | config | [USBConfig](#usbconfig) | Yes| USB configuration to set.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| +| config | [USBConfig](#usbconfig) | Yes| USB configuration to set.| **Return value** - | Type| Description| - | -------- | -------- | - | number | Returns **0** if the USB configuration is successfully set; returns an error code otherwise.| + +| Type| Description| +| -------- | -------- | +| number | The value **0** indicates that the USB configuration is successfully set, and an error code indicates the opposite.| **Example** @@ -266,9 +278,10 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi | iface | [USBInterface](#usbinterface) | Yes | USB interface to set. | **Return value** - | Type| Description| - | -------- | -------- | - | number | Returns **0** if the USB interface is successfully set; returns an error code otherwise.| + +| Type| Description| +| -------- | -------- | +| number | The value **0** indicates that the USB interface is successfully set, and an error code indicates the opposite.| **Example** @@ -289,14 +302,15 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| **Return value** + | Type| Description| | -------- | -------- | -| Uint8Array | Returns the raw USB descriptor if the operation is successful; returns **undefined** otherwise.| +| Uint8Array | The return value is the raw USB descriptor if the operation is successful, or **undefined** if the operation has failed.| **Example** @@ -315,15 +329,16 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| Device pipe, which is used to determine the bus number and device address.| **Return value** | Type | Description | | ------ | -------------------- | -| number | Returns the file descriptor of the USB device if the operation is successful; returns **-1** otherwise.| +| number | The return value is the file descriptor of the USB device if the operation is successful, or **-1** if the operation has failed.| **Example** @@ -342,16 +357,18 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device.| - | contrlparam | [USBControlParams](#usbcontrolparams) | Yes| Control transfer parameters.| - | timeout | number | No| Timeout duration. The default value is **0**, indicating no timeout.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device.| +| contrlparam | [USBControlParams](#usbcontrolparams) | Yes| Control transfer parameters.| +| timeout | number | No| Timeout duration in ms. This parameter is optional. The default value is **0**, indicating no timeout.| **Return value** - | Type| Description| - | -------- | -------- | - | Promise<number> | Returns the size of the transmitted or received data block if the control transfer is successful; returns **-1** if an exception occurs.| + +| Type| Description| +| -------- | -------- | +| Promise<number> | Promise used to return the result, which is the size of the transmitted or received data block if the transfer is successful, or **-1** if an exception has occurred.| **Example** @@ -372,17 +389,19 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device.| - | endpoint | [USBEndpoint](#usbendpoint) | Yes| USB endpoint, which is used to determine the USB port for data transfer.| - | buffer | Uint8Array | Yes| Buffer for writing or reading data.| - | timeout | number | No| Timeout duration. The default value is **0**, indicating no timeout.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe, which is used to determine the USB device.| +| endpoint | [USBEndpoint](#usbendpoint) | Yes| USB endpoint, which is used to determine the USB port for data transfer.| +| buffer | Uint8Array | Yes| Buffer for writing or reading data.| +| timeout | number | No| Timeout duration in ms. This parameter is optional. The default value is **0**, indicating no timeout.| **Return value** - | Type| Description| - | -------- | -------- | - | Promise<number> | Returns the size of the transmitted or received data block if the control transfer is successful; returns **-1** if an exception occurs.| + +| Type| Description| +| -------- | -------- | +| Promise<number> | Promise used to return the result, which is the size of the transmitted or received data block if the transfer is successful, or **-1** if an exception has occurred.| **Example** @@ -406,14 +425,16 @@ Before you do this, call [usb.getDevices](#usbgetdevices) to obtain the USB devi **System capability**: SystemCapability.USB.USBManager **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| pipe | [USBDevicePipe](#usbdevicepipe) | Yes| USB device pipe.| **Return value** - | Type| Description| - | -------- | -------- | - | number | Returns **0** if the USB device pipe is closed successfully; returns an error code otherwise.| + +| Type| Description| +| -------- | -------- | +| number | The value **0** indicates that the USB device pipe is closed successfully, and an error code indicates the opposite.| **Example** @@ -498,8 +519,8 @@ Sets the current USB function list in Device mode. **Return value** -| Type | Description | -| ------------------ | ------------------------------------------------------ | +| Type | Description | +| ------------------ | ------------------------------------------------------------ | | Promise\ | Promise used to return the result. The value **true** indicates that the operation is successful, and the value **false** indicates the opposite.| **Example** @@ -601,8 +622,8 @@ Sets the role types supported by a specified port, which can be **powerRole** (f **Return value** -| Type | Description | -| ------------------ | -------------- | +| Type | Description | +| ------------------ | ------------------------------------------------------------ | | Promise\ | Promise used to return the result. The value **true** indicates that the operation is successful, and the value **false** indicates the opposite.| **Example** diff --git a/en/application-dev/reference/apis/js-apis-useriam-faceauth.md b/en/application-dev/reference/apis/js-apis-useriam-faceauth.md new file mode 100644 index 0000000000000000000000000000000000000000..60690327946699362eb5b86deaaae3b438897e3e --- /dev/null +++ b/en/application-dev/reference/apis/js-apis-useriam-faceauth.md @@ -0,0 +1,81 @@ +# Facial Authentication + +The **userIAM.faceAuth** module provides APIs for face enrollment. + +> **NOTE** +> +> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. +> +> The APIs provided by this module are system APIs. + +## Modules to Import + +```js +import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; +``` + +## FaceAuthManager + +Provides APIs for facial authentication management. + +### constructor + +constructor() + +A constructor used to create a **FaceAuthManager** object. + +**System capability**: SystemCapability.UserIAM.UserAuth.FaceAuth + +**Return value** + +| Type | Description | +| ---------------------- | -------------------- | +| [FaceAuthManager](#faceauthmanager) | **FaceAuthManager** object.| + +**Example** + + ```js + import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; + + let faceAuthManager = new userIAM_faceAuth.FaceAuthManager() + ``` + +### setSurfaceId + +setSurfaceId(surfaceId: string): ResultCode; + +Sets an [XComponent surface ID](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid) for the face preview page in the face enrollment process. + +**System capability**: SystemCapability.UserIAM.UserAuth.FaceAuth + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------------- | ---------------------------------- | ---- | -------------------------- | +| surfaceId | string | Yes | ID of the surface held by the [XComponent](../arkui-ts/ts-basic-components-xcomponent.md#getxcomponentsurfaceid).| + +**Return value** + +| Type | Description | +| ---------- | ------------------------------------------------------------ | +| [ResultCode](#resultcode) | Operation result code.| + +**Example** + + ```js + import userIAM_faceAuth from '@ohos.userIAM.faceAuth'; + + let faceAuthManager = new userIAM_faceAuth.FaceAuthManager() + faceAuthManager.setSurfaceId("0"); + ``` + +## ResultCode + + Enumerates the operation result codes. + + **System capability**: SystemCapability.UserIAM.UserAuth.FaceAuth + +| Name | Default Value| Description | +| ----------------------- | ------ | -------------------- | +| SUCCESS | 0 | The operation is successful. | +| FAIL | 1 | The operation fails. | diff --git a/en/application-dev/reference/apis/js-apis-useriam-userauth.md b/en/application-dev/reference/apis/js-apis-useriam-userauth.md index d98f43faaf7bc2a575cfa80907a776d9436bfbff..a43b77bcf631b9ad1c2882a841af545fbe9669fd 100644 --- a/en/application-dev/reference/apis/js-apis-useriam-userauth.md +++ b/en/application-dev/reference/apis/js-apis-useriam-userauth.md @@ -119,8 +119,6 @@ constructor() A constructor used to create an **authenticator** object. -**Required permissions**: ohos.permission.ACCESS_BIOMETRIC - **System capability**: SystemCapability.UserIAM.UserAuth.Core **Return value** @@ -279,7 +277,8 @@ Cancels an authentication. // contextId can be obtained using auth(). In this example, it is defined here. let contextId = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]); - let cancelCode = auth.cancel(contextId); + let auth = new userIAM_userAuth.UserAuth(); + let cancelCode = auth.cancelAuth(contextId); if (cancelCode == userIAM_userAuth.ResultCode.SUCCESS) { console.info("cancel auth success"); } else { @@ -492,11 +491,10 @@ getAuthenticator(): Authenticator Obtains an **Authenticator** object for user authentication. -**Required permissions**: ohos.permission.ACCESS_BIOMETRIC - **System capability**: SystemCapability.UserIAM.UserAuth.Core **Return value** + | Type | Description | | ----------------------------------------- | ------------ | | [Authenticator](#authenticatordeprecated) | **Authenticator** object obtained.| @@ -516,7 +514,7 @@ Provides methods to manage an **Authenticator** object. ### execute(deprecated) -execute(type: string, level: string, callback: AsyncCallback<number>): void +execute(type: AuthType, level: SecureLevel, callback: AsyncCallback<number>): void > **NOTE**
> This API is not longer maintained since API version 8. You are advised to use [auth](#auth8). @@ -531,8 +529,8 @@ Performs user authentication. This API uses asynchronous callback to return the | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | ------------------------------------------------------------ | -| type | string | Yes | Authentication type. Only **FACE_ONLY** is supported.
**ALL** is reserved and not supported by the current version.| -| level | string | Yes | Security level of the authentication. It can be S1 (lowest), S2, S3, or S4 (highest).
Devices capable of 3D facial recognition support S3 and lower-level authentication.
Devices capable of 2D facial recognition support S2 and lower-level authentication.| +| type | AuthType | Yes | Authentication type. Only **FACE_ONLY** is supported.
**ALL** is reserved and not supported by the current version.| +| level | SecureLevel | Yes | Security level of the authentication. It can be **S1** (lowest), **S2**, **S3**, or **S4** (highest).
Devices capable of 3D facial recognition support S3 and lower-level authentication.
Devices capable of 2D facial recognition support S2 and lower-level authentication.| | callback | AsyncCallback<number> | No | Callback used to return the result. | Parameters returned in callback @@ -543,19 +541,20 @@ Performs user authentication. This API uses asynchronous callback to return the **Example** ```js - authenticator.execute("FACE_ONLY", "S2", (code)=>{ - if (code == userIAM_userAuth.AuthenticationResult.SUCCESS) { + let authenticator = userIAM_userAuth.getAuthenticator(); + authenticator.execute("FACE_ONLY", "S2", (error, code)=>{ + if (code === userIAM_userAuth.ResultCode.SUCCESS) { console.info("auth success"); return; } console.error("auth fail, code = " + code); - }) + }); ``` ### execute(deprecated) -execute(type:string, level:string): Promise<number> +execute(type:AuthType, level:SecureLevel): Promise<number> > **NOTE**
> This API is not longer maintained since API version 8. You are advised to use [auth](#auth8). @@ -567,26 +566,28 @@ Performs user authentication. This API uses a promise to return the result. **System capability**: SystemCapability.UserIAM.UserAuth.Core **Parameters** + | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------------------------------------------------ | -| type | string | Yes | Authentication type. Only **FACE_ONLY** is supported.
**ALL** is reserved and not supported by the current version.| -| level | string | Yes | Security level of the authentication. It can be S1 (lowest), S2, S3, or S4 (highest).
Devices capable of 3D facial recognition support S3 and lower-level authentication.
Devices capable of 2D facial recognition support S2 and lower-level authentication.| +| type | AuthType | Yes | Authentication type. Only **FACE_ONLY** is supported.
**ALL** is reserved and not supported by the current version.| +| level | SecureLevel | Yes | Security level of the authentication. It can be **S1** (lowest), **S2**, **S3**, or **S4** (highest).
Devices capable of 3D facial recognition support S3 and lower-level authentication.
Devices capable of 2D facial recognition support S2 and lower-level authentication.| **Return value** + | Type | Description | | --------------------- | ------------------------------------------------------------ | | Promise<number> | Promise used to return the authentication result, which is a number. For details, see [AuthenticationResult](#authenticationresultdeprecated).| **Example** -```js -let authenticator = userIAM_userAuth.getAuthenticator(); -authenticator.execute("FACE_ONLY", "S2").then((code)=>{ - console.info("auth success"); -}).catch((code)=>{ - console.error("auth fail, code = " + code); -}); -``` + ```js + let authenticator = userIAM_userAuth.getAuthenticator(); + authenticator.execute("FACE_ONLY", "S2").then((code)=>{ + console.info("auth success"); + }).catch((error)=>{ + console.error("auth fail, code = " + error); + }); + ``` ## AuthenticationResult(deprecated) diff --git a/en/application-dev/reference/apis/js-apis-util.md b/en/application-dev/reference/apis/js-apis-util.md index d1ffe6f45c4a792bdfda7ad81743a3fe1b8aac51..eb52d85a2c418842f2cb2d581fb0583917b68622 100755 --- a/en/application-dev/reference/apis/js-apis-util.md +++ b/en/application-dev/reference/apis/js-apis-util.md @@ -24,19 +24,21 @@ Prints the input content in a formatted string. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | format | string | Yes| Format of the string to print.| | ...args | Object[] | No| Data to format.| **Return value** + | Type| Description| | -------- | -------- | | string | String in the specified format.| **Example** ```js - var res = util.printf("%s", "hello world!"); + let res = util.printf("%s", "hello world!"); console.log(res); ``` @@ -50,19 +52,21 @@ Obtains detailed information about a system error code. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | errno | number | Yes| Error code generated.| **Return value** + | Type| Description| | -------- | -------- | | string | Detailed information about the error code.| **Example** ```js - var errnum = 10; // 10 is a system error code. - var result = util.getErrorString(errnum); + let errnum = 10; // 10 is a system error code. + let result = util.getErrorString(errnum); console.log("result = " + result); ``` @@ -82,6 +86,7 @@ Calls back an asynchronous function. In the callback, the first parameter indica | original | Function | Yes| Asynchronous function.| **Return value** + | Type| Description| | -------- | -------- | | Function | Callback, in which the first parameter indicates the cause of the rejection (the value is **null** if the promise has been resolved) and the second parameter indicates the resolved value.| @@ -91,8 +96,8 @@ Calls back an asynchronous function. In the callback, the first parameter indica async function promiseFn() { return Promise.reject('value'); } - var err = "type err"; - var cb = util.callbackWrapper(promiseFn); + let err = "type err"; + let cb = util.callbackWrapper(promiseFn); cb((err, ret) => { console.log(err); console.log(ret); @@ -105,7 +110,6 @@ Calls back an asynchronous function. In the callback, the first parameter indica promiseWrapper(original: (err: Object, value: Object) => void): Object > **NOTE** -> > This API is deprecated since API version 9. You are advised to use **[util.promisify9+](#utilpromisify9)** instead. Processes an asynchronous function and returns a promise version. @@ -119,9 +123,10 @@ Processes an asynchronous function and returns a promise version. | original | Function | Yes| Asynchronous function.| **Return value** + | Type| Description| | -------- | -------- | -| Function | Function in the error-first style (that is, **(err, value) =>...** is called as the last parameter) and the promise version.| +| Function | Function in the error-first style (that is, **(err, value) =>...** is called as the last parameter) and the promise.| ## util.promisify9+ @@ -132,11 +137,13 @@ Processes an asynchronous function and returns a promise. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | original | Function | Yes| Asynchronous function.| **Return value** + | Type| Description| | -------- | -------- | | Function | Function in the error-first style (that is, **(err, value) =>...** is called as the last parameter) and the promise.| @@ -156,6 +163,90 @@ Processes an asynchronous function and returns a promise. }) ``` +## util.randomUUID9+ + +randomUUID(entropyCache?: boolean): string + +Uses a secure random number generator to generate a random universally unique identifier (UUID) of RFC 4122 version 4. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| entropyCache | boolean | No| Whether a cached UUID can be used. The default value is **true**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| string | A string representing the UUID generated.| + +**Example** + ```js + let uuid = util.randomUUID(true); + console.log("RFC 4122 Version 4 UUID:" + uuid); + // Output: + // RFC 4122 Version 4 UUID:88368f2a-d5db-47d8-a05f-534fab0a0045 + ``` + +## util.randomBinaryUUID9+ + +randomBinaryUUID(entropyCache?: boolean): Uint8Array + +Uses a secure random number generator to generate a random binary UUID of RFC 4122 version 4. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| entropyCache | boolean | No| Whether a cached UUID can be used. The default value is **true**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Uint8Array | A Uint8Array value representing the UUID generated.| + +**Example** + ```js + let uuid = util.randomBinaryUUID(true); + console.log(JSON.stringify(uuid)); + // Output: + // 138,188,43,243,62,254,70,119,130,20,235,222,199,164,140,150 + ``` + +## util.parseUUID9+ + +parseUUID(uuid: string): Uint8Array + +Parses a UUID from a string, as described in RFC 4122 version 4. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| uuid | string | Yes| A string representing the UUID.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| Uint8Array | A Uint8Array value representing the UUID parsed. If the parsing fails, **SyntaxError** is thrown.| + +**Example** + ```js + let uuid = util.parseUUID("84bdf796-66cc-4655-9b89-d6218d100f9c"); + console.log(JSON.stringify(uuid)); + // Output: + // 132,189,247,150,102,204,70,85,155,137,214,33,141,16,15,156 + ``` + ## TextDecoder ### Attributes @@ -178,6 +269,7 @@ A constructor used to create a **TextDecoder** object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | encoding | string | No| Encoding format.| @@ -192,7 +284,7 @@ A constructor used to create a **TextDecoder** object. **Example** ```js - var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); + let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); ``` @@ -205,6 +297,7 @@ Decodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | input | Uint8Array | Yes| Uint8Array to decode.| @@ -217,14 +310,15 @@ Decodes the input content. | stream | boolean | No| Whether to allow data blocks in subsequent **decode()**. If data is processed in blocks, set this parameter to **true**. If this is the last data block to process or data is not divided into blocks, set this parameter to **false**. The default value is **false**.| **Return value** + | Type| Description| | -------- | -------- | | string | Data decoded.| **Example** ```js - var textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); - var result = new Uint8Array(6); + let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); + let result = new Uint8Array(6); result[0] = 0xEF; result[1] = 0xBB; result[2] = 0xBF; @@ -232,7 +326,50 @@ Decodes the input content. result[4] = 0x62; result[5] = 0x63; console.log("input num:"); - var retStr = textDecoder.decode( result , {stream: false}); + let retStr = textDecoder.decode( result , {stream: false}); + console.log("retStr = " + retStr); + ``` + + +### decodeWithStream9+ + +decodeWithStream(input: Uint8Array, options?: { stream?: boolean }): string + +Decodes the input content. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| input | Uint8Array | Yes| Uint8Array to decode.| +| options | Object | No| Options related to decoding.| + + **Table 2** options + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| stream | boolean | No| Whether to allow data blocks in subsequent **decodeWithStream()**. If data is processed in blocks, set this parameter to **true**. If this is the last data block to process or data is not divided into blocks, set this parameter to **false**. The default value is **false**.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| string | Data decoded.| + +**Example** + ```js + let textDecoder = new util.TextDecoder("utf-8",{ignoreBOM: true}); + let result = new Uint8Array(6); + result[0] = 0xEF; + result[1] = 0xBB; + result[2] = 0xBF; + result[3] = 0x61; + result[4] = 0x62; + result[5] = 0x63; + console.log("input num:"); + let retStr = textDecoder.decodeWithStream( result , {stream: false}); console.log("retStr = " + retStr); ``` @@ -258,7 +395,7 @@ A constructor used to create a **TextEncoder** object. **Example** ```js - var textEncoder = new util.TextEncoder(); + let textEncoder = new util.TextEncoder(); ``` @@ -271,20 +408,22 @@ Encodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | input | string | Yes| String to encode.| **Return value** + | Type| Description| | -------- | -------- | | Uint8Array | Encoded text.| **Example** ```js - var textEncoder = new util.TextEncoder(); - var buffer = new ArrayBuffer(20); - var result = new Uint8Array(buffer); + let textEncoder = new util.TextEncoder(); + let buffer = new ArrayBuffer(20); + let result = new Uint8Array(buffer); result = textEncoder.encode("\uD800¥¥"); ``` @@ -298,22 +437,24 @@ Stores the UTF-8 encoded text. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | input | string | Yes| String to encode.| | dest | Uint8Array | Yes| **Uint8Array** instance used to store the UTF-8 encoded text.| **Return value** + | Type| Description| | -------- | -------- | | Uint8Array | Encoded text.| **Example** ```js - var that = new util.TextEncoder() - var buffer = new ArrayBuffer(4) - var dest = new Uint8Array(buffer) - var result = new Object() + let that = new util.TextEncoder() + let buffer = new ArrayBuffer(4) + let dest = new Uint8Array(buffer) + let result = new Object() result = that.encodeInto('abcd', dest) ``` @@ -329,6 +470,7 @@ A constructor used to create a **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | numerator | number | Yes| Numerator, which is an integer.| @@ -336,7 +478,7 @@ A constructor used to create a **RationalNumber** object. **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); + let rationalNumber = new util.RationalNumber(1,2); ``` @@ -349,19 +491,21 @@ Creates a **RationalNumber** object based on the given string. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | rationalString | string | Yes| String used to create the **RationalNumber** object.| **Return value** + | Type| Description| | -------- | -------- | | object | **RationalNumber** object created.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var rational = util.RationalNumber.createRationalFromString("3/4"); + let rationalNumber = new util.RationalNumber(1,2); + let rational = util.RationalNumber.createRationalFromString("3/4"); ``` @@ -374,20 +518,22 @@ Compares this **RationalNumber** object with a given object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | another | RationalNumber | Yes| Object used to compare with this **RationalNumber** object.| **Return value** + | Type| Description| | -------- | -------- | | number | Returns **0** if the two objects are equal; returns **1** if the given object is less than this object; return **-1** if the given object is greater than this object.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var rational = util.RationalNumber.createRationalFromString("3/4"); - var result = rationalNumber.compareTo(rational); + let rationalNumber = new util.RationalNumber(1,2); + let rational = util.RationalNumber.createRationalFromString("3/4"); + let result = rationalNumber.compareTo(rational); ``` @@ -400,14 +546,15 @@ Obtains the value of this **RationalNumber** object as an integer or a floating- **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | An integer or a floating-point number.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.valueOf(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.valueOf(); ``` @@ -420,20 +567,22 @@ Checks whether this **RationalNumber** object equals the given object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | object | Object | Yes| Object used to compare with this **RationalNumber** object.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the two objects are equal; returns **false** otherwise.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var rational = util.RationalNumber.createRationalFromString("3/4"); - var result = rationalNumber.equals(rational); + let rationalNumber = new util.RationalNumber(1,2); + let rational = util.RationalNumber.createRationalFromString("3/4"); + let result = rationalNumber.equals(rational); ``` @@ -446,20 +595,22 @@ Obtains the greatest common divisor of two specified integers. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | number1 | number | Yes| The first integer used to get the greatest common divisor.| | number2 | number | Yes| The second integer used to get the greatest common divisor.| **Return value** + | Type| Description| | -------- | -------- | | number | Greatest common divisor obtained.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = util.RationalNumber.getCommonDivisor(4,6); + let rationalNumber = new util.RationalNumber(1,2); + let result = util.RationalNumber.getCommonDivisor(4,6); ``` @@ -479,8 +630,8 @@ Obtains the numerator of this **RationalNumber** object. **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.getNumerator(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.getNumerator(); ``` @@ -493,14 +644,15 @@ Obtains the denominator of this **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Denominator of this **RationalNumber** object.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.getDenominator(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.getDenominator(); ``` @@ -513,14 +665,15 @@ Checks whether this **RationalNumber** object is **0**. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the value of this **RationalNumber** object is **0**; returns **false** otherwise.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.isZero(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.isZero(); ``` @@ -533,14 +686,15 @@ Checks whether this **RationalNumber** object is a Not a Number (NaN). **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if this **RationalNumber** object is a NaN (the denominator and numerator are both **0**); returns **false** otherwise.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.isNaN(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.isNaN(); ``` @@ -553,14 +707,15 @@ Checks whether this **RationalNumber** object represents a finite value. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if this **RationalNumber** object represents a finite value (the denominator is not **0**); returns **false** otherwise.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.isFinite(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.isFinite(); ``` @@ -573,14 +728,15 @@ Obtains the string representation of this **RationalNumber** object. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | string | Returns **NaN** if the numerator and denominator of this object are both **0**; returns a string in Numerator/Denominator format otherwise, for example, **3/5**.| **Example** ```js - var rationalNumber = new util.RationalNumber(1,2); - var result = rationalNumber.toString(); + let rationalNumber = new util.RationalNumber(1,2); + let result = rationalNumber.toString(); ``` ## LruBuffer8+ @@ -595,10 +751,10 @@ Obtains the string representation of this **RationalNumber** object. **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); pro.put(1,8); - var result = pro.length; + let result = pro.length; ``` @@ -611,13 +767,14 @@ A constructor used to create an **LruBuffer** instance. The default capacity of **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | capacity | number | No| Capacity of the **LruBuffer** to create.| **Example** ```js - var lrubuffer= new util.LruBuffer(); + let lrubuffer= new util.LruBuffer(); ``` @@ -630,14 +787,15 @@ Changes the **LruBuffer** capacity. If the new capacity is less than or equal to **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | newCapacity | number | Yes| New capacity of the **LruBuffer**.| **Example** ```js - var pro = new util.LruBuffer(); - var result = pro.updateCapacity(100); + let pro = new util.LruBuffer(); + let result = pro.updateCapacity(100); ``` @@ -650,17 +808,18 @@ Obtains the string representation of this **LruBuffer** object. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | string | String representation of this **LruBuffer** object.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); pro.get(2); pro.remove(20); - var result = pro.toString(); + let result = pro.toString(); ``` @@ -673,14 +832,15 @@ Obtains the capacity of this buffer. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Capacity of this buffer.| **Example** ```js - var pro = new util.LruBuffer(); - var result = pro.getCapacity(); + let pro = new util.LruBuffer(); + let result = pro.getCapacity(); ``` @@ -694,9 +854,9 @@ Clears key-value pairs from this buffer. The **afterRemoval()** method will be c **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.length; + let result = pro.length; pro.clear(); ``` @@ -710,15 +870,16 @@ Obtains the number of return values for **createDefault()**. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Number of return values for **createDefault()**.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(1,8); - var result = pro.getCreateCount(); + let result = pro.getCreateCount(); ``` @@ -731,16 +892,17 @@ Obtains the number of times that the queried values are mismatched. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Number of times that the queried values are mismatched.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); pro.get(2); - var result = pro.getMissCount(); + let result = pro.getMissCount(); ``` @@ -753,17 +915,18 @@ Obtains the number of removals from this buffer. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Number of removals from the buffer.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); pro.updateCapacity(2); pro.put(50,22); - var result = pro.getRemovalCount(); + let result = pro.getRemovalCount(); ``` @@ -776,16 +939,17 @@ Obtains the number of times that the queried values are matched. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Number of times that the queried values are matched.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); pro.get(2); - var result = pro.getMatchCount(); + let result = pro.getMatchCount(); ``` @@ -798,15 +962,16 @@ Obtains the number of additions to this buffer. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | number | Number of additions to the buffer.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.getPutCount(); + let result = pro.getPutCount(); ``` @@ -819,15 +984,16 @@ Checks whether this buffer is empty. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the buffer does not contain any value.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.isEmpty(); + let result = pro.isEmpty(); ``` @@ -840,20 +1006,22 @@ Obtains the value of the specified key. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | K | Yes| Key based on which the value is queried.| **Return value** + | Type| Description| | -------- | -------- | -| V \| undefind | Returns the value of the key if a match is found in the buffer; returns **undefined** otherwise.| +| V \| undefined | Returns the value of the key if a match is found in the buffer; returns **undefined** otherwise.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.get(2); + let result = pro.get(2); ``` @@ -866,23 +1034,24 @@ Adds a key-value pair to this buffer. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | K | Yes| Key of the key-value pair to add.| | value | V | Yes| Value of the key-value pair to add.| **Return value** + | Type| Description| | -------- | -------- | | V | Returns the existing value if the key already exists; returns the value added otherwise. If the key or value is null, an exception will be thrown. | **Example** ```js - var pro = new util.LruBuffer(); - var result = pro.put(2,10); + let pro = new util.LruBuffer(); + let result = pro.put(2,10); ``` - ### values8+ values(): V[] @@ -892,17 +1061,18 @@ Obtains all values in this buffer, listed from the most to the least recently ac **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | V [] | All values in the buffer, listed from the most to the least recently accessed.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); pro.put(2,"anhu"); pro.put("afaf","grfb"); - var result = pro.values(); + let result = pro.values(); ``` @@ -915,15 +1085,16 @@ Obtains all keys in this buffer, listed from the most to the least recently acce **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | K [] | All keys in the buffer, listed from the most to the least recently accessed.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.keys(); + let result = pro.keys(); ``` @@ -936,20 +1107,22 @@ Removes the specified key and its value from this buffer. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | K | Yes| Key to remove.| **Return value** + | Type| Description| | -------- | -------- | -| V \| undefind | Returns an **Optional** object containing the removed key-value pair if the key exists in the buffer; returns an empty **Optional** object otherwise. If the key is null, an exception will be thrown.| +| V \| undefined | Returns an **Optional** object containing the removed key-value pair if the key exists in the buffer; returns an empty **Optional** object otherwise. If the key is null, an exception will be thrown.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.remove(20); + let result = pro.remove(20); ``` @@ -962,6 +1135,7 @@ Performs subsequent operations after a value is removed. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | isEvict | boolean | No| Whether the buffer capacity is insufficient. If the value is **true**, this method is called due to insufficient capacity.| @@ -971,8 +1145,8 @@ Performs subsequent operations after a value is removed. **Example** ```js - var arr = []; - class ChildLruBuffer extends util.LruBuffer + let arr = []; + class ChildLruBuffer extends util.LruBuffer { constructor() { @@ -986,7 +1160,7 @@ Performs subsequent operations after a value is removed. } } } - var lru = new ChildLruBuffer(); + let lru = new ChildLruBuffer(); lru.afterRemoval(false,10,30,null); ``` @@ -1000,20 +1174,22 @@ Checks whether this buffer contains the specified key. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | K | Yes| Key to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the buffer contains the specified key; returns **false** otherwise.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.contains(20); + let result = pro.contains(20); ``` @@ -1026,19 +1202,21 @@ Creates a value if the value of the specified key is not available. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | key | K | Yes| Key of which the value is missing.| **Return value** + | Type| Description| | -------- | -------- | | V | Value of the key.| **Example** ```js - var pro = new util.LruBuffer(); - var result = pro.createDefault(50); + let pro = new util.LruBuffer(); + let result = pro.createDefault(50); ``` @@ -1051,15 +1229,16 @@ Obtains a new iterator object that contains all key-value pairs in this object. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | [K, V] | Iterable array.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro.entries(); + let result = pro.entries(); ``` @@ -1072,15 +1251,16 @@ Obtains a two-dimensional array in key-value pairs. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | [K, V] | Two-dimensional array in key-value pairs.| **Example** ```js - var pro = new util.LruBuffer(); + let pro = new util.LruBuffer(); pro.put(2,10); - var result = pro[Symbol.iterator](); + let result = pro[Symbol.iterator](); ``` @@ -1111,7 +1291,7 @@ class Temperature{ // private readonly _temp: Temperature; this._temp = value; } - comapreTo(value){ + compareTo(value){ return this._temp >= value.getTemp(); } getTemp(){ @@ -1133,6 +1313,7 @@ A constructor used to create a **Scope** object with the specified upper and low **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | lowerObj | [ScopeType](#scopetype8) | Yes| Lower limit of the **Scope** object.| @@ -1140,9 +1321,9 @@ A constructor used to create a **Scope** object with the specified upper and low **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var range = new util.Scope(tempLower, tempUpper); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); ``` @@ -1155,16 +1336,17 @@ Obtains a string representation that contains this **Scope**. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | string | String representation containing the **Scope**.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var range = new util.Scope(tempLower, tempUpper); - var result = range.toString(); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.toString(); ``` @@ -1177,23 +1359,25 @@ Obtains the intersection of this **Scope** and the given **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | range | [Scope](#scope8) | Yes| **Scope** specified.| **Return value** + | Type| Description| | -------- | -------- | | [Scope](#scope8) | Intersection of this **Scope** and the given **Scope**.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var range = new util.Scope(tempLower, tempUpper); - var tempMiDF = new Temperature(35); - var tempMidS = new Temperature(39); - var rangeFir = new util.Scope(tempMiDF, tempMidS); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let rangeFir = new util.Scope(tempMiDF, tempMidS); range.intersect(rangeFir ); ``` @@ -1207,24 +1391,26 @@ Obtains the intersection of this **Scope** and the given lower and upper limits. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | lowerObj | [ScopeType](#scopetype8) | Yes| Lower limit.| | upperObj | [ScopeType](#scopetype8) | Yes| Upper limit.| **Return value** + | Type| Description| | -------- | -------- | | [Scope](#scope8) | Intersection of this **Scope** and the given lower and upper limits.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var tempMiDF = new Temperature(35); - var tempMidS = new Temperature(39); - var range = new util.Scope(tempLower, tempUpper); - var result = range.intersect(tempMiDF, tempMidS); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let result = range.intersect(tempMiDF, tempMidS); ``` @@ -1244,10 +1430,10 @@ Obtains the upper limit of this **Scope**. **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var range = new util.Scope(tempLower, tempUpper); - var result = range.getUpper(); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.getUpper(); ``` @@ -1260,16 +1446,17 @@ Obtains the lower limit of this **Scope**. **System capability**: SystemCapability.Utils.Lang **Return value** + | Type| Description| | -------- | -------- | | [ScopeType](#scopetype8) | Lower limit of this **Scope**.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var range = new util.Scope(tempLower, tempUpper); - var result = range.getLower(); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let result = range.getLower(); ``` @@ -1282,12 +1469,14 @@ Obtains the union set of this **Scope** and the given lower and upper limits. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | lowerObj | [ScopeType](#scopetype8) | Yes| Lower limit.| | upperObj | [ScopeType](#scopetype8) | Yes| Upper limit.| **Return value** + | Type| Description| | -------- | -------- | | [Scope](#scope8) | Union set of this **Scope** and the given lower and upper limits.| @@ -1295,12 +1484,12 @@ Obtains the union set of this **Scope** and the given lower and upper limits. **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var tempMiDF = new Temperature(35); - var tempMidS = new Temperature(39); - var range = new util.Scope(tempLower, tempUpper); - var result = range.expand(tempMiDF, tempMidS); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let result = range.expand(tempMiDF, tempMidS); ``` @@ -1313,24 +1502,26 @@ Obtains the union set of this **Scope** and the given **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | range | [Scope](#scope8) | Yes| **Scope** specified.| **Return value** + | Type| Description| | -------- | -------- | | [Scope](#scope8) | Union set of this **Scope** and the given **Scope**.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var tempMiDF = new Temperature(35); - var tempMidS = new Temperature(39); - var range = new util.Scope(tempLower, tempUpper); - var rangeFir = new util.Scope(tempMiDF, tempMidS); - var result = range.expand(rangeFir); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let tempMidS = new Temperature(39); + let range = new util.Scope(tempLower, tempUpper); + let rangeFir = new util.Scope(tempMiDF, tempMidS); + let result = range.expand(rangeFir); ``` @@ -1343,22 +1534,24 @@ Obtains the union set of this **Scope** and the given value. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | [ScopeType](#scopetype8) | Yes| Value specified.| **Return value** + | Type| Description| | -------- | -------- | | [Scope](#scope8) | Union set of this **Scope** and the given value.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var tempMiDF = new Temperature(35); - var range = new util.Scope(tempLower, tempUpper); - var result = range.expand(tempMiDF); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + let result = range.expand(tempMiDF); ``` @@ -1371,21 +1564,23 @@ Checks whether a value is within this **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | [ScopeType](#scopetype8) | Yes| Value specified.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the value is within this **Scope**; returns **false** otherwise.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var tempMiDF = new Temperature(35); - var range = new util.Scope(tempLower, tempUpper); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); range.contains(tempMiDF); ``` @@ -1399,24 +1594,26 @@ Checks whether a range is within this **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | range | [Scope](#scope8) | Yes| **Scope** specified.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the range is within this **Scope**; returns **false** otherwise.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var range = new util.Scope(tempLower, tempUpper); - var tempLess = new Temperature(20); - var tempMore = new Temperature(45); - var rangeSec = new util.Scope(tempLess, tempMore); - var result = range.contains(rangeSec); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let range = new util.Scope(tempLower, tempUpper); + let tempLess = new Temperature(20); + let tempMore = new Temperature(45); + let rangeSec = new util.Scope(tempLess, tempMore); + let result = range.contains(rangeSec); ``` @@ -1429,22 +1626,24 @@ Limits a value to this **Scope**. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | [ScopeType](#scopetype8) | Yes| Value specified.| **Return value** + | Type| Description| | -------- | -------- | | [ScopeType](#scopetype8) | Returns **lowerObj** if the specified value is less than the lower limit; returns **upperObj** if the specified value is greater than the upper limit; returns the specified value if it is within this **Scope**.| **Example** ```js - var tempLower = new Temperature(30); - var tempUpper = new Temperature(40); - var tempMiDF = new Temperature(35); - var range = new util.Scope(tempLower, tempUpper); - var result = range.clamp(tempMiDF); + let tempLower = new Temperature(30); + let tempUpper = new Temperature(40); + let tempMiDF = new Temperature(35); + let range = new util.Scope(tempLower, tempUpper); + let result = range.clamp(tempMiDF); ``` @@ -1461,7 +1660,7 @@ A constructor used to create a **Base64** object. **Example** ```js - var base64 = new util.Base64(); + let base64 = new util.Base64(); ``` @@ -1474,20 +1673,22 @@ Encodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | src | Uint8Array | Yes| Uint8Array to encode.| **Return value** + | Type| Description| | -------- | -------- | | Uint8Array | Uint8Array encoded.| **Example** ```js - var that = new util.Base64(); - var array = new Uint8Array([115,49,51]); - var result = that.encodeSync(array); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let result = that.encodeSync(array); ``` @@ -1500,20 +1701,22 @@ Encodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | src | Uint8Array | Yes| Uint8Array to encode.| **Return value** + | Type| Description| | -------- | -------- | | string | String encoded from the Uint8Array.| **Example** ```js - var that = new util.Base64(); - var array = new Uint8Array([115,49,51]); - var result = that.encodeToStringSync(array); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let result = that.encodeToStringSync(array); ``` @@ -1526,20 +1729,22 @@ Decodes the input content. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | src | Uint8Array \| string | Yes| Uint8Array or string to decode.| **Return value** + | Type| Description| | -------- | -------- | | Uint8Array | Uint8Array decoded.| **Example** ```js - var that = new util.Base64(); - var buff = 'czEz'; - var result = that.decodeSync(buff); + let that = new util.Base64(); + let buff = 'czEz'; + let result = that.decodeSync(buff); ``` @@ -1552,20 +1757,22 @@ Encodes the input content asynchronously. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | src | Uint8Array | Yes| Uint8Array to encode asynchronously.| **Return value** + | Type| Description| | -------- | -------- | | Promise<Uint8Array> | Uint8Array obtained after asynchronous encoding.| **Example** ```js - var that = new util.Base64(); - var array = new Uint8Array([115,49,51]); - var rarray = new Uint8Array([99,122,69,122]); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); + let rarray = new Uint8Array([99,122,69,122]); that.encode(array).then(val=>{ for (var i = 0; i < rarray.length; i++) { console.log(val[i].toString()) @@ -1583,19 +1790,21 @@ Encodes the input content asynchronously. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | src | Uint8Array | Yes| Uint8Array to encode asynchronously.| **Return value** + | Type| Description| | -------- | -------- | | Promise<string> | String obtained after asynchronous encoding.| **Example** ```js - var that = new util.Base64(); - var array = new Uint8Array([115,49,51]); + let that = new util.Base64(); + let array = new Uint8Array([115,49,51]); that.encodeToString(array).then(val=>{ console.log(val) }) @@ -1611,20 +1820,22 @@ Decodes the input content asynchronously. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | src | Uint8Array \| string | Yes| Uint8Array or string to decode asynchronously.| **Return value** + | Type| Description| | -------- | -------- | | Promise<Uint8Array> | Uint8Array obtained after asynchronous decoding.| **Example** ```js - var that = new util.Base64(); - var array = new Uint8Array([99,122,69,122]); - var rarray = new Uint8Array([115,49,51]); + let that = new util.Base64(); + let array = new Uint8Array([99,122,69,122]); + let rarray = new Uint8Array([115,49,51]); that.decode(array).then(val=>{ for (var i = 0; i < rarray.length; i++) { console.log(val[i].toString()) @@ -1646,7 +1857,7 @@ A constructor used to create a **Types** object. **Example** ```js - var type = new util.types(); + let type = new util.types(); ``` @@ -1659,19 +1870,21 @@ Checks whether the input value is of the **ArrayBuffer** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **ArrayBuffer** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isAnyArrayBuffer(new ArrayBuffer(0)); + let that = new util.types(); + let result = that.isAnyArrayBuffer(new ArrayBuffer(0)); ``` @@ -1686,19 +1899,21 @@ Checks whether the input value is of the **ArrayBufferView** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **ArrayBufferView** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isArrayBufferView(new Int8Array([])); + let that = new util.types(); + let result = that.isArrayBufferView(new Int8Array([])); ``` @@ -1711,22 +1926,24 @@ Checks whether the input value is of the **arguments** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **arguments** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); function foo() { var result = that.isArgumentsObject(arguments); } - var f = foo(); + let f = foo(); ``` @@ -1739,19 +1956,21 @@ Checks whether the input value is of the **ArrayBuffer** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **ArrayBuffer** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isArrayBuffer(new ArrayBuffer(0)); + let that = new util.types(); + let result = that.isArrayBuffer(new ArrayBuffer(0)); ``` @@ -1764,19 +1983,21 @@ Checks whether the input value is an asynchronous function. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is an asynchronous function; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isAsyncFunction(async function foo() {}); + let that = new util.types(); + let result = that.isAsyncFunction(async function foo() {}); ``` @@ -1789,19 +2010,21 @@ Checks whether the input value is of the **Boolean** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Boolean** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isBooleanObject(new Boolean(true)); + let that = new util.types(); + let result = that.isBooleanObject(new Boolean(true)); ``` @@ -1814,19 +2037,21 @@ Checks whether the input value is of the **Boolean**, **Number**, **String**, or **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Boolean**, **Number**, **String**, or **Symbol** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isBoxedPrimitive(new Boolean(false)); + let that = new util.types(); + let result = that.isBoxedPrimitive(new Boolean(false)); ``` @@ -1839,20 +2064,22 @@ Checks whether the input value is of the **DataView** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **DataView** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); const ab = new ArrayBuffer(20); - var result = that.isDataView(new DataView(ab)); + let result = that.isDataView(new DataView(ab)); ``` @@ -1865,19 +2092,21 @@ Checks whether the input value is of the **Date** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Date** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isDate(new Date()); + let that = new util.types(); + let result = that.isDate(new Date()); ``` @@ -1890,19 +2119,21 @@ Checks whether the input value is of the **native external** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **native external** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isExternal(true); + let that = new util.types(); + let result = that.isExternal(true); ``` @@ -1915,19 +2146,21 @@ Checks whether the input value is of the **Float32Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Float32Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isFloat32Array(new Float32Array()); + let that = new util.types(); + let result = that.isFloat32Array(new Float32Array()); ``` @@ -1940,19 +2173,21 @@ Checks whether the input value is of the **Float64Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Float64Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isFloat64Array(new Float64Array()); + let that = new util.types(); + let result = that.isFloat64Array(new Float64Array()); ``` @@ -1965,19 +2200,21 @@ Checks whether the input value is a generator function. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a generator function; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isGeneratorFunction(function* foo() {}); + let that = new util.types(); + let result = that.isGeneratorFunction(function* foo() {}); ``` @@ -1990,21 +2227,23 @@ Checks whether the input value is a generator object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a generator object; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); function* foo() {} const generator = foo(); - var result = that.isGeneratorObject(generator); + let result = that.isGeneratorObject(generator); ``` @@ -2017,19 +2256,21 @@ Checks whether the input value is of the **Int8Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Int8Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isInt8Array(new Int8Array([])); + let that = new util.types(); + let result = that.isInt8Array(new Int8Array([])); ``` @@ -2042,19 +2283,21 @@ Checks whether the input value is of the **Int16Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Int16Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isInt16Array(new Int16Array([])); + let that = new util.types(); + let result = that.isInt16Array(new Int16Array([])); ``` @@ -2067,19 +2310,21 @@ Checks whether the input value is of the **Int32Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Int32Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isInt32Array(new Int32Array([])); + let that = new util.types(); + let result = that.isInt32Array(new Int32Array([])); ``` @@ -2092,19 +2337,21 @@ Checks whether the input value is of the **Map** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Map** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isMap(new Map()); + let that = new util.types(); + let result = that.isMap(new Map()); ``` @@ -2117,20 +2364,22 @@ Checks whether the input value is of the **MapIterator** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **MapIterator** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); const map = new Map(); - var result = that.isMapIterator(map.keys()); + let result = that.isMapIterator(map.keys()); ``` @@ -2143,19 +2392,21 @@ Checks whether the input value is of the **Error** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Error** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isNativeError(new TypeError()); + let that = new util.types(); + let result = that.isNativeError(new TypeError()); ``` @@ -2168,19 +2419,21 @@ Checks whether the input value is a number object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a number object; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isNumberObject(new Number(0)); + let that = new util.types(); + let result = that.isNumberObject(new Number(0)); ``` @@ -2193,19 +2446,21 @@ Checks whether the input value is a promise. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a promise; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isPromise(Promise.resolve(1)); + let that = new util.types(); + let result = that.isPromise(Promise.resolve(1)); ``` @@ -2218,21 +2473,23 @@ Checks whether the input value is a proxy. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a proxy; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); const target = {}; const proxy = new Proxy(target, {}); - var result = that.isProxy(proxy); + let result = that.isProxy(proxy); ``` @@ -2245,19 +2502,21 @@ Checks whether the input value is of the **RegExp** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **RegExp** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isRegExp(new RegExp('abc')); + let that = new util.types(); + let result = that.isRegExp(new RegExp('abc')); ``` @@ -2270,19 +2529,21 @@ Checks whether the input value is of the **Set** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Set** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isSet(new Set()); + let that = new util.types(); + let result = that.isSet(new Set()); ``` @@ -2295,20 +2556,22 @@ Checks whether the input value is of the **SetIterator** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **SetIterator** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); const set = new Set(); - var result = that.isSetIterator(set.keys()); + let result = that.isSetIterator(set.keys()); ``` @@ -2321,19 +2584,21 @@ Checks whether the input value is a string object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a string object; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isStringObject(new String('foo')); + let that = new util.types(); + let result = that.isStringObject(new String('foo')); ``` @@ -2346,20 +2611,22 @@ Checks whether the input value is a symbol object. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is a symbol object; returns **false** otherwise.| **Example** ```js - var that = new util.types(); + let that = new util.types(); const symbols = Symbol('foo'); - var result = that.isSymbolObject(Object(symbols)); + let result = that.isSymbolObject(Object(symbols)); ``` @@ -2374,19 +2641,21 @@ Checks whether the input value is of the **TypedArray** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **TypedArray** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isTypedArray(new Float64Array([])); + let that = new util.types(); + let result = that.isTypedArray(new Float64Array([])); ``` @@ -2399,19 +2668,21 @@ Checks whether the input value is of the **Uint8Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Uint8Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isUint8Array(new Uint8Array([])); + let that = new util.types(); + let result = that.isUint8Array(new Uint8Array([])); ``` @@ -2424,19 +2695,21 @@ Checks whether the input value is of the **Uint8ClampedArray** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Uint8ClampedArray** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isUint8ClampedArray(new Uint8ClampedArray([])); + let that = new util.types(); + let result = that.isUint8ClampedArray(new Uint8ClampedArray([])); ``` @@ -2449,19 +2722,21 @@ Checks whether the input value is of the **Uint16Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Uint16Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isUint16Array(new Uint16Array([])); + let that = new util.types(); + let result = that.isUint16Array(new Uint16Array([])); ``` @@ -2474,19 +2749,21 @@ Checks whether the input value is of the **Uint32Array** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **Uint32Array** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isUint32Array(new Uint32Array([])); + let that = new util.types(); + let result = that.isUint32Array(new Uint32Array([])); ``` @@ -2499,19 +2776,21 @@ Checks whether the input value is of the **WeakMap** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **WeakMap** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isWeakMap(new WeakMap()); + let that = new util.types(); + let result = that.isWeakMap(new WeakMap()); ``` @@ -2524,17 +2803,128 @@ Checks whether the input value is of the **WeakSet** type. **System capability**: SystemCapability.Utils.Lang **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | value | Object | Yes| Object to check.| **Return value** + | Type| Description| | -------- | -------- | | boolean | Returns **true** if the input value is of the **WeakSet** type; returns **false** otherwise.| **Example** ```js - var that = new util.types(); - var result = that.isWeakSet(new WeakSet()); + let that = new util.types(); + let result = that.isWeakSet(new WeakSet()); + ``` + + +### isBigInt64Array8+ + +isBigInt64Array(value: Object): boolean + +Checks whether the input value is of the **BigInt64Array** type. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | Object | Yes| Object to check.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the input value is of the **BigInt64Array** type; returns **false** otherwise.| + +**Example** + ```js + let that = new util.types(); + let result = that.isBigInt64Array(new BigInt64Array([])); + ``` + + +### isBigUint64Array8+ + +isBigUint64Array(value: Object): boolean + +Checks whether the input value is of the **BigUint64Array** type. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | Object | Yes| Object to check.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the input value is of the **BigUint64Array** type; returns **false** otherwise.| + +**Example** + ```js + let that = new util.types(); + let result = that.isBigUint64Array(new BigUint64Array([])); + ``` + + +### isModuleNamespaceObject8+ + +isModuleNamespaceObject(value: Object): boolean + +Checks whether the input value is a module namespace object. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | Object | Yes| Object to check.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the input value is a module namespace object; returns **false** otherwise.| + +**Example** + ```js + import url from '@ohos.url' + let that = new util.types(); + let result = that.isModuleNamespaceObject(url); + ``` + + +### isSharedArrayBuffer8+ + +isSharedArrayBuffer(value: Object): boolean + +Checks whether the input value is of the **SharedArrayBuffer** type. + +**System capability**: SystemCapability.Utils.Lang + +**Parameters** + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| value | Object | Yes| Object to check.| + +**Return value** + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the input value is of the **SharedArrayBuffer** type; returns **false** otherwise.| + +**Example** + ```js + let that = new util.types(); + let result = that.isSharedArrayBuffer(new SharedArrayBuffer(0)); ``` diff --git a/en/application-dev/reference/apis/js-apis-vector.md b/en/application-dev/reference/apis/js-apis-vector.md index 5dd8e49bb0c2467b2885784b9c1281f61e46a003..24fc9e14ffe48ebbfd672aa73218c2110757c3d8 100644 --- a/en/application-dev/reference/apis/js-apis-vector.md +++ b/en/application-dev/reference/apis/js-apis-vector.md @@ -10,6 +10,9 @@ Both **Vector** and **[ArrayList](js-apis-arraylist.md)** are implemented based **Recommended use case**: Use **Vector** when the data volume is large. +This topic uses the following to identify the use of generics: +- T: Type + ## Modules to Import ```ts @@ -71,7 +74,7 @@ let result = vector.add("a"); let result1 = vector.add(1); let b = [1, 2, 3]; vector.add(b); -let c = {name : "lala", age : "13"}; +let c = {name : "Dylon", age : "13"}; let result3 = vector.add(c); ``` @@ -123,9 +126,9 @@ Checks whether this container has the specified element. ```ts let vector = new Vector(); -let result = vector.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -vector.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); -let result1 = vector.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf"); +let result = vector.has("squirrel"); +vector.add("squirrel"); +let result1 = vector.has("squirrel"); ``` ### getIndexOf @@ -862,7 +865,6 @@ Obtains an iterator. Each item of the iterator is a JavaScript object. **System capability**: SystemCapability.Utils.Lang **Return value** - | Type| Description| | -------- | -------- | | IterableIterator<T> | Iterator obtained.| diff --git a/en/application-dev/reference/apis/js-apis-vibrator.md b/en/application-dev/reference/apis/js-apis-vibrator.md index b27059e688201d7621fe90006df89e1720eb5823..8d0c0ad48f1dc919c5032dc1d37ad39026071583 100644 --- a/en/application-dev/reference/apis/js-apis-vibrator.md +++ b/en/application-dev/reference/apis/js-apis-vibrator.md @@ -2,8 +2,6 @@ The **Vibrator** module provides APIs for triggering or stopping vibration. -Misc devices, including vibrators and LED lights, are used to send signals externally. You can call the APIs of this module to control the vibration of vibrators and turning-on/off of LED lights. - > **NOTE** > > The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version. @@ -19,25 +17,26 @@ import vibrator from '@ohos.vibrator'; vibrate(duration: number): Promise<void> -Triggers vibration with a specific duration. This API uses a promise to return the execution result. +Triggers vibration with the specified duration. This API uses a promise to return the result. -**Required permissions**: ohos.permission.VIBRATE (a system permission) +**Required permissions**: ohos.permission.VIBRATE **System capability**: SystemCapability.Sensors.MiscDevice - **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------ | ---- | ------------ | -| duration | number | Yes | Vibration duration.| + +| Name | Type | Mandatory| Description | +| -------- | ------ | ---- | ---------------------- | +| duration | number | Yes | Vibration duration, in ms.| **Return value** -| Type | Description | -| ------------------- | ----------- | -| Promise<void> | Promise used to indicate whether the vibration is triggered successfully.| +| Type | Description | +| ------------------- | -------------------------------------- | +| Promise<void> | Promise that returns no value.| **Example** + ```js vibrator.vibrate(1000).then(()=>{ console.log("Promise returned to indicate a successful vibration."); @@ -46,28 +45,67 @@ Triggers vibration with a specific duration. This API uses a promise to return t }); ``` +## vibrator.vibrate9+ + +vibrate(effect: VibrateEffect, attribute: VibrateAttribute): Promise<void> + +Triggers vibration with the specified effect and attribute. This API uses a promise to return the result. + +**Required permissions**: ohos.permission.VIBRATE + +**System capability**: SystemCapability.Sensors.MiscDevice + +**Parameters** + +| Name | Type | Mandatory| Description | +| --------- | -------------------------------------- | ---- | :------------- | +| effect | [VibrateEffect](#vibrateeffect9) | Yes | Vibration effect.| +| attribute | [VibrateAttribute](#vibrateattribute9) | Yes | Vibration attribute.| + +**Return value** + +| Type | Description | +| ------------------- | -------------------------------------- | +| Promise<void> | Promise that returns no value.| + +**Example** + +```js +vibrator.vibrate({ + type: 'time', + duration: 1000 +}, { + id: 0, + usage: 'alarm' +}).then(()=>{ + console.log("Promise returned to indicate a successful vibration"); +}).catch((error)=>{ + console.log("error.code" + error.code + "error.message" + error.message); +}) +``` ## vibrator.vibrate vibrate(duration: number, callback?: AsyncCallback<void>): void -Triggers vibration with a specific duration. This API uses an asynchronous callback to return the execution result. +Triggers vibration with the specified duration. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.VIBRATE (a system permission) +**Required permissions**: ohos.permission.VIBRATE **System capability**: SystemCapability.Sensors.MiscDevice **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | ---- | ----------------------- | -| duration | number | Yes | Vibration duration. | -| callback | AsyncCallback<void> | No | Callback used to indicate whether the vibration is triggered successfully.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ---------------------------------------------------------- | +| duration | number | Yes | Vibration duration, in ms. | +| callback | AsyncCallback<void> | No | Callback used to the result. If the vibration starts, **err** is **undefined**. Otherwise, **err** is an error object.| **Example** + ```js vibrator.vibrate(1000,function(error){ if(error){ - console.log("error.code"+error.code+"error.message"+error.message); + console.log("error.code" + error.code + "error.message" + error.message); }else{ console.log("Callback returned to indicate a successful vibration."); } @@ -79,28 +117,28 @@ Triggers vibration with a specific duration. This API uses an asynchronous callb vibrate(effectId: EffectId): Promise<void> -Triggers vibration with a specific effect. This API uses a promise to return the execution result. +Triggers vibration with the specified effect. This API uses a promise to return the result. -**Required permissions**: ohos.permission.VIBRATE (a system permission) +**Required permissions**: ohos.permission.VIBRATE **System capability**: SystemCapability.Sensors.MiscDevice **Parameters** -| Name | Type | Mandatory | Description | -| -------- | --------------------- | ---- | ------------- | -| effectId | [EffectId](#effectid) | Yes | Vibration effect. | +| Name | Type | Mandatory| Description | +| -------- | --------------------- | ---- | ------------------ | +| effectId | [EffectId](#effectid) | Yes | Preset vibration effect ID.| **Return value** -| Type | Description | -| ------------------- | ----------- | -| Promise<void> | Promise used to indicate whether the vibration is triggered successfully.| +| Type | Description | +| ------------------- | -------------------------------------- | +| Promise<void> | Promise that returns no value.| **Example** ```js vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER).then(()=>{ console.log("Promise returned to indicate a successful vibration."); }, (error)=>{ - console.log("error.code"+error.code+"error.message"+error.message); + console.log("error.code" + error.code + "error.message" + error.message); }); ``` @@ -109,56 +147,94 @@ Triggers vibration with a specific effect. This API uses a promise to return the vibrate(effectId: EffectId, callback?: AsyncCallback<void>): void -Triggers vibration with a specific effect. This API uses an asynchronous callback to return the execution result. +Triggers vibration with the specified effect. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.VIBRATE (a system permission) +**Required permissions**: ohos.permission.VIBRATE **System capability**: SystemCapability.Sensors.MiscDevice **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------- | ---- | ----------------------- | -| effectId | [EffectId](#effectid) | Yes | Vibration effect. | -| callback | AsyncCallback<void> | No | Callback used to indicate whether the vibration is triggered successfully.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------- | ---- | ---------------------------------------------------------- | +| effectId | [EffectId](#effectid) | Yes | Preset vibration effect ID. | +| callback | AsyncCallback<void> | No | Callback used to the result. If the vibration starts, **err** is **undefined**. Otherwise, **err** is an error object.| **Example** + ```js vibrator.vibrate(vibrator.EffectId.EFFECT_CLOCK_TIMER, function(error){ if(error){ - console.log("error.code"+error.code+"error.message"+error.message); + console.log("error.code" + error.code + "error.message" + error.message); }else{ console.log("Callback returned to indicate a successful vibration."); } }) ``` +## vibrator.vibrate9+ + +vibrate(effect: VibrateEffect, attribute: VibrateAttribute, callback: AsyncCallback<void>): void + +Triggers vibration with the specified effect and attribute. This API uses an asynchronous callback to return the result. + +**Required permissions**: ohos.permission.VIBRATE + +**System capability**: SystemCapability.Sensors.MiscDevice + +**Parameters** + +| Name | Type | Mandatory| Description | +| --------- | -------------------------------------- | ---- | :--------------------------------------------------------- | +| effect | [VibrateEffect](#vibrateeffect9) | Yes | Vibration effect. | +| attribute | [VibrateAttribute](#vibrateattribute9) | Yes | Vibration attribute. | +| callback | AsyncCallback<void> | Yes | Callback used to the result. If the vibration starts, **err** is **undefined**. Otherwise, **err** is an error object.| + +**Example** + +```js +vibrator.vibrate({ + type:'time', + duration:1000, +},{ + id:0, + usage: 'alarm' +}, (error)=>{ + if(error){ + console.log("vibrate fail, error.code:" + error.code + ",error.message:" + error.message); + }else{ + console.log("Callback returned to indicate a successful vibration."); + } +}); +``` ## vibrator.stop stop(stopMode: VibratorStopMode): Promise<void> -Stops the vibration based on the specified **stopMode**. This API uses a promise to return the execution result. If the specified **stopMode** is different from the mode used to trigger the vibration, this API fails to be called. +Stops the vibration with the specified **stopMode**. This API uses a promise to return the result. If the specified **stopMode** is different from the mode used to trigger the vibration, this API fails to be called. -**Required permissions**: ohos.permission.VIBRATE (a system permission) +**Required permissions**: ohos.permission.VIBRATE **System capability**: SystemCapability.Sensors.MiscDevice **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------------------- | ---- | --------------- | -| stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Vibration mode to stop.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------- | ---- | ------------------------ | +| stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Mode to stop the vibration.| **Return value** -| Type | Description | -| ------------------- | ----------- | -| Promise<void> | Promise used to indicate whether the vibration is stopped successfully.| + +| Type | Description | +| ------------------- | -------------------------------------- | +| Promise<void> | Promise that returns no value.| **Example** + ```js vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then(()=>{ console.log("Promise returned to indicate a successful vibration."); }, (error)=>{ - console.log("error.code"+error.code+"error.message"+error.message); + console.log("error.code" + error.code + "error.message" + error.message); }); ``` @@ -167,23 +243,24 @@ Stops the vibration based on the specified **stopMode**. This API uses a promise stop(stopMode: VibratorStopMode, callback?: AsyncCallback<void>): void; -Stops the vibration based on the specified **stopMode**. This API uses an asynchronous callback to return the execution result. If the specified **stopMode** is different from the mode used to trigger the vibration, this API fails to be called. +Stops the vibration with the specified **stopMode**. This API uses an asynchronous callback to return the result. If the specified **stopMode** is different from the mode used to trigger the vibration, this API fails to be called. -**Required permissions**: ohos.permission.VIBRATE (a system permission) +**Required permissions**: ohos.permission.VIBRATE **System capability**: SystemCapability.Sensors.MiscDevice **Parameters** -| Name | Type | Mandatory | Description | -| -------- | ------------------------------------- | ---- | ----------------------- | -| stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Vibration mode to stop. | -| callback | AsyncCallback<void> | No | Callback used to indicate whether the vibration is stopped successfully.| +| Name | Type | Mandatory| Description | +| -------- | ------------------------------------- | ---- | ------------------------------------------------------------ | +| stopMode | [VibratorStopMode](#vibratorstopmode) | Yes | Mode to stop the vibration. | +| callback | AsyncCallback<void> | No | Callback used to the result. If the vibration stops, **err** is **undefined**. Otherwise, **err** is an error object.| **Example** + ```js vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET, function(error){ if(error){ - console.log("error.code"+error.code+"error.message"+error.message); + console.log("error.code" + error.code + "error.message" + error.message); }else{ console.log("Callback returned to indicate a successful stop."); } @@ -193,22 +270,85 @@ Stops the vibration based on the specified **stopMode**. This API uses an asynch ## EffectId -Describes the vibration effect. +Describes the vibration effect ID. **System capability**: SystemCapability.Sensors.MiscDevice -| Name | Default Value | Description | -| ------------------ | -------------------- | --------------- | -| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | Vibration effect of the vibrator when a user adjusts the timer.| +| Name | Default Value | Description | +| ------------------ | -------------------- | ------------------ | +| EFFECT_CLOCK_TIMER | "haptic.clock.timer" | Preset vibration effect ID.| ## VibratorStopMode -Describes the vibration mode to stop. +Enumerates the modes available to stop the vibration. **System capability**: SystemCapability.Sensors.MiscDevice -| Name | Default Value | Description | -| ------------------------- | -------- | ---------------------------------------- | +| Name | Default Value | Description | +| ------------------------- | -------- | ------------------------------------------------------------ | | VIBRATOR_STOP_MODE_TIME | "time" | The vibration to stop is in **duration** mode. This vibration is triggered with the parameter **duration** of the **number** type.| | VIBRATOR_STOP_MODE_PRESET | "preset" | The vibration to stop is in **EffectId** mode. This vibration is triggered with the parameter **effectId** of the **EffectId** type.| + +## VibrateEffect9+ + +Describes the vibration effect. + +**System capability**: SystemCapability.Sensors.MiscDevice + +| Type | Description | +| -------------------------------- | ------------------------------ | +| [VibrateTime](#vibratetime9) | Triggers vibration with the specified duration. This API uses a promise to return the result.| +| [VibratePreset](#vibratepreset9) | Vibration with a preset effect.| + +## VibrateTime9+ + +Describes the vibration with the specified duration. + +**System capability**: SystemCapability.Sensors.MiscDevice + +| Name | Default Value| Description | +| -------- | ------ | ------------------------------ | +| type | "time" | Vibration with the specified duration.| +| duration | - | Vibration duration, in ms. | + +## VibratePreset9+ + +Describes the vibration with a preset effect. + +**System capability**: SystemCapability.Sensors.MiscDevice + +| Name | Default Value | Description | +| -------- | -------- | ------------------------------ | +| type | "preset" | Vibration with the specified effect.| +| effectId | - | Preset vibration effect ID. | +| count | - | Number of vibrations to repeat. | + +## VibrateAttribute9+ + +Describes the vibration attribute. + +**System capability**: SystemCapability.Sensors.MiscDevice + +| Name | Default Value| Description | +| ----- | ------ | -------------- | +| id | 0 | Vibrator ID. | +| usage | - | Vibration scenario.| + +## Usage9+ + +Enumerates the vibration scenarios. + +**System capability**: SystemCapability.Sensors.MiscDevice + +| Name | Type | Description | +| ---------------- | ------ | ------------------------------ | +| unknown | string | Unknown scenario, with the lowest priority.| +| alarm | string | Vibration for alarms. | +| ring | string | Vibration for incoming calls. | +| notification | string | Vibration for notifications. | +| communication | string | Vibration for communication. | +| touch | string | Touch vibration scenario. | +| media | string | Multimedia vibration scenario. | +| physicalFeedback | string | Physical feedback vibration scenario. | +| simulateReality | string | Simulated reality vibration scenario. | diff --git a/en/application-dev/reference/apis/js-apis-wallpaper.md b/en/application-dev/reference/apis/js-apis-wallpaper.md index 2eae3ec8e5599a6e2b0123f4f6fa7368e51365e7..8c6ca80a6161e29fd1eb4ccd5e3a4f9f7841556b 100644 --- a/en/application-dev/reference/apis/js-apis-wallpaper.md +++ b/en/application-dev/reference/apis/js-apis-wallpaper.md @@ -21,10 +21,10 @@ Defines the wallpaper type. **System capability**: SystemCapability.MiscServices.Wallpaper -| Name | Description | +| Name| Description| | -------- | -------- | -| WALLPAPER_LOCKSCREEN | Lock screen wallpaper. | -| WALLPAPER_SYSTEM | Home screen wallpaper. | +| WALLPAPER_LOCKSCREEN | Lock screen wallpaper.| +| WALLPAPER_SYSTEM | Home screen wallpaper.| ## wallpaper.getColors @@ -36,10 +36,11 @@ Obtains the main color information of the wallpaper of the specified type. This **System capability**: SystemCapability.MiscServices.Wallpaper **Parameters** -| Name | Type | Mandatory | Description | + +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | -| callback | AsyncCallback<Array<[RgbaColor](#rgbacolor)>> | Yes | Callback used to return the main color information of the wallpaper. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| +| callback | AsyncCallback<Array<[RgbaColor](#rgbacolor)>> | Yes| Callback used to return the main color information of the wallpaper.| **Example** @@ -64,15 +65,15 @@ Obtains the main color information of the wallpaper of the specified type. This **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<Array<[RgbaColor](#rgbacolor)>> | Promise used to return the main color information of the wallpaper. | +| Promise<Array<[RgbaColor](#rgbacolor)>> | Promise used to return the main color information of the wallpaper.| **Example** @@ -95,10 +96,10 @@ Obtains the ID of the wallpaper of the specified type. This API uses an asynchro **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | -| callback | AsyncCallback<number> | Yes | Callback used to return the wallpaper ID. If the wallpaper of the specified type is configured, a number greater than or equal to **0** is returned. Otherwise, **-1** is returned. The value ranges from -1 to 2^31-1. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| +| callback | AsyncCallback<number> | Yes| Callback used to return the wallpaper ID. If the wallpaper of the specified type is configured, a number greater than or equal to **0** is returned. Otherwise, **-1** is returned. The value ranges from -1 to 2^31-1.| **Example** @@ -124,15 +125,15 @@ Obtains the ID of the wallpaper of the specified type. This API uses a promise t **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<number> | Promise used to return the wallpaper ID. If this type of wallpaper is configured, a number greater than or equal to **0** is returned. Otherwise, **-1** is returned. The value ranges from -1 to 2^31-1. | +| Promise<number> | Promise used to return the wallpaper ID. If this type of wallpaper is configured, a number greater than or equal to **0** is returned. Otherwise, **-1** is returned. The value ranges from -1 to 2^31-1.| **Example** @@ -155,9 +156,9 @@ Obtains the minimum height of this wallpaper. This API uses an asynchronous call **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<number> | Yes | Callback used to return the minimum wallpaper height, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default height should be used instead. | +| callback | AsyncCallback<number> | Yes| Callback used to return the minimum wallpaper height, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default height should be used instead.| **Example** @@ -183,9 +184,9 @@ Obtains the minimum height of this wallpaper. This API uses a promise to return **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<number> | Promise used to return the minimum wallpaper height, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default height should be used instead. | +| Promise<number> | Promise used to return the minimum wallpaper height, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default height should be used instead.| **Example** @@ -206,11 +207,12 @@ Obtains the minimum width of this wallpaper. This API uses an asynchronous callb **System capability**: SystemCapability.MiscServices.Wallpaper + **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<number> | Yes | Callback used to return the minimum wallpaper width, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default width should be used instead. | +| callback | AsyncCallback<number> | Yes| Callback used to return the minimum wallpaper width, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default width should be used instead.| **Example** @@ -235,9 +237,9 @@ Obtains the minimum width of this wallpaper. This API uses a promise to return t **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<number> | Promised used to return the minimum wallpaper width, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default width should be used instead. | +| Promise<number> | Promised used to return the minimum wallpaper width, in pixels. If the return value is **0**, no wallpaper is set. In this case, the default width should be used instead.| **Example** @@ -260,9 +262,9 @@ Checks whether to allow the application to change the wallpaper for the current **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | Yes | Returns **true** if the application is allowed to change the wallpaper for the current user; returns **false** otherwise. | +| callback | AsyncCallback<boolean> | Yes| Callback used to return the result. Returns **true** if the application is allowed to change the wallpaper for the current user; returns **false** otherwise.| **Example** @@ -287,9 +289,9 @@ Checks whether to allow the application to change the wallpaper for the current **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<boolean> | Returns **true** if the application is allowed to change the wallpaper for the current user; returns **false** otherwise. | +| Promise<boolean> | Promise used to return the result. Returns **true** if the application is allowed to change the wallpaper for the current user; returns **false** otherwise.| **Example** @@ -312,9 +314,9 @@ Checks whether the user is allowed to set wallpapers. This API uses an asynchron **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| callback | AsyncCallback<boolean> | Yes | Returns **true** if the user is allowed to set wallpapers; returns **false** otherwise. | +| callback | AsyncCallback<boolean> | Yes| Callback used to return the result. Returns **true** if the user is allowed to set wallpapers; returns **false** otherwise.| **Example** @@ -339,9 +341,9 @@ Checks whether the user is allowed to set wallpapers. This API uses a promise to **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<boolean> | Returns **true** if the user is allowed to set wallpapers; returns **false** otherwise. | +| Promise<boolean> | Promise used to return the result. Returns **true** if the user is allowed to set wallpapers; returns **false** otherwise.| **Example** @@ -366,10 +368,10 @@ Resets the wallpaper of the specified type to the default wallpaper. This API us **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | -| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, the result is returned. Otherwise, error information is returned. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| +| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation is successful, the result of removal is returned. Otherwise, error information is returned.| **Example** @@ -396,15 +398,15 @@ Resets the wallpaper of the specified type to the default wallpaper. This API us **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<void> | Promise used to return the result. If the operation is successful, the result is returned. Otherwise, error information is returned. | +| Promise<void> | Promise used to return the result. If the operation is successful, the result is returned. Otherwise, error information is returned.| **Example** @@ -429,16 +431,16 @@ Sets a specified source as the wallpaper of a specified type. This API uses an a **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| source | string \| [PixelMap](js-apis-image.md#pixelmap7) | Yes | URI of a JPEG or PNG file, or bitmap of a PNG file. | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | -| callback | AsyncCallback<void> | Yes | Callback used to return the result. If the operation is successful, the setting result is returned. Otherwise, error information is returned. | +| source | string \|[PixelMap](js-apis-image.md#pixelmap7) | | URI of a JPEG or PNG file, or bitmap of a PNG file.| +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| +| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation is successful, the setting result is returned. Otherwise, error information is returned.| **Example** -```js -// The source type is string. + ```js + //The source type is string. let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg"; wallpaper.setWallpaper(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM, (error, data) => { if (error) { @@ -448,7 +450,7 @@ Sets a specified source as the wallpaper of a specified type. This API uses an a console.log(`success to setWallpaper.`); }); -// The source type is image.PixelMap. + // The source type is image.PixelMap. import image from '@ohos.multimedia.image'; let imageSource = image.createImageSource("file://" + wallpaperPath); let opts = { @@ -468,7 +470,7 @@ Sets a specified source as the wallpaper of a specified type. This API uses an a }).catch((error) => { console.error(`failed to createPixelMap because: ` + JSON.stringify(error)); }); -``` + ``` ## wallpaper.setWallpaper @@ -483,21 +485,21 @@ Sets a specified source as the wallpaper of a specified type. This API uses a pr **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| source | string \| [PixelMap](js-apis-image.md#pixelmap7) | Yes | URI path of the JPEG or PNG file, or bitmap of the PNG file. | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | +| source | string \|[PixelMap](js-apis-image.md#pixelmap7) | Yes| URI of a JPEG or PNG file, or bitmap of a PNG file.| +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<void> | Promise used to return the result. If the operation is successful, the setting result is returned. Otherwise, error information is returned. | +| Promise<void> | Promise used to return the result. If the operation is successful, the setting result is returned. Otherwise, error information is returned.| **Example** -```js -// The source type is string. + ```js + // The source type is string. let wallpaperPath = "/data/data/ohos.acts.aafwk.plrdtest.form/files/Cup_ic.jpg"; wallpaper.setWallpaper(wallpaperPath, wallpaper.WallpaperType.WALLPAPER_SYSTEM).then((data) => { console.log(`success to setWallpaper.`); @@ -505,7 +507,7 @@ Sets a specified source as the wallpaper of a specified type. This API uses a pr console.error(`failed to setWallpaper because: ` + JSON.stringify(error)); }); -// The source type is image.PixelMap. + // The source type is image.PixelMap. import image from '@ohos.multimedia.image'; let imageSource = image.createImageSource("file://" + wallpaperPath); let opts = { @@ -523,7 +525,7 @@ Sets a specified source as the wallpaper of a specified type. This API uses a pr }).catch((error) => { console.error(`failed to createPixelMap because: ` + JSON.stringify(error)); }); -``` + ``` ## wallpaper.getFile8+ @@ -537,10 +539,10 @@ Obtains the wallpaper of the specified type. This API uses an asynchronous callb **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | -| callback | AsyncCallback<number> | Yes | Callback used to return the result. If the operation is successful, the file descriptor ID to the wallpaper is returned. Otherwise, error information is returned. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| +| callback | AsyncCallback<number> | Yes| Callback used to return the result. If the operation is successful, the file descriptor ID to the wallpaper is returned. Otherwise, error information is returned.| **Example** @@ -566,15 +568,15 @@ Obtains the wallpaper of the specified type. This API uses a promise to return t **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| wallpaperType | [WallpaperType](#wallpapertype) | Yes | Wallpaper type. | +| wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| **Return value** -| Type | Description | +| Type| Description| | -------- | -------- | -| Promise<number> | Promise used to return the result. If the operation is successful, the file descriptor ID to the wallpaper is returned. Otherwise, error information is returned. | +| Promise<number> | Promise used to return the result. If the operation is successful, the file descriptor ID to the wallpaper is returned. Otherwise, error information is returned.| **Example** @@ -591,18 +593,20 @@ Obtains the wallpaper of the specified type. This API uses a promise to return t getPixelMap(wallpaperType: WallpaperType, callback: AsyncCallback<image.PixelMap>): void; -Obtains the pixel image for the wallpaper of the specified type. This API uses an asynchronous callback to return the result. +Obtains the pixel map for the wallpaper of the specified type. This API uses an asynchronous callback to return the result. **Required permissions**: ohos.permission.GET_WALLPAPER **System capability**: SystemCapability.MiscServices.Wallpaper +**System API**: This is a system API and cannot be called by third-party applications. + **Parameters** | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | wallpaperType | [WallpaperType](#wallpapertype) | Yes| Wallpaper type.| -| callback | AsyncCallback<void> | Yes| Callback used to return the result. If the operation is successful, the result is returned. Otherwise, error information is returned.| +| callback | AsyncCallback<void> | Yes| Callback used to return the result. Returns the pixel map size of the wallpaper if the operation is successful; returns an error message otherwise.| **Example** @@ -618,12 +622,14 @@ Obtains the pixel image for the wallpaper of the specified type. This API uses a getPixelMap(wallpaperType: WallpaperType): Promise<image.PixelMap> -Obtains the pixel image for the wallpaper of the specified type. This API uses a promise to return the result. +Obtains the pixel map for the wallpaper of the specified type. This API uses a promise to return the result. **Required permissions**: ohos.permission.GET_WALLPAPER **System capability**: SystemCapability.MiscServices.Wallpaper +**System API**: This is a system API and cannot be called by third-party applications. + **Parameters** | Name| Type| Mandatory| Description| @@ -634,7 +640,7 @@ Obtains the pixel image for the wallpaper of the specified type. This API uses a | Type| Description| | -------- | -------- | -| Promise<void> | Promise used to return the result. If the operation is successful, the result is returned. Otherwise, error information is returned.| +| Promise<void> | Promise used to return the result. Returns the pixel map size of the wallpaper if the operation is successful; returns an error message otherwise.| **Example** @@ -659,10 +665,10 @@ Subscribes to the wallpaper color change event. **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| type | string | Yes | Type of the event to subscribe to. The value **colorChange** indicates subscribing to the wallpaper color change event. | -| callback | function | Yes | Callback triggered when the wallpaper color changes. The wallpaper type and main colors are returned.
- colors
Main color information of the wallpaper. For details, see [RgbaColor](#rgbacolor).
- wallpaperType
Wallpaper type. | +| type | string | Yes| Type of the event to subscribe to. The value **'colorChange'** indicates subscribing to the wallpaper color change event.| +| callback | function | Yes| Callback triggered when the wallpaper color changes. The wallpaper type and main colors are returned.
- colors
Main color information of the wallpaper. For details, see [RgbaColor](#rgbacolor).
- wallpaperType
Wallpaper type.| **Example** @@ -684,10 +690,10 @@ Unsubscribes from the wallpaper color change event. **Parameters** -| Name | Type | Mandatory | Description | +| Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | -| type | string | Yes | Type of the event to unsubscribe from. The value **colorChange** indicates unsubscribing from the wallpaper color change event. | -| callback | function | No | Callback for the wallpaper color change event. If this parameter is not specified, all callbacks corresponding to the wallpaper color change event are invoked.
- colors
Main color information of the wallpaper. For details, see [RgbaColor](#rgbacolor).
- wallpaperType
Wallpaper type. | +| type | string | Yes| Type of the event to unsubscribe from. The value **colorChange** indicates unsubscribing from the wallpaper color change event.| +| callback | function | No| Callback for the wallpaper color change event. If this parameter is not specified, all callbacks corresponding to the wallpaper color change event are invoked.
- colors
Main color information of the wallpaper. For details, see [RgbaColor](#rgbacolor).
- wallpaperType
Wallpaper type.| **Example** @@ -696,10 +702,10 @@ Unsubscribes from the wallpaper color change event. console.log(`wallpaper color changed.`); }; wallpaper.on('colorChange', listener); -// Unsubscribe from the listener. -wallpaper.off('colorChange', listener); -// Unsubscribe from all subscriptions of the colorChange type. -wallpaper.off('colorChange'); + // Unsubscribe from the listener. + wallpaper.off('colorChange', listener); + // Unsubscribe from all subscriptions of the colorChange type. + wallpaper.off('colorChange'); ``` @@ -707,9 +713,9 @@ wallpaper.off('colorChange'); **System capability**: SystemCapability.MiscServices.Wallpaper -| Name | Type | Readable | Writable | Description | +| Name| Type| Readable| Writable| Description| | -------- | -------- | -------- | -------- | -------- | -| red | number | Yes | Yes | Red color. The value ranges from 0 to 255. | -| green | number | Yes | Yes | Green color. The value ranges from 0 to 255. | -| blue | number | Yes | Yes | Blue color. The value ranges from 0 to 255. | -| alpha | number | Yes | Yes | Alpha value. The value ranges from 0 to 255. | +| red | number | Yes| Yes| Red color. The value ranges from 0 to 255.| +| green | number | Yes| Yes| Green color. The value ranges from 0 to 255.| +| blue | number | Yes| Yes| Blue color. The value ranges from 0 to 255.| +| alpha | number | Yes| Yes| Alpha value. The value ranges from 0 to 255.| diff --git a/en/application-dev/reference/apis/js-apis-wifi.md b/en/application-dev/reference/apis/js-apis-wifi.md index eccade788a2d19a81b1512ae206dbdfba449b95d..7f5b41145c5831f3ecd0014687a52366b598f9d4 100644 --- a/en/application-dev/reference/apis/js-apis-wifi.md +++ b/en/application-dev/reference/apis/js-apis-wifi.md @@ -16,16 +16,18 @@ import wifi from '@ohos.wifi'; enableWifi(): boolean Enables WLAN. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.disableWifi @@ -33,16 +35,18 @@ This is a system API. disableWifi(): boolean Disables WLAN. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.isWifiActive @@ -56,9 +60,10 @@ Checks whether WLAN is enabled. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if WLAN is enabled; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if WLAN is enabled; returns **false** otherwise.| ## wifi.scan @@ -72,9 +77,10 @@ Starts a scan for WLAN. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.getScanInfos @@ -88,9 +94,10 @@ Obtains the scan result. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise used to return the detected hotspots.| + +| **Type**| **Description**| +| -------- | -------- | +| Promise< Array<[WifiScanInfo](#wifiscaninfo)> > | Promise used to return the detected hotspots.| ## wifi.getScanInfos @@ -104,9 +111,10 @@ Obtains the scan result. This API uses an asynchronous callback to return the re **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the detected hotspots. Otherwise, **err** is a non-zero value and **data** is empty.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback< Array<[WifiScanInfo](#wifiscaninfo)>> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the detected hotspots. Otherwise, **err** is a non-zero value and **data** is empty.| **Example** ```js @@ -157,6 +165,7 @@ Represents WLAN hotspot information. **System capability**: SystemCapability.Communication.WiFi.STA + | **Name**| **Type**| **Readable/Writable**| **Description**| | -------- | -------- | -------- | -------- | | ssid | string | Read only| Service set identifier (SSID) of the hotspot, in UTF-8 format.| @@ -167,8 +176,8 @@ Represents WLAN hotspot information. | band | number | Read only| Frequency band of the WLAN access point (AP).| | frequency | number | Read only| Frequency of the WLAN AP.| | channelWidth | number | Read only| Channel width of the WLAN AP.| -| centerFrequency09+ | number | Read only| Center frequency.| -| centerFrequency19+ | number | Read only| Center frequency.| +| centerFrequency09+ | number | Read only| Center frequency of the hotspot.| +| centerFrequency19+ | number | Read only| Center frequency of the hotspot. If the hotspot uses two non-overlapping WLAN channels, two center frequencies, namely **centerFrequency0** and **centerFrequency1**, are returned.| | infoElems9+ | Array<[WifiInfoElem](#wifiinfoelem9)> | Read only| Information elements.| | timestamp | number | Read only| Timestamp.| @@ -179,6 +188,7 @@ Enumerates the WLAN security types. **System capability**: SystemCapability.Communication.WiFi.Core + | **Name**| **Default Value**| **Description**| | -------- | -------- | -------- | | WIFI_SEC_TYPE_INVALID | 0 | Invalid security type.| @@ -197,8 +207,11 @@ Enumerates the WLAN security types. Represents a WLAN information element. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA + | **Name**| **Type**| **Readable/Writable**| **Description**| | -------- | -------- | -------- | -------- | | eid | number | Read only| ID of the information element.| @@ -211,6 +224,7 @@ Enumerates the WLAN channel widths. **System capability**: SystemCapability.Communication.WiFi.STA + | **Name**| **Default Value**| **Description**| | -------- | -------- | -------- | | WIDTH_20MHZ | 0 | 20 MHz.| @@ -232,9 +246,10 @@ Obtains the scan result. This API returns the result synchronously. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - |  Array<[WifiScanInfo](#wifiscaninfo)> | Scan result obtained.| + +| **Type**| **Description**| +| -------- | -------- | +|  Array<[WifiScanInfo](#wifiscaninfo)> | Scan result obtained.| ## wifi.addDeviceConfig @@ -242,21 +257,24 @@ Obtains the scan result. This API returns the result synchronously. addDeviceConfig(config: WifiDeviceConfig): Promise<number> Adds network configuration. This API uses a promise to return the result. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | Promise<number> | Promise used to return the WLAN configuration ID. If **-1** is returned, the operation has failed.| + +| **Type**| **Description**| +| -------- | -------- | +| Promise<number> | Promise used to return the WLAN configuration ID. If **-1** is returned, the operation has failed.| ## WifiDeviceConfig @@ -264,6 +282,7 @@ Represents the WLAN configuration. **System capability**: SystemCapability.Communication.WiFi.STA + | **Name**| **Type**| **Readable/Writable**| **Description**| | -------- | -------- | -------- | -------- | | ssid | string | Read only| SSID of the hotspot, in UTF-8 format.| @@ -271,22 +290,25 @@ Represents the WLAN configuration. | preSharedKey | string | Read only| PSK of the hotspot.| | isHiddenSsid | boolean | Read only| Whether the network is hidden.| | securityType | [WifiSecurityType](#wifisecuritytype) | Read only| Security type.| -| creatorUid | number | Read only| User ID, which is available only to system applications.| -| disableReason | number | Read only| Reason for disabling WLAN. This parameter is available only to system applications.| -| netId | number | Read only| Allocated network ID, which is available only to system applications.| -| randomMacType | number | Read only| Random MAC type, which is available only to system applications.| -| randomMacAddr | string | Read only| Random MAC address, which is available only for system applications.| -| ipType | [IpType](#iptype7) | Read only| IP address type, which is available only to system applications.| -| staticIp | [IpConfig](#ipconfig7) | Read only| Static IP address configuration, which is available only to system applications.| -| eapConfig9+ | [WifiEapConfig](#wifieapconfig9) | Read only| EAP configuration, which is available only to system applications.| +| creatorUid | number | Read only| ID of the creator.
**System API**: This is a system API.| +| disableReason | number | Read only| Reason for disabling WLAN.
**System API**: This is a system API.| +| netId | number | Read only| Network ID.
**System API**: This is a system API.| +| randomMacType | number | Read only| Random MAC type.
**System API**: This is a system API.| +| randomMacAddr | string | Read only| Random MAC address.
**System API**: This is a system API.| +| ipType | [IpType](#iptype7) | Read only| IP address type.
**System API**: This is a system API.| +| staticIp | [IpConfig](#ipconfig7) | Read only| Static IP address configuration.
**System API**: This is a system API.| +| eapConfig9+ | [WifiEapConfig](#wifieapconfig9) | Read only| EAP configuration.
**System API**: This is a system API.| ## IpType7+ Enumerate the IP address types. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA + | Name| Default Value| Description| | -------- | -------- | -------- | | STATIC | 0 | Static IP address.| @@ -298,6 +320,8 @@ Enumerate the IP address types. Represents IP configuration information. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA | **Name**| **Type**| **Readable/Writable**| **Description**| @@ -312,6 +336,8 @@ Represents IP configuration information. Represents EAP configuration information. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA | **Name**| **Type**| **Readable/Writable**| **Description**| @@ -335,6 +361,8 @@ Represents EAP configuration information. Enumerates the EAP authentication methods. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA | Name| Default Value| Description| @@ -354,6 +382,8 @@ Enumerates the EAP authentication methods. Enumerates the Phase 2 authentication methods. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA | Name| Default Value| Description| @@ -373,17 +403,19 @@ Enumerates the Phase 2 authentication methods. addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void Adds network configuration. This API uses an asynchronous callback to return the result. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| - | callback | AsyncCallback<number> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the network configuration ID. If **data** is **-1**, the operation has failed. If **err** is not **0**, an error has occurred.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| +| callback | AsyncCallback<number> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the network configuration ID. If **data** is **-1**, the operation has failed. If **err** is not **0**, an error has occurred.| ## wifi.addUntrustedConfig7+ @@ -397,14 +429,16 @@ Adds the configuration of an untrusted network. This API uses a promise to retur **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | Promise<boolean> | Promise used to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.| + +| **Type**| **Description**| +| -------- | -------- | +| Promise<boolean> | Promise used to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.| ## wifi.addUntrustedConfig7+ @@ -418,10 +452,11 @@ Adds the configuration of an untrusted network. This API uses an asynchronous ca **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| - | callback | AsyncCallback<boolean> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is **true**. If the operation fails, **data** is **false**. If **err** is not **0**, an error has occurred.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| +| callback | AsyncCallback<boolean> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is **true**. If the operation fails, **data** is **false**. If **err** is not **0**, an error has occurred.| ## wifi.removeUntrustedConfig7+ @@ -435,14 +470,16 @@ Removes the configuration of an untrusted network. This API uses a promise to re **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to remove.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to remove.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | Promise<boolean> | Promise used to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.| + +| **Type**| **Description**| +| -------- | -------- | +| Promise<boolean> | Promise used to return the result. If the operation is successful, **true** is returned; otherwise, **false** is returned.| ## wifi.removeUntrustedConfig7+ @@ -456,10 +493,11 @@ Removes the configuration of an untrusted network. This API uses an asynchronous **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to remove.| - | callback | AsyncCallback<boolean> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is **true**. If the operation fails, **data** is **false**. If **err** is not **0**, an error has occurred.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to remove.| +| callback | AsyncCallback<boolean> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is **true**. If the operation fails, **data** is **false**. If **err** is not **0**, an error has occurred.| ## wifi.addCandidateConfig9+ @@ -473,14 +511,16 @@ Adds the configuration of a candidate network. This API uses a promise to return **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | Promise<number> | Promise used to return the network configuration ID.| + +| **Type**| **Description**| +| -------- | -------- | +| Promise<number> | Promise used to return the network configuration ID.| ## wifi.addCandidateConfig9+ @@ -494,10 +534,11 @@ Adds the configuration of a candidate network. This API uses an asynchronous cal **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| - | callback | AsyncCallback<number> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the network configuration ID. If **data** is **-1**, the operation has failed. If **err** is not **0**, an error has occurred.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration to add.| +| callback | AsyncCallback<number> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the network configuration ID. If **data** is **-1**, the operation has failed. If **err** is not **0**, an error has occurred.| ## wifi.removeCandidateConfig9+ @@ -511,14 +552,16 @@ Removes the configuration of a candidate network. This API uses a promise to ret **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | networkId | number | Yes| ID of the network configuration to remove.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| networkId | number | Yes| ID of the network configuration to remove.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | Promise<void> | Promise used to return the result.| + +| **Type**| **Description**| +| -------- | -------- | +| Promise<void> | Promise used to return the result.| ## wifi.removeCandidateConfig9+ @@ -532,10 +575,11 @@ Removes the configuration of a candidate network. This API uses an asynchronous **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | networkId | number | Yes| ID of the network configuration to remove.| - | callback | AsyncCallback<void> | Yes| Callback invoked to return the result. If the operation is successful, the value of **err** is **0**. If **err** is not **0**, an error has occurred.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| networkId | number | Yes| ID of the network configuration to remove.| +| callback | AsyncCallback<void> | Yes| Callback invoked to return the result. If the operation is successful, the value of **err** is **0**. If **err** is not **0**, an error has occurred.| ## wifi.getCandidateConfigs9+ @@ -549,14 +593,15 @@ Obtains candidate network configuration. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - |  Array<[WifiDeviceConfig](#wifideviceconfig)> | Candidate network configuration obtained.| + +| **Type**| **Description**| +| -------- | -------- | +|  Array<[WifiDeviceConfig](#wifideviceconfig)> | Candidate network configuration obtained.| ## wifi.connectToCandidateConfig9+ -connectToCandidateConfig(networkId: number): boolean +connectToCandidateConfig(networkId: number): void Connects to a candidate network. @@ -565,14 +610,10 @@ Connects to a candidate network. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | networkId | number | Yes| ID of the candidate network configuration.| -**Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| networkId | number | Yes| ID of the candidate network configuration.| ## wifi.connectToNetwork @@ -580,21 +621,24 @@ Connects to a candidate network. connectToNetwork(networkId: number): boolean Connects to the specified network. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | networkId | number | Yes| Network configuration ID.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| networkId | number | Yes| Network configuration ID.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.connectToDevice @@ -602,42 +646,45 @@ This is a system API. connectToDevice(config: WifiDeviceConfig): boolean Connects to the specified network. -This is a system API. -**Required permissions**: - ohos.permission.SET_WIFI_INFO, ohos.permission.SET_WIFI_CONFIG, and ohos.permissio.MANAGE_WIFI_CONNECTION (available only to system applications) +**System API**: This is a system API. + +**Required permissions**: ohos.permission.SET_WIFI_INFO, ohos.permission.SET_WIFI_CONFIG, and ohos.permissio.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| WLAN configuration.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.disconnect disconnect(): boolean -Disconnects from the specified network. -This is a system API. +Disconnects the network. -**Required permissions**: - ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) +**System API**: This is a system API. + +**Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.getSignalLevel @@ -651,15 +698,17 @@ Obtains the WLAN signal level. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | rssi | number | Yes| RSSI of the hotspot, in dBm.| - | band | number | Yes| Frequency band of the WLAN AP.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| rssi | number | Yes| RSSI of the hotspot, in dBm.| +| band | number | Yes| Frequency band of the WLAN AP.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | number | Signal level obtained. The value range is [0, 4].| + +| **Type**| **Description**| +| -------- | -------- | +| number | Signal level obtained. The value range is [0, 4].| ## wifi.getLinkedInfo @@ -673,9 +722,10 @@ Obtains WLAN connection information. This API uses a promise to return the resul **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | Type| Description| - | -------- | -------- | - | Promise<[WifiLinkedInfo](#wifilinkedinfo)> | Promise used to return the WLAN connection information obtained.| + +| Type| Description| +| -------- | -------- | +| Promise<[WifiLinkedInfo](#wifilinkedinfo)> | Promise used to return the WLAN connection information obtained.| ## wifi.getLinkedInfo @@ -689,9 +739,10 @@ Obtains WLAN connection information. This API uses an asynchronous callback to r **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiLinkedInfo](#wifilinkedinfo)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the WLAN connection information obtained. If **err** is not **0**, an error has occurred.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<[WifiLinkedInfo](#wifilinkedinfo)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the WLAN connection information obtained. If **err** is not **0**, an error has occurred.| **Example** ```js @@ -723,19 +774,19 @@ Represents the WLAN connection information. | -------- | -------- | -------- | -------- | | ssid | string | Read only| SSID of the hotspot, in UTF-8 format.| | bssid | string | Read only| BSSID of the hotspot.| -| networkId | number | Read only| Network configuration ID, which is available only to system applications.| +| networkId | number | Read only| Network configuration ID.
**System API**: This is a system API.| | rssi | number | Read only| RSSI of the hotspot, in dBm.| | band | number | Read only| Frequency band of the WLAN AP.| | linkSpeed | number | Read only| Speed of the WLAN AP.| | frequency | number | Read only| Frequency of the WLAN AP.| | isHidden | boolean | Read only| Whether to hide the WLAN AP.| | isRestricted | boolean | Read only| Whether to restrict data volume at the WLAN AP.| -| chload | number | Read only| Channel load. A larger value indicates a higher load. This parameter is only available to system applications.| -| snr | number | Read only| Signal-to-noise ratio (SNR), which is available only to system applications.| +| chload | number | Read only| Channel load. A larger value indicates a higher load.
**System API**: This is a system API.| +| snr | number | Read only| Signal-to-noise ratio (SNR).
**System API**: This is a system API.| | macType9+ | number | Read only| MAC address type.| | macAddress | string | Read only| MAC address of the device.| | ipAddress | number | Read only| IP address of the device that sets up the WLAN connection.| -| suppState | [SuppState](#suppstate) | Read only| Supplicant state, which is available only to system applications.| +| suppState | [SuppState](#suppstate) | Read only| Supplicant state.
**System API**: This is a system API.| | connState | [ConnState](#connstate) | Read only| WLAN connection state.| @@ -761,6 +812,8 @@ Enumerates the WLAN connection states. Enumerates the supplicant states. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.STA | Name| Default Value| Description| @@ -790,9 +843,10 @@ Checks whether the WLAN is connected. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the WLAN is connected; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the WLAN is connected; returns **false** otherwise.| ## wifi.getSupportedFeatures7+ @@ -800,31 +854,33 @@ Checks whether the WLAN is connected. getSupportedFeatures(): number Obtains the features supported by this device. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO **System capability**: SystemCapability.Communication.WiFi.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | number | Feature value. | + +| **Type**| **Description**| +| -------- | -------- | +| number | Feature value. | **Feature IDs** | Value| Description| | -------- | -------- | -| 0x0001 | WLAN infrastructure mode| -| 0x0002 | 5 GHz feature| -| 0x0004 | Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature| -| 0x0008 | Wi-Fi Direct| -| 0x0010 | SoftAP| -| 0x0040 | Wi-Fi AWare| -| 0x8000 | WLAN AP/STA concurrency| -| 0x8000000 | WPA3 Personal (WPA-3 SAE)| -| 0x10000000 | WPA3-Enterprise Suite B | -| 0x20000000 | Enhanced open feature| +| 0x0001 | WLAN infrastructure mode. | +| 0x0002 | 5 GHz feature. | +| 0x0004 | Generic Advertisement Service (GAS)/Access Network Query Protocol (ANQP) feature. | +| 0x0008 | Wi-Fi Direct. | +| 0x0010 | SoftAP. | +| 0x0040 | Wi-Fi AWare. | +| 0x8000 | WLAN AP/STA concurrency. | +| 0x8000000 | WPA3 Personal (WPA-3 SAE). | +| 0x10000000 | WPA3-Enterprise Suite B. | +| 0x20000000 | Enhanced open feature. | ## wifi.isFeatureSupported7+ @@ -839,14 +895,16 @@ Checks whether the device supports the specified WLAN feature. **Parameters** - | **Name**| **Type**| Mandatory| **Description**| - | -------- | -------- | -------- | -------- | - | featureId | number | Yes| Feature ID.| + +| **Name**| **Type**| Mandatory| **Description**| +| -------- | -------- | -------- | -------- | +| featureId | number | Yes| Feature ID.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the feature is supported; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the feature is supported; returns **false** otherwise.| ## wifi.getDeviceMacAddress7+ @@ -854,16 +912,18 @@ Checks whether the device supports the specified WLAN feature. getDeviceMacAddress(): string[] Obtains the device MAC address. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_LOCAL_MAC and ohos.permission.GET_WIFI_INFO (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | string[] | MAC address obtained.| + +| **Type**| **Description**| +| -------- | -------- | +| string[] | MAC address obtained.| ## wifi.getIpInfo7+ @@ -877,9 +937,10 @@ Obtains IP information. **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | [IpInfo](#ipinfo7) | IP information obtained.| + +| **Type**| **Description**| +| -------- | -------- | +| [IpInfo](#ipinfo7) | IP information obtained.| ## IpInfo7+ @@ -910,9 +971,10 @@ Obtains the country code. **System capability**: SystemCapability.Communication.WiFi.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | string | Country code obtained.| + +| **Type**| **Description**| +| -------- | -------- | +| string | Country code obtained.| ## wifi.reassociate7+ @@ -920,16 +982,18 @@ Obtains the country code. reassociate(): boolean Re-associates with the network. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.reconnect7+ @@ -937,16 +1001,18 @@ This is a system API. reconnect(): boolean Reconnects to the network. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.getDeviceConfigs7+ @@ -954,38 +1020,43 @@ This is a system API. getDeviceConfigs():  Array<[WifiDeviceConfig](#wifideviceconfig)> Obtains network configuration. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION, and ohos.permission.GET_WIFI_CONFIG **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - |  Array<[WifiDeviceConfig](#wifideviceconfig)> | Array of network configuration obtained.| + +| **Type**| **Description**| +| -------- | -------- | +|  Array<[WifiDeviceConfig](#wifideviceconfig)> | Array of network configuration obtained.| ## wifi.updateNetwork7+ -updateNetwork(config: WifiDeviceConfig): boolean +updateNetwork(config: WifiDeviceConfig): number Updates network configuration. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiDeviceConfig](#wifideviceconfig) | Yes| New WLAN configuration.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiDeviceConfig](#wifideviceconfig) | Yes| New WLAN configuration.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| number | ID of the updated network configuration. The value **-1** indicates that the operation has failed.| ## wifi.disableNetwork7+ @@ -993,21 +1064,24 @@ This is a system API. disableNetwork(netId: number): boolean Disables network configuration. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | netId | number | Yes| ID of the network configuration to disable.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| netId | number | Yes| ID of the network configuration to disable.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.removeAllNetwork7+ @@ -1015,16 +1089,18 @@ This is a system API. removeAllNetwork(): boolean Removes the configuration of all networks. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.removeDevice7+ @@ -1032,21 +1108,24 @@ This is a system API. removeDevice(id: number): boolean Removes the specified network configuration. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | id | number | Yes| ID of the network configuration to remove.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| id | number | Yes| ID of the network configuration to remove.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.enableHotspot7+ @@ -1054,16 +1133,18 @@ This is a system API. enableHotspot(): boolean Enables this hotspot. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.AP.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.disableHotspot7+ @@ -1071,16 +1152,18 @@ This is a system API. disableHotspot(): boolean Disables this hotspot. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.AP.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.isHotspotDualBandSupported7+ @@ -1088,16 +1171,18 @@ This is a system API. isHotspotDualBandSupported(): boolean Checks whether the hotspot supports dual band. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.AP.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the feature is supported; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the feature is supported; returns **false** otherwise.| ## wifi.isHotspotActive7+ @@ -1105,16 +1190,18 @@ This is a system API. isHotspotActive(): boolean Checks whether this hotspot is active. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO **System capability**: SystemCapability.Communication.WiFi.AP.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the hotspot is active; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the hotspot is active; returns **false** otherwise.| ## wifi.setHotspotConfig7+ @@ -1122,27 +1209,32 @@ This is a system API. setHotspotConfig(config: HotspotConfig): boolean Sets hotspot configuration. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG **System capability**: SystemCapability.Communication.WiFi.AP.Core **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | config | [HotspotConfig](#hotspotconfig7) | Yes| Hotspot configuration to set.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| config | [HotspotConfig](#hotspotconfig7) | Yes| Hotspot configuration to set.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## HotspotConfig7+ Represents the hotspot configuration. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.AP.Core | **Name**| **Type**| **Readable/Writable**| **Description**| @@ -1159,16 +1251,18 @@ Represents the hotspot configuration. getHotspotConfig(): HotspotConfig obtains hotspot configuration. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG **System capability**: SystemCapability.Communication.WiFi.AP.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - | [HotspotConfig](#hotspotconfig7) | Hotspot configuration obtained.| + +| **Type**| **Description**| +| -------- | -------- | +| [HotspotConfig](#hotspotconfig7) | Hotspot configuration obtained.| ## wifi.getStations7+ @@ -1176,22 +1270,26 @@ This is a system API. getStations():  Array<[StationInfo](#stationinfo7)> Obtains information about the connected stations. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION, and ohos.permission.MANAGE_WIFI_HOTSPOT (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.AP.Core **Return value** - | **Type**| **Description**| - | -------- | -------- | - |  Array<[StationInfo](#stationinfo7)> | Connected stations obtained.| + +| **Type**| **Description**| +| -------- | -------- | +|  Array<[StationInfo](#stationinfo7)> | Connected stations obtained.| ## StationInfo7+ Represents the station information. +**System API**: This is a system API. + **System capability**: SystemCapability.Communication.WiFi.AP.Core | **Name**| **Type**| **Readable/Writable**| **Description**| @@ -1212,9 +1310,10 @@ Obtains P2P link information. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | Promise<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Promise used to return the P2P link information obtained.| + +| Type| Description| +| -------- | -------- | +| Promise<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Promise used to return the P2P link information obtained.| @@ -1254,9 +1353,10 @@ Obtains P2P link information. This API uses an asynchronous callback to return t **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the P2P link information. If **err** is not **0**, an error has occurred.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the P2P link information. If **err** is not **0**, an error has occurred.| ## wifi.getCurrentGroup8+ @@ -1270,9 +1370,10 @@ Obtains the current P2P group information. This API uses a promise to return the **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | Promise<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | Promise used to return the group information obtained.| + +| Type| Description| +| -------- | -------- | +| Promise<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | Promise used to return the group information obtained.| ## wifi.getCurrentGroup8+ @@ -1286,9 +1387,10 @@ Obtains the current P2P group information. This API uses an asynchronous callbac **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the group information obtained. If **err** is not **0**, an error has occurred.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the group information obtained. If **err** is not **0**, an error has occurred.| ## wifi.getP2pPeerDevices8+ @@ -1302,9 +1404,10 @@ Obtains the peer device list in the P2P connection. This API uses a promise to r **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | Promise<[WifiP2pDevice[]](#wifip2pdevice8)> | Promise used to return the peer device list.| + +| Type| Description| +| -------- | -------- | +| Promise<[WifiP2pDevice[]](#wifip2pdevice8)> | Promise used to return the peer device list.| ## wifi.getP2pPeerDevices8+ @@ -1318,9 +1421,10 @@ Obtains the peer device list in the P2P connection. This API uses an asynchronou **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pDevice[]](#wifip2pdevice8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the peer device list obtained. If **err** is not **0**, an error has occurred.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<[WifiP2pDevice[]](#wifip2pdevice8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the peer device list obtained. If **err** is not **0**, an error has occurred.| ## WifiP2pDevice8+ @@ -1364,9 +1468,10 @@ Obtains the local device information in the P2P connection. This API uses a prom **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | Promise<[WifiP2pDevice](#wifip2pdevice8)> | Promise used to return the local device information obtained.| + +| Type| Description| +| -------- | -------- | +| Promise<[WifiP2pDevice](#wifip2pdevice8)> | Promise used to return the local device information obtained.| ## wifi.getP2pLocalDevice9+ @@ -1380,9 +1485,10 @@ Obtains the local device information in the P2P connection. This API uses an asy **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<[WifiP2pDevice](#wifip2pdevice8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the local device information obtained. If **err** is not **0**, an error has occurred.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<[WifiP2pDevice](#wifip2pdevice8)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the local device information obtained. If **err** is not **0**, an error has occurred.| ## wifi.createGroup8+ @@ -1397,14 +1503,15 @@ Creates a P2P group. **Parameters** - | **Name**| **Type**| Mandatory| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiP2PConfig](#wifip2pconfig8) | Yes| Group configuration.| +| **Name**| **Type**| Mandatory| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiP2PConfig](#wifip2pconfig8) | Yes| Group configuration.| **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## WifiP2PConfig8+ @@ -1446,9 +1553,10 @@ Removes this P2P group. **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.p2pConnect8+ @@ -1463,14 +1571,16 @@ Sets up a P2P connection. **Parameters** - | **Name**| **Type**| Mandatory| **Description**| - | -------- | -------- | -------- | -------- | - | config | [WifiP2PConfig](#wifip2pconfig8) | Yes| P2P group configuration.| + +| **Name**| **Type**| Mandatory| **Description**| +| -------- | -------- | -------- | -------- | +| config | [WifiP2PConfig](#wifip2pconfig8) | Yes| P2P group configuration.| **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| **Example** @@ -1551,9 +1661,10 @@ Cancels this P2P connection. **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.startDiscoverDevices8+ @@ -1567,9 +1678,10 @@ Starts to discover devices. **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.stopDiscoverDevices8+ @@ -1583,9 +1695,10 @@ Stops discovering devices. **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.deletePersistentGroup8+ @@ -1594,20 +1707,24 @@ deletePersistentGroup(netId: number): boolean Deletes a persistent group. -**Required permissions**: ohos.permission.GET_WIFI_INFO +**System API**: This is a system API. + +**Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| Mandatory| **Description**| - | -------- | -------- | -------- | -------- | - | netId | number | Yes| ID of the group to delete.| + +| **Name**| **Type**| Mandatory| **Description**| +| -------- | -------- | -------- | -------- | +| netId | number | Yes| ID of the group to delete.| **Return value** - | Type| Description| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| Type| Description| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.getP2pGroups9+ @@ -1615,16 +1732,18 @@ Deletes a persistent group. getP2pGroups(): Promise<Array<WifiP2pGroupInfo>> Obtains information about all P2P groups. This API uses a promise to return the result. -This is a system API. + +**System API**: This is a system API. **Required permissions**: ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION **System capability**: SystemCapability.Communication.WiFi.P2P **Return value** - | Type| Description| - | -------- | -------- | - | Promise< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> > | Promise used to return the group information obtained.| + +| Type| Description| +| -------- | -------- | +| Promise< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo8)> > | Promise used to return the group information obtained.| ## WifiP2pGroupInfo8+ @@ -1652,14 +1771,17 @@ getP2pGroups(callback: AsyncCallback<Array<WifiP2pGroupInfo>>): void Obtains information about all P2P groups. This API uses an asynchronous callback to return the result. +**System API**: This is a system API. + **Required permissions**: ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | Name| Type| Mandatory| Description| - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo8)>> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the group information obtained. If **err** is not **0**, an error has occurred.| + +| Name| Type| Mandatory| Description| +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback< Array<[WifiP2pGroupInfo](#wifip2pgroupinfo8)>> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the group information obtained. If **err** is not **0**, an error has occurred.| ## wifi.setDeviceName8+ @@ -1667,22 +1789,24 @@ Obtains information about all P2P groups. This API uses an asynchronous callback setDeviceName(devName: string): boolean Sets the device name. -This is a system API. -**Required permissions**: - ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) +**System API**: This is a system API. + +**Required permissions**: ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION (available only to system applications) **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | devName | string | Yes| Device name to set.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| devName | string | Yes| Device name to set.| **Return value** - | **Type**| **Description**| - | -------- | -------- | - | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| + +| **Type**| **Description**| +| -------- | -------- | +| boolean | Returns **true** if the operation is successful; returns **false** otherwise.| ## wifi.on('wifiStateChange')7+ @@ -1696,19 +1820,20 @@ Registers the WLAN state change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiStateChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the WLAN state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiStateChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the WLAN state.| **WLAN states** | **Value**| **Description**| | -------- | -------- | -| 0 | Deactivated| -| 1 | Activated| -| 2 | Activating| -| 3 | Deactivating| +| 0 | Deactivated. | +| 1 | Activated. | +| 2 | Activating. | +| 3 | Deactivating. | ## wifi.off('wifiStateChange')7+ @@ -1722,25 +1847,25 @@ Unregisters the WLAN state change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiStateChange**.| - | callback | Callback<number> | No| Callback used to return the WLAN state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiStateChange**.| +| callback | Callback<number> | No| Callback used to return the WLAN state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| **Example** ```js import wifi from '@ohos.wifi'; - var WIFI_POWER_STATE = "wifiStateChange"; var recvPowerNotifyFunc = result => { console.info("Receive power state change event: " + result); } // Register an event. - wifi.on(WIFI_POWER_STATE, recvPowerNotifyFunc); + wifi.on("wifiStateChange", recvPowerNotifyFunc); // Unregister an event. - wifi.off(WIFI_POWER_STATE, recvPowerNotifyFunc); + wifi.off("wifiStateChange", recvPowerNotifyFunc); ``` @@ -1755,17 +1880,18 @@ Registers the WLAN connection state change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiConnectionChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the WLAN connection state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiConnectionChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the WLAN connection state.| **WLAN connection states** | **Value**| **Description**| | -------- | -------- | -| 0 | Disconnected| -| 1 | Connected| +| 0 | Disconnected.| +| 1 | Connected.| ## wifi.off('wifiConnectionChange')7+ @@ -1779,10 +1905,11 @@ Unregisters the WLAN connection state change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiConnectionChange**.| - | callback | Callback<number> | No| Callback used to return the WLAN connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiConnectionChange**.| +| callback | Callback<number> | No| Callback used to return the WLAN connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('wifiScanStateChange')7+ @@ -1796,17 +1923,18 @@ Registers the WLAN scan state change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiScanStateChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the WLAN scan state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiScanStateChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the WLAN scan state.| **WLAN scan states** | **Value**| **Description**| | -------- | -------- | -| 0 | Scan failed| -| 1 | Scan successful| +| 0 | Scan failed.| +| 1 | Scan successful.| ## wifi.off('wifiScanStateChange')7+ @@ -1838,10 +1966,11 @@ Registers the RSSI change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiRssiChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the RSSI, in dBm.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiRssiChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the RSSI, in dBm.| ## wifi.off('wifiRssiChange')7+ @@ -1855,10 +1984,11 @@ Unregisters the RSSI change events. **System capability**: SystemCapability.Communication.WiFi.STA **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **wifiRssiChange**.| - | callback | Callback<number> | No| Callback used to return the RSSI. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **wifiRssiChange**.| +| callback | Callback<number> | No| Callback used to return the RSSI. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('hotspotStateChange')7+ @@ -1872,19 +2002,20 @@ Registers the hotspot state change events. **System capability**: SystemCapability.Communication.WiFi.AP.Core **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **hotspotStateChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the hotspot state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **hotspotStateChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the hotspot state.| **Hotspot states** | **Value**| **Description**| | -------- | -------- | -| 0 | Deactivated| -| 1 | Activated| -| 2 | Activating| -| 3 | Deactivating| +| 0 | Deactivated. | +| 1 | Activated. | +| 2 | Activating. | +| 3 | Deactivating. | ## wifi.off('hotspotStateChange')7+ @@ -1898,10 +2029,11 @@ Unregisters the hotspot state change events. **System capability**: SystemCapability.Communication.WiFi.AP.Core **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **hotspotStateChange**.| - | callback | Callback<number> | No| Callback used to return the hotspot state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **hotspotStateChange**.| +| callback | Callback<number> | No| Callback used to return the hotspot state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('p2pStateChange')8+ @@ -1915,20 +2047,21 @@ Registers the P2P state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pStateChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the P2P state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pStateChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the P2P state.| **P2P states** | **Value**| **Description**| | -------- | -------- | -| 1 | Available| -| 2 | Opening| -| 3 | Opened| -| 4 | Closing| -| 5 | Closed| +| 1 | Available. | +| 2 | Opening. | +| 3 | Opened. | +| 4 | Closing. | +| 5 | Closed. | ## wifi.off('p2pStateChange')8+ @@ -1941,10 +2074,11 @@ Unregisters the P2P state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pStateChange**.| - | callback | Callback<number> | No| Callback used to return the P2P state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pStateChange**.| +| callback | Callback<number> | No| Callback used to return the P2P state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('p2pConnectionChange')8+ @@ -1958,10 +2092,11 @@ Registers the P2P connection state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pConnectionChange**.| - | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Yes| Callback invoked to return the P2P connection state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pConnectionChange**.| +| callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | Yes| Callback invoked to return the P2P connection state.| ## wifi.off('p2pConnectionChange')8+ @@ -1975,10 +2110,11 @@ Unregisters the P2P connection state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pConnectionChange**.| - | callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | No| Callback used to return the P2P connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pConnectionChange**.| +| callback | Callback<[WifiP2pLinkedInfo](#wifip2plinkedinfo8)> | No| Callback used to return the P2P connection state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('p2pDeviceChange')8+ @@ -1992,10 +2128,11 @@ Registers the P2P device state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pDeviceChange**.| - | callback | Callback<[WifiP2pDevice](#wifip2pdevice8)> | Yes| Callback invoked to return the P2P device state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pDeviceChange**.| +| callback | Callback<[WifiP2pDevice](#wifip2pdevice8)> | Yes| Callback invoked to return the P2P device state.| ## wifi.off('p2pDeviceChange')8+ @@ -2009,10 +2146,11 @@ Unregisters the P2P device state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pDeviceChange**.| - | callback | Callback<[WifiP2pDevice](#wifip2pdevice8)> | No| Callback used to return the P2P device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pDeviceChange**.| +| callback | Callback<[WifiP2pDevice](#wifip2pdevice8)> | No| Callback used to return the P2P device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('p2pPeerDeviceChange')8+ @@ -2026,10 +2164,11 @@ Registers the P2P peer device state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| - | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice8)> | Yes| Callback invoked to return the P2P peer device state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| +| callback | Callback<[WifiP2pDevice[]](#wifip2pdevice8)> | Yes| Callback invoked to return the P2P peer device state.| ## wifi.off('p2pPeerDeviceChange')8+ @@ -2043,10 +2182,11 @@ Unregisters the P2P peer device state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| - | callback | Callback<[WifiP2pDevice[]](#wifip2pdevice8)> | No| Callback used to return the peer device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pPeerDeviceChange**.| +| callback | Callback<[WifiP2pDevice[]](#wifip2pdevice8)> | No| Callback used to return the peer device state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('p2pPersistentGroupChange')8+ @@ -2060,10 +2200,11 @@ Registers the P2P persistent group state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| - | callback | Callback<void> | Yes| Callback invoked to return the P2P persistent group state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| +| callback | Callback<void> | Yes| Callback invoked to return the P2P persistent group state.| ## wifi.off('p2pPersistentGroupChange')8+ @@ -2077,10 +2218,11 @@ Unregisters the P2P persistent group state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| - | callback | Callback<void> | No| Callback used to return the P2P persistent group state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pPersistentGroupChange**.| +| callback | Callback<void> | No| Callback used to return the P2P persistent group state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| ## wifi.on('p2pDiscoveryChange')8+ @@ -2094,17 +2236,18 @@ Registers the P2P device discovery state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| - | callback | Callback<number> | Yes| Callback invoked to return the P2P device discovery state.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| +| callback | Callback<number> | Yes| Callback invoked to return the P2P device discovery state.| **P2P discovered device states** | **Value**| **Description**| | -------- | -------- | -| 0 | Initial state| -| 1 | Discovered| +| 0 | Initial state.| +| 1 | Discovered.| ## wifi.off('p2pDiscoveryChange')8+ @@ -2118,7 +2261,8 @@ Unregisters the P2P device discovery state change events. **System capability**: SystemCapability.Communication.WiFi.P2P **Parameters** - | **Name**| **Type**| **Mandatory**| **Description**| - | -------- | -------- | -------- | -------- | - | type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| - | callback | Callback<number> | No| Callback used to return the P2P device discovery state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| + +| **Name**| **Type**| **Mandatory**| **Description**| +| -------- | -------- | -------- | -------- | +| type | string | Yes| Event type. The value is **p2pDiscoveryChange**.| +| callback | Callback<number> | No| Callback used to return the P2P device discovery state. If this parameter is not specified, all callbacks associated with the specified event will be unregistered.| diff --git a/en/application-dev/reference/apis/js-apis-wifiext.md b/en/application-dev/reference/apis/js-apis-wifiext.md index e421081e97a52ec917050bbfee15dda5e0c6c74a..9ce53d76e2517eb199067f779168fb9fe9d8b032 100644 --- a/en/application-dev/reference/apis/js-apis-wifiext.md +++ b/en/application-dev/reference/apis/js-apis-wifiext.md @@ -23,6 +23,7 @@ Enables the WLAN hotspot. **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Return value** + | **Type**| **Description**| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -39,6 +40,7 @@ Disables the WLAN hotspot. **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Return value** + | **Type**| **Description**| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| @@ -55,6 +57,7 @@ Obtains the supported power models. This API uses a promise to return the result **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Return value** + | Type| Description| | -------- | -------- | | Promise<Array<[PowerModel](#powermodel)>> | Promise used to return the power models obtained.| @@ -84,6 +87,7 @@ Obtains the supported power models. This API uses an asynchronous callback to re **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[PowerModel](#powermodel)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is 0 and **data** is the power models obtained. If **err** is not **0**, an error has occurred.| @@ -100,6 +104,7 @@ Obtains the power model. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Return value** + | Type| Description| | -------- | -------- | | Promise<[PowerModel](#powermodel)> | Promise used to return the power model obtained.| @@ -116,6 +121,7 @@ Obtains the power model. This API uses an asynchronous callback to return the re **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | callback | AsyncCallback<[PowerModel](#powermodel)> | Yes| Callback invoked to return the result. If the operation is successful, **err** is **0** and **data** is the power model obtained. If **err** is not **0**, an error has occurred.| @@ -132,11 +138,13 @@ setPowerModel(model: PowerModel) : boolean; **System capability**: SystemCapability.Communication.WiFi.AP.Extension **Parameters** + | Name| Type| Mandatory| Description| | -------- | -------- | -------- | -------- | | model | AsyncCallback<[PowerModel](#powermodel)> | Yes| Power model to set.| **Return value** + | **Type**| **Description**| | -------- | -------- | | boolean | Returns **true** if the operation is successful; returns **false** otherwise.| diff --git a/en/application-dev/reference/apis/js-apis-window.md b/en/application-dev/reference/apis/js-apis-window.md index 4c716d142c2d773da09dec8e2c0d8b09d0d628aa..91c284004f4b1e2f22d46ba27c3249d9b05dd5bb 100644 --- a/en/application-dev/reference/apis/js-apis-window.md +++ b/en/application-dev/reference/apis/js-apis-window.md @@ -303,8 +303,8 @@ Creates a subwindow. This API uses an asynchronous callback to return the result **Example** ```js -var windowClass = null; -window.create("first", window.WindowType.TYPE_APP,(err,data) => { +let windowClass = null; +window.create('first', window.WindowType.TYPE_APP,(err,data) => { if(err.code){ console.error('Failed to create the subWindow. Cause: ' + JSON.stringify(err)); return; @@ -340,8 +340,8 @@ Creates a subwindow. This API uses a promise to return the result. **Example** ```js -var windowClass = null; -let promise = window.create("first", window.WindowType.TYPE_APP); +let windowClass = null; +let promise = window.create('first', window.WindowType.TYPE_APP); promise.then((data)=> { windowClass = data; console.info('Succeeded in creating the subWindow. Data: ' + JSON.stringify(data)); @@ -370,8 +370,8 @@ Creates a subwindow (in API version 8) or a system window (from API version 9). **Example** ```js -var windowClass = null; - window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => { +let windowClass = null; + window.create(this.context, 'alertWindow', window.WindowType.TYPE_SYSTEM_ALERT, (err, data) => { if (err.code) { console.error('Failed to create the window. Cause: ' + JSON.stringify(err)); return; @@ -407,8 +407,8 @@ Creates a subwindow (in API version 8) or a system window (from API version 9). **Example** ```js -var windowClass = null; -let promise = window.create(this.context, "alertWindow", window.WindowType.TYPE_SYSTEM_ALERT); +let windowClass = null; +let promise = window.create(this.context, 'alertWindow', window.WindowType.TYPE_SYSTEM_ALERT); promise.then((data)=> { windowClass = data; console.info('Succeeded in creating the window. Data:' + JSON.stringify(data)); @@ -435,8 +435,8 @@ Finds a window based on the ID. This API uses an asynchronous callback to return **Example** ```js -var windowClass = null; - window.find("alertWindow", (err, data) => { +let windowClass = null; + window.find('alertWindow', (err, data) => { if (err.code) { console.error('Failed to find the Window. Cause: ' + JSON.stringify(err)); return; @@ -469,8 +469,8 @@ Finds a window based on the ID. This API uses a promise to return the result. **Example** ```js -var windowClass = null; -let promise = window.find("alertWindow"); +let windowClass = null; +let promise = window.find('alertWindow'); promise.then((data)=> { windowClass = data; console.info('Succeeded in finding the window. Data: ' + JSON.stringify(data)); @@ -498,7 +498,7 @@ Obtains the top window of the current application. This API uses an asynchronous **Example** ```js -var windowClass = null; +let windowClass = null; window.getTopWindow((err, data) => { if (err.code) { console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err)); @@ -528,7 +528,7 @@ Obtains the top window of the current application. This API uses a promise to re **Example** ```js -var windowClass = null; +let windowClass = null; let promise = window.getTopWindow(); promise.then((data)=> { windowClass = data; @@ -556,7 +556,7 @@ Obtains the top window of the current application. This API uses an asynchronous **Example** ```js -var windowClass = null; +let windowClass = null; window.getTopWindow(this.context, (err, data) => { if (err.code) { console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(err)); @@ -590,7 +590,7 @@ Obtains the top window of the current application. This API uses a promise to re **Example** ```js -var windowClass = null; +let windowClass = null; let promise = window.getTopWindow(this.context); promise.then((data)=> { windowClass = data; @@ -622,7 +622,7 @@ Minimizes all windows on a display. This API uses an asynchronous callback to re import display from '@ohos.display' import window from '@ohos.window' -var displayClass = null; +let displayClass = null; display.getDefaultDisplay((err, data) => { if(err.code) { return; @@ -665,7 +665,7 @@ Minimizes all windows on a display. This API uses a promise to return the result import display from '@ohos.display' import window from '@ohos.window' -var displayClass = null; +let displayClass = null; display.getDefaultDisplay((err, data) => { if(err.code) { return; @@ -1255,7 +1255,7 @@ Sets the type of this window. This API uses an asynchronous callback to return t **Example** ```js -var type = window.WindowType.TYPE_APP; +let type = window.WindowType.TYPE_APP; windowClass.setWindowType(type, (err, data) => { if (err.code) { console.error('Failed to set the window type. Cause: ' + JSON.stringify(err)); @@ -1294,7 +1294,7 @@ Sets the type of this window. This API uses a promise to return the result. **Example** ```js -var type = window.WindowType.TYPE_APP; +let type = window.WindowType.TYPE_APP; let promise = windowClass.setWindowType(type); promise.then((data)=> { console.info('Succeeded in setting the window type. Data: ' + JSON.stringify(data)); @@ -1372,7 +1372,7 @@ Obtains the area where this window cannot be displayed, for example, the system **Example** ```js -var type = window.AvoidAreaType.TYPE_SYSTEM; +let type = window.AvoidAreaType.TYPE_SYSTEM; windowClass.getAvoidArea(type, (err, data) => { if (err.code) { console.error('Failed to obtain the area. Cause:' + JSON.stringify(err)); @@ -1405,7 +1405,7 @@ Obtains the area where this window cannot be displayed, for example, the system **Example** ```js -var type = window.AvoidAreaType.TYPE_SYSTEM; +let type = window.AvoidAreaType.TYPE_SYSTEM; let promise = windowClass.getAvoidArea(type); promise.then((data)=> { console.info('Succeeded in obtaining the area. Data:' + JSON.stringify(data)); @@ -1432,7 +1432,7 @@ Sets whether to enable the full-screen mode for this window. This API uses an as **Example** ```js -var isFullScreen = true; +let isFullScreen = true; windowClass.setFullScreen(isFullScreen, (err, data) => { if (err.code) { console.error('Failed to enable the full-screen mode. Cause: ' + JSON.stringify(err)); @@ -1465,7 +1465,7 @@ Sets whether to enable the full-screen mode for this window. This API uses a pro **Example** ```js -var isFullScreen = true; +let isFullScreen = true; let promise = windowClass.setFullScreen(isFullScreen); promise.then((data)=> { console.info('Succeeded in enabling the full-screen mode. Data: ' + JSON.stringify(data)); @@ -1492,7 +1492,7 @@ Sets whether to enable the full-screen mode for the window layout. This API uses **Example** ```js -var isLayoutFullScreen= true; +let isLayoutFullScreen= true; windowClass.setLayoutFullScreen(isLayoutFullScreen, (err, data) => { if (err.code) { console.error('Failed to set the window layout to full-screen mode. Cause:' + JSON.stringify(err)); @@ -1525,7 +1525,7 @@ Sets whether to enable the full-screen mode for the window layout. This API uses **Example** ```js -var isLayoutFullScreen = true; +let isLayoutFullScreen = true; let promise = windowClass.setLayoutFullScreen(isLayoutFullScreen); promise.then((data)=> { console.info('Succeeded in setting the window layout to full-screen mode. Data: ' + JSON.stringify(data)); @@ -1546,14 +1546,14 @@ Sets whether to display the status bar and navigation bar in this window. This A | Name | Type | Mandatory| Description | | -------- | ------------------------- | ---- | ------------------------------------------------------------ | -| names | Array | Yes | Whether to display the status bar and navigation bar.
For example, to display the status bar and navigation bar, set this parameter to `["status", "navigation"]`. By default, they are not displayed.| +| names | Array | Yes | Whether to display the status bar and navigation bar.
For example, to display the status bar and navigation bar, set this parameter to `['status', 'navigation']`. By default, they are not displayed.| | callback | AsyncCallback<void> | Yes | Callback used to return the result. | **Example** ```js // In this example, the status bar and navigation bar are not displayed. -var names = []; +let names = []; windowClass.setSystemBarEnable(names, (err, data) => { if (err.code) { console.error('Failed to set the system bar to be invisible. Cause:' + JSON.stringify(err)); @@ -1575,7 +1575,7 @@ Sets whether to display the status bar and navigation bar in this window. This A | Name| Type | Mandatory| Description | | ------ | ----- | ---- | ------------------------------------------------------------ | -| names | Array | Yes | Whether to display the status bar and navigation bar.
For example, to display the status bar and navigation bar, set this parameter to `["status", "navigation"]`. By default, they are not displayed.| +| names | Array | Yes | Whether to display the status bar and navigation bar.
For example, to display the status bar and navigation bar, set this parameter to `['status', 'navigation']`. By default, they are not displayed.| **Return value** @@ -1587,7 +1587,7 @@ Sets whether to display the status bar and navigation bar in this window. This A ```js // In this example, the status bar and navigation bar are not displayed. -var names = []; +let names = []; let promise = windowClass.setSystemBarEnable(names); promise.then((data)=> { console.info('Succeeded in setting the system bar to be invisible. Data: ' + JSON.stringify(data)); @@ -1614,7 +1614,7 @@ Sets the properties of the status bar and navigation bar in this window. This AP **Example** ```js -var SystemBarProperties={ +let SystemBarProperties={ statusBarColor: '#ff00ff', navigationBarColor: '#00ff00', // The following properties are supported since API version 7. @@ -1656,7 +1656,7 @@ Sets the properties of the status bar and navigation bar in this window. This AP **Example** ```js -var SystemBarProperties={ +let SystemBarProperties={ statusBarColor: '#ff00ff', navigationBarColor: '#00ff00', // The following properties are supported since API version 7. @@ -1692,7 +1692,7 @@ Sets the preferred orientation for this window. This API uses an asynchronous ca **Example** ```js -var orientation = window.Orientation.AUTO_ROTATION; +let orientation = window.Orientation.AUTO_ROTATION; windowClass.setPreferredOrientation(orientation, (err, data) => { if (err.code) { console.error('Failed to set window orientation. Cause: ' + JSON.stringify(err)); @@ -1725,7 +1725,7 @@ Sets the preferred orientation for this window. This API uses a promise to retur **Example** ```js -var orientation = window.Orientation.AUTO_ROTATION; +let orientation = window.Orientation.AUTO_ROTATION; let promise = windowClass.setPreferredOrientation(orientation); promise.then((data)=> { console.info('Succeeded in setting the window orientation. Data: ' + JSON.stringify(data)); @@ -1752,7 +1752,7 @@ Loads content from a page to this window. This API uses an asynchronous callback **Example** ```js -windowClass.loadContent("pages/page2/page2", (err, data) => { +windowClass.loadContent('pages/page2/page2', (err, data) => { if (err.code) { console.error('Failed to load the content. Cause:' + JSON.stringify(err)); return; @@ -1784,7 +1784,7 @@ Loads content from a page to this window. This API uses a promise to return the **Example** ```js -let promise = windowClass.loadContent("pages/page2/page2"); +let promise = windowClass.loadContent('pages/page2/page2'); promise.then((data)=> { console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)); }).catch((err)=>{ @@ -1816,9 +1816,9 @@ class myAbility extends Ability { storage : LocalStorage onWindowStageCreate(windowStage) { this.storage = new LocalStorage(); - this.storage.setOrCreate("storageSimpleProp",121); + this.storage.setOrCreate('storageSimpleProp',121); console.log('onWindowStageCreate'); - windowStage.loadContent("pages/page2",this.storage,(err, data) => { + windowStage.loadContent('pages/page2',this.storage,(err, data) => { if (err.code) { console.error('Failed to load the content. Cause:' + JSON.stringify(err)); return; @@ -1859,10 +1859,10 @@ class myAbility extends Ability { storage : LocalStorage onWindowStageCreate(windowStage) { this.storage = new LocalStorage(); - this.storage.setOrCreate("storageSimpleProp",121); + this.storage.setOrCreate('storageSimpleProp',121); console.log('onWindowStageCreate'); - var windowClass = null; - let promise = windowStage.loadContent("pages/page2",this.storage); + let windowClass = null; + let promise = windowStage.loadContent('pages/page2',this.storage); promise.then((data)=> { windowClass = data; console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)); @@ -2195,7 +2195,7 @@ Unsubscribes from screenshot events. **Example** ```js -var callback = ()=>{ +let callback = ()=>{ console.info('screenshot happened'); } windowClass.on('screenshot', callback) @@ -2272,7 +2272,7 @@ Binds the modal window to the target window, and adds a callback to listen for m ```js class MyDeathRecipient { onRemoteDied() { - console.log("server died"); + console.log('server died'); } } class TestRemoteObject extends rpc.RemoteObject { @@ -2289,7 +2289,7 @@ class TestRemoteObject extends rpc.RemoteObject { return false; } } -let token = new TestRemoteObject("testObject"); +let token = new TestRemoteObject('testObject'); windowClass.bindDialogTarget(token, () => { console.info('Dialog Window Need Destroy.'); }, (err, data) => { @@ -2329,7 +2329,7 @@ Binds the modal window to the target window, and adds a callback to listen for m ```js class MyDeathRecipient { onRemoteDied() { - console.log("server died"); + console.log('server died'); } } class TestRemoteObject extends rpc.RemoteObject { @@ -2346,7 +2346,7 @@ class TestRemoteObject extends rpc.RemoteObject { return false; } } -let token = new TestRemoteObject("testObject"); +let token = new TestRemoteObject('testObject'); let promise = windowClass.bindDialogTarget(token, () => { console.info('Dialog Window Need Destroy.'); }); @@ -2535,7 +2535,7 @@ Sets the background color for this window. This API uses an asynchronous callbac **Example** ```js -var color = '#00ff33'; +let color = '#00ff33'; windowClass.setBackgroundColor(color, (err, data) => { if (err.code) { console.error('Failed to set the background color. Cause: ' + JSON.stringify(err)); @@ -2568,7 +2568,7 @@ Sets the background color for this window. This API uses a promise to return the **Example** ```js -var color = '#00ff33'; +let color = '#00ff33'; let promise = windowClass.setBackgroundColor(color); promise.then((data)=> { console.info('Succeeded in setting the background color. Data: ' + JSON.stringify(data)); @@ -2596,7 +2596,7 @@ Wakes up the screen. **Example** ```js -var wakeUp = true; +let wakeUp = true; windowClass.setWakeUpScreen(wakeUp); ``` @@ -2618,7 +2618,7 @@ Sets the screen brightness for this window. This API uses an asynchronous callba **Example** ```js -var brightness = 1; +let brightness = 1; windowClass.setBrightness(brightness, (err, data) => { if (err.code) { console.error('Failed to set the brightness. Cause: ' + JSON.stringify(err)); @@ -2651,7 +2651,7 @@ Sets the screen brightness for this window. This API uses a promise to return th **Example** ```js -var brightness = 1; +let brightness = 1; let promise = windowClass.setBrightness(brightness); promise.then((data)=> { console.info('Succeeded in setting the brightness. Data: ' + JSON.stringify(data)); @@ -2748,7 +2748,7 @@ Sets whether this window can gain focus. This API uses an asynchronous callback **Example** ```js -var isFocusable= true; +let isFocusable= true; windowClass.setFocusable(isFocusable, (err, data) => { if (err.code) { console.error('Failed to set the window to be focusable. Cause:' + JSON.stringify(err)); @@ -2781,7 +2781,7 @@ Sets whether this window can gain focus. This API uses a promise to return the r **Example** ```js -var isFocusable= true; +let isFocusable= true; let promise = windowClass.setFocusable(isFocusable); promise.then((data)=> { console.info('Succeeded in setting the window to be focusable. Data: ' + JSON.stringify(data)); @@ -2808,7 +2808,7 @@ Sets whether to keep the screen always on. This API uses an asynchronous callbac **Example** ```js -var isKeepScreenOn = true; +let isKeepScreenOn = true; windowClass.setKeepScreenOn(isKeepScreenOn, (err, data) => { if (err.code) { console.error('Failed to set the screen to be always on. Cause: ' + JSON.stringify(err)); @@ -2841,7 +2841,7 @@ Sets whether to keep the screen always on. This API uses a promise to return the **Example** ```js -var isKeepScreenOn = true; +let isKeepScreenOn = true; let promise = windowClass.setKeepScreenOn(isKeepScreenOn); promise.then((data) => { console.info('Succeeded in setting the screen to be always on. Data: ' + JSON.stringify(data)); @@ -2938,7 +2938,7 @@ Sets whether this window is in privacy mode. This API uses an asynchronous callb **Example** ```js -var isPrivacyMode = true; +let isPrivacyMode = true; windowClass.setPrivacyMode(isPrivacyMode, (err, data) => { if (err.code) { console.error('Failed to set the window to privacy mode. Cause:' + JSON.stringify(err)); @@ -2972,7 +2972,7 @@ Sets whether this window is in privacy mode. This API uses a promise to return t **Example** ```js -var isPrivacyMode = true; +let isPrivacyMode = true; let promise = windowClass.setPrivacyMode(isPrivacyMode); promise.then((data)=> { console.info('Succeeded in setting the window to privacy mode. Data: ' + JSON.stringify(data)); @@ -2996,7 +2996,7 @@ Sets whether to ignore this window during screen capturing or recording. | ------------- | ------- | ---- | -------------------- | | isSkip | boolean | Yes | Whether to ignore the window. The default value is `false`.
The value `true` means that the window is ignored, and `false` means the opposite.
| ```js -var isSkip = true; +let isSkip = true; windowClass.setSnapshotSkip(isSkip); ``` @@ -3018,7 +3018,7 @@ Sets whether this window is touchable. This API uses an asynchronous callback to **Example** ```js -var isTouchable = true; +let isTouchable = true; windowClass.setTouchable(isTouchable, (err, data) => { if (err.code) { console.error('Failed to set the window to be touchable. Cause:' + JSON.stringify(err)); @@ -3052,7 +3052,7 @@ Sets whether this window is touchable. This API uses a promise to return the res **Example** ```js -var isTouchable = true; +let isTouchable = true; let promise = windowClass.setTouchable(isTouchable); promise.then((data)=> { console.info('Succeeded in setting the window to be touchable. Data: ' + JSON.stringify(data)); @@ -3081,7 +3081,7 @@ Sets whether this window is forbidden to move in split-screen mode. This API use **Example** ```js -var isForbidSplitMove = true; +let isForbidSplitMove = true; windowClass.setForbidSplitMove(isForbidSplitMove, (err, data) => { if (err.code) { console.error('Failed to forbid window moving in split screen mode. Cause:' + JSON.stringify(err)); @@ -3117,12 +3117,12 @@ Sets whether this window is forbidden to move in split-screen mode. This API use **Example** ```js -var isForbidSplitMove = true; +let isForbidSplitMove = true; let promise = windowClass.setForbidSplitMove(isForbidSplitMove); promise.then((data)=> { console.info('Succeeded in forbidding window moving in split screen mode. Data: ' + JSON.stringify(data)); }).catch((err)=>{ - console.error('Failed to forbidd window moving in split screen mode. Cause: ' + JSON.stringify(err)); + console.error('Failed to forbid window moving in split screen mode. Cause: ' + JSON.stringify(err)); }); ``` @@ -3333,7 +3333,7 @@ Sets the scale parameters for this window. **Example** ```js -var obj : window.ScaleOptions = { +let obj : window.ScaleOptions = { x : 2.0, y : 1.0, pivotX = 0.5; @@ -3361,7 +3361,7 @@ Sets the rotation parameters for this window. **Example** ```js -var obj : window.RotateOptions = { +let obj : window.RotateOptions = { x : 1.0, y : 1.0, z : 45.0, @@ -3390,7 +3390,7 @@ Sets the translation parameters for this window. **Example** ```js -var obj : window.TranslateOptions = { +let obj : window.TranslateOptions = { x : 100.0, y : 0.0, z : 0.0 @@ -3431,7 +3431,7 @@ controller.animationForHidden = (context : window.TransitionContext) => { context.completeTransition(true) } }, () => { - var obj : window.TranslateOptions = { + let obj : window.TranslateOptions = { x : 100.0, y : 0.0, z : 0.0 @@ -3495,7 +3495,7 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - var windowClass = null; + let windowClass = null; windowStage.getMainWindow((err, data) => { if (err.code) { console.error('Failed to obtain the main window. Cause: ' + JSON.stringify(err)); @@ -3530,7 +3530,7 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - var windowClass = null; + let windowClass = null; let promise = windowStage.getMainWindow(); promise.then((data)=> { windowClass = data; @@ -3565,8 +3565,8 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - var windowClass = null; - windowStage.createSubWindow("mySubWindow", (err, data) => { + let windowClass = null; + windowStage.createSubWindow('mySubWindow', (err, data) => { if (err.code) { console.error('Failed to create the subwindow. Cause: ' + JSON.stringify(err)); return; @@ -3607,8 +3607,8 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - var windowClass = null; - let promise = windowStage.createSubWindow("mySubWindow"); + let windowClass = null; + let promise = windowStage.createSubWindow('mySubWindow'); promise.then((data)=> { windowClass = data; console.info('Succeeded in creating the subwindow. Data: ' + JSON.stringify(data)); @@ -3641,7 +3641,7 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - var windowClass = null; + let windowClass = null; windowStage.getSubWindow((err, data) => { if (err.code) { console.error('Failed to obtain the subwindow. Cause: ' + JSON.stringify(err)); @@ -3676,7 +3676,7 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - var windowClass = null; + let windowClass = null; let promise = windowStage.getSubWindow(); promise.then((data)=> { windowClass = data; @@ -3713,9 +3713,9 @@ class myAbility extends Ability { storage : LocalStorage onWindowStageCreate(windowStage) { this.storage = new LocalStorage(); - this.storage.setOrCreate("storageSimpleProp",121); + this.storage.setOrCreate('storageSimpleProp',121); console.log('onWindowStageCreate'); - windowStage.loadContent("pages/page2",this.storage,(err, data) => { + windowStage.loadContent('pages/page2',this.storage,(err, data) => { if (err.code) { console.error('Failed to load the content. Cause:' + JSON.stringify(err)); return; @@ -3757,10 +3757,10 @@ class myAbility extends Ability { storage : LocalStorage onWindowStageCreate(windowStage) { this.storage = new LocalStorage(); - this.storage.setOrCreate("storageSimpleProp",121); + this.storage.setOrCreate('storageSimpleProp',121); console.log('onWindowStageCreate'); - var windowClass = null; - let promise = windowStage.loadContent("pages/page2",this.storage); + let windowClass = null; + let promise = windowStage.loadContent('pages/page2',this.storage); promise.then((data)=> { windowClass = data; console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data)); @@ -3795,7 +3795,7 @@ import Ability from '@ohos.application.Ability'; class myAbility extends Ability { onWindowStageCreate(windowStage) { console.log('onWindowStageCreate'); - windowStage.loadContent("pages/page2", (err, data) => { + windowStage.loadContent('pages/page2', (err, data) => { if (err.code) { console.error('Failed to load the content. Cause:' + JSON.stringify(err)); return; @@ -3963,7 +3963,7 @@ controller.animationForShown = (context : window.TransitionContext) => { iterations: 1, // Number of playback times. playMode: PlayMode.Normal // Animation playback mode. }, () => { - var obj : window.TranslateOptions = { + let obj : window.TranslateOptions = { x : 100.0, y : 0.0, z : 0.0 @@ -4014,7 +4014,7 @@ controller.animationForShown = (context : window.TransitionContext) => { context.completeTransition(true) } }, () => { - var obj : window.TranslateOptions = { + let obj : window.TranslateOptions = { x : 100.0, y : 0.0, z : 0.0 @@ -4060,7 +4060,7 @@ controller.animationForHidden = (context : window.TransitionContext) => { context.completeTransition(true) } }, () => { - var obj : window.TranslateOptions = { + let obj : window.TranslateOptions = { x : 100.0, y : 0.0, z : 0.0 diff --git a/en/application-dev/reference/apis/js-apis-windowAnimationManager.md b/en/application-dev/reference/apis/js-apis-windowAnimationManager.md index ee3fa7397ef213d615ce3e0f71d094cb3d4fc98e..248e4977d5b215d20a67373e9608c3f6ae1588bb 100644 --- a/en/application-dev/reference/apis/js-apis-windowAnimationManager.md +++ b/en/application-dev/reference/apis/js-apis-windowAnimationManager.md @@ -2,7 +2,6 @@ The **WindowAnimationManager** module provides APIs to listen for application start/exit events and window minimization/maximization events and associate animations with these events. > **NOTE** -> > The APIs of this module are supported since API version 9. Updates will be marked with a superscript to indicate their earliest API version. > > The APIs provided by this module are system APIs. @@ -17,7 +16,9 @@ import windowAnimationManager from '@ohos.animation.windowAnimationManager' setController(controller: WindowAnimationController): void -Sets a window animation controller. +Sets a window animation controller. For details about the controller, see [WindowAnimationController](#windowanimationcontroller). + +Before using other APIs of **windowAnimationManager**, you must call this API to set a window animation controller. **System capability**: SystemCapability.WindowManager.WindowManager.Core @@ -30,23 +31,39 @@ Sets a window animation controller. **Example** ```js -var controller = { - onStartAppFromLauncher(startingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onStartAppFromLauncher', startingWindowTarget); - }, - onStartAppFromRecent(startingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onStartAppFromRecent', startingWindowTarget); +let controller = { + onStartAppFromLauncher(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromLauncher, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onStartAppFromRecent(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromRecent, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onStartAppFromOther(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromOther, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); }, - onStartAppFromOther(startingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onStartAppFromOther', startingWindowTarget); + onAppTransition(fromWindowTarget: windowAnimationManager.WindowAnimationTarget, toWindowTarget: WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onAppTransition, the fromWindowTarget is: ' + fromWindowTarget); + console.log('onAppTransition, the toWindowTarget is: ' + toWindowTarget); + finishCallback.onAnimationFinish(); }, - onAppTransition(fromWindowTarget: WindowAnimationTarget, toWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { + onMinimizeWindow(minimizingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onMinimizeWindow, the minimizingWindowTarget is: ' + minimizingWindowTarget); + finishCallback.onAnimationFinish(); }, - onMinimizeWindow(minimizingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { + onCloseWindow(closingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onCloseWindow, the closingWindowTarget is: ' + closingWindowTarget); + finishCallback.onAnimationFinish(); }, - onCloseWindow(closingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { + onScreenUnlock(finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onScreenUnlock called'); + finishCallback.onAnimationFinish(); }, - onScreenUnlock(finishCallback: WindowAnimationFinishedCallback): void { + onWindowAnimationTargetsUpdate(fullScreenWindowTarget: windowAnimationManager.WindowAnimationTarget, floatingWindowTargets: Array): void{ + console.log('onWindowAnimationTargetsUpdate, the fullScreenWindowTarget is: ' + fullScreenWindowTarget); + console.log('onWindowAnimationTargetsUpdate, the floatingWindowTargets are: ' + floatingWindowTargets); } } @@ -71,16 +88,46 @@ Minimizes the window that displays the animation. This API uses an asynchronous **Example** ```js -var target: WindowAnimationTarget = undefined; -var controller = { - onWindowAnimationTargetsUpdate(fullScreenWindowTarget: WindowAnimationTarget, floatingWindowTargets: Array): void { - target = fullScreenWindowTarget; - }, +let target: WindowAnimationTarget = undefined; +let controller = { + onStartAppFromLauncher(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromLauncher, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onStartAppFromRecent(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromRecent, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onStartAppFromOther(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromOther, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onAppTransition(fromWindowTarget: windowAnimationManager.WindowAnimationTarget, toWindowTarget: WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onAppTransition, the fromWindowTarget is: ' + fromWindowTarget); + console.log('onAppTransition, the toWindowTarget is: ' + toWindowTarget); + finishCallback.onAnimationFinish(); + }, + onMinimizeWindow(minimizingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onMinimizeWindow, the minimizingWindowTarget is: ' + minimizingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onCloseWindow(closingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onCloseWindow, the closingWindowTarget is: ' + closingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onScreenUnlock(finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onScreenUnlock called'); + finishCallback.onAnimationFinish(); + }, + onWindowAnimationTargetsUpdate(fullScreenWindowTarget: windowAnimationManager.WindowAnimationTarget, floatingWindowTargets: Array): void{ + console.log('onWindowAnimationTargetsUpdate, the fullScreenWindowTarget is: ' + fullScreenWindowTarget); + console.log('onWindowAnimationTargetsUpdate, the floatingWindowTargets are: ' + floatingWindowTargets); + } } windowAnimationManager.setController(controller) -var finishedCallback = null; +let finishedCallback = null; windowAnimationManager.minimizeWindowWithAnimation(target, (err, data) => { if (err.code) { console.error('Failed to minimize the window target. Cause: ' + JSON.stringify(err)); @@ -117,11 +164,41 @@ Minimizes the window that displays the animation. This API uses a promise to ret **Example** ```js -var target: WindowAnimationTarget = undefined; -var controller = { - onWindowAnimationTargetsUpdate(fullScreenWindowTarget: WindowAnimationTarget, floatingWindowTargets: Array): void { - target = fullScreenWindowTarget; - }, +let target: WindowAnimationTarget = undefined; +let controller = { + onStartAppFromLauncher(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromLauncher, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onStartAppFromRecent(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromRecent, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onStartAppFromOther(startingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onStartAppFromOther, the startingWindowTarget is: ' + startingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onAppTransition(fromWindowTarget: windowAnimationManager.WindowAnimationTarget, toWindowTarget: WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onAppTransition, the fromWindowTarget is: ' + fromWindowTarget); + console.log('onAppTransition, the toWindowTarget is: ' + toWindowTarget); + finishCallback.onAnimationFinish(); + }, + onMinimizeWindow(minimizingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onMinimizeWindow, the minimizingWindowTarget is: ' + minimizingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onCloseWindow(closingWindowTarget: windowAnimationManager.WindowAnimationTarget, finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onCloseWindow, the closingWindowTarget is: ' + closingWindowTarget); + finishCallback.onAnimationFinish(); + }, + onScreenUnlock(finishCallback: windowAnimationManager.WindowAnimationFinishedCallback): void { + console.log('onScreenUnlock called'); + finishCallback.onAnimationFinish(); + }, + onWindowAnimationTargetsUpdate(fullScreenWindowTarget: windowAnimationManager.WindowAnimationTarget, floatingWindowTargets: Array): void{ + console.log('onWindowAnimationTargetsUpdate, the fullScreenWindowTarget is: ' + fullScreenWindowTarget); + console.log('onWindowAnimationTargetsUpdate, the floatingWindowTargets are: ' + floatingWindowTargets); + } } windowAnimationManager.setController(controller) @@ -137,7 +214,7 @@ promise.then((data) => { ## WindowAnimationController -Implements the window animation controller. +Implements the window animation controller. When creating a **WindowAnimationController** object, you must implement all callbacks in the object. **System capability**: SystemCapability.WindowManager.WindowManager.Core @@ -156,13 +233,7 @@ Called when an application is started from the home screen. **Example** -```js -var controller = { - onStartAppFromLauncher(startingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onStartAppFromLauncher', startingWindowTarget); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onStartAppFromRecent @@ -179,13 +250,7 @@ Called when an application is started from the recent task list. **Example** -```js -var controller = { - onStartAppFromRecent(startingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onStartAppFromRecent', startingWindowTarget); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onStartAppFromOther @@ -202,13 +267,7 @@ Called when an application is started from a place other than the home screen an **Example** -```js -var controller = { - onStartAppFromOther(startingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onStartAppFromOther', startingWindowTarget); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onAppTransition @@ -226,14 +285,7 @@ Called during application transition. **Example** -```js -var controller = { - onAppTransition(fromWindowTarget: WindowAnimationTarget, toWindowTarget: WindowAnimationTarget, - finishCallback: WindowAnimationFinishedCallback): void { - console.log('onAppTransition', fromWindowTarget); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onMinimizeWindow @@ -250,13 +302,7 @@ Called when a window is minimized. **Example** -```js -var controller = { - onMinimizeWindow(minimizingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onMinimizeWindow', minimizingWindowTarget); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onCloseWindow @@ -273,13 +319,7 @@ Called when a window is closed. **Example** -```js -var controller = { - onCloseWindow(closingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - console.log('onCloseWindow', closingWindowTarget); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onScreenUnlock @@ -295,13 +335,7 @@ Called when the screen is unlocked. **Example** -```js -var controller = { - onScreenUnlock(finishCallback: WindowAnimationFinishedCallback): void { - console.log('onScreenUnlock'.); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ### onWindowAnimationTargetsUpdate @@ -318,15 +352,7 @@ Called when the window that displays the animation is updated. **Example** -```js -var controller = { - onWindowAnimationTargetsUpdate(fullScreenWindowTarget: WindowAnimationTarget, floatingWindowTargets: Array): void { - console.log('onWindowAnimationTargetsUpdate'.); - } -} - -windowAnimationManager.setController(controller) -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ## WindowAnimationFinishedCallback Implements a callback that is invoked when the animation is finished. @@ -341,13 +367,7 @@ Called when the animation is finished. **Example** -```js -var controller = { - onCloseWindow(closingWindowTarget: WindowAnimationTarget, finishCallback: WindowAnimationFinishedCallback): void { - finishCallback.onAnimationFinish(); - } -} -``` +For details, see the sample code under [windowAnimationManager.setController](#windowanimationmanagersetcontroller). ## WindowAnimationTarget Defines a window to display animation. diff --git a/en/application-dev/reference/apis/js-apis-workScheduler.md b/en/application-dev/reference/apis/js-apis-workScheduler.md index 725b313ba88bedca924f0f5f1d2f6166308d2b8f..d897bc91717348ee8addd00751741f83cc77c345 100644 --- a/en/application-dev/reference/apis/js-apis-workScheduler.md +++ b/en/application-dev/reference/apis/js-apis-workScheduler.md @@ -8,12 +8,13 @@ The system executes Work Scheduler tasks at an appropriate time, subject to the > > - The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. > - The APIs of this module can be used only in the stage model. +> - For details about the constraints on the Work Scheduler usage, see [Work Scheduler Overview](../../task-management/work-scheduler-overview.md). ## Modules to Import ```js -import workScheduler from '@ohos.workScheduler' +import workScheduler from '@ohos.workScheduler'; ``` ## workScheduler.startWork @@ -53,7 +54,7 @@ Instructs the **WorkSchedulerService** to add the specified task to the executio } } var res = workScheduler.startWork(workInfo); - console.info("workschedulerLog res:" + res); + console.info(`workschedulerLog res: ${res}`); ``` ## workScheduler.stopWork @@ -94,7 +95,7 @@ Instructs the **WorkSchedulerService** to stop the specified task. } } var res = workScheduler.stopWork(workInfo, false); - console.info("workschedulerLog res:" + res); + console.info(`workschedulerLog res: ${res}`); ``` ## workScheduler.getWorkStatus @@ -116,10 +117,10 @@ Obtains the latest task status. This API uses an asynchronous callback to return ```js workScheduler.getWorkStatus(50, (err, res) => { if (err) { - console.info('workschedulerLog getWorkStatus failed, because:' + err.code); + console.info(`workschedulerLog getWorkStatus failed, because: ${err.code}`); } else { for (let item in res) { - console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); + console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`); } } }); @@ -149,10 +150,10 @@ Obtains the latest task status. This API uses a promise to return the result. ```js workScheduler.getWorkStatus(50).then((res) => { for (let item in res) { - console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); + console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`); } }).catch((err) => { - console.info('workschedulerLog getWorkStatus failed, because:' + err.code); + console.info(`workschedulerLog getWorkStatus failed, because: ${err.code}`); }) ``` @@ -167,7 +168,7 @@ Obtains all tasks associated with this application. This API uses an asynchronou | Name | Type | Mandatory | Description | | -------- | -------------------- | ---- | ------------------------------- | -| callback | AsyncCallback\ | Yes | Callback used to return all tasks associated with the current application.| +| callback | AsyncCallback\ | Yes | Callback used to return all tasks associated with the current application. | **Return value** @@ -180,9 +181,9 @@ Obtains all tasks associated with this application. This API uses an asynchronou ```js workScheduler.obtainAllWorks((err, res) =>{ if (err) { - console.info('workschedulerLog obtainAllWorks failed, because:' + err.code); + console.info(`workschedulerLog obtainAllWorks failed, because: ${err.code}`); } else { - console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); + console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`); } }); ``` @@ -198,15 +199,15 @@ Obtains all tasks associated with this application. This API uses a promise to r | Type | Description | | -------------------------------------- | ------------------------------ | -| Promise> | Promise used to return all tasks associated with the current application.| +| Promise> | Promise used to return all tasks associated with the current application. | **Example** ```js workScheduler.obtainAllWorks().then((res) => { - console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); + console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`); }).catch((err) => { - console.info('workschedulerLog obtainAllWorks failed, because:' + err.code); + console.info(`workschedulerLog obtainAllWorks failed, because: ${err.code}`); }) ``` @@ -221,7 +222,7 @@ Stops and cancels all tasks associated with the current application. ```js let res = workScheduler.stopAndClearWorks(); - console.info("workschedulerLog res:" + res); + console.info(`workschedulerLog res: ${res}`); ``` ## workScheduler.isLastWorkTimeOut @@ -249,9 +250,9 @@ Checks whether the last execution of the specified task timed out. This API uses ```js workScheduler.isLastWorkTimeOut(500, (err, res) =>{ if (err) { - console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code); + console.info(`workschedulerLog isLastWorkTimeOut failed, because: ${err.code}`); } else { - console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); + console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`); } }); ``` @@ -280,10 +281,10 @@ Checks whether the last execution of the specified task timed out. This API uses ```js workScheduler.isLastWorkTimeOut(500) .then(res => { - console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); + console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`); }) .catch(err => { - console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.code); + console.info(`workschedulerLog isLastWorkTimeOut failed, because: ${err.code}`); }); ``` diff --git a/en/application-dev/reference/apis/js-apis-worker.md b/en/application-dev/reference/apis/js-apis-worker.md index 067897c8c6f4d3292683d63b4288a7fc987c578c..5aa129293c705d4c8c9ce5eaf78ac2a6f7960662 100644 --- a/en/application-dev/reference/apis/js-apis-worker.md +++ b/en/application-dev/reference/apis/js-apis-worker.md @@ -8,7 +8,7 @@ The worker thread is an independent thread running in parallel with the main thr ## Modules to Import -``` +```js import worker from '@ohos.worker'; ``` @@ -28,10 +28,11 @@ Provides options that can be set for the **Worker** instance to create. **System capability**: SystemCapability.Utils.Lang -| Name| Type | Readable| Writable| Description | -| ---- | --------- | ---- | ---- | ---------------------- | -| type | "classic" | Yes | Yes | Mode in which the worker thread executes the script.| -| name | string | Yes | Yes | Name of the worker thread. | +| Name | Type | Readable| Writable| Description | +| ------ | --------- | ---- | ---- | ---------------------- | +| type | "classic" | Yes | Yes | Mode in which the worker thread executes the script.| +| name | string | Yes | Yes | Name of the worker thread. | +| shared | boolean | Yes | Yes | Whether the worker can be shared.| ## Worker @@ -51,7 +52,7 @@ A constructor used to create a **Worker** instance. | Name | Type | Mandatory| Description | | --------- | ------------------------------- | ---- | ------------------------------------------------------------ | -| scriptURL | string | Yes | URL of the script to be executed by the Worker thread. The script is stored in the **workers** directory, which is in the same directory as the **pages** directory of the new DevEco Studio project. If the **workers** directory does not exist, you need to create it.| +| scriptURL | string | Yes | URL of the script to be executed by the worker thread.
In the FA or stage model, DevEco Studio creates a **Worker** project in either of the following scenarios:
(a) The **workers** directory is at the same level as the **pages** directory.
(b) The **workers** directory is at a different level from the **pages** directory. | options | [WorkerOptions](#workeroptions) | No | Options that can be set for the **Worker** instance. | **Return value** @@ -62,11 +63,69 @@ A constructor used to create a **Worker** instance. **Example** +```js +import worker from '@ohos.worker'; +// Create a worker thread. + +// In the FA model, the workers and pages directories are at the same level. +const workerFAModel01 = new worker.Worker("workers/worker.js", {name:"first worker"}); +// In the FA model, the workers and pages directories are at different levels. +const workerFAModel02 = new worker.Worker("../workers/worker.js", {name:"first worker"}); + +// In the stage model, the workers and pages directories are at the same level. +const workerStageModel01 = new worker.Worker('entry/ets/workers/worker.ts'); +// In the stage model, the workers and pages directories are at different levels. +const workerStageModel02 = new worker.Worker('entry/ets/pages/workers/worker.ts'); + +// scriptURL—— Description of "entry/ets/workers/worker.ts". +// entry is the value of the name attribute under module in the module.json5 file. +// ets indicates the programming language in use. +``` +Depending on whether the works and pages directories are at the same level, you may need to configure the **buildOption** attribute in the **build-profile.json5** file. + +(1) If the workers and pages directories are at the same level, the configuration is optional. +In the FA model: + +```json + "buildOption": { + "sourceOption": { + "workers": [ + "./src/main/ets/MainAbility/workers/worker.ts" + ] + } + } +``` +In the stage model: +```json + "buildOption": { + "sourceOption": { + "workers": [ + "./src/main/ets/workers/worker.ts" + ] + } + } +``` +(2) If the workers and pages directories are at different levels, the configuration is mandatory. +In the FA model: +```json + "buildOption": { + "sourceOption": { + "workers": [ + "./src/main/ets/workers/worker.ts" + ] + } + } +``` +In the stage model: +```json + "buildOption": { + "sourceOption": { + "workers": [ + "./src/main/ets/pages/workers/worker.ts" + ] + } + } ``` -const workerInstance = new worker.Worker("workers/worker.js", {name:"first worker"}); -``` - - ### postMessage postMessage(message: Object, options?: PostMessageOptions): void @@ -84,13 +143,11 @@ Sends a message to the worker thread. The message data is transferred using the **Example** -``` +```js const workerInstance = new worker.Worker("workers/worker.js"); + workerInstance.postMessage("hello world"); -``` -``` -const workerInstance= new worker.Worker("workers/worker.js"); var buffer = new ArrayBuffer(8); workerInstance.postMessage(buffer, [buffer]); ``` @@ -113,8 +170,8 @@ Adds an event listener for the worker instance. **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") +```js +const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.on("alert", (e)=>{ console.log("alert listener callback"); }) @@ -138,7 +195,7 @@ Adds an event listener for the worker thread and removes the event listener afte **Example** -``` +```js const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.once("alert", (e)=>{ console.log("alert listener callback"); @@ -163,7 +220,7 @@ Removes an event listener for the worker thread. **Example** -``` +```js const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.off("alert"); ``` @@ -179,9 +236,9 @@ Terminates the worker thread to stop it from receiving messages. **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") -workerInstance.terminate() +```js +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.terminate(); ``` @@ -201,10 +258,10 @@ Defines the event handler to be called when the worker thread exits. The handler **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") +```js +const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.onexit = function(e) { - console.log("onexit") + console.log("onexit"); } ``` @@ -225,17 +282,17 @@ Defines the event handler to be called when an exception occurs during worker ex **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") +```js +const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.onerror = function(e) { - console.log("onerror") + console.log("onerror"); } ``` ### onmessage -onmessage?: (event: MessageEvent) => void +onmessage?: (event: MessageEvent\) => void Defines the event handler to be called when the host thread receives a message sent by the worker thread through **parentPort.postMessage**. The event handler is executed in the host thread. @@ -249,17 +306,19 @@ Defines the event handler to be called when the host thread receives a message s **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") +```js +const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.onmessage = function(e) { - console.log("onerror") + // e: MessageEvent. The usage is as follows: + // let data = e.data; + console.log("onmessage"); } ``` ### onmessageerror -onmessageerror?: (event: MessageEvent) => void +onmessageerror?: (event: MessageEvent\) => void Defines the event handler to be called when the worker thread receives a message that cannot be serialized. The event handler is executed in the host thread. @@ -273,10 +332,10 @@ Defines the event handler to be called when the worker thread receives a message **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") +```js +const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.onmessageerror= function(e) { - console.log("onmessageerror") + console.log("onmessageerror"); } ``` @@ -301,8 +360,8 @@ Adds an event listener for the worker thread. **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") +```js +const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.addEventListener("alert", (e)=>{ console.log("alert listener callback"); }) @@ -326,9 +385,9 @@ Removes an event listener for the worker thread. **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") -workerInstance.removeEventListener("alert") +```js +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.removeEventListener("alert"); ``` @@ -354,9 +413,9 @@ Dispatches the event defined for the worker thread. **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") -workerInstance.dispatchEvent({type:"alert"}) +```js +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.dispatchEvent({type:"alert"}); ``` @@ -370,9 +429,9 @@ Removes all event listeners for the worker thread. **Example** -``` -const workerInstance = new worker.Worker("workers/worker.js") -workerInstance.removeAllListener({type:"alert"}) +```js +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.removeAllListener(); ``` @@ -383,7 +442,7 @@ Implements communication between the worker thread and the host thread. The **po ### postMessage -postMessage(message: Object, options?: PostMessageOptions): void +postMessage(messageObject: Object, options?: PostMessageOptions): void Sends a message to the host thread from the worker thread. @@ -398,22 +457,23 @@ Sends a message to the host thread from the worker thread. **Example** -``` +```js // main.js import worker from '@ohos.worker'; -const workerInstance = new worker.Worker("workers/worker.js") -workerInstance.postMessage("hello world") +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.postMessage("hello world"); workerInstance.onmessage = function(e) { - console.log("receive data from worker.js") + // let data = e.data; + console.log("receive data from worker.js"); } ``` - -``` +```js // worker.js import worker from '@ohos.worker'; const parentPort = worker.parentPort; parentPort.onmessage = function(e){ - parentPort.postMessage("receive data from main.js") + // let data = e.data; + parentPort.postMessage("receive data from main.js"); } ``` @@ -428,13 +488,12 @@ Terminates the worker thread to stop it from receiving messages. **Example** -``` +```js // main.js import worker from '@ohos.worker'; -const workerInstance = new worker.Worker("workers/worker.js") -``` - +const workerInstance = new worker.Worker("workers/worker.js"); ``` +```js // worker.js import worker from '@ohos.worker'; const parentPort = worker.parentPort; @@ -446,7 +505,7 @@ parentPort.onmessage = function(e) { ### onmessage -onmessage?: (event: MessageEvent) => void +onmessage?: (event: MessageEvent\) => void Defines the event handler to be called when the worker thread receives a message sent by the host thread through **worker.postMessage**. The event handler is executed in the worker thread. @@ -460,26 +519,25 @@ Defines the event handler to be called when the worker thread receives a message **Example** -``` +```js // main.js import worker from '@ohos.worker'; -const workerInstance = new worker.Worker("workers/worker.js") -workerInstance.postMessage("hello world") -``` - +const workerInstance = new worker.Worker("workers/worker.js"); +workerInstance.postMessage("hello world"); ``` +```js // worker.js import worker from '@ohos.worker'; const parentPort = worker.parentPort; parentPort.onmessage = function(e) { - console.log("receive main.js message") + console.log("receive main.js message"); } ``` ### onmessageerror -onmessageerror?: (event: MessageEvent) => void +onmessageerror?: (event: MessageEvent\) => void Defines the event handler to be called when the worker thread receives a message that cannot be deserialized. The event handler is executed in the worker thread. @@ -493,13 +551,12 @@ Defines the event handler to be called when the worker thread receives a message **Example** -``` +```js // main.js import worker from '@ohos.worker'; -const workerInstance = new worker.Worker("workers/worker.js") -``` - +const workerInstance = new worker.Worker("workers/worker.js"); ``` +```js // worker.js import worker from '@ohos.worker'; const parentPort = worker.parentPort; @@ -557,7 +614,7 @@ Specifies the callback to invoke. **Example** -``` +```js const workerInstance = new worker.Worker("workers/worker.js"); workerInstance.addEventListener("alert", (e)=>{ console.log("alert listener callback"); @@ -621,13 +678,12 @@ Defines the event handler to be called when an exception occurs during worker ex **Example** -``` +```js // main.js import worker from '@ohos.worker'; const workerInstance = new worker.Worker("workers/worker.js") ``` - -``` +```js // worker.js import worker from '@ohos.worker'; const parentPort = worker.parentPort @@ -635,3 +691,98 @@ parentPort.onerror = function(e){ console.log("worker.js onerror") } ``` + +## Sample Code +### FA Model +```js +// main.js (The following assumes that the workers and pages directories are at the same level.) +import worker from '@ohos.worker'; +const workerInstance = new worker.Worker("workers/worker.ts"); +// Create either a .json or .ts file. +// const workerInstance = new worker.Worker("workers/worker.js"); + +workerInstance.postMessage("123"); +workerInstance.onmessage = function(e) { + let data = e.data; + console.log("main.js onmessage"); + // Call terminate after the worker thread receives messages. + workerInstance.terminate(); +} +// Call onexit. +workerInstance.onexit = function() { + console.log("main.js terminate"); +} +``` +```js +// worker.js +import worker from '@ohos.worker'; +const parentPort = worker.parentPort + +parentPort.onmessage = function(e) { + let data = e.data; + console.log("worker.js onmessage"); + parentPort.postMessage("123") +} + +parentPort.onerror= function(e) { + console.log("worker.js onerror"); +} +``` +Configuration of the **build-profile.json5** file: +```json + "buildOption": { + "sourceOption": { + "workers": [ + "./src/main/ets/MainAbility/workers/worker.ts" + ] + } + } +``` +### Stage Model +```js +// main.js (The following assumes that the workers and pages directories are at different levels.) +import worker from '@ohos.worker'; +const workerInstance = new worker.Worker("entry/ets/pages/workers/worker.ts"); +// Create either a .json or .ts file. +// const workerInstance = new worker.Worker("entry/ets/pages/workers/worker.js"); +workerInstance.postMessage("123"); +workerInstance.onmessage = function(e) { + let data = e.data; + console.log("main.js onmessage"); + // Call terminate after the worker thread receives messages. + workerInstance.terminate(); +} +// Call onexit. +workerInstance.onexit = function() { + console.log("main.js terminate"); +} +``` +```js +// worker.js +import worker from '@ohos.worker'; +const parentPort = worker.parentPort + +parentPort.onmessage = function(e) { + let data = e.data; + console.log("worker.js onmessage"); + parentPort.postMessage("123") +} + +parentPort.onerror= function(e) { + console.log("worker.js onerror"); +} +``` +Configuration of the **build-profile.json5** file: +```json + "buildOption": { + "sourceOption": { + "workers": [ + "./src/main/ets/pages/workers/worker.ts" + ] + } + } +``` + +## Precautions +Currently, a maximum of seven workers can co-exist. +If the number of workers exceeds the upper limit, the error message "Too many workers, the number of workers exceeds the maximum." is displayed. diff --git a/en/application-dev/reference/apis/js-apis-xml.md b/en/application-dev/reference/apis/js-apis-xml.md index c7d28fe1bf86073c4453ea9e2cf9cbcb3698062e..322a8000a525eef6e32174a2a099f04573570edc 100644 --- a/en/application-dev/reference/apis/js-apis-xml.md +++ b/en/application-dev/reference/apis/js-apis-xml.md @@ -32,9 +32,9 @@ A constructor used to create an **XmlSerializer** instance. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var bufView = new DataView(arrayBuffer); -var thatSer = new xml.XmlSerializer(bufView); +let arrayBuffer = new ArrayBuffer(1024); +let bufView = new DataView(arrayBuffer); +let thatSer = new xml.XmlSerializer(bufView); ``` @@ -56,9 +56,9 @@ Sets an attribute. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var bufView = new DataView(arrayBuffer); -var thatSer = new xml.XmlSerializer(bufView); +let arrayBuffer = new ArrayBuffer(1024); +let bufView = new DataView(arrayBuffer); +let thatSer = new xml.XmlSerializer(bufView); thatSer.setAttributes("importance", "high"); ``` @@ -80,9 +80,9 @@ Adds an empty element. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var bufView = new DataView(arrayBuffer); -var thatSer = new xml.XmlSerializer(bufView); +let arrayBuffer = new ArrayBuffer(1024); +let bufView = new DataView(arrayBuffer); +let thatSer = new xml.XmlSerializer(bufView); thatSer.addEmptyElement("b"); // => ``` @@ -98,9 +98,9 @@ Sets a declaration. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var bufView = new DataView(arrayBuffer); -var thatSer = new xml.XmlSerializer(bufView); +let arrayBuffer = new ArrayBuffer(1024); +let bufView = new DataView(arrayBuffer); +let thatSer = new xml.XmlSerializer(bufView); thatSer.setDeclaration() // => ; ``` @@ -122,8 +122,8 @@ Writes the start tag based on the given element name. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var thatSer = new xml.XmlSerializer(arrayBuffer); +let arrayBuffer = new ArrayBuffer(1024); +let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.startElement("notel"); thatSer.endElement();// => ''; ``` @@ -140,9 +140,9 @@ Writes the end tag of the element. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var bufView = new DataView(arrayBuffer); -var thatSer = new xml.XmlSerializer(bufView); +let arrayBuffer = new ArrayBuffer(1024); +let bufView = new DataView(arrayBuffer); +let thatSer = new xml.XmlSerializer(bufView); thatSer.setNamespace("h", "http://www.w3.org/TR/html4/"); thatSer.startElement("table"); thatSer.setAttributes("importance", "high"); @@ -169,8 +169,8 @@ Sets the namespace for an element tag. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var thatSer = new xml.XmlSerializer(arrayBuffer); +let arrayBuffer = new ArrayBuffer(1024); +let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.setDeclaration(); thatSer.setNamespace("h", "http://www.w3.org/TR/html4/"); thatSer.startElement("note"); @@ -194,8 +194,8 @@ Sets the comment. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var thatSer = new xml.XmlSerializer(arrayBuffer); +let arrayBuffer = new ArrayBuffer(1024); +let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.startElement("note"); thatSer.setComment("Hi!"); thatSer.endElement(); // => '\r\n \r\n'; @@ -219,8 +219,8 @@ Sets CDATA attributes. **Example** ```js -var arrayBuffer = new ArrayBuffer(1028); -var thatSer = new xml.XmlSerializer(arrayBuffer); +let arrayBuffer = new ArrayBuffer(1028); +let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.setCDATA('root SYSTEM') // => ''; ``` @@ -242,8 +242,8 @@ Sets **Text**. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var thatSer = new xml.XmlSerializer(arrayBuffer); +let arrayBuffer = new ArrayBuffer(1024); +let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.startElement("note"); thatSer.setAttributes("importance", "high"); thatSer.setText("Happy1"); @@ -268,8 +268,8 @@ Sets **DocType**. **Example** ```js -var arrayBuffer = new ArrayBuffer(1024); -var thatSer = new xml.XmlSerializer(arrayBuffer); +let arrayBuffer = new ArrayBuffer(1024); +let thatSer = new xml.XmlSerializer(arrayBuffer); thatSer.setDocType('root SYSTEM'); // => ''; ``` @@ -295,20 +295,20 @@ Creates and returns an **XmlPullParser** object. The **XmlPullParser** object pa **Example** ```js -var strXml = +let strXml = '' + '' + ' Happy' + ' Work' + ' Play' + ''; -var arrayBuffer = new ArrayBuffer(strXml.length*2); -var bufView = new Uint8Array(arrayBuffer); -var strLen = strXml.length; +let arrayBuffer = new ArrayBuffer(strXml.length); +let bufView = new Uint8Array(arrayBuffer); +let strLen = strXml.length; for (var i = 0; i < strLen; ++i) { bufView[i] = strXml.charCodeAt(i);// Set the ArrayBuffer mode. } -var that = new xml.XmlPullParser(arrayBuffer); +let that = new xml.XmlPullParser(arrayBuffer); ``` @@ -329,37 +329,37 @@ Parses XML information. **Example** ```js -var strXml = +let strXml = '' + '' + ' Happy' + ' Work' + ' Play' + ''; -var arrayBuffer = new ArrayBuffer(strXml.length*2); -var bufView = new Uint8Array(arrayBuffer); -var strLen = strXml.length; -for (var i = 0; i < strLen; ++i) { - bufView[i] = strXml.charCodeAt(i); +let arrayBuffer = new ArrayBuffer(strXml.length); +let bufView = new Uint8Array(arrayBuffer); +let strLen = strXml.length; +for (var tmp = 0; tmp < strLen; ++tmp) { + bufView[tmp] = strXml.charCodeAt(tmp); } -var that = new xml.XmlPullParser(arrayBuffer); -var arrTag = {}; -var str = ""; -var i = 0; +let that = new xml.XmlPullParser(arrayBuffer); +let arrTag = {}; +let str = ""; +let i = 0; function func(key, value){ arrTag[i] = 'key:'+key+' value:'+ value.getDepth(); str += arrTag[i]; i++; return true; // Determines whether to continuely parse, which is used to continue or terminate parsing. } -var options = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func} +let options = {supportDoctype:true, ignoreNameSpace:true, tokenValueCallbackFunction:func} that.parse(options); console.log(str); // Output: // key:0 value:0key:2 value:1key:10 value:1key:2 value:2key:4 value:2key:3 value:2key:10 value:1key:2 value:2key:4 value:2key:3 value:2key:10 value:1key:2 value:2key:4 value:2key:3 value:2key:3 value:1key:1 value:0 -// Notes: -// The key represents the current event type, and the value represents the depth of the current parsing. You can know the parsed event according to EVENTTYPE. For example, the result 'key: value' in this example means: -// 0(START_DOCUMENT):0(Parse to the START_DOCUMENT, and the depth is 0), 2(START_TAG):1(Parse to the START_TAG node, and the depth is 1), 10(WHITESPACE):1(Parse to the WHITESPACE space, and the depth is 1), 2(START_TAG):2(Parse to the START_TAG title, and the depth is 2), ... +// Note: +// key indicates the event type, and value indicates the parsing depth. You can learn the specific parsed event based on EVENTTYPE. In this example, key: value means: +// 0(START_DOCUMENT):0 (START_DOCUMENT is being parsed, and the depth is 0), 2(START_TAG):1 (START_TAG is being parsed, and the depth is 1), 10(WHITESPACE):1 (WHITESPACE is being parsed, and the depth is 1), 2(START_TAG):2 (START_TAG is being parsed, and the depth is 2), ... ``` @@ -387,7 +387,7 @@ Provides APIs to manage the parsed XML information. getColumnNumber(): number -Obtains the column line number, which starts from 1. +Obtains the column line number, starting from 1. **System capability**: SystemCapability.Utils.Lang diff --git a/en/application-dev/reference/arkui-js/js-components-basic-input.md b/en/application-dev/reference/arkui-js/js-components-basic-input.md index 1f10982593566d8ad21467a9613d260ab6e6a3ec..2ce4c7d3b07a6e8dbdcd47c4d3143ec8e4b285df 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-input.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-input.md @@ -20,44 +20,44 @@ Not supported In addition to the [universal attributes](../arkui-js/js-components-common-attributes.md), the following attributes are supported. -| Name | Type | Default Value | Mandatory| Description | -| -------------------------------- | ----------------------- | --------- | ---- | ------------------------------------------------------------ | -| type | string | text
| No | Type of the input component. Available values include **text**, **email**, **date**, **time**, **number**, **password**, **button**, **checkbox**, and **radio**.
The **text**, **email**, **date**, **time**, **number**, and **password** types can be dynamically switched and modified.
The **button**, **checkbox**, and **radio** types cannot be dynamically modified.
- **button**: a button that can be clicked.
- **checkbox**: a check box.
- **radio**: a radio button that allows users to select one from multiple others with the same name.
- **text**: a single-line text field.
- **email**: a field used for an email address.
- **date**: date component, including the year, month, and day, but excluding time.
- **time**: time component, without the time zone.
- **number**: field for entering digits.
- **password**: password field, in which characters will be shielded.| -| checked | boolean | false | No | Whether the **\** component is selected. This attribute is valid only when **type** is set to **checkbox** or **radio**. | -| name | string | - | No | Name of the **\** component.
This attribute is mandatory when **type** is set to **radio**. | -| value | string | - | No | Value of the **\** component. When **type** is **radio**, this attribute is mandatory and the value must be unique for radio buttons with the same name.| -| placeholder | string | - | No | Content of the hint text. This attribute is available only when the component type is set to **text**, **email**, **date**, **time**, **number**, or **password**.| -| maxlength | number | - | No | Maximum number of characters that can be entered in the input box. The empty value indicates no limit.| -| enterkeytype | string | default | No | Type of the **Enter** key on the soft keyboard. The value cannot be dynamically updated.
Available values include:
- default
- next
- go
- done
- send
- search
Except for the **next** type, clicking the Enter key hides the soft keyboard.| -| headericon | string | - | No | Icon resource path before text input. This icon does not support click events and is unavailable for **button**, **checkbox**, and **radio** types. The supported icon image formats are JPG, PNG, and SVG.| -| showcounter5+ | boolean | false | No | Whether to display the character counter for an input box. This attribute takes effect only when **maxlength** is set. | -| menuoptions5+ | Array<MeunOption> | - | No | Menu options displayed after users click the **More** button. | -| autofocus6+ | boolean | false | No | Whether to automatically obtain focus.
This attribute setting does not take effect on the application home page. You can enable a text box on the home page to automatically obtain focus, by delaying the **focus** method call (for about 100–500 ms) in **onActive**.| -| selectedstart6+ | number | -1 | No | Start position for text selection. | -| selectedend6+ | number | -1 | No | End position for text selection. | -| softkeyboardenabled6+ | boolean | true | No | Whether to display the soft keyboard during editing. | -| showpasswordicon6+ | boolean | true | No | Whether to display the icon at the end of the password text box. This attribute is available only when **type** is set to **password**. | +| Name | Type | Default Value | Mandatory | Description | +| -------------------------------- | ----------------------- | ------------- | --------- | ---------------------------------------- | +| type | string | text
| No | Type of the input component. Available values include **text**, **email**, **date**, **time**, **number**, **password**, **button**, **checkbox**, and **radio**.
The **text**, **email**, **date**, **time**, **number**, and **password** types can be dynamically switched and modified.
The **button**, **checkbox**, and **radio** types cannot be dynamically modified.
- **button**: a button that can be clicked.
- **checkbox**: a check box.
- **radio**: a radio button that allows users to select one from multiple others with the same name.
- **text**: a single-line text field.
- **email**: a field used for an email address.
- **date**: date component, including the year, month, and day, but excluding time.
- **time**: time component, without the time zone.
- **number**: field for entering digits.
- **password**: password field, in which characters will be shielded. | +| checked | boolean | false | No | Whether the **\** component is selected. This attribute is valid only when **type** is set to **checkbox** or **radio**. | +| name | string | - | No | Name of the **\** component.
This attribute is mandatory when **type** is set to **radio**. | +| value | string | - | No | Value of the **\** component. When **type** is **radio**, this attribute is mandatory and the value must be unique for radio buttons with the same name. | +| placeholder | string | - | No | Content of the hint text. This attribute is available only when the component type is set to **text** \|email\|date\|time\|number\|**password**. | +| maxlength | number | - | No | Maximum number of characters that can be entered in the input box. The empty value indicates no limit. | +| enterkeytype | string | default | No | Type of the **Enter** key on the soft keyboard. The value cannot be dynamically updated.
Available values include:
- default
- next
- go
- done
- send
- search
Except for the **next** type, clicking the Enter key hides the soft keyboard. | +| headericon | string | - | No | Icon resource path before text input. This icon does not support click events and is unavailable for **button**, **checkbox**, and **radio** types. The supported icon image formats are JPG, PNG, and SVG. | +| showcounter5+ | boolean | false | No | Whether to display the character counter for an input box. This attribute takes effect only when **maxlength** is set. | +| menuoptions5+ | Array<MenuOption> | - | No | Menu options displayed after users click the **More** button. | +| autofocus6+ | boolean | false | No | Whether to automatically obtain focus.
This attribute setting does not take effect on the application home page. You can enable a text box on the home page to automatically obtain focus, by delaying the **focus** method call (for about 100–500 ms) in **onActive**. | +| selectedstart6+ | number | -1 | No | Start position for text selection. | +| selectedend6+ | number | -1 | No | End position for text selection. | +| softkeyboardenabled6+ | boolean | true | No | Whether to display the soft keyboard during editing. | +| showpasswordicon6+ | boolean | true | No | Whether to display the icon at the end of the password text box. This attribute is available only when **type** is set to **password**. | **Table 1** MenuOption5+ -| Name | Type | Description | -| ------- | ------ | ----------- | -| icon | string | Path of the icon for a menu option.| -| content | string | Text content of a menu option.| +| Name | Type | Description | +| ------- | ------ | ----------------------------------- | +| icon | string | Path of the icon for a menu option. | +| content | string | Text content of a menu option. | ## Styles In addition to the [universal styles](../arkui-js/js-components-common-styles.md), the following styles are supported. -| Name | Type | Default Value | Mandatory| Description | -| ------------------------ | -------------------------- | ---------- | ---- | ------------------------------------------------------------ | -| color | <color> | \#e6000000 | No | Font color of the single-line text box or button. | -| font-size | <length> | 16px | No | Font size of the single-line text box or button. | -| allow-scale | boolean | true | No | Whether the font size changes with the system's font size settings.
If the **config-changes** tag of **fontSize** is configured for abilities in the **config.json** file, the setting takes effect without application restart.| -| placeholder-color | <color> | \#99000000 | No | Color of the hint text in the single-line text box. This attribute is available when **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**.| -| font-weight | number \| string | normal | No | Font weight of the single-line text box or button. For details, see **font-weight** of the [**\** component](../arkui-js/js-components-basic-text.md).| -| caret-color6+ | <color> | - | No | Color of the input cursor. | +| Name | Type | Default Value | Mandatory | Description | +| ------------------------ | ---------------- | ------------- | --------- | ---------------------------------------- | +| color | <color> | \#e6000000 | No | Font color of the single-line text box or button. | +| font-size | <length> | 16px | No | Font size of the single-line text box or button. | +| allow-scale | boolean | true | No | Whether the font size changes with the system's font size settings.
If the **config-changes** tag of **fontSize** is configured for abilities in the **config.json** file, the setting takes effect without application restart. | +| placeholder-color | <color> | \#99000000 | No | Color of the hint text in the single-line text box. This attribute is available only when **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**. | +| font-weight | number \| string | normal | No | Font weight of the single-line text box or button. For details, see **font-weight** of the [**\**](../arkui-js/js-components-basic-text.md) component. | +| caret-color6+ | <color> | - | No | Color of the caret. | ## Events @@ -65,30 +65,32 @@ In addition to the [universal styles](../arkui-js/js-components-common-styles.md In addition to the [universal events](../arkui-js/js-components-common-events.md), the following events are supported. - When **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**, the following events are supported. - | Name | Parameter | Description | + + | Name | Parameter | Description | | ------------------------- | ---------------------------------------- | ---------------------------------------- | - | change | {
 value: inputValue
 } | Triggered when the content entered in the input box changes. The most recent content entered by the user is returned.
If you change the **value** attribute directly, this event will not be triggered.| - | enterkeyclick | {
 value: enterKey
 } | Triggered when the **Enter** key on the soft keyboard is clicked. The type of the **Enter** key is returned, which is of the number type. Available values are as follows:
- **2**: returned if **enterkeytype** is **go**.
- **3**: returned if **enterkeytype** is **search**.
- **4**: returned if **enterkeytype** is **send**.
- **5**: returned if **enterkeytype** is **next**.
- **6**: returned if **enterkeytype** is **default**, **done**, or is not set.| - | translate5+ | {
 value: selectedText
 } | Triggered when users click the translate button in the menu displayed after they select a text segment. The selected text content is returned.| - | share5+ | {
 value: selectedText
 } | Triggered when users click the share button in the menu displayed after they select a text segment. The selected text content is returned.| - | search5+ | {
 value: selectedText
 } | Triggered when users click the search button in the menu displayed after they select a text segment. The selected text content is returned.| - | optionselect5+ | {
 index: optionIndex,
 value: selectedText
 } | Triggered when users click a menu option in the menu displayed after they select a text segment. This event is valid only when the **menuoptions** attribute is set. The option index and selected text content are returned.| - | selectchange6+ | {
start: number,
end: number
 } | Triggered when the text selection changes. | + | change | {
value: inputValue
} | Triggered when the content entered in the input box changes. The most recent content entered by the user is returned.
If you change the **value** attribute directly, this event will not be triggered. | + | enterkeyclick | {
value: enterKey
} | Triggered when the **Enter** key on the soft keyboard is clicked. The type of the **Enter** key is returned, which is of the number type. Available values are as follows:
- **2**: returned if **enterkeytype** is **go**.
- **3**: returned if **enterkeytype** is **search**.
- **4**: returned if **enterkeytype** is **send**.
- **5**: returned if **enterkeytype** is **next**.
- **6**: returned if **enterkeytype** is **default**, **done**, or is not set. | + | translate5+ | {
value: selectedText
} | Triggered when users click the translate button in the menu displayed after they select a text segment. The selected text content is returned. | + | share5+ | {
value: selectedText
} | Triggered when users click the share button in the menu displayed after they select a text segment. The selected text content is returned. | + | search5+ | {
value: selectedText
} | Triggered when users click the search button in the menu displayed after they select a text segment. The selected text content is returned. | + | optionselect5+ | {
index: optionIndex,
value: selectedText
} | Triggered when users click a menu option in the menu displayed after they select a text segment. This event is valid only when the **menuoptions** attribute is set. The option index and selected text content are returned. | + | selectchange6+ | {
start: number,
end: number
} | Triggered when the text selection changes. | - When **type** is set to **checkbox** or **radio**, the following events are supported. - | Name | Parameter | Description | - | ------ | ---------------------------------------- | ---------------------------------------- | - | change | {
 checked:true \| false 
} | Triggered when the checked status of the **checkbox** or **radio** button changes.| + + | Name | Parameter | Description | + | ------ | --------------------------------- | ---------------------------------------- | + | change | {
checked:true \| false
} | Triggered when the checked status of the **checkbox** or **radio** button changes. | ## Methods In addition to the [universal methods](../arkui-js/js-components-common-methods.md), the following methods are supported. -| Name | Parameter | Description | -| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | -| focus | {
 focus: true\|false
 }:
If **focus** is not passed, the default value **true** is used.| Obtains or loses focus. When **type** is set to **text**, **email**, **date**, **time**, **number**, or password, the input method can be displayed or hidden.| -| showError | {
 error: string 
} | Displays the error message. This attribute is available when **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**.| -| delete6+ | - | Deletes the text content based on the current cursor position when **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**; deletes the last character and displays the cursor if the current input component does not have a cursor.| +| Name | Parameter | Description | +| ------------------- | ---------------------------------------- | ---------------------------------------- | +| focus | {
focus: true\|false
}:
If **focus** is not passed, the default value **true** is used. | Obtains or loses focus. When **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**, the input method can be displayed or collapsed. | +| showError | {
error: string
} | Displays the error message. This method is available when **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**. | +| delete6+ | - | Deletes text based on the current caret position when **type** is set to **text**, **email**, **date**, **time**, **number**, or **password**; deletes the last character and displays the caret if the current input component does not have a caret. | ## Example diff --git a/en/application-dev/reference/arkui-js/js-components-basic-qrcode.md b/en/application-dev/reference/arkui-js/js-components-basic-qrcode.md index 2c353515b816e544af9948e162a9b18d1aefb815..5c3ac41ddfbe254387501071a8a21b3149495e91 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-qrcode.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-qrcode.md @@ -1,119 +1,67 @@ -# qrcode +# qrcode -The **** component is used to generate and display a QR code. +The **\** component is used to generate and display a QR code. -## Required Permissions +> **NOTE** +> +> This component is supported since API version 5. Updates will be marked with a superscript to indicate their earliest API version. + + +## Required Permissions None -## Child Components + +## Child Components Not supported -## Attributes - -In addition to the attributes in [Universal Attributes](js-components-common-attributes.md), the following attributes are supported. - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Default Value

-

Mandatory

-

Description

-

value

-

string

-

-

-

Yes

-

Content used to generate the QR code

-

type

-

string

-

rect

-

No

-

QR code type. Available values are as follows:

-
  • rect: rectangular QR code
  • circle: round QR code
-
- -## Styles - -In addition to the styles in [Universal Styles](js-components-common-styles.md), the following styles are supported. - - - - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Default Value

-

Mandatory

-

Description

-

color

-

<color>

-

#000000

-

No

-

QR code color

-

background-color

-

<color>

-

#ffffff

-

No

-

QR code background color

-
- ->![](../../public_sys-resources/icon-note.gif) **NOTE:** ->- If the values of **width** and **height** are different, the smaller value is used as the length of the QR code. The generated QR code is center displayed. ->- If either **width** or **height** is set, the value is used as the length of the QR code. If neither of them is set, the default length is 200 px. - -## Events - -Events in [Universal Events](js-components-common-events.md) are supported. - -## Methods - -Methods in [Universal Methods](js-components-common-methods.md) are supported. - -## Example -``` +## Attributes + +In addition to the [universal attributes](../arkui-js/js-components-common-attributes.md), the following attributes are supported. + +| Name | Type | Default Value | Mandatory | Description | +| ----- | ------ | ---- | ---- | ---------------------------------------- | +| value | string | - | Yes | Content used to generate the QR code. | +| type | string | rect | No | QR code type. Available values are as follows:
- **rect**: rectangular QR code
- **circle**: round QR code| + + +## Styles + +In addition to the [universal styles](../arkui-js/js-components-common-styles.md), the following styles are supported. + +| Name | Type | Default Value | Mandatory | Description | +| ---------------- | ------------- | -------- | ---- | -------- | +| color | <color> | \#000000 | No | Color of the QR code. | +| background-color | <color> | \#ffffff | No | Background color of the QR code.| + +> **NOTE** +> - If the values of **width** and **height** are different, the smaller value is used as the length of the QR code. The generated QR code is centered. +> +> +> - If either **width** or **height** is set, the value is used as the length of the QR code. If neither of them is set, the default length 200 px is used. +> + + +## Events + +The [universal events](../arkui-js/js-components-common-events.md) are supported. + +## Methods + +The [universal methods](../arkui-js/js-components-common-methods.md) are supported. + + +## Example + +```html
+ Value + 123 Type Color @@ -127,7 +75,7 @@ Methods in [Universal Methods](js-components-common-methods.md) are supported.
``` -``` +```css /* xxx.css */ .container { width: 100%; @@ -146,10 +94,11 @@ select{ } ``` -``` +```js /* index.js */ export default { data: { + qr_value:'', qr_type: 'rect', qr_size: '300px', qr_col: '#87ceeb', @@ -176,5 +125,4 @@ export default { } ``` -![](figures/12.gif) - +![12](figures/12.gif) diff --git a/en/application-dev/reference/arkui-js/js-components-basic-select.md b/en/application-dev/reference/arkui-js/js-components-basic-select.md index 98b7075a6b76bf36a92f480f5b897bef73f42939..32aab0871d34f16e5740a03247fb9d3c373e3c42 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-select.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-select.md @@ -1,83 +1,52 @@ -# select - -The **** component provides a drop-down list that allows users to select among multiple options. - -## Required Permissions - -None - -## Child Component - -The **<[option](js-components-basic-option.md)\>** child component is supported. - -## Attributes - -Attributes in [Universal Attributes](js-components-common-attributes.md) are supported. - -## Styles - -In addition to the styles in [Universal Styles](js-components-common-styles.md), the following styles are supported. - - - - - - - - - - - - - - - - -

Name

-

Type

-

Default Value

-

Mandatory

-

Description

-

font-family

-

string

-

sans-serif

-

No

-

Font family, in which fonts are separated by commas (,). Each font is set using a font name or font family name. The first font that exists in the system or the font specified by Custom Font Styles in the family is selected as the font for the text.

-
- -## Events - -In addition to the events in [Universal Events](js-components-common-events.md), the following events are supported. - - - - - - - - - - - - -

Name

-

Parameter

-

Description

-

change

-

{newValue: newValue}

-

Triggered after a value is selected from the drop-down list. The value of newValue is the attribute value of the child component option.

-
- ->![](../../public_sys-resources/icon-note.gif) **NOTE:** ->- The **** component does not support the **click** event. - -## Method - -Methods in [Universal Methods](js-components-common-methods.md) are supported. - -## Example Code +# select -``` +The **** component provides a drop-down list that allows users to select among multiple options. + +> **NOTE** +> +> This component is supported since API version 4. Updates will be marked with a superscript to indicate their earliest API version. + + +## Child Components + +The **<[option](js-components-basic-option.md)\>** child component is supported. + + +## Attributes + +The [universal attributes](../arkui-js/js-components-common-attributes.md) are supported. + + +## Ad Asset + +In addition to the [universal styles](../arkui-js/js-components-common-styles.md), the following styles are supported. + +| Name | Type | Mandatory| Description | +| ----------- | ------ | ---- | ------------------------------------------------------------ | +| font-family | string | No | Font family, in which fonts are separated by commas (,). The first font in the family or the specified [custom font](./js-components-common-customizing-font.md) is used for the text.
Default value: **sans-serif**| + + +## Events + +In addition to the [universal events](../arkui-js/js-components-common-events.md), the following events are supported. + +| Name | Parameter | Description | +| ------ | ------------------------- | ------------------------------------------------------------ | +| change | {newValue: newValue} | Triggered when an option is selected from the drop-down list to return an object. The value of **newValue** is the value of the selected option.| + +> **NOTE** +> +> The **\ @@ -94,7 +63,7 @@ Methods in [Universal Methods](js-components-common-methods.md) are supported. ``` -``` +```css /* xxx.css */ .container { display: flex; @@ -103,5 +72,13 @@ Methods in [Universal Methods](js-components-common-methods.md) are supported. } ``` -![](figures/en-us_image_0000001152588538.png) +```js +// ×××.js +export default { + changeFruit(e){ + console.log("newValue:" + e.newValue) + } +} +``` +![en-us_image_0000001152588538](figures/en-us_image_0000001152588538.png) diff --git a/en/application-dev/reference/arkui-js/js-components-basic-web.md b/en/application-dev/reference/arkui-js/js-components-basic-web.md index 7130a68b89c88a8e02cc9872a0eaa29d17807105..0342d75b5b9183f396ab4fec35c212de5ea9617d 100644 --- a/en/application-dev/reference/arkui-js/js-components-basic-web.md +++ b/en/application-dev/reference/arkui-js/js-components-basic-web.md @@ -1,7 +1,8 @@ # web The **\** component displays web page content. ->![](../../public_sys-resources/icon-note.gif) **NOTE** -> This component is supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version. +>**NOTE** +> +>This component is supported since API version 6. Updates will be marked with a superscript to indicate their earliest API version. ## Required Permissions ohos.permission.INTERNET, required only for accessing online web pages. @@ -25,6 +26,7 @@ Universal style settings are not supported. ## Events The following events are supported. + | Name| Parameter| Description| | -------- | -------- | -------- | | pagestart | {url: string} | Triggered when web page loading starts.| @@ -33,12 +35,13 @@ The following events are supported. ## Methods The following methods are supported. + | Name| Parameter| Description| | -------- | -------- | -------- | | reload | - | Reloads a page.| ## Example -``` +```html
@@ -46,7 +49,7 @@ The following methods are supported.
``` -``` +```js // xxx.js export default { reloadWeb() { diff --git a/en/application-dev/reference/arkui-js/js-components-canvas-canvas.md b/en/application-dev/reference/arkui-js/js-components-canvas-canvas.md index 8a29479f73e396ee3b4d7a591025ce538b70967e..edf0d3afa3412cb67b3d97f38036218f46e1de33 100644 --- a/en/application-dev/reference/arkui-js/js-components-canvas-canvas.md +++ b/en/application-dev/reference/arkui-js/js-components-canvas-canvas.md @@ -1,171 +1,88 @@ -# canvas +# canvas -The **** component is used for customizing drawings. +> **NOTE** +> +> This component is supported since API version 4. Updates will be marked with a superscript to indicate their earliest API version. -## Required Permissions +The **\** component is used for customizing drawings. + +## Required Permissions None -## Child Components + +## Child Component Not supported -## Attributes - -Attributes in [Universal Attributes](js-components-common-attributes.md) are supported. - -## Styles - -Styles in [Universal Styles](js-components-common-styles.md) are supported. - -## Events - -Events in [Universal Events](js-components-common-events.md) are supported. - -## Methods - -In addition to the methods in [Universal Methods](js-components-common-methods.md), the following events are supported. - -### getContext - -getContext\(type: '2d', options?: ContextAttrOptions\): CanvasRendering2dContext - -Obtains the canvas drawing context. This API cannot be called in **onInit** or **onReady**. - -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

Yes

-

The value is set to '2d', indicating that a 2D drawing object is returned. This object can be used to draw rectangles, texts, and images on the canvas component.

-

options6+

-

ContextAttrOptions

-

No

-

Whether to enable anti-aliasing. By default, anti-aliasing is disabled.

-
- - **Table 1** ContextAttrOptions - - - - - - - - - - - - -

Name

-

Type

-

Description

-

antialias

-

boolean

-

Whether to enable anti-aliasing. The default value is false.

-
- -- Return values - - - - - - - - - - -

Type

-

Description

-

CanvasRenderingContext2D

-

2D drawing object, which can be used to draw rectangles, images, and texts on the canvas component.

-
- - -### toDataURL6+ - -toDataURL\(type?: string, quality?: number\): string + +## Attributes + +The [universal attributes](../arkui-js/js-components-common-attributes.md) are supported. + + +## Styles + +The [universal styles](../arkui-js/js-components-common-styles.md) are supported. + + +## Events + +The [universal events](../arkui-js/js-components-common-events.md) are supported. + + +## Methods + +In addition to the [universal methods](../arkui-js/js-components-common-methods.md), the following methods are supported. + + +### getContext + +getContext(type: '2d', options?: ContextAttrOptions): CanvasRendering2dContext + +Obtains the canvas drawing context. This API cannot be called in **onInit** or **onReady**. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------------------- | ------------------ | ---- | ---------------------------------------- | +| type | string | Yes | Object type. The value is set to **'2d'**, indicating that a 2D drawing object is returned. This object can be used to draw rectangles, texts, and images on the canvas component.| +| options6+ | ContextAttrOptions | No | Whether to enable anti-aliasing. By default, anti-aliasing is disabled. | + +**Table 1** ContextAttrOptions + +| Name | Type | Description | +| --------- | ------- | ------------------- | +| antialias | boolean | Whether to enable anti-aliasing. The default value is **false**.| + +**Return value** + +| Type | Description | +| ---------------------------------------- | -------------------- | +| [CanvasRenderingContext2D](../arkui-js/js-components-canvas-canvasrenderingcontext2d.md) | 2D drawing object, which can be used to draw rectangles, images, and texts, on the canvas component. | + +### toDataURL6+ + +toDataURL(type?: string, quality?: number): string Generates a URL containing image display information. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

No

-

Image format. The default value is image/png.

-

quality

-

number

-

No

-

Image quality, which ranges from 0 to 1, when the image format is image/jpeg or image/webp. If the set value is beyond the value range, the default value 0.92 is used.

-
- -- Return values - - - - - - - - - - -

Type

-

Description

-

string

-

Image URL.

-
- - -## Example +**Parameters** -``` +| Name | Type | Mandatory | Description | +| ------- | ------ | ---- | ---------------------------------------- | +| type | string | No | Image format. The default value is **image/png**. | +| quality | number | No | Image quality, which ranges from 0 to 1, when the image format is **image/jpeg** or **image/webp**. If the set value is beyond the value range, the default value **0.92** is used.| + +**Return value** + +| Type | Description | +| ------ | --------- | +| string | Image URL.| + +## Example + +```html
@@ -173,7 +90,7 @@ Generates a URL containing image display information.
``` -``` +```js // xxx.js export default { handleClick() { @@ -184,4 +101,3 @@ export default { } } ``` - diff --git a/en/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md b/en/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md index 7a94f110d4680dbd6115fbab80684f2287086722..9bc724d26a7610fa4b7fdbd48b21811a2f472cf2 100644 --- a/en/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md +++ b/en/application-dev/reference/arkui-js/js-components-canvas-canvasgradient.md @@ -4,7 +4,7 @@ > > This component is supported since API version 4. Updates will be marked with a superscript to indicate their earliest API version. -**CanvasGradient** provides a gradient object. +**CanvasGradient** provides a gradient object. ## addColorStop @@ -20,6 +20,7 @@ Adds a color stop for the **CanvasGradient** object based on the specified offse | color | string | Gradient color to set. | **Example** + ```html
diff --git a/en/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md b/en/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md index 0747f7fa8f9b9800ff315dc6f0102736cbd00ab6..4100f9429985f1df7dd1e52087c842f128496226 100644 --- a/en/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md +++ b/en/application-dev/reference/arkui-js/js-components-canvas-canvasrenderingcontext2d.md @@ -48,25 +48,25 @@ ## Attributes -| Name | Type | Default Value | Description | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| [fillStyle](#fillstyle) | \ \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | - | Style to fill an area.
- When the type is **\**, this parameter indicates the color of the filling area.
- When the type is **CanvasGradient**, this parameter indicates a gradient object, which is created using the **createLinearGradient()** method.
- When the type is **CanvasPattern**, this parameter indicates a canvas pattern, which is created using the **createPattern()** method. | -| [lineWidth](#linewidth) | number | - | Line width. | -| [strokeStyle](#strokestyle) | \ \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | - | Stroke style.
- When the type is **\**, this parameter indicates the stroke color.
- When the type is **CanvasGradient**, this parameter indicates a gradient object, which is created using the **createLinearGradient()** method.
- When the type is **CanvasPattern**, this parameter indicates a canvas pattern, which is created using the **createPattern()** method. | -| [lineCap](#linecap) | string | butt | Style of the specified line endpoint. The options are as follows:
- **butt**: The endpoints of the line are squared off.
- **round**: The endpoints of the line are rounded.
- **square**: The endpoints of the line are squared off, and each endpoint has added a rectangle whose length is the same as the line thickness and whose width is half of the line thickness.| -| [lineJoin](#linejoin) | string | miter | Style of the intersection point between line segments. The options are as follows:
- **round**: The intersection is a sector, whose radius at the rounded corner is equal to the line width.
- **bevel**: The intersection is a triangle. The rectangular corner of each line is independent.
- **miter**: The intersection has a miter corner by extending the outside edges of the lines until they meet. You can view the effect of this attribute in **miterLimit**.| -| [miterLimit](#miterlimit) | number | 10 | Maximum miter length. The miter length is the distance between the inner corner and the outer corner where two lines meet. | -| [font](#font) | string | "normal normal 14px sans-serif" | Font style.
Syntax: ctx.font="font-style font-weight font-size font-family"5+
- (Optional) **font-style**: font style. Available values are **normal** and **italic**.
- (Optional) **font-weight**: font weight. Available values are as follows: **normal**, **bold**, **bolder**, **lighter**, **100**, **200**, **300**, **400**, **500**, **600**, **700**, **800**, **900**.
- (Optional) **font-size**: font size and row height. The unit can only be pixels.
- (Optional) **font-family**: font family. Available values are **sans-serif**, **serif**, and **monospace**. | -| [textAlign](#textalign) | string | left | Text alignment mode. Available values are as follows:
- **left**: The text is left-aligned.
- **right**: The text is right-aligned.
- **center**: The text is center-aligned.
- **start**: The text is aligned with the start bound.
- **end**: The text is aligned with the end bound.
In the **ltr** layout mode, the value **start** equals **left**. In the **rtl** layout mode, the value **start** equals **right**.| -| [textBaseline](#textbaseline) | string | alphabetic | Horizontal alignment mode of text. Available values are as follows:
- **alphabetic**: The text baseline is the normal alphabetic baseline.
- **top**: The text baseline is on the top of the text bounding box.
- **hanging**: The text baseline is a hanging baseline over the text.
- **middle**: The text baseline is in the middle of the text bounding box.
- **ideographic**: The text baseline is the ideographic baseline. If a character exceeds the alphabetic baseline, the ideographic baseline is located at the bottom of the excessive character.
- **bottom**: The text baseline is at the bottom of the text bounding box. Its difference from the ideographic baseline is that the ideographic baseline does not consider letters in the next line.| -| [globalAlpha](#globalalpha) | number | - | Opacity.
**0.0**: completely transparent.
**1.0**: completely opaque. | -| [lineDashOffset](#linedashoffset) | number | 0.0 | Offset of the dashed line. The precision is float. | -| [globalCompositeOperation](#globalcompositeoperation) | string | source-over | Composition operation type. Available values are as follows: **source-over**, **source-atop**, **source-in**, **source-out**, **destination-over**, **destination-atop**, **destination-in**, **destination-out**, **lighter**, copy, and **xor**. For details, see [Operation types](#globalcompositeoperation).| -| [shadowBlur](#shadowblur) | number | 0.0 | Blur level during shadow drawing. A larger value indicates a more blurred effect. The precision is float. | -| [shadowColor](#shadowcolor) | <color> | - | Shadow color. | -| [shadowOffsetX](#shadowoffsetx) | number | - | X-axis shadow offset relative to the original object. | -| [shadowOffsetY](#shadowoffsety) | number | - | Y-axis shadow offset relative to the original object. | -| [imageSmoothingEnabled](#imagesmoothingenabled6)6+ | boolean | true | Whether to adjust the image smoothness during image drawing. The value **true** means to enable this feature, and **false** means the opposite. | +| Name | Type | Description | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| [fillStyle](#fillstyle) | <color> \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | Style to fill an area.
- When the type is **\**, this parameter indicates the color of the filling area.
- When the type is **CanvasGradient**, this parameter indicates a gradient object, which is created using the **createLinearGradient()** method.
- When the type is **CanvasPattern**, this parameter indicates a canvas pattern, which is created using the **createPattern()** method.| +| [lineWidth](#linewidth) | number | Line width. | +| [strokeStyle](#strokestyle) | <color> \| [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md) \| CanvasPattern | Stroke style.
- When the type is **\**, this parameter indicates the stroke color.
- When the type is **CanvasGradient**, this parameter indicates a gradient object, which is created using the **createLinearGradient()** method.
- When the type is **CanvasPattern**, this parameter indicates a canvas pattern, which is created using the **createPattern()** method.| +| [lineCap](#linecap) | string | Style of the specified line endpoint. The options are as follows:
- **butt**: The endpoints of the line are squared off.
- **round**: The endpoints of the line are rounded.
- **square**: The endpoints of the line are squared off, and each endpoint has added a rectangle whose length is the same as the line thickness and whose width is half of the line thickness.
Default value: **butt**| +| [lineJoin](#linejoin) | string | Style of the intersection point between line segments. The options are as follows:
- **round**: The intersection is a sector, whose radius at the rounded corner is equal to the line width.
- **bevel**: The intersection is a triangle. The rectangular corner of each line is independent.
- **miter**: The intersection has a miter corner by extending the outside edges of the lines until they meet. You can view the effect of this attribute in **miterLimit**.
Default value: **miter**| +| [miterLimit](#miterlimit) | number | Maximum miter length. The miter length is the distance between the inner corner and the outer corner where two lines meet.
Default value: **10** | +| [font](#font) | string | Font style.
Syntax: ctx.font="font-style font-weight font-size font-family"5+
- (Optional) **font-style**: font style. Available values are **normal** and **italic**.
- (Optional) **font-weight**: font weight. Available values are as follows: **normal**, **bold**, **bolder**, **lighter**, **100**, **200**, **300**, **400**, **500**, **600**, **700**, **800**, **900**.
- (Optional) **font-size**: font size and row height. The unit can only be pixels.
- (Optional) **font-family**: font family. Available values are **sans-serif**, **serif**, and **monospace**.
Default value: **"normal normal 14px sans-serif"**| +| [textAlign](#textalign) | string | Text alignment mode. Available values are as follows:
- **left**: The text is left-aligned.
- **right**: The text is right-aligned.
- **center**: The text is center-aligned.
- **start**: The text is aligned with the start bound.
- **end**: The text is aligned with the end bound.
In the **ltr** layout mode, the value **start** equals **left**. In the **rtl** layout mode, the value **start** equals **right**.
Default value: **left**| +| [textBaseline](#textbaseline) | string | Horizontal alignment mode of text. Available values are as follows:
- **alphabetic**: The text baseline is the normal alphabetic baseline.
- **top**: The text baseline is on the top of the text bounding box.
- **hanging**: The text baseline is a hanging baseline over the text.
- **middle**: The text baseline is in the middle of the text bounding box.
- **ideographic**: The text baseline is the ideographic baseline. If a character exceeds the alphabetic baseline, the ideographic baseline is located at the bottom of the excessive character.
- **bottom**: The text baseline is at the bottom of the text bounding box. Its difference from the ideographic baseline is that the ideographic baseline does not consider letters in the next line.
Default value: **alphabetic**| +| [globalAlpha](#globalalpha) | number | Opacity.
**0.0**: completely transparent.
**1.0**: completely opaque. | +| [lineDashOffset](#linedashoffset) | number | Offset of the dashed line. The precision is float.
Default value: **0.0** | +| [globalCompositeOperation](#globalcompositeoperation) | string | Composition operation type. Available values are as follows: **source-over**, **source-atop**, **source-in**, **source-out**, **destination-over**, **destination-atop**, **destination-in**, **destination-out**, **lighter**, copy, and **xor**. For details, see [Operation types](#globalcompositeoperation).
Default value: **ource-over**| +| [shadowBlur](#shadowblur) | number | Blur level during shadow drawing. A larger value indicates a more blurred effect. The precision is float.
Default value: **0.0**| +| [shadowColor](#shadowcolor) | <color> | Shadow color. | +| [shadowOffsetX](#shadowoffsetx) | number | X-axis shadow offset relative to the original object. | +| [shadowOffsetY](#shadowoffsety) | number | Y-axis shadow offset relative to the original object. | +| [imageSmoothingEnabled](#imagesmoothingenabled6)6+ | boolean | Whether to adjust the image smoothness during image drawing. The value **true** means to enable this feature, and **false** means the opposite.
Default value: **true**| ### fillStyle @@ -380,7 +380,8 @@ export default { ### globalCompositeOperation -Operation types +Enumerates the operation types. + | Value | Description | | ---------------- | ------------------------ | | source-over | Displays the new drawing above the existing drawing. This attribute is used by default. | @@ -425,7 +426,7 @@ export default { } ``` - ![en-us_image_0000001213192781](figures/en-us_image_0000001213192781.png) +![en-us_image_0000001213192781](figures/en-us_image_0000001213192781.png) In the above example, the blue rectangle represents the new drawing, and the red rectangle represents the existing drawing. @@ -571,6 +572,7 @@ fillRect(x: number, y: number, width:number, height: number): void Fills a rectangle on the canvas. **Parameters** + | Name | Type | Description | | ------ | ------ | ------------- | | x | number | X-coordinate of the upper left corner of the rectangle.| @@ -607,6 +609,7 @@ clearRect(x: number, y: number, width:number, height: number): void Clears the content in a rectangle on the canvas. **Parameters** + | Name | Type | Description | | ------ | ------ | ------------- | | x | number | X-coordinate of the upper left corner of the rectangle.| @@ -645,6 +648,7 @@ strokeRect(x: number, y: number, width:number, height: number): void Draws a rectangle stroke on the canvas. **Parameters** + | Name | Type | Description | | ------ | ------ | ------------ | | x | number | X-coordinate of the upper left corner of the rectangle stroke.| @@ -681,6 +685,7 @@ fillText(text: string, x: number, y: number): void Draws filled text on the canvas. **Parameters** + | Name | Type | Description | | ---- | ------ | --------------- | | text | string | Text to draw. | @@ -716,6 +721,7 @@ strokeText(text: string, x: number, y: number): void Draws a text stroke on the canvas. **Parameters** + | Name | Type | Description | | ---- | ------ | --------------- | | text | string | Text to draw. | @@ -751,11 +757,13 @@ measureText(text: string): TextMetrics Returns a **TextMetrics** object used to obtain the width of specified text. **Parameters** + | Name | Type | Description | | ---- | ------ | ---------- | | text | string | Text to be measured.| **Return value** + | Type | Description | | ----------- | -------------------------------------- | | TextMetrics | Object that contains the text width. You can obtain the width by **TextMetrics.width**.| @@ -854,6 +862,7 @@ moveTo(x: number, y: number): void Moves a drawing path to a target position on the canvas. **Parameters** + | Name | Type | Description | | ---- | ------ | --------- | | x | number | X-coordinate of the target position.| @@ -890,6 +899,7 @@ lineTo(x: number, y: number): void Connects the current point to a target position using a straight line. **Parameters** + | Name | Type | Description | | ---- | ------ | --------- | | x | number | X-coordinate of the target position.| @@ -958,12 +968,14 @@ createPattern(image: Image, repetition: string): Object Creates a pattern for image filling based on a specified source image and repetition mode. **Parameters** + | Name | Type | Description | | ---------- | ------ | ---------------------------------------- | | image | Image | Source image. For details, see [Image](../arkui-js/js-components-canvas-image.md).| | repetition | string | Repetition mode. The value can be **"repeat"**, **"repeat-x"**, **"repeat-y"**, or **"no-repeat"**.| **Return value** + | Type | Description | | ------ | ----------------- | | Object | Pattern of image filling.| @@ -1000,6 +1012,7 @@ bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, Draws a cubic bezier curve on the canvas. **Parameters** + | Name | Type | Description | | ---- | ------ | -------------- | | cp1x | number | X-coordinate of the first parameter of the bezier curve.| @@ -1040,6 +1053,7 @@ quadraticCurveTo(cpx: number, cpy: number, x: number, y: number): void Draws a quadratic curve on the canvas. **Parameters** + | Name | Type | Description | | ---- | ------ | ----------- | | cpx | number | X-coordinate of the bezier curve parameter.| @@ -1078,6 +1092,7 @@ arc(x: number, y: number, radius: number, startAngle: number, endAngle: number, Draws an arc on the canvas. **Parameters** + | Name | Type | Description | | ------------- | ------- | ---------- | | x | number | X-coordinate of the center point of the arc.| @@ -1117,6 +1132,7 @@ arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): void Draws an arc based on the radius and points on the arc. **Parameters** + | Name | Type | Description | | ------ | ------ | --------------- | | x1 | number | X-coordinate of the first point on the arc.| @@ -1155,6 +1171,7 @@ ellipse(x: number, y: number, radiusX: number, radiusY: number, rotation: number Draws an ellipse in the specified rectangular region on the canvas. **Parameters** + | Name | Type | Description | | ------------- | ------ | ------------------------------------ | | x | number | X-coordinate of the ellipse center. | @@ -1196,6 +1213,7 @@ rect(x: number, y: number, width: number, height: number): void Creates a rectangle on the canvas. **Parameters** + | Name | Type | Description | | ------ | ------ | ------------- | | x | number | X-coordinate of the upper left corner of the rectangle.| @@ -1292,6 +1310,7 @@ rotate(rotate: number): void Rotates a canvas clockwise around its coordinate axes. **Parameters** + | Name | Type | Description | | ------ | ------ | ---------------------------------------- | | rotate | number | Clockwise rotation angle. You can use **Math.PI / 180** to convert the angle to a radian.| @@ -1325,6 +1344,7 @@ scale(x: number, y: number): void Scales the canvas based on scale factors. **Parameters** + | Name | Type | Description | | ---- | ------ | ----------- | | x | number | Horizontal scale factor.| @@ -1367,6 +1387,7 @@ Defines a transformation matrix. To transform a graph, you only need to set para > - y' = skewX \* x + scaleY \* y + translateY **Parameters** + | Name | Type | Description | | ---------- | ------ | -------- | | scaleX | number | X-axis scale.| @@ -1411,6 +1432,7 @@ setTransform(scaleX: number, skewX: number, skewY: number, scale: number, transl Resets the existing transformation matrix and creates a new transformation matrix by using the same parameters as the **transform()** function. **Parameters** + | Name | Type | Description | | ---------- | ------ | -------- | | scaleX | number | X-axis scale.| @@ -1452,6 +1474,7 @@ translate(x: number, y: number): void Moves the origin of the coordinate system. **Parameters** + | Name | Type | Description | | ---- | ------ | -------- | | x | number | X-axis translation.| @@ -1487,6 +1510,7 @@ createPath2D(path: Path2D, cmds: string): Path2D Creates a **Path2D** object. **Parameters** + | Name | Type | Description | | ---- | ------ | -------------- | | path | Path2D | **Path2D** object. | @@ -1494,10 +1518,9 @@ Creates a **Path2D** object. **Return value** -[Path2D object](../arkui-js/js-components-canvas-path2d.md) + [Path2D object](../arkui-js/js-components-canvas-path2d.md) **Example** - ```html
@@ -1534,6 +1557,7 @@ drawImage(image: Image | PixelMap, sx: number, sy: number, sWidth: number, sHeig Draws an image on the canvas. **Parameters** + | Name | Type | Description | | ------- | ------------------------------ | ---------------------------------------- | | image | Image \| PixelMap9+ | Image resource. For details, see [Image](../arkui-js/js-components-canvas-image.md) or [PixelMap](../apis/js-apis-image.md#pixelmap7).| @@ -1626,6 +1650,7 @@ createLinearGradient(x0: number, y0: number, x1: number, y1: number): Object Creates a linear gradient and returns a **CanvasGradient** object. For details, see [CanvasGradient](../arkui-js/js-components-canvas-canvasgradient.md). **Parameters** + | Name | Type | Description | | ---- | ------ | -------- | | x0 | number | X-coordinate of the start point.| @@ -1634,6 +1659,7 @@ Creates a linear gradient and returns a **CanvasGradient** object. For details, | y1 | number | Y-coordinate of the end point.| **Return value** + | Type | Description | | ------ | ---------------------- | | Object | Created **CanvasGradient** object.| @@ -1675,6 +1701,7 @@ createRadialGradient(x0: number, y0: number, r0: number, x1: number, y1: number, Creates a radial gradient and returns a **CanvasGradient** object. **Parameters** + | Name | Type | Description | | ---- | ------ | ----------------- | | x0 | number | X-coordinate of the center of the start circle. | @@ -1685,6 +1712,7 @@ Creates a radial gradient and returns a **CanvasGradient** object. | r1 | number | Radius of the end circle, which must be a non-negative finite number.| **Return value** + | Type | Description | | ------ | ---------------------- | | Object | Created **CanvasGradient** object.| @@ -1726,6 +1754,7 @@ createImageData(width: number, height: number, imageData: Object): Object Creates an **ImageData** object. For details, see [ImageData](../arkui-js/js-components-canvas-imagedata.md). **Parameters** + | Name | Type | Description | | --------- | ------ | ----------------- | | width | number | Width of the **ImageData** object. | @@ -1733,6 +1762,7 @@ Creates an **ImageData** object. For details, see [ImageData](../arkui-js/js-com | imagedata | Object | **ImageData** object with the same width and height copied from the original **ImageData** object.| **Return value** + | Type | Description | | ------ | ----------------- | | Object | Created **ImageData** object.| @@ -1764,6 +1794,7 @@ getImageData(sx: number, sy: number, sw: number, sh: number): Object Obtains the **ImageData** object created with the pixels within the specified area on the canvas. **Parameters** + | Name | Type | Description | | ---- | ------ | --------------- | | sx | number | X-coordinate of the upper left corner of the output area.| @@ -1772,6 +1803,7 @@ Obtains the **ImageData** object created with the pixels within the specified ar | sh | number | Height of the output area. | **Return value** + | Type | Description | | ------ | ----------------------- | | Object | **ImageData** object that contains pixels in the specified area on the canvas.| @@ -1802,6 +1834,7 @@ putImageData(imageData: Object, dx: number, dy: number, dirtyX: number, dirtyY: Puts the **ImageData** onto a rectangular area on the canvas. **Parameters** + | Name | Type | Description | | ----------- | ------ | ----------------------------- | | imagedata | Object | **ImageData** object with pixels to put onto the canvas. | @@ -1888,6 +1921,7 @@ setLineDash(segments: Array): void Sets the dash line style. **Parameters** + | Name | Type | Description | | -------- | ----- | -------------------- | | segments | Array | An array describing the interval of alternate line segments and length of spacing.| @@ -1922,6 +1956,7 @@ getLineDash(): Array Obtains the dash line style. **Return value** + | Type | Description | | ----- | ------------------------ | | Array | An array describing the interval of alternate line segments and length of spacing.| @@ -1952,6 +1987,7 @@ transferFromImageBitmap(bitmap: ImageBitmap): void Displays the specified **ImageBitmap** object. **Parameters** + | Name | Type | Description | | ------ | ----------- | ------------------ | | bitmap | ImageBitmap | **ImageBitmap** object to display.| diff --git a/en/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md b/en/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md index ff809fb5f91c182738670f03821508e6de31e301..16a15bb2edfbd402b9065980bdee6a3357c5d4f1 100644 --- a/en/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md +++ b/en/application-dev/reference/arkui-js/js-components-canvas-offscreencanvas.md @@ -1,190 +1,87 @@ -# OffscreenCanvas - ->![](../../public_sys-resources/icon-note.gif) **NOTE:** ->**OffscreenCanvas** is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version. - -**OffscreenCanvas** defines a canvas object that can be rendered off the screen. - -## Attributes - - - - - - - - - - - - - - - - -

Name

-

Type

-

Description

-

width

-

number

-

Width of the OffscreenCanvas object.

-

height

-

number

-

Height of the OffscreenCanvas object.

-
- -## Methods - -### getContext - -getContext\(type: string, options?: CanvasRenderingContext2DSettings\): OffscreenCanvasRenderingContext2D - -Obtains the **OffscreenCanvas** context. This method returns a 2D drawing object. - -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

contextId

-

string

-

Yes

-

The value can only be "2d".

-

options

-

CanvasRenderingContext2DSettings

-

No

-

2D drawing object, which can be used to draw rectangles, images, and texts, on the OffscreenCanvas.

-
- -- Return values - - - - - - - - - - -

Type

-

Description

-

OffscreenCanvasRenderingContext2D

-

2D drawing object, which can be used to draw rectangles, images, and texts, on the OffscreenCanvas.

-
- - -### toDataURL - -toDataURL\(type?: string, quality?:number\): +# OffscreenCanvas + +> **NOTE** +> +> The APIs of this component are supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version. + + +**OffscreenCanvas** defines a canvas object that can be rendered off the screen. + + +## Attributes + +| Name | Type | Description | +| ------ | ------ | --------------------------- | +| width | number | Width of the **OffscreenCanvas** object.| +| height | number | Height of the **OffscreenCanvas** object.| + + +## Methods + + +### getContext + +getContext(type: string, options?: CanvasRenderingContext2DSettings): OffscreenCanvasRenderingContext2D + +Obtains the **OffscreenCanvas** context. This API returns a 2D drawing object. + +**Parameters** + +| Name | Type | Mandatory | Description | +| --------- | ---------------------------------------- | ---- | ---------------------- | +| contextId | string | Yes | Context ID. The value can only be **"2d"**. | +| options | [CanvasRenderingContext2DSettings](../arkui-js/js-offscreencanvasrenderingcontext2d.md) | No | 2D drawing object, which can be used to draw rectangles, images, and texts, on the **OffscreenCanvas**. | + +**Return value** + +| Type | Description | +| ---------------------------------------- | --------------------------- | +| [OffscreenCanvasRenderingContext2D](../arkui-js/js-offscreencanvasrenderingcontext2d.md) | 2D drawing object, which can be used to draw rectangles, images, and texts, on the **OffscreenCanvas**. | + + +### toDataURL + +toDataURL(type?: string, quality?:number): Generates a URL containing image display information. -- Parameters - - - - - - - - - - - - - - - - - - - -

Name

-

Type

-

Mandatory

-

Description

-

type

-

string

-

No

-

Image format. The default value is image/png.

-

quality

-

number

-

No

-

Image quality, which ranges from 0 to 1, when the image format is image/jpeg or image/webp. If the set value is beyond the value range, the default value 0.92 is used.

-
- -- Return values - - - - - - - - - - -

Type

-

Description

-

string

-

Image URL.

-
- - -### transferToImageBitmap - -transferToImageBitmap\(\): ImageBitmap - -Creates an **ImageBitmap** object on the most recently rendered image of the **OffscreenCanvas**. - -- Return values - - - - - - - - - - -

Type

-

Description

-

ImageBitmap

-

Pixel data rendered on the OffscreenCanvas.

-
- - -## Example +**Parameters** -``` +| Name | Type | Mandatory | Description | +| ------- | ------ | ---- | ---------------------------------------- | +| type | string | No | Image format. The default value is **image/png**. | +| quality | number | No | Image quality, which ranges from 0 to 1, when the image format is **image/jpeg** or **image/webp**. If the set value is beyond the value range, the default value **0.92** is used.| + +**Return value** + +| Type | Description | +| ------ | --------- | +| string | Image URL.| + + +### transferToImageBitmap + +transferToImageBitmap(): ImageBitmap + +Creates an **ImageBitmap** object on the most recently rendered image of the **OffscreenCanvas**. + +**Return value** + +| Type | Description | +| ---------------------------------------- | --------------- | +| [ImageBitmap](../arkui-js/js-components-canvas-imagebitmap.md) | Pixel data rendered on the **OffscreenCanvas**.| + + +## Example + +```html
``` -``` +```js //xxx.js export default { onShow() { @@ -202,4 +99,3 @@ export default { } } ``` - diff --git a/en/application-dev/reference/arkui-js/js-components-canvas-path2d.md b/en/application-dev/reference/arkui-js/js-components-canvas-path2d.md index f0d8345a3bac2c96c323c94731e3244b1ff8df77..f5f4179442862246d1c3171dde95879efbe4c532 100644 --- a/en/application-dev/reference/arkui-js/js-components-canvas-path2d.md +++ b/en/application-dev/reference/arkui-js/js-components-canvas-path2d.md @@ -19,6 +19,7 @@ Adds a path to this path. | path | Object | Path to be added to this path. | **Example** + ```html
@@ -60,6 +61,7 @@ Sets the path transformation matrix. | translateY | number | Translation distance of the y-axis. | **Example** + ```html
@@ -130,6 +132,7 @@ Moves the current coordinate point of the path to the target point, without draw | y | number | Y-coordinate of the target point. | **Example** + ```html
@@ -216,6 +219,7 @@ Draws a cubic bezier curve on the canvas. | y | number | Y-coordinate of the end point on the bezier curve. | **Example** + ```html
@@ -256,6 +260,7 @@ Draws a quadratic curve on the canvas. | y | number | Y-coordinate of the end point on the bezier curve. | **Example** + ```html
@@ -298,6 +303,7 @@ Draws an arc on the canvas. | anticlockwise | boolean | Whether to draw the arc counterclockwise. | **Example** + ```html
@@ -338,6 +344,7 @@ Draws an arc based on the radius and points on the arc. | radius | number | Radius of the arc. | **Example** + ```html
@@ -381,6 +388,7 @@ Draws an ellipse in the specified rectangular region. | anticlockwise | number | Whether to draw the ellipse in the anticlockwise direction. The value **0** indicates clockwise and the value **1** indicates anticlockwise. This parameter is optional. The default value is **0**. | **Example** + ```html
@@ -420,6 +428,7 @@ Creates a rectangle. | height | number | Height of the rectangle. | **Example** + ```html
diff --git a/en/application-dev/reference/arkui-js/js-components-common-animation.md b/en/application-dev/reference/arkui-js/js-components-common-animation.md index 24676a73232a85ae609e6ea07b403bdd78961bb4..72969d608a86f4ce8fdf8ad2eb95431e18b93528 100644 --- a/en/application-dev/reference/arkui-js/js-components-common-animation.md +++ b/en/application-dev/reference/arkui-js/js-components-common-animation.md @@ -6,20 +6,20 @@ Components support dynamic rotation, translation, and scaling effects. These eff > > The initial APIs of this component are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version. -| Name | Type | Default Value | Description | -| ------------------------- | ------------------------------------------------------------ | ------------------------------------- | ------------------------------------------------------------ | -| transform-origin | string6+ \| \ \| \ string6+ \| \ \| \ | center center | Origin position of the transformed element. The unit can be px or a percentage (relative to the animation target component). If only one value is specified, the other one is **50%**. The available values for the first string are **left**, **center**, and **right**. The available values for the second string are **top**, **center**, and **bottom**.
Example:
transform-origin: 200px 30%
transform-origin: 100px topt
ransform-origin: center center | -| transform | string | - | Translation, rotation, and scaling attributes.
For details, see **transform**. | -| animation6+ | string | 0s ease 0s 1 normal none running none | Animation attributes in the format of **duration \| timing-function \| delay \| iteration-count \| direction \| fill-mode \| play-state \| name**. The order of the parameters is not specified, but the **duration** and **delay** parameters are parsed based on where they are placed. | -| animation-name | string | - | @keyframes rule. For details, see **@keyframes**. | -| animation-delay | \