diff --git a/en/application-dev/ai/Readme-EN.md b/en/application-dev/ai/Readme-EN.md new file mode 100644 index 0000000000000000000000000000000000000000..525a9f3afe7e1e951d2216160cc23ba4c9b3335b --- /dev/null +++ b/en/application-dev/ai/Readme-EN.md @@ -0,0 +1,3 @@ +# AI + +- [Using MindSpore Lite for Model Inference (JS)](mindspore-lite-js-guidelines.md) diff --git a/en/application-dev/ai/mindspore-lite-js-guidelines.md b/en/application-dev/ai/mindspore-lite-js-guidelines.md new file mode 100644 index 0000000000000000000000000000000000000000..1f309acf19ba608ac698892ed64bb2e75ffdc437 --- /dev/null +++ b/en/application-dev/ai/mindspore-lite-js-guidelines.md @@ -0,0 +1,122 @@ +# Using MindSpore Lite for Model Inference (JS) + +## Scenarios + +MindSpore Lite is an AI engine that implements AI model inference for different hardware devices. It has been used in a wide range of fields, such as image classification, target recognition, facial recognition, and character recognition. + +This document describes the general development process for implementing MindSpore Lite model inference. For details about how to use native APIs to implement model inference, see [Using MindSpore Lite for Model Inference](../napi/mindspore-lite-guidelines.md). + +## Basic Concepts + +Before getting started, you need to understand the following basic concepts: + +**Tensor**: a special data structure that is similar to arrays and matrices. It is basic data structure used in MindSpore Lite network operations. + +**Float16 inference mode**: a mode that uses half-precision inference. Float16 uses 16 bits to represent a number and therefore it is also called half-precision. + +## Available APIs +APIs involved in MindSpore Lite model inference are categorized into context APIs, model APIs, and tensor APIs. For more APIs, see [@ohos.ai.mindSporeLite](../reference/apis/js-apis-mindSporeLite.md). + +| API | Description | +| ------------------ | ----------------- | +|loadModelFromFile(model: string, options: Context): Promise<Model>|Loads a model from a file.| +|getInputs(): MSTensor[]|Obtains the model input.| +|predict(inputs: MSTensor[]): Promise<MSTensor>|Performs model inference.| +| getData(): ArrayBuffer | Obtains tensor data.| +| setData(inputArray: ArrayBuffer): void | Sets the tensor data.| + +## How to Develop + +The development process consists of the following main steps: + +1. Prepare the required model. You can download the required model directly or obtain the model by using the model conversion tool. The required data is read from the `bin` file. + + - If the downloaded model is in the `.ms` format, you can use it directly for inference. This document uses `mnet.caffemodel.ms` as an example. + - If the downloaded model uses a third-party framework, such as TensorFlow, TensorFlow Lite, Caffe, or ONNX, you can use the [model conversion tool](https://www.mindspore.cn/lite/docs/en/r2.0/use/downloads.html#1-8-1) to convert it to the `.ms` format. +2. Create a context, and set parameters such as the number of runtime threads and device type. +3. Load the model. In this example, the model is read from the file. +4. Load data. Before executing a model, you need to obtain the model input and then fill data in the input tensor. +5. Perform inference and print the output. Call the **predict** API to perform model inference. +```js +@State inputName: string = 'mnet_caffemodel_nhwc.bin'; +@State T_model_predict: string = 'Test_MSLiteModel_predict' +inputBuffer: any = null; +build() { + Row() { + Column() { + Text(this.T_model_predict) + .focusable(true) + .fontSize(30) + .fontWeight(FontWeight.Bold) + .onClick(async () => { + // 1. Prepare for a model. + let syscontext = globalThis.context; + syscontext.resourceManager.getRawFileContent(this.inputName).then((buffer) => { + this.inputBuffer = buffer; + console.log('=========input bin byte length: ' + this.inputBuffer.byteLength) + }).catch(error => { + console.error('Failed to get buffer, error code: ${error.code},message:${error.message}.'); + }) + // 2. Create a context. + let context: mindSporeLite.Context = {}; + context.target = ['cpu']; + context.cpu = {} + context.cpu.threadNum = 1; + context.cpu.threadAffinityMode = 0; + context.cpu.precisionMode = 'enforce_fp32'; + // 3. Load the model. + let modelFile = '/data/storage/el2/base/haps/entry/files/mnet.caffemodel.ms'; + let msLiteModel = await mindSporeLite.loadModelFromFile(modelFile, context); + // 4. Load data. + const modelInputs = msLiteModel.getInputs(); + modelInputs[0].setData(this.inputBuffer.buffer); + // 5. Perform inference and print the output. + console.log('=========MSLITE predict start=====') + msLiteModel.predict(modelInputs).then((modelOutputs) => { + let output0 = new Float32Array(modelOutputs[0].getData()); + for (let i = 0; i < output0.length; i++) { + console.log(output0[i].toString()); + } + }) + console.log('=========MSLITE predict success=====') + }) + } + .width('100%') + } + .height('100%') +} +``` + +## Debugging and Verification + +1. Connect to the rk3568 development board on DevEco Studio, click **Run entry**, and compile your own HAP. The following information is displayed: + + ```shell + Launching com.example.myapptfjs + $ hdc uninstall com.example.myapptfjs + $ hdc install -r "D:\TVOS\JSAPI\MyAppTfjs\entry\build\default\outputs\default\entry-default-signed.hap" + $ hdc shell aa start -a EntryAbility -b com.example.myapptfjs + ``` + +2. Use the hdc tool to connect to the rk3568 development board and push `mnet.caffemodel.ms` to the sandbox directory on the device. `mnet\_caffemodel\_nhwc.bin` is stored in the `rawfile` directory of the local project. + + ```shell + hdc -t 7001005458323933328a00bcdf423800 file send .\mnet.caffemodel.ms /data/app/el2/100/base/com.example.myapptfjs/haps/entry/files/ + ``` +3. Click **Test\_MSLiteModel\_predict** on the screen of the rk3568 development board to run the test case. The following information is displayed in the HiLog printing result: + + ```shell + 08-27 23:25:50.278 31782-31782/? I C03d00/JSAPP: =========MSLITE predict start===== + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: 0.10046602040529252 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: 0.07535600662231445 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: 0.06326554715633392 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: 0.0015114173293113708 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: -0.026745859533548355 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: -0.055590517818927765 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: -0.05325715243816376 + 08-27 23:25:51.487 31782-31782/? I C03d00/JSAPP: -0.04629542678594589 + ... + 08-27 23:25:52.881 31782-31782/? I C03d00/JSAPP: 0.23317644000053404 + 08-27 23:25:52.881 31782-31782/? I C03d00/JSAPP: 0.17999525368213654 + 08-27 23:25:50.372 31782-31782/? I C03d00/JSAPP: =========MSLITE predict success===== + ``` diff --git a/en/application-dev/napi/mindspore-lite-guidelines.md b/en/application-dev/napi/mindspore-lite-guidelines.md index 8dd76e32683a9a8fd6369cb4f4f53863c4e85607..e175c3750b7c0f445f570b742073e67824726537 100644 --- a/en/application-dev/napi/mindspore-lite-guidelines.md +++ b/en/application-dev/napi/mindspore-lite-guidelines.md @@ -85,7 +85,7 @@ The development process consists of the following main steps: The required model can be downloaded directly or obtained using the model conversion tool. - If the downloaded model is in the `.ms` format, you can use it directly for inference. The following uses the **mobilenetv2.ms** model as an example. - - If the downloaded model uses a third-party framework, such as TensorFlow, TensorFlow Lite, Caffe, or ONNX, you can use the [model conversion tool](https://www.mindspore.cn/lite/docs/zh-CN/r1.5/use/downloads.html#id1) to convert it to the .ms format. + - If the downloaded model uses a third-party framework, such as TensorFlow, TensorFlow Lite, Caffe, or ONNX, you can use the [model conversion tool](https://www.mindspore.cn/lite/docs/en/r1.5/use/downloads.html#id1) to convert it to the .ms format. 2. Create a context, and set parameters such as the number of runtime threads and device type. @@ -280,7 +280,3 @@ The development process consists of the following main steps: output data is: 0.000018 0.000012 0.000026 0.000194 0.000156 0.001501 0.000240 0.000825 0.000016 0.000006 0.000007 0.000004 0.000004 0.000004 0.000015 0.000099 0.000011 0.000013 0.000005 0.000023 0.000004 0.000008 0.000003 0.000003 0.000008 0.000014 0.000012 0.000006 0.000019 0.000006 0.000018 0.000024 0.000010 0.000002 0.000028 0.000372 0.000010 0.000017 0.000008 0.000004 0.000007 0.000010 0.000007 0.000012 0.000005 0.000015 0.000007 0.000040 0.000004 0.000085 0.000023 ``` - -## Samples -The following sample is provided to help you better understand how to use MindSpore Lite: -- [Simple MindSpore Lite Tutorial](https://gitee.com/openharmony/third_party_mindspore/tree/OpenHarmony-3.2-Release/mindspore/lite/examples/quick_start_c) diff --git a/en/application-dev/reference/apis/figures/Cursor_Circle.png b/en/application-dev/reference/apis/figures/Cursor_Circle.png new file mode 100644 index 0000000000000000000000000000000000000000..75b942a03da161b31d717fcfcb0a6ede1d65e76b Binary files /dev/null and b/en/application-dev/reference/apis/figures/Cursor_Circle.png differ diff --git a/en/application-dev/reference/apis/figures/Cursor_Cross.png b/en/application-dev/reference/apis/figures/Cursor_Cross.png new file mode 100644 index 0000000000000000000000000000000000000000..1b8391c4dc617e07270489643c03eede068882d1 Binary files /dev/null and b/en/application-dev/reference/apis/figures/Cursor_Cross.png differ diff --git a/en/application-dev/reference/apis/figures/Horizontal_Text_Cursor.png b/en/application-dev/reference/apis/figures/Horizontal_Text_Cursor.png new file mode 100644 index 0000000000000000000000000000000000000000..6911b3a2c702613239bef39a7101832f5343ccdb Binary files /dev/null and b/en/application-dev/reference/apis/figures/Horizontal_Text_Cursor.png differ diff --git a/en/application-dev/reference/apis/js-apis-pointer.md b/en/application-dev/reference/apis/js-apis-pointer.md index 61bac1ec1ef7b02115705e7e5e34b600faedca60..9f949c10e762e34ae641d648d676f0d754c9b52c 100644 --- a/en/application-dev/reference/apis/js-apis-pointer.md +++ b/en/application-dev/reference/apis/js-apis-pointer.md @@ -850,3 +850,879 @@ Enumerates mouse pointer styles. | MIDDLE_BTN_SOUTH_EAST | 36 | Scrolling south-east |![MID_Btn_South_East.png](./figures/MID_Btn_South_East.png)| | MIDDLE_BTN_SOUTH_WEST | 37 | Scrolling south-west |![MID_Btn_South_West.png](./figures/MID_Btn_South_West.png)| | MIDDLE_BTN_NORTH_SOUTH_WEST_EAST | 38 | Moving as a cone in four directions|![MID_Btn_North_South_West_East.png](./figures/MID_Btn_North_South_West_East.png)| +| HORIZONTAL_TEXT_CURSOR10+ | 39 | Horizontal text selection|![Horizontal_Text_Cursor.png](./figures/Horizontal_Text_Cursor.png)| +| CURSOR_CROSS10+ | 40 | Cross cursor|![Cursor_Cross.png](./figures/Cursor_Cross.png)| +| CURSOR_CIRCLE10+ | 41 | Circular cursor|![Cursor_Circle.png](./figures/Cursor_Circle.png)| + +## pointer.setTouchpadScrollSwitch10+ + +setTouchpadScrollSwitch(state: boolean, callback: AsyncCallback\): void + +Sets the scroll switch of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| state | boolean | Yes | Scroll switch status. The value **true** indicates that the scroll switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadScrollSwitch(true, (error) => { + if (error) { + console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadScrollSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadScrollSwitch10+ + +setTouchpadScrollSwitch(state: boolean): Promise\ + +Sets the scroll switch of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| state | boolean| Yes | Scroll switch status. The value **true** indicates that the scroll switch is enabled, and the value **false** indicates the opposite. The default value is **true**.| + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadScrollSwitch(false).then(() => { + console.log(`setTouchpadScrollSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadScrollSwitch10+ + +getTouchpadScrollSwitch(callback: AsyncCallback\): void + +Obtains the scroll switch status of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadScrollSwitch ((error, state) => { + console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadScrollSwitch10+ + +getTouchpadScrollSwitch(): Promise\ + +Obtains the scroll switch status of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadScrollSwitch().then((state) => { + console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadScrollDirection10+ + +setTouchpadScrollDirection(state: boolean, callback: AsyncCallback\): void + +Sets the scroll direction of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| state | boolean | Yes | Scroll direction of the touchpad. The value **true** indicates that the scroll direction is the same as the finger moving direction, and the value **false** indicates the opposite. The default value is **true**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadScrollDirection(true, (error) => { + if (error) { + console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadScrollDirection success`); + }); +} catch (error) { + console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadScrollDirection10+ + +setTouchpadScrollDirection(state: boolean): Promise\ + +Sets the scroll direction of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| state | boolean| Yes | Scroll direction of the touchpad. The value **true** indicates that the scroll direction is the same as the finger moving direction, and the value **false** indicates the opposite. The default value is **true**. | + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadScrollDirection (false).then(() => { + console.log(`setTouchpadScrollDirection success`); + }); +} catch (error) { + console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadScrollDirection10+ + +getTouchpadScrollDirection(callback: AsyncCallback\): void + +Obtains the scroll direction of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadScrollSwitch ((error, state) => { + console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadScrollDirection10+ + +getTouchpadScrollDirection(): Promise\ + +Obtains the scroll direction of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadScrollDirection().then((state) => { + console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadTapSwitch10+ + +setTouchpadTapSwitch(state: boolean, callback: AsyncCallback\): void + +Sets the tap switch of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| state | boolean | Yes |Tap switch status of the touchpad The value **true** indicates that the tap switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadTapSwitch(true, (error) => { + if (error) { + console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadTapSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadTapSwitch 10+ + +setTouchpadTapSwitch(state: boolean): Promise\ + +Sets the tap switch of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| state | boolean| Yes | Tap switch status of the touchpad The value **true** indicates that the tap switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadTapSwitch(false).then(() => { + console.log(`setTouchpadTapSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadTapSwitch10+ + +getTouchpadTapSwitch(callback: AsyncCallback\): void + +Obtains the tap switch status of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadTapSwitch((error, state) => { + console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadTapSwitch10+ + +getTouchpadTapSwitch(): Promise\ + +Obtains the tap switch status of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadTapSwitch().then((state) => { + console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadPointerSpeed10+ + +setTouchpadPointerSpeed(speed: number, callback: AsyncCallback\): void + +Sets the cursor moving speed of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| speed | number | Yes |Cursor moving speed of the touchpad. The value range is [1,11]. The default value is **5**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadPointerSpeed(1, (error) => { + if (error) { + console.log(`setTouchpadPointerSpeedfailed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadPointerSpeed success`); + }); +} catch (error) { + console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadPointerSpeed10+ + +setTouchpadPointerSpeed(speed: number): Promise\ + +Sets the cursor moving speed of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| speed| number | Yes | Cursor moving speed of the touchpad. The value range is [1,11]. The default value is **5**. | + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadPointerSpeed(10).then(() => { + console.log(`setTouchpadPointerSpeed success`); + }); +} catch (error) { + console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadPointerSpeed10+ + +getTouchpadPointerSpeed(callback: AsyncCallback\): void + +Obtains the cursor moving speed of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadPointerSpeed((error, speed) => { + console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`); + }); +} catch (error) { + console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadPointerSpeed10+ + +getTouchpadPointerSpeed(): Promise\ + +Obtains the cursor moving speed of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadPointerSpeed().then((speed) => { + console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`); + }); +} catch (error) { + console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadPinchSwitch10+ + +setTouchpadPinchSwitch(state: boolean, callback: AsyncCallback\): void + +Sets the pinch switch of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| state | boolean | Yes |Pinch switch status of the touchpad. The value **true** indicates that the pinch switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadTapSwitch(true, (error) => { + if (error) { + console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadPinchSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadPinchSwitch10+ + +setTouchpadPinchSwitch(state: boolean): Promise\ + +Sets the pinch switch of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| state | boolean| Yes | Pinch switch status of the touchpad. The value **true** indicates that the pinch switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadPinchSwitch(false).then(() => { + console.log(`setTouchpadPinchSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadPinchSwitch10+ + +getTouchpadPinchSwitch(callback: AsyncCallback\): void + +Obtains the pinch switch status of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadPinchSwitch((error, state) => { + console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadPinchSwitch10+ + +getTouchpadPinchSwitch(): Promise\ + +Obtains the pinch switch status of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadPinchSwitch().then((state) => { + console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadSwipeSwitch10+ + +setTouchpadSwipeSwitch(state: boolean, callback: AsyncCallback\): void + +Sets the multi-finger swipe switch of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| state | boolean | Yes |Swipe switch status of the touchpad. The value **true** indicates that the swipe switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadSwipeSwitch(true, (error) => { + if (error) { + console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadSwipeSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadSwipeSwitch10+ + +setTouchpadSwipeSwitch(state: boolean): Promise\ + +Sets the swipe switch of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| state | boolean| Yes | Swipe switch status of the touchpad. The value **true** indicates that the swipe switch is enabled, and the value **false** indicates the opposite. The default value is **true**. | + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadSwipeSwitch(false).then(() => { + console.log(`setTouchpadSwipeSwitch success`); + }); +} catch (error) { + console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadSwipeSwitch10+ + +getTouchpadSwipeSwitch(callback: AsyncCallback\): void + +Obtains the multi-finger swipe switch status of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadSwipeSwitch((error, state) => { + console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadSwipeSwitch10+ + +getTouchpadSwipeSwitch(): Promise\ + +Obtains the multi-finger swipe switch status of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadSwipeSwitch().then((state) => { + console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`); + }); +} catch (error) { + console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## RightClickType10+ + +Enumerates shortcut menu triggering modes. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +| Name | Value | Description | +| -------------------------------- | ---- | ------ | +| TOUCHPAD_RIGHT_BUTTON | 1 |Tapping the right-button area of the touchpad.| +| TOUCHPAD_LEFT_BUTTON | 2 |Tapping the left-button area of the touchpad.| +| TOUCHPAD_TWO_FINGER_TAP | 3 |Tapping or pressing the touchpad with two fingers.| + +## pointer.setTouchpadRightClickType10+ + +setTouchpadRightClickType(type: RightClickType, callback: AsyncCallback\): void + +Sets the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | ------------------------- | ---- | ------------------------------------- | +| type| RightClickType| Yes |Shortcut menu type of the touchpad.
- TOUCHPAD_RIGHT_BUTTON: tapping the right-button area of the touchpad.
- TOUCHPAD_LEFT_BUTTON: tapping the left-button area of the touchpad.
- TOUCHPAD_TWO_FINGER_TAP: tapping or pressing the touchpad with two fingers.
The default value is **TOUCHPAD_RIGHT_BUTTON**. | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadRightClickType(RightClickType::TOUCHPAD_RIGHT_BUTTON , (error) => { + if (error) { + console.log(`setTouchpadRightClickType, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setTouchpadRightClickType success`); + }); +} catch (error) { + console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setTouchpadRightClickType10+ + +setTouchpadRightClickType(type: RightClickType): Promise\ + +Sets the shortcut menu type of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| ----- | ------ | ---- | ----------------------------------- | +| type| RightClickType| Yes | Shortcut menu type of the touchpad.
- TOUCHPAD_RIGHT_BUTTON: tapping the right-button area of the touchpad.
- TOUCHPAD_LEFT_BUTTON: tapping the left-button area of the touchpad.
- TOUCHPAD_TWO_FINGER_TAP: tapping or pressing the touchpad with two fingers.
The default value is **TOUCHPAD_RIGHT_BUTTON**.| + +**Return value** + +| Name | Description | +| ------------------- | ---------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.setTouchpadRightClickType(RightClickType::TOUCHPAD_RIGHT_BUTTON ).then(() => { + console.log(`setTouchpadRightClickType success`); + }); +} catch (error) { + console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadRightClickType10+ + +getTouchpadRightClickType(callback: AsyncCallback\): void + +Obtains the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Parameters** + +| Name | Type | Mandatory | Description | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback\ | Yes | Callback used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadRightClickType((error, type) => { + console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`); + }); +} catch (error) { + console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getTouchpadRightClickType10+ + +getTouchpadRightClickType(): Promise\ + +Obtains the shortcut menu type of the touchpad. This API uses a promise to return the result. + +**System capability**: SystemCapability.MultimodalInput.Input.Pointer + +**System API**: This is a system API. + +**Return value** + +| Name | Description | +| --------------------- | ------------------- | +| Promise\ | Promise used to return the result.| + +**Example** + +```js +try { + pointer.getTouchpadRightClickType().then((type) => { + console.log(`getTouchpadRightClickType success, typeed: ${JSON.stringify(type)}`); + }); +} catch (error) { + console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` diff --git a/en/application-dev/reference/apis/js-apis-radio.md b/en/application-dev/reference/apis/js-apis-radio.md index cd0c226e17cff6db5a3e6c51371137403adcd2a1..2050db9a62813fe6fabc01fd98cb9c0997bff43a 100644 --- a/en/application-dev/reference/apis/js-apis-radio.md +++ b/en/application-dev/reference/apis/js-apis-radio.md @@ -231,7 +231,7 @@ promise.then(data => { getNetworkSelectionMode\(slotId: number, callback: AsyncCallback\\): void -Obtains the network selection mode of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. +Obtains the network selection mode for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CoreService @@ -268,7 +268,7 @@ radio.getNetworkSelectionMode(slotId, (err, data) => { getNetworkSelectionMode\(slotId: number\): Promise\ -Obtains the network selection mode of the SIM card in the specified slot. This API uses a promise to return the result. +Obtains the network selection mode for the SIM card in the specified slot. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CoreService @@ -957,7 +957,7 @@ promise.then(() => { 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. +Obtains the IMEI for the SIM card in a card slot. This API uses an asynchronous callback to return the result. **System API**: This is a system API. @@ -998,7 +998,7 @@ radio.getIMEI((err, data) => { 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. +Obtains the IMEI for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System API**: This is a system API. @@ -1041,7 +1041,7 @@ radio.getIMEI(slotId, (err, data) => { getIMEI\(slotId?: number\): Promise\ -Obtains the IMEI of the SIM card in the specified slot. This API uses a promise to return the result. +Obtains the IMEI for the SIM card in the specified slot. This API uses a promise to return the result. **System API**: This is a system API. @@ -1091,7 +1091,7 @@ promise.then(data => { 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. +Obtains the MEID for the SIM card in a card slot. This API uses an asynchronous callback to return the result. **System API**: This is a system API. @@ -1132,7 +1132,7 @@ radio.getMEID((err, data) => { 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. +Obtains the MEID for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System API**: This is a system API. @@ -1175,7 +1175,7 @@ radio.getMEID(slotId, (err, data) => { getMEID\(slotId?: number\): Promise\ -Obtains the MEID of the SIM card in the specified slot. This API uses a promise to return the result. +Obtains the MEID for the SIM card in the specified slot. This API uses a promise to return the result. **System API**: This is a system API. @@ -1225,7 +1225,7 @@ promise.then(data => { 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. +Obtains the unique device ID for the SIM card in a card slot. This API uses an asynchronous callback to return the result. **System API**: This is a system API. @@ -1266,7 +1266,7 @@ radio.getUniqueDeviceId((err, data) => { 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. +Obtains the unique device ID for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System API**: This is a system API. @@ -1309,7 +1309,7 @@ radio.getUniqueDeviceId(slotId, (err, data) => { 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. +Obtains the unique device ID for the SIM card in the specified slot. This API uses a promise to return the result. **System API**: This is a system API. @@ -2867,6 +2867,206 @@ promise.then(data => { ``` +## radio.getNetworkCapability10+ + +getNetworkCapability\(slotId: number, type: NetworkCapabilityType, callback: AsyncCallback\\): void + +Obtains the network capability for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. + +**Required permission**: ohos.permission.GET_TELEPHONY_STATE + +**System capability**: SystemCapability.Telephony.CoreService + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | -----------------------------------------------------------------------| ---- | ----------------------------------- | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [NetworkCapabilityType](#networkcapabilitytype10) | Yes | Network capability type. | +| callback | AsyncCallback\<[NetworkCapabilityState](#networkcapabilitystate10)\> | Yes | Callback used to return the result. | + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let type = radio.NetworkCapabilityType.SERVICE_TYPE_NR; +radio.getNetworkCapability(slotId, type, (err, data) => { + console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); +}); +``` + + +## radio.getNetworkCapability10+ + +getNetworkCapability\(slotId: number, type: NetworkCapabilityType\): Promise\ + +Obtains the network capability for the SIM card in the specified slot. This API uses a promise to return the result. + +**System API**: This is a system API. + +**Required permission**: ohos.permission.GET_TELEPHONY_STATE + +**System capability**: SystemCapability.Telephony.CoreService + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------------------------------- | ---- | -------------------------------------- | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [NetworkCapabilityType](#networkcapabilitytype10) | Yes | Network capability type. | + +**Return value** + +| Type | Description | +| ------------------------------------------------------------- | ----------------------- | +| Promise\<[NetworkCapabilityState](#networkcapabilitystate10)\> | Promise used to return the result.| + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let type = radio.NetworkCapabilityType.SERVICE_TYPE_NR; +let promise = radio.getNetworkCapability(slotId, type); +promise.then(data => { + console.log(`getNetworkCapability success, promise: data->${JSON.stringify(data)}`); +}).catch(err => { + console.log(`getNetworkCapability failed, promise: err->${JSON.stringify(err)}`); +}); +``` + + +## radio.setNetworkCapability10+ + +setNetworkCapability\(slotId: number, type: NetworkCapabilityType, state: NetworkCapabilityState, + callback: AsyncCallback\\): void + +Sets the network capability for the SIM card in the specified slot. This API uses an asynchronous callback to return the result. + +**System API**: This is a system API. + +**Required permission**: ohos.permission.SET_TELEPHONY_STATE + +**System capability**: SystemCapability.Telephony.CoreService + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------------------------------- | ---- | -------------------------------------- | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [NetworkCapabilityType](#networkcapabilitytype10) | Yes | Network capability type. | +| state | [NetworkCapabilityState](#networkcapabilitystate10) | Yes | Network capability status. | +| callback | AsyncCallback\ | Yes | Callback used to return the result. | + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let type = radio.NetworkCapabilityType.SERVICE_TYPE_NR; +let state = radio.NetworkCapabilityState.SERVICE_CAPABILITY_ON; +radio.setNetworkCapability(slotId, type, state, (err) => { + console.log(`callback: err->${JSON.stringify(err)}`); +}); +``` + +## radio.setNetworkCapability10+ + +setNetworkCapability\(slotId: number, type: NetworkCapabilityType, state: NetworkCapabilityState\): Promise\ + +Sets the network capability for the SIM card in the specified slot. This API uses a promise to return the result. + +**System API**: This is a system API. + +**Required permission**: ohos.permission.SET_TELEPHONY_STATE + +**System capability**: SystemCapability.Telephony.CoreService + +**Parameters** + +| Name | Type | Mandatory| Description | +| -------- | --------------------------------------------------------------- | ---- | -------------------------------------- | +| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| type | [NetworkCapabilityType](#networkcapabilitytype10) | Yes | Network capability type. | +| state | [NetworkCapabilityState](#networkcapabilitystate10) | Yes | Network capability status. | + +**Return value** + +| Type | Description | +| --------------- | ----------------------- | +| Promise\ | Promise used to return the result.| + +**Error codes** + +For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). + +| ID| Error Message | +| -------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Non-system applications use system APIs. | +| 401 | Parameter error. | +| 8300001 | Invalid parameter value. | +| 8300002 | Operation failed. Cannot connect to service. | +| 8300003 | System internal error. | +| 8300999 | Unknown error code. | + +**Example** + +```js +let slotId = 0; +let type = radio.NetworkCapabilityType.SERVICE_TYPE_NR; +let state = radio.NetworkCapabilityState.SERVICE_CAPABILITY_ON; +let promise = radio.setNetworkCapability(slotId, type, state); +promise.then(data => { + console.log(`setNetworkCapability success, promise: data->${JSON.stringify(data)}`); +}).catch(err => { + console.log(`setNetworkCapability failed, promise: err->${JSON.stringify(err)}`); +}); +``` + + ## RadioTechnology Enumerates radio access technologies. @@ -3290,3 +3490,29 @@ Enumerates IMS service types. | TYPE_VIDEO | 1 | Video service.| | TYPE_UT | 2 | UT service. | | TYPE_SMS | 3 | SMS service.| + +## NetworkCapabilityType10+ + +Network capability type. + +**System API**: This is a system API. + +**System capability**: SystemCapability.Telephony.CoreService + +| Name | Value | Description | +| -----------------| ---- | ---------- | +| SERVICE_TYPE_LTE | 0 | LTE service.| +| SERVICE_TYPE_NR | 1 | NR service.| + +## NetworkCapabilityState10+ + +Defines the network capability switch status. + +**System API**: This is a system API. + +**System capability**: SystemCapability.Telephony.CoreService + +| Name | Value | Description | +| -----------------------| ---- | ---------- | +| SERVICE_CAPABILITY_OFF | 0 | The network capability is disabled.| +| SERVICE_CAPABILITY_ON | 1 | The network capability is enabled.| diff --git a/en/release-notes/changelogs/v4.0-beta1/Readme-EN.md b/en/release-notes/changelogs/v4.0-beta1/Readme-EN.md index eba424652412699f84cddb477631fe4ec156b80c..10cca9e6fee269b59608b52d12cf7940faaf6fce 100644 --- a/en/release-notes/changelogs/v4.0-beta1/Readme-EN.md +++ b/en/release-notes/changelogs/v4.0-beta1/Readme-EN.md @@ -13,6 +13,8 @@ | ArkUI | UX changed | [The hover effect of the \