Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 2c476b34 编写于 作者: S shawn_he
浏览文件
操作

update doc 

Signed-off-by: Nshawn_he <shawn.he@huawei.com>
上级 ee430fb8
显示空白变更内容
内联 并排
Showing with 946 addition and 1232 deletion
en/application-dev/connectivity/http-request.md
浏览文件 @ 2c476b34
...@@ -81,3 +81,8 @@ httpRequest.request( ...@@ -81,3 +81,8 @@ httpRequest.request(
} }
); );
``` ```
## Samples
The following sample is provided to help you better understand how to develop the HTTP data request feature:
- [HTTP Communication (ArkTS) (API9)](https://gitee.com/openharmony/codelabs/tree/master/NetworkManagement/SmartChatEtsOH)
en/application-dev/faqs/Readme-EN.md
浏览文件 @ 2c476b34
...@@ -18,5 +18,4 @@ ...@@ -18,5 +18,4 @@
- [Native API Usage](faqs-native.md) - [Native API Usage](faqs-native.md)
- [Usage of Third- and Fourth-Party Libraries](faqs-third-party-library.md) - [Usage of Third- and Fourth-Party Libraries](faqs-third-party-library.md)
- [IDE Usage](faqs-ide.md) - [IDE Usage](faqs-ide.md)
- [hdc_std Command Usage](faqs-hdc-std.md)
- [Development Board](faqs-development-board.md) - [Development Board](faqs-development-board.md)
\ No newline at end of file
en/application-dev/faqs/faqs-hdc-std.md 已删除 100644 → 0
浏览文件 @ ee430fb8
# hdc_std Command Usage
## Common Log Commands
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 &gt; 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.
## What should I do if the HAP installed on the development board through the IDE cannot be opened?
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 the 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 the 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.
## How do I change the read and write permissions on a file directory on the development board?
Applicable to: OpenHarmony SDK 3.2.5.6, stage model of API version 9
Run the **hdc\_std shell mount -o remount,rw /** command.
## What should I do if the error message "Unknown file option -r" is displayed when hdc_std file recv is run?
Applicable to: OpenHarmony SDK 3.2.5.6, stage model of API version 9
1. Use the the hdc tool in the device image or SDK of the same version.
2. Remove any Chinese characters or spaces from the directory specified for the hdc tool.
## How do I uninstall an application using the hdc command?
Applicable to: OpenHarmony SDK 3.2.2.5
Run the **hdc\_std uninstall [-k] [package_name]** command.
## How do I check whether the system is 32-bit or 64-bit?
Applicable to: OpenHarmony SDK 3.2.5.5
Run the **hdc\_std shell getconf LONG_BIT** command.
If **64** is returned, the system is a 64-bit one. Otherwise, the system is a 32-bit one.
## How do I view the component tree structure?
Applicable to: OpenHarmony SDK 3.2.5.5
1. Run the **hdc\_std shell** command to launch the CLI.
2. Run the **aa dump -a** command to find **abilityID**.
3. Run the **aa dump -i [abilityID] -c -render** command to view the component tree.
en/application-dev/reference/apis/js-apis-call.md
浏览文件 @ 2c476b34
...@@ -14,110 +14,6 @@ To subscribe to the call status, use [`observer.on('callStateChange')`](js-apis- ...@@ -14,110 +14,6 @@ To subscribe to the call status, use [`observer.on('callStateChange')`](js-apis-
import call from '@ohos.telephony.call'; import call from '@ohos.telephony.call';
``` ```
## call.dial<sup>(deprecated)</sup>
dial\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void
Initiates a call. This API uses an asynchronous callback to return the result.
>**NOTE**
>
>This parameter is supported since API version 6 and deprecated since API version 9. You are advised to use [dialCall](#calldialcall9).
**Required Permissions**: ohos.permission.PLACE_CALL
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | --------------------------------------- |
| phoneNumber | string | Yes | Phone number. |
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example**
```js
call.dial("138xxxxxxxx", (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## call.dial<sup>(deprecated)</sup>
dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback<boolean\>\): void
Initiates a call. You can set call options as needed. This API uses an asynchronous callback to return the result.
>**NOTE**
>
>This parameter is supported since API version 6 and deprecated since API version 9. You are advised to use [dialCall](#calldialcall9).
**Required Permissions**: ohos.permission.PLACE_CALL
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | --------------------------------------- |
| phoneNumber | string | Yes | Phone number. |
| options | [DialOptions](#dialoptions) | Yes | Call option, which indicates whether the call is a voice call or video call. |
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example**
```js
call.dial("138xxxxxxxx", {
extras: false
}, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## call.dial<sup>(deprecated)</sup>
dial\(phoneNumber: string, options?: DialOptions\): Promise<boolean\>
Initiates a call. You can set call options as needed. This API uses a promise to return the result.
>**NOTE**
>
>This parameter is supported since API version 6 and deprecated since API version 9. You are advised to use [dialCall](#calldialcall9).
**Required Permissions**: ohos.permission.PLACE_CALL
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | --------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | Yes | Phone number. |
| options | [DialOptions](#dialoptions) | No | Call option, which indicates whether the call is a voice call or video call.|
**Return value**
| Type | Description |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example**
```js
let promise = call.dial("138xxxxxxxx", {
extras: false
});
promise.then(data => {
console.log(`dial success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
console.error(`dial fail, promise: err->${JSON.stringify(err)}`);
});
```
## call.dialCall<sup>9+</sup> ## call.dialCall<sup>9+</sup>
dialCall\(phoneNumber: string, callback: AsyncCallback<void\>\): void dialCall\(phoneNumber: string, callback: AsyncCallback<void\>\): void
...@@ -158,7 +54,6 @@ call.dialCall("138xxxxxxxx", (err) => { ...@@ -158,7 +54,6 @@ call.dialCall("138xxxxxxxx", (err) => {
}); });
``` ```
## call.dialCall<sup>9+</sup> ## call.dialCall<sup>9+</sup>
dialCall\(phoneNumber: string, options: DialCallOptions, callback: AsyncCallback<void\>\): void dialCall\(phoneNumber: string, options: DialCallOptions, callback: AsyncCallback<void\>\): void
...@@ -205,7 +100,6 @@ call.dialCall("138xxxxxxxx", { ...@@ -205,7 +100,6 @@ call.dialCall("138xxxxxxxx", {
}); });
``` ```
## call.dialCall<sup>9+</sup> ## call.dialCall<sup>9+</sup>
dialCall\(phoneNumber: string, options?: DialCallOptions\): Promise<void\> dialCall\(phoneNumber: string, options?: DialCallOptions\): Promise<void\>
...@@ -260,6 +154,108 @@ promise.then(() => { ...@@ -260,6 +154,108 @@ promise.then(() => {
}); });
``` ```
## call.dial<sup>(deprecated)</sup>
dial\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void
Initiates a call. This API uses an asynchronous callback to return the result.
>**NOTE**
>
> This API is supported since API version 6 and deprecated since API version 9. You are advised to use [dialCall](#calldialcall9). The substitute API is available only for system applications.
**Required Permissions**: ohos.permission.PLACE_CALL
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | --------------------------------------- |
| phoneNumber | string | Yes | Phone number. |
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example**
```js
call.dial("138xxxxxxxx", (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## call.dial<sup>(deprecated)</sup>
dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback<boolean\>\): void
Initiates a call. You can set call options as needed. This API uses an asynchronous callback to return the result.
>**NOTE**
>
> This API is supported since API version 6 and deprecated since API version 9. You are advised to use [dialCall](#calldialcall9). The substitute API is available only for system applications.
**Required Permissions**: ohos.permission.PLACE_CALL
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | ---------------------------- | ---- | --------------------------------------- |
| phoneNumber | string | Yes | Phone number. |
| options | [DialOptions](#dialoptions) | Yes | Call option, which indicates whether the call is a voice call or video call. |
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example**
```js
call.dial("138xxxxxxxx", {
extras: false
}, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## call.dial<sup>(deprecated)</sup>
dial\(phoneNumber: string, options?: DialOptions\): Promise<boolean\>
Initiates a call. You can set call options as needed. This API uses a promise to return the result.
>**NOTE**
>
> This API is supported since API version 6 and deprecated since API version 9. You are advised to use [dialCall](#calldialcall9). The substitute API is available only for system applications.
**Required Permissions**: ohos.permission.PLACE_CALL
**System capability**: SystemCapability.Telephony.CallManager
**Parameters**
| Name | Type | Mandatory| Description |
| ----------- | --------------------------- | ---- | -------------------------------------- |
| phoneNumber | string | Yes | Phone number. |
| options | [DialOptions](#dialoptions) | No | Call option, which indicates whether the call is a voice call or video call.|
**Return value**
| Type | Description |
| ---------------------- | ------------------------------------------------------------ |
| Promise&lt;boolean&gt; | Promise used to return the result.<br>- **true**: success<br>- **false**: failure|
**Example**
```js
let promise = call.dial("138xxxxxxxx", {
extras: false
});
promise.then(data => {
console.log(`dial success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
console.error(`dial fail, promise: err->${JSON.stringify(err)}`);
});
```
## call.makeCall<sup>7+</sup> ## call.makeCall<sup>7+</sup>
......
en/application-dev/reference/apis/js-apis-contact.md
浏览文件 @ 2c476b34
...@@ -488,8 +488,6 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void ...@@ -488,8 +488,6 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void
Selects a contact. This API uses an asynchronous callback to return the result. Selects a contact. This API uses an asynchronous callback to return the result.
**Permission required**: ohos.permission.READ_CONTACTS
**System capability**: SystemCapability.Applications.Contacts **System capability**: SystemCapability.Applications.Contacts
**Parameters** **Parameters**
...@@ -517,8 +515,6 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt; ...@@ -517,8 +515,6 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;
Selects a contact. This API uses a promise to return the result. Selects a contact. This API uses a promise to return the result.
**Permission required**: ohos.permission.READ_CONTACTS
**System capability**: SystemCapability.Applications.Contacts **System capability**: SystemCapability.Applications.Contacts
**Return Value** **Return Value**
......
en/application-dev/reference/apis/js-apis-hichecker.md
浏览文件 @ 2c476b34
# @ohos.hichecker (HiChecker) # @ohos.hichecker (HiChecker)
The **hichecker** module is provided for you to check issues that may be easily ignored during development of OpenHarmony applications (including system-built and third-party applications). Such issues include calling of time-consuming functions by key application threads, event distribution and execution timeout in application processes, and ability resource leakage in application processes. The issues are recorded in logs or lead to process crashes explicitly so that you can find and rectify them. The HiChecker module allows you to check issues that may be easily ignored during development of applications (including system-built and third-party applications). Such issues include calling of time-consuming functions by key application threads, event distribution and execution timeout in application processes, and ability resource leakage in application processes. The issues are recorded in logs or lead to process crashes explicitly so that you can find and rectify them.
> **NOTE**<br> > **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. > 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.
...@@ -13,7 +14,7 @@ import hichecker from '@ohos.hichecker'; ...@@ -13,7 +14,7 @@ import hichecker from '@ohos.hichecker';
``` ```
## Constant ## Constants
Provides the constants of all rule types. Provides the constants of all rule types.
...@@ -26,10 +27,8 @@ Provides the constants of all rule types. ...@@ -26,10 +27,8 @@ Provides the constants of all rule types.
| RULE_THREAD_CHECK_SLOW_PROCESS | bigint | Caution rule, which is programmed to detect whether any time-consuming function is invoked. | | RULE_THREAD_CHECK_SLOW_PROCESS | bigint | Caution rule, which is programmed to detect whether any time-consuming function is invoked. |
| RULE_CHECK_ABILITY_CONNECTION_LEAK | bigint | Caution rule, which is programmed to detect whether ability leakage has occurred. | | RULE_CHECK_ABILITY_CONNECTION_LEAK | bigint | Caution rule, which is programmed to detect whether ability leakage has occurred. |
## hichecker.addCheckRule<sup>9+</sup> ## hichecker.addCheckRule<sup>9+</sup>
## hichecker.addRule
addCheckRule(rule: bigint): void addCheckRule(rule: bigint): void
Adds one or more rules. HiChecker detects unexpected operations or gives feedback based on the added rules. Adds one or more rules. HiChecker detects unexpected operations or gives feedback based on the added rules.
...@@ -121,12 +120,12 @@ try { ...@@ -121,12 +120,12 @@ try {
## hichecker.addRule<sup>(deprecated)</sup> ## hichecker.addRule<sup>(deprecated)</sup>
## hichecker.addRule
> **NOTE**<br>This API is deprecated since API version 9. You are advised to use [hichecker.addCheckRule](#hicheckeraddcheckrule9) instead.
addRule(rule: bigint): void addRule(rule: bigint): void
> **NOTE**
>
> This API is deprecated since API version 9. You are advised to use [hichecker.addCheckRule](#hicheckeraddcheckrule9).
Adds one or more rules. HiChecker detects unexpected operations or gives feedback based on the added rules. Adds one or more rules. HiChecker detects unexpected operations or gives feedback based on the added rules.
**System capability**: SystemCapability.HiviewDFX.HiChecker **System capability**: SystemCapability.HiviewDFX.HiChecker
...@@ -152,7 +151,9 @@ hichecker.addRule( ...@@ -152,7 +151,9 @@ hichecker.addRule(
removeRule(rule: bigint): void removeRule(rule: bigint): void
> **NOTE**<br>This API is deprecated since API version 9. You are advised to use [hichecker.removeCheckRule](#hicheckerremovecheckrule9) instead. > **NOTE**
>
> This API is deprecated since API version 9. You are advised to use [hichecker.removeCheckRule](#hicheckerremovecheckrule9).
Removes one or more rules. The removed rules will become ineffective. Removes one or more rules. The removed rules will become ineffective.
...@@ -203,7 +204,9 @@ hichecker.getRule(); // return 1n; ...@@ -203,7 +204,9 @@ hichecker.getRule(); // return 1n;
contains(rule: bigint): boolean contains(rule: bigint): boolean
> **NOTE**<br>This API is deprecated since API version 9. You are advised to use [hichecker.containsCheckRule](#hicheckercontainscheckrule9) instead. > **NOTE**
>
> This API is deprecated since API version 9. You are advised to use [hichecker.containsCheckRule](#hicheckercontainscheckrule9).
Checks whether the specified rule exists in the collection of added rules. If the rule is of the thread level, this operation is performed only on the current thread. Checks whether the specified rule exists in the collection of added rules. If the rule is of the thread level, this operation is performed only on the current thread.
......
en/application-dev/reference/apis/js-apis-http.md
浏览文件 @ 2c476b34
...@@ -336,7 +336,7 @@ on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void ...@@ -336,7 +336,7 @@ on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void
Registers an observer for HTTP Response Header events. Registers an observer for HTTP Response Header events.
>**NOTE** >**NOTE**
>This API has been deprecated. You are advised to use [on('headersReceive')<sup>8+</sup>](#onheadersreceive8) instead. >This API has been deprecated. You are advised to use [on('headersReceive')<sup>8+</sup>](#onheadersreceive8).
**System capability**: SystemCapability.Communication.NetStack **System capability**: SystemCapability.Communication.NetStack
...@@ -363,7 +363,7 @@ Unregisters the observer for HTTP Response Header events. ...@@ -363,7 +363,7 @@ Unregisters the observer for HTTP Response Header events.
>**NOTE** >**NOTE**
> >
>1. This API has been deprecated. You are advised to use [off('headersReceive')<sup>8+</sup>](#offheadersreceive8) instead. >1. This API has been deprecated. You are advised to use [off('headersReceive')<sup>8+</sup>](#offheadersreceive8).
> >
>2. You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events. >2. You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.
......
en/application-dev/reference/apis/js-apis-net-connection.md
浏览文件 @ 2c476b34
...@@ -275,8 +275,8 @@ Binds an application to the specified network, so that the application can acces ...@@ -275,8 +275,8 @@ Binds an application to the specified network, so that the application can acces
```js ```js
connection.getDefaultNet().then(function (netHandle) { connection.getDefaultNet().then(function (netHandle) {
connection.setAppNet(netHandle).then((error, data) => { connection.setAppNet(netHandle).then(() => {
console.log(JSON.stringify(data)) console.log("success")
}).catch(error => { }).catch(error => {
console.log(JSON.stringify(error)) console.log(JSON.stringify(error))
}) })
...@@ -936,7 +936,7 @@ getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>): ...@@ -936,7 +936,7 @@ getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>):
Resolves the host name by using the default network to obtain all IP addresses. This API uses an asynchronous callback to return the result. Resolves the host name by using the default network to obtain all IP addresses. This API uses an asynchronous callback to return the result.
**Required permission**: ohos.permission.GET_NETWORK_INFO **Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.Communication.NetManager.Core **System capability**: SystemCapability.Communication.NetManager.Core
...@@ -973,7 +973,7 @@ getAddressesByName(host: string): Promise\<Array\<NetAddress>> ...@@ -973,7 +973,7 @@ getAddressesByName(host: string): Promise\<Array\<NetAddress>>
Resolves the host name by using the default network to obtain all IP addresses. This API uses a promise to return the result. Resolves the host name by using the default network to obtain all IP addresses. This API uses a promise to return the result.
**Required permission**: ohos.permission.GET_NETWORK_INFO **Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.Communication.NetManager.Core **System capability**: SystemCapability.Communication.NetManager.Core
...@@ -1478,7 +1478,7 @@ getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>): ...@@ -1478,7 +1478,7 @@ getAddressesByName(host: string, callback: AsyncCallback\<Array\<NetAddress>>):
Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses an asynchronous callback to return the result. Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses an asynchronous callback to return the result.
**Required permission**: ohos.permission.GET_NETWORK_INFO **Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.Communication.NetManager.Core **System capability**: SystemCapability.Communication.NetManager.Core
...@@ -1517,7 +1517,7 @@ getAddressesByName(host: string): Promise\<Array\<NetAddress>> ...@@ -1517,7 +1517,7 @@ getAddressesByName(host: string): Promise\<Array\<NetAddress>>
Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses a promise to return the result. Resolves the host name by using the corresponding network to obtain all IP addresses. This API uses a promise to return the result.
**Required permission**: ohos.permission.GET_NETWORK_INFO **Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.Communication.NetManager.Core **System capability**: SystemCapability.Communication.NetManager.Core
...@@ -1560,7 +1560,7 @@ getAddressByName(host: string, callback: AsyncCallback\<NetAddress>): void ...@@ -1560,7 +1560,7 @@ getAddressByName(host: string, callback: AsyncCallback\<NetAddress>): void
Resolves the host name by using the corresponding network to obtain the first IP address. This API uses an asynchronous callback to return the result. Resolves the host name by using the corresponding network to obtain the first IP address. This API uses an asynchronous callback to return the result.
**Required permission**: ohos.permission.GET_NETWORK_INFO **Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.Communication.NetManager.Core **System capability**: SystemCapability.Communication.NetManager.Core
...@@ -1599,7 +1599,7 @@ getAddressByName(host: string): Promise\<NetAddress> ...@@ -1599,7 +1599,7 @@ getAddressByName(host: string): Promise\<NetAddress>
Resolves the host name by using the corresponding network to obtain the first IP address. This API uses a promise to return the result. Resolves the host name by using the corresponding network to obtain the first IP address. This API uses a promise to return the result.
**Required permission**: ohos.permission.GET_NETWORK_INFO **Required permissions**: ohos.permission.INTERNET
**System capability**: SystemCapability.Communication.NetManager.Core **System capability**: SystemCapability.Communication.NetManager.Core
......
en/application-dev/reference/apis/js-apis-radio.md
浏览文件 @ 2c476b34
...@@ -10,7 +10,7 @@ The **radio** module provides basic network search management functions. You can ...@@ -10,7 +10,7 @@ The **radio** module provides basic network search management functions. You can
## Modules to Import ## Modules to Import
``` ```
import radio from '@ohos.telephony.radio' import radio from '@ohos.telephony.radio';
``` ```
## radio.getRadioTech ## radio.getRadioTech
...@@ -31,6 +31,7 @@ Obtains the RAT used in the CS and PS domains for the SIM card in the specified ...@@ -31,6 +31,7 @@ Obtains the RAT used in the CS and PS domains for the SIM card in the specified
| callback | AsyncCallback\<{psRadioTech: [RadioTechnology](#radiotechnology), csRadioTech:[RadioTechnology](#radiotechnology)}\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<{psRadioTech: [RadioTechnology](#radiotechnology), csRadioTech:[RadioTechnology](#radiotechnology)}\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -46,7 +47,7 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -46,7 +47,7 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
radio.getRadioTech(slotId, (err, data) =>{ radio.getRadioTech(slotId, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
}); });
``` ```
...@@ -75,6 +76,7 @@ Obtains the RAT used in the CS and PS domains for the SIM card in the specified ...@@ -75,6 +76,7 @@ Obtains the RAT used in the CS and PS domains for the SIM card in the specified
| Promise<{psRadioTech: [RadioTechnology](#radiotechnology), csRadioTech: [RadioTechnology](#radiotechnology)}> | Promise used to return the result.| | Promise<{psRadioTech: [RadioTechnology](#radiotechnology), csRadioTech: [RadioTechnology](#radiotechnology)}> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -116,6 +118,7 @@ Obtains the network status. This API uses an asynchronous callback to return the ...@@ -116,6 +118,7 @@ Obtains the network status. This API uses an asynchronous callback to return the
| callback | AsyncCallback\<[NetworkState](#networkstate)\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<[NetworkState](#networkstate)\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -130,7 +133,7 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -130,7 +133,7 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
radio.getNetworkState((err, data) =>{ radio.getNetworkState((err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
}); });
``` ```
...@@ -154,6 +157,7 @@ Obtains the network status. This API uses an asynchronous callback to return the ...@@ -154,6 +157,7 @@ Obtains the network status. This API uses an asynchronous callback to return the
| callback | AsyncCallback\<[NetworkState](#networkstate)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[NetworkState](#networkstate)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -198,6 +202,7 @@ Obtains the network status. This API uses a promise to return the result. ...@@ -198,6 +202,7 @@ Obtains the network status. This API uses a promise to return the result.
| Promise\<[NetworkState](#networkstate)\> | Promise used to return the result.| | Promise\<[NetworkState](#networkstate)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -238,6 +243,7 @@ Obtains the network selection mode of the SIM card in the specified slot. This A ...@@ -238,6 +243,7 @@ Obtains the network selection mode of the SIM card in the specified slot. This A
| callback | AsyncCallback\<[NetworkSelectionMode](#networkselectionmode)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[NetworkSelectionMode](#networkselectionmode)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -279,6 +285,7 @@ Obtains the network selection mode of the SIM card in the specified slot. This A ...@@ -279,6 +285,7 @@ Obtains the network selection mode of the SIM card in the specified slot. This A
| Promise\<[NetworkSelectionMode](#networkselectionmode)\> | Promise used to return the result.| | Promise\<[NetworkSelectionMode](#networkselectionmode)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -318,6 +325,7 @@ Obtains the ISO country code of the network with which the SIM card in the speci ...@@ -318,6 +325,7 @@ Obtains the ISO country code of the network with which the SIM card in the speci
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result, which is an ISO country code, for example, **CN** (China).| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result, which is an ISO country code, for example, **CN** (China).|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -359,6 +367,7 @@ Obtains the ISO country code of the network with which the SIM card in the speci ...@@ -359,6 +367,7 @@ Obtains the ISO country code of the network with which the SIM card in the speci
| Promise\<string\> | Promise used to return the result, which is an ISO country code, for example, **CN** (China).| | Promise\<string\> | Promise used to return the result, which is an ISO country code, for example, **CN** (China).|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -397,6 +406,7 @@ Obtains the ID of the slot in which the primary card is located. This API uses a ...@@ -397,6 +406,7 @@ Obtains the ID of the slot in which the primary card is located. This API uses a
| callback | AsyncCallback\<number\> | Yes | Callback invoked to return the result.| | callback | AsyncCallback\<number\> | Yes | Callback invoked to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -430,6 +440,7 @@ Obtains the ID of the slot in which the primary card is located. This API uses a ...@@ -430,6 +440,7 @@ Obtains the ID of the slot in which the primary card is located. This API uses a
| Promise\<number\> | Promise used to return the result.| | Promise\<number\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -467,6 +478,7 @@ Obtains a list of signal strengths of the network with which the SIM card in the ...@@ -467,6 +478,7 @@ Obtains a list of signal strengths of the network with which the SIM card in the
| callback | AsyncCallback\<Array\<[SignalInformation](#signalinformation)\>\> | Yes | Callback used to return the result, which is a list of [SignalInformation](#signalinformation) objects.| | callback | AsyncCallback\<Array\<[SignalInformation](#signalinformation)\>\> | Yes | Callback used to return the result, which is a list of [SignalInformation](#signalinformation) objects.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -508,6 +520,7 @@ Obtains a list of signal strengths of the network with which the SIM card in the ...@@ -508,6 +520,7 @@ Obtains a list of signal strengths of the network with which the SIM card in the
| Promise\<Array\<[SignalInformation](#signalinformation)\>\> | Promise used to return the result, which is a list of [SignalInformation](#signalinformation) objects.| | Promise\<Array\<[SignalInformation](#signalinformation)\>\> | Promise used to return the result, which is a list of [SignalInformation](#signalinformation) objects.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -656,6 +669,7 @@ Checks whether the radio service is enabled on the primary SIM card. This API us ...@@ -656,6 +669,7 @@ Checks whether the radio service is enabled on the primary SIM card. This API us
| callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.<br>- **true**: The radio service is enabled.<br>- **false**: The radio service is disabled.| | callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.<br>- **true**: The radio service is enabled.<br>- **false**: The radio service is disabled.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -694,6 +708,7 @@ Checks whether the radio service is enabled on the SIM card in the specified slo ...@@ -694,6 +708,7 @@ Checks whether the radio service is enabled on the SIM card in the specified slo
| callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.<br>- **true**: The radio service is enabled.<br>- **false**: The radio service is disabled.| | callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result.<br>- **true**: The radio service is enabled.<br>- **false**: The radio service is disabled.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -738,6 +753,7 @@ Checks whether the radio service is enabled on the SIM card in the specified slo ...@@ -738,6 +753,7 @@ Checks whether the radio service is enabled on the SIM card in the specified slo
| Promise\<boolean\> | Promise used to return the result.<br>- **true**: The radio service is enabled.<br>- **false**: The radio service is disabled.| | Promise\<boolean\> | Promise used to return the result.<br>- **true**: The radio service is enabled.<br>- **false**: The radio service is disabled.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -778,6 +794,7 @@ Obtains the carrier name for the SIM card in the specified slot. This API uses a ...@@ -778,6 +794,7 @@ Obtains the carrier name for the SIM card in the specified slot. This API uses a
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result, which is the carrier name, for example, China Mobile.| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result, which is the carrier name, for example, China Mobile.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -819,6 +836,7 @@ Obtains the carrier name for the SIM card in the specified slot. This API uses a ...@@ -819,6 +836,7 @@ Obtains the carrier name for the SIM card in the specified slot. This API uses a
| Promise\<string\> | Promise used t return the result, which is the carrier name, for example, China Mobile. | | Promise\<string\> | Promise used t return the result, which is the carrier name, for example, China Mobile. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -861,6 +879,7 @@ Sets the ID of the slot in which the primary card is located. This API uses an a ...@@ -861,6 +879,7 @@ Sets the ID of the slot in which the primary card is located. This API uses an a
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -877,8 +896,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -877,8 +896,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
radio.setPrimarySlotId(slotId, (err, data) => { radio.setPrimarySlotId(slotId, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -908,6 +927,7 @@ Sets the ID of the slot in which the primary card is located. This API uses a pr ...@@ -908,6 +927,7 @@ Sets the ID of the slot in which the primary card is located. This API uses a pr
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -925,9 +945,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -925,9 +945,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
let promise = radio.setPrimarySlotId(slotId); let promise = radio.setPrimarySlotId(slotId);
promise.then(data => { promise.then(() => {
console.log(`setPrimarySlotId success, promise: data->${JSON.stringify(data)}`); console.log(`setPrimarySlotId success.`);
}).catch(err => { }).catch((err) => {
console.log(`setPrimarySlotId failed, promise: err->${JSON.stringify(err)}`); console.log(`setPrimarySlotId failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -951,6 +971,7 @@ Obtains the IMEI of the SIM card in a card slot. This API uses an asynchronous c ...@@ -951,6 +971,7 @@ Obtains the IMEI of the SIM card in a card slot. This API uses an asynchronous c
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. If the IMEI does not exist, an empty string is returned.| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. If the IMEI does not exist, an empty string is returned.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -991,6 +1012,7 @@ Obtains the IMEI of the SIM card in the specified card slot. This API uses an as ...@@ -991,6 +1012,7 @@ Obtains the IMEI of the SIM card in the specified card slot. This API uses an as
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. If the IMEI does not exist, an empty string is returned.| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. If the IMEI does not exist, an empty string is returned.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1037,6 +1059,7 @@ Obtains the IMEI of the SIM card in the specified card slot. This API uses a pro ...@@ -1037,6 +1059,7 @@ Obtains the IMEI of the SIM card in the specified card slot. This API uses a pro
| Promise\<string\> | Promise used to return the result. If the IMEI does not exist, an empty string is returned.| | Promise\<string\> | Promise used to return the result. If the IMEI does not exist, an empty string is returned.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1079,6 +1102,7 @@ Obtains the MEID of the SIM card in a card slot. This API uses an asynchronous c ...@@ -1079,6 +1102,7 @@ Obtains the MEID of the SIM card in a card slot. This API uses an asynchronous c
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1119,6 +1143,7 @@ Obtains the MEID of the SIM card in the specified card slot. This API uses an as ...@@ -1119,6 +1143,7 @@ Obtains the MEID of the SIM card in the specified card slot. This API uses an as
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1165,6 +1190,7 @@ Obtains the MEID of the SIM card in the specified card slot. This API uses a pro ...@@ -1165,6 +1190,7 @@ Obtains the MEID of the SIM card in the specified card slot. This API uses a pro
| Promise\<string\> | Promise used to return the result.| | Promise\<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1207,6 +1233,7 @@ Obtains the unique device ID of the SIM card in a card slot. This API uses an as ...@@ -1207,6 +1233,7 @@ Obtains the unique device ID of the SIM card in a card slot. This API uses an as
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1247,6 +1274,7 @@ Obtains the unique device ID of the SIM card in the specified card slot. This AP ...@@ -1247,6 +1274,7 @@ Obtains the unique device ID of the SIM card in the specified card slot. This AP
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1293,6 +1321,7 @@ Obtains the unique device ID of the SIM card in the specified card slot. This AP ...@@ -1293,6 +1321,7 @@ Obtains the unique device ID of the SIM card in the specified card slot. This AP
| Promise\<string\> | Promise used to return the result.| | Promise\<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1335,6 +1364,7 @@ Sends a cell location update request. This API uses an asynchronous callback to ...@@ -1335,6 +1364,7 @@ Sends a cell location update request. This API uses an asynchronous callback to
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1349,8 +1379,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1349,8 +1379,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
radio.sendUpdateCellLocationRequest((err, data) => { radio.sendUpdateCellLocationRequest((err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1374,6 +1404,7 @@ Sends a cell location update request for the SIM card in the specified slot. Thi ...@@ -1374,6 +1404,7 @@ Sends a cell location update request for the SIM card in the specified slot. Thi
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1389,8 +1420,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1389,8 +1420,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
radio.sendUpdateCellLocationRequest(slotId, (err, data) => { radio.sendUpdateCellLocationRequest(slotId, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1419,6 +1450,7 @@ Sends a cell location update request for the SIM card in the specified slot. Thi ...@@ -1419,6 +1450,7 @@ Sends a cell location update request for the SIM card in the specified slot. Thi
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1434,10 +1466,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1434,10 +1466,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
let promise = radio.sendUpdateCellLocationRequest(slotId); radio.sendUpdateCellLocationRequest(slotId).then(() => {
promise.then(data => { console.log(`sendUpdateCellLocationRequest success.`);
console.log(`sendUpdateCellLocationRequest success, promise: data->${JSON.stringify(data)}`); }).catch((err) => {
}).catch(err => {
console.log(`sendUpdateCellLocationRequest failed, promise: err->${JSON.stringify(err)}`); console.log(`sendUpdateCellLocationRequest failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1461,6 +1492,7 @@ Obtains cell information. This API uses an asynchronous callback to return the r ...@@ -1461,6 +1492,7 @@ Obtains cell information. This API uses an asynchronous callback to return the r
| callback | AsyncCallback\<Array<[CellInformation](#cellinformation8)\>\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<Array<[CellInformation](#cellinformation8)\>\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1501,6 +1533,7 @@ Obtains cell information for the SIM card in the specified slot. This API uses a ...@@ -1501,6 +1533,7 @@ Obtains cell information for the SIM card in the specified slot. This API uses a
| callback | AsyncCallback\<Array<[CellInformation](#cellinformation8)\>\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<Array<[CellInformation](#cellinformation8)\>\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1547,6 +1580,7 @@ Obtains cell information for the SIM card in the specified slot. This API uses a ...@@ -1547,6 +1580,7 @@ Obtains cell information for the SIM card in the specified slot. This API uses a
| Promise\<Array<[CellInformation](#cellinformation8)\>\> | Promise used to return the result.| | Promise\<Array<[CellInformation](#cellinformation8)\>\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1590,6 +1624,7 @@ Sets the network selection mode. This API uses an asynchronous callback to retur ...@@ -1590,6 +1624,7 @@ Sets the network selection mode. This API uses an asynchronous callback to retur
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1616,8 +1651,8 @@ let networkSelectionModeOptions={ ...@@ -1616,8 +1651,8 @@ let networkSelectionModeOptions={
networkInformation: networkInformation, networkInformation: networkInformation,
resumeSelection: true resumeSelection: true
} }
radio.setNetworkSelectionMode(networkSelectionModeOptions, (err, data) => { radio.setNetworkSelectionMode(networkSelectionModeOptions, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1646,6 +1681,7 @@ Sets the network selection mode. This API uses a promise to return the result. ...@@ -1646,6 +1681,7 @@ Sets the network selection mode. This API uses a promise to return the result.
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1673,9 +1709,9 @@ let networkSelectionModeOptions={ ...@@ -1673,9 +1709,9 @@ let networkSelectionModeOptions={
resumeSelection: true resumeSelection: true
} }
let promise = radio.setNetworkSelectionMode(networkSelectionModeOptions); let promise = radio.setNetworkSelectionMode(networkSelectionModeOptions);
promise.then(data => { promise.then(() => {
console.log(`setNetworkSelectionMode success, promise: data->${JSON.stringify(data)}`); console.log(`setNetworkSelectionMode success.`);
}).catch(err => { }).catch((err) => {
console.log(`setNetworkSelectionMode failed, promise: err->${JSON.stringify(err)}`); console.log(`setNetworkSelectionMode failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1700,6 +1736,7 @@ Obtains network search information for the SIM card in the specified slot. This ...@@ -1700,6 +1736,7 @@ Obtains network search information for the SIM card in the specified slot. This
| callback | AsyncCallback\<[NetworkSearchResult](#networksearchresult)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[NetworkSearchResult](#networksearchresult)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1744,6 +1781,7 @@ Obtains network search information for the SIM card in the specified slot. This ...@@ -1744,6 +1781,7 @@ Obtains network search information for the SIM card in the specified slot. This
| Promise\<[NetworkSearchResult](#networksearchresult)\> | Promise used to return the result.| | Promise\<[NetworkSearchResult](#networksearchresult)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1783,6 +1821,7 @@ Obtains the NR option mode. This API uses an asynchronous callback to return the ...@@ -1783,6 +1821,7 @@ Obtains the NR option mode. This API uses an asynchronous callback to return the
| callback | AsyncCallback\<[NrOptionMode](#nroptionmode8)\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<[NrOptionMode](#nroptionmode8)\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1820,6 +1859,7 @@ Obtains the NR option mode for the SIM card in the specified slot. This API uses ...@@ -1820,6 +1859,7 @@ Obtains the NR option mode for the SIM card in the specified slot. This API uses
| callback | AsyncCallback\<[NrOptionMode](#nroptionmode8)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[NrOptionMode](#nroptionmode8)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1863,6 +1903,7 @@ Obtains the NR option mode for the SIM card in the specified slot. This API uses ...@@ -1863,6 +1903,7 @@ Obtains the NR option mode for the SIM card in the specified slot. This API uses
| Promise\<[NrOptionMode](#nroptionmode8)\> | Promise used to return the result.| | Promise\<[NrOptionMode](#nroptionmode8)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1904,6 +1945,7 @@ Turns on the radio function. This API uses an asynchronous callback to return th ...@@ -1904,6 +1945,7 @@ Turns on the radio function. This API uses an asynchronous callback to return th
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1918,8 +1960,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1918,8 +1960,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
radio.turnOnRadio((err, data) => { radio.turnOnRadio((err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1944,6 +1986,7 @@ Turns on the radio function for the SIM card in the specified slot. This API use ...@@ -1944,6 +1986,7 @@ Turns on the radio function for the SIM card in the specified slot. This API use
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1959,8 +2002,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1959,8 +2002,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
radio.turnOnRadio(slotId, (err, data) => { radio.turnOnRadio(slotId, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1990,6 +2033,7 @@ Turns on the radio function for the SIM card in the specified slot. This API use ...@@ -1990,6 +2033,7 @@ Turns on the radio function for the SIM card in the specified slot. This API use
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2005,10 +2049,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2005,10 +2049,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
let promise = radio.turnOnRadio(slotId); radio.turnOnRadio(slotId).then(() => {
promise.then(data => { console.log(`turnOnRadio success.`);
console.log(`turnOnRadio success, promise: data->${JSON.stringify(data)}`); }).catch((err) => {
}).catch(err => {
console.error(`turnOnRadio failed, promise: err->${JSON.stringify(err)}`); console.error(`turnOnRadio failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2032,6 +2075,7 @@ Turns off the radio function. This API uses an asynchronous callback to return t ...@@ -2032,6 +2075,7 @@ Turns off the radio function. This API uses an asynchronous callback to return t
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<void\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2046,8 +2090,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2046,8 +2090,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
radio.turnOffRadio((err, data) => { radio.turnOffRadio((err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2072,6 +2116,7 @@ Turns off the radio function for the SIM card in the specified slot. This API us ...@@ -2072,6 +2116,7 @@ Turns off the radio function for the SIM card in the specified slot. This API us
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2087,8 +2132,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2087,8 +2132,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
radio.turnOffRadio(slotId, (err, data) => { radio.turnOffRadio(slotId, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2118,6 +2163,7 @@ Turns off the radio function for the SIM card in the specified slot. This API us ...@@ -2118,6 +2163,7 @@ Turns off the radio function for the SIM card in the specified slot. This API us
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2133,10 +2179,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2133,10 +2179,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
let promise = radio.turnOffRadio(slotId); radio.turnOffRadio(slotId).then(() => {
promise.then(data => { console.log(`turnOffRadio success.`);
console.log(`turnOffRadio success, promise: data->${JSON.stringify(data)}`); }).catch((err) => {
}).catch(err => {
console.error(`turnOffRadio failed, promise: err->${JSON.stringify(err)}`); console.error(`turnOffRadio failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2162,6 +2207,7 @@ Sets the preferred network for the SIM card in the specified slot. This API uses ...@@ -2162,6 +2207,7 @@ Sets the preferred network for the SIM card in the specified slot. This API uses
| callback | AsyncCallback\<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2176,8 +2222,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2176,8 +2222,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
radio.setPreferredNetwork(0, 1, (err, data) => { let slotId = 0;
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); radio.setPreferredNetwork(slotId, radio.PreferredNetworkMode.PREFERRED_NETWORK_MODE_GSM, (err) => {
console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2207,6 +2254,7 @@ Sets the preferred network for the SIM card in the specified slot. This API uses ...@@ -2207,6 +2254,7 @@ Sets the preferred network for the SIM card in the specified slot. This API uses
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2221,10 +2269,10 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2221,10 +2269,10 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
let promise = radio.setPreferredNetwork(0, 1); let slotId = 0;
promise.then(data => { radio.setPreferredNetwork(slotId, radio.PreferredNetworkMode.PREFERRED_NETWORK_MODE_GSM).then(() => {
console.log(`setPreferredNetwork success, promise: data->${JSON.stringify(data)}`); console.log(`setPreferredNetwork success.`);
}).catch(err => { }).catch((err) => {
console.log(`setPreferredNetwork failed, promise: err->${JSON.stringify(err)}`); console.log(`setPreferredNetwork failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2249,6 +2297,7 @@ Obtains the preferred network for the SIM card in the specified slot. This API u ...@@ -2249,6 +2297,7 @@ Obtains the preferred network for the SIM card in the specified slot. This API u
| callback | AsyncCallback\<[PreferredNetworkMode](#preferrednetworkmode8)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[PreferredNetworkMode](#preferrednetworkmode8)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2293,6 +2342,7 @@ Obtains the preferred network for the SIM card in the specified slot. This API u ...@@ -2293,6 +2342,7 @@ Obtains the preferred network for the SIM card in the specified slot. This API u
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2336,6 +2386,7 @@ Obtains the IMS registration status of the specified IMS service type for the SI ...@@ -2336,6 +2386,7 @@ Obtains the IMS registration status of the specified IMS service type for the SI
| callback | AsyncCallback<[ImsRegInfo](#imsreginfo9)\> | Yes | Callback used to return the result. | | callback | AsyncCallback<[ImsRegInfo](#imsreginfo9)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2381,6 +2432,7 @@ Obtains the IMS registration status of the specified IMS service type for the SI ...@@ -2381,6 +2432,7 @@ Obtains the IMS registration status of the specified IMS service type for the SI
| Promise\<[ImsRegInfo](#imsreginfo9)\> | Promise used to return the result.| | Promise\<[ImsRegInfo](#imsreginfo9)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2425,6 +2477,7 @@ Enables listening for **imsRegStateChange** events. This API uses an asynchronou ...@@ -2425,6 +2477,7 @@ Enables listening for **imsRegStateChange** events. This API uses an asynchronou
| callback | Callback<[ImsRegInfo](#imsreginfo9)> | Yes | Callback used to return the result. | | callback | Callback<[ImsRegInfo](#imsreginfo9)> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2466,6 +2519,7 @@ Disables listening for **imsRegStateChange** events. This API uses an asynchrono ...@@ -2466,6 +2519,7 @@ Disables listening for **imsRegStateChange** events. This API uses an asynchrono
| callback | Callback<[ImsRegInfo](#imsreginfo9)> | No | Callback used to return the result. | | callback | Callback<[ImsRegInfo](#imsreginfo9)> | No | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
......
en/application-dev/reference/apis/js-apis-sim.md
浏览文件 @ 2c476b34
...@@ -133,6 +133,7 @@ Checks whether the application (caller) has been granted the operator permission ...@@ -133,6 +133,7 @@ Checks whether the application (caller) has been granted the operator permission
| callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<boolean\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -141,7 +142,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -141,7 +142,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -173,6 +173,7 @@ Checks whether the application (caller) has been granted the operator permission ...@@ -173,6 +173,7 @@ Checks whether the application (caller) has been granted the operator permission
| Promise\<boolean\> | Promise used to return the result. The value **true** indicates that the application (caller) has been granted the carrier permission, and the value **false** indicates the opposite.| | Promise\<boolean\> | Promise used to return the result. The value **true** indicates that the application (caller) has been granted the carrier permission, and the value **false** indicates the opposite.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -181,7 +182,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -181,7 +182,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -211,6 +211,7 @@ Obtains the ISO country code of the SIM card in the specified slot. This API use ...@@ -211,6 +211,7 @@ Obtains the ISO country code of the SIM card in the specified slot. This API use
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result, which is an ISO country code, for example, **CN** (China).| | callback | AsyncCallback\<string\> | Yes | Callback used to return the result, which is an ISO country code, for example, **CN** (China).|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -252,6 +253,7 @@ Obtains the ISO country code of the SIM card in the specified slot. This API use ...@@ -252,6 +253,7 @@ Obtains the ISO country code of the SIM card in the specified slot. This API use
| Promise\<string\> | Promise used to return the result, which is an ISO country code, for example, **CN** (China).| | Promise\<string\> | Promise used to return the result, which is an ISO country code, for example, **CN** (China).|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -291,6 +293,7 @@ Obtains the public land mobile network \(PLMN\) ID of the SIM card in the specif ...@@ -291,6 +293,7 @@ Obtains the public land mobile network \(PLMN\) ID of the SIM card in the specif
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -332,6 +335,7 @@ Obtains the PLMN ID of the SIM card in the specified slot. This API uses a promi ...@@ -332,6 +335,7 @@ Obtains the PLMN ID of the SIM card in the specified slot. This API uses a promi
| Promise\<string\> | Promise used to return the result.| | Promise\<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -371,6 +375,7 @@ Obtains the service provider name (SPN) of the SIM card in the specified slot. T ...@@ -371,6 +375,7 @@ Obtains the service provider name (SPN) of the SIM card in the specified slot. T
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -412,6 +417,7 @@ Obtains the SPN of the SIM card in the specified slot. This API uses a promise t ...@@ -412,6 +417,7 @@ Obtains the SPN of the SIM card in the specified slot. This API uses a promise t
| Promise\<string\> | Promise used to return the result.| | Promise\<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -451,6 +457,7 @@ Obtains the state of the SIM card in the specified slot. This API uses an asynch ...@@ -451,6 +457,7 @@ Obtains the state of the SIM card in the specified slot. This API uses an asynch
| callback | AsyncCallback\<[SimState](#simstate)\> | Yes | Callback used to return the result. For details, see [SimState](#simstate). | | callback | AsyncCallback\<[SimState](#simstate)\> | Yes | Callback used to return the result. For details, see [SimState](#simstate). |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -459,7 +466,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -459,7 +466,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -492,6 +498,7 @@ Obtains the state of the SIM card in the specified slot. This API uses a promise ...@@ -492,6 +498,7 @@ Obtains the state of the SIM card in the specified slot. This API uses a promise
| Promise\<[SimState](#simstate)\> | Promise used to return the result.| | Promise\<[SimState](#simstate)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -500,7 +507,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -500,7 +507,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -530,6 +536,7 @@ Obtains the type of the SIM card in the specified slot. This API uses an asynchr ...@@ -530,6 +536,7 @@ Obtains the type of the SIM card in the specified slot. This API uses an asynchr
| callback | AsyncCallback\<[CardType](#cardtype7)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[CardType](#cardtype7)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -571,6 +578,7 @@ Obtains the type of the SIM card in the specified slot. This API uses a promise ...@@ -571,6 +578,7 @@ Obtains the type of the SIM card in the specified slot. This API uses a promise
| Promise\<[CardType](#cardtype7)\> | Promise used to return the result.| | Promise\<[CardType](#cardtype7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -579,7 +587,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -579,7 +587,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -610,6 +617,7 @@ Checks whether the SIM card in the specified slot is installed. This API uses an ...@@ -610,6 +617,7 @@ Checks whether the SIM card in the specified slot is installed. This API uses an
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -618,7 +626,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -618,7 +626,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -651,6 +658,7 @@ Checks whether the SIM card in the specified slot is installed. This API uses a ...@@ -651,6 +658,7 @@ Checks whether the SIM card in the specified slot is installed. This API uses a
| Promise&lt;boolean&gt; | Promise used to return the result. The value **true** indicates that the SIM card in the specified slot is installed, and the value **false** indicates the opposite.| | Promise&lt;boolean&gt; | Promise used to return the result. The value **true** indicates that the SIM card in the specified slot is installed, and the value **false** indicates the opposite.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -693,6 +701,7 @@ Obtains SIM card account information. This API uses an asynchronous callback to ...@@ -693,6 +701,7 @@ Obtains SIM card account information. This API uses an asynchronous callback to
| callback | AsyncCallback\<[IccAccountInfo](#iccaccountinfo7)\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<[IccAccountInfo](#iccaccountinfo7)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -740,6 +749,7 @@ Obtains SIM card account information. This API uses a promise to return the resu ...@@ -740,6 +749,7 @@ Obtains SIM card account information. This API uses a promise to return the resu
| Promise<[IccAccountInfo](#iccaccountinfo7)\> | Promise used to return the result.| | Promise<[IccAccountInfo](#iccaccountinfo7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -783,6 +793,7 @@ Obtains the account information list of the active SIM card. This API uses an as ...@@ -783,6 +793,7 @@ Obtains the account information list of the active SIM card. This API uses an as
| callback | AsyncCallback\<Array<[IccAccountInfo](#iccaccountinfo7)\>\> | Yes | Callback used to return the result.| | callback | AsyncCallback\<Array<[IccAccountInfo](#iccaccountinfo7)\>\> | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -823,6 +834,7 @@ Obtains the account information list of the active SIM card. This API uses a pro ...@@ -823,6 +834,7 @@ Obtains the account information list of the active SIM card. This API uses a pro
| Promise<Array<[IccAccountInfo](#iccaccountinfo7)\>\> | Promise used to return the result.| | Promise<Array<[IccAccountInfo](#iccaccountinfo7)\>\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -866,6 +878,7 @@ Sets the default slot ID of the SIM card that provides voice services. This API ...@@ -866,6 +878,7 @@ Sets the default slot ID of the SIM card that provides voice services. This API
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -882,8 +895,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -882,8 +895,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
sim.setDefaultVoiceSlotId(0, (err, data) => { sim.setDefaultVoiceSlotId(0, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -913,6 +926,7 @@ Sets the default slot ID of the SIM card that provides voice services. This API ...@@ -913,6 +926,7 @@ Sets the default slot ID of the SIM card that provides voice services. This API
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -930,9 +944,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -930,9 +944,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let promise = sim.setDefaultVoiceSlotId(0); let promise = sim.setDefaultVoiceSlotId(0);
promise.then(data => { promise.then(() => {
console.log(`setDefaultVoiceSlotId success, promise: data->${JSON.stringify(data)}`); console.log(`setDefaultVoiceSlotId success.`);
}).catch(err => { }).catch((err) => {
console.log(`setDefaultVoiceSlotId failed, promise: err->${JSON.stringify(err)}`); console.log(`setDefaultVoiceSlotId failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -958,6 +972,7 @@ Sets a display name for the SIM card in the specified slot. This API uses an asy ...@@ -958,6 +972,7 @@ Sets a display name for the SIM card in the specified slot. This API uses an asy
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -974,8 +989,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -974,8 +989,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let name = "ShowName"; let name = "ShowName";
sim.setShowName(0, name, (err, data) => { sim.setShowName(0, name, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1005,6 +1020,7 @@ Sets a display name for the SIM card in the specified slot. This API uses a prom ...@@ -1005,6 +1020,7 @@ Sets a display name for the SIM card in the specified slot. This API uses a prom
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1022,9 +1038,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1022,9 +1038,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let name = "ShowName"; let name = "ShowName";
let promise = sim.setShowName(0, name); let promise = sim.setShowName(0, name);
promise.then(data => { promise.then(() => {
console.log(`setShowName success, promise: data->${JSON.stringify(data)}`); console.log(`setShowName success.`);
}).catch(err => { }).catch((err) => {
console.log(`setShowName failed, promise: err->${JSON.stringify(err)}`); console.log(`setShowName failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1049,6 +1065,7 @@ Obtains the name of the SIM card in the specified slot. This API uses an asynchr ...@@ -1049,6 +1065,7 @@ Obtains the name of the SIM card in the specified slot. This API uses an asynchr
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1095,6 +1112,7 @@ Obtains the name of the SIM card in the specified slot. This API uses a promise ...@@ -1095,6 +1112,7 @@ Obtains the name of the SIM card in the specified slot. This API uses a promise
| Promise&lt;string&gt; | Promise used to return the result.| | Promise&lt;string&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1139,6 +1157,7 @@ Sets a display number for the SIM card in the specified slot. This API uses an a ...@@ -1139,6 +1157,7 @@ Sets a display number for the SIM card in the specified slot. This API uses an a
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1155,8 +1174,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1155,8 +1174,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let number = '+861xxxxxxxxxx'; let number = '+861xxxxxxxxxx';
sim.setShowNumber(0, number, (err, data) => { sim.setShowNumber(0, number, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1187,6 +1206,7 @@ Sets a display number for the SIM card in the specified slot. This API uses a pr ...@@ -1187,6 +1206,7 @@ Sets a display number for the SIM card in the specified slot. This API uses a pr
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1204,9 +1224,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1204,9 +1224,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let number = '+861xxxxxxxxxx'; let number = '+861xxxxxxxxxx';
let promise = sim.setShowNumber(0, number); let promise = sim.setShowNumber(0, number);
promise.then(data => { promise.then(() => {
console.log(`setShowNumber success, promise: data->${JSON.stringify(data)}`); console.log(`setShowNumber success.`);
}).catch(err => { }).catch((err) => {
console.log(`setShowNumber failed, promise: err->${JSON.stringify(err)}`); console.log(`setShowNumber failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1231,6 +1251,7 @@ Obtains the display number of the SIM card in the specified slot. This API uses ...@@ -1231,6 +1251,7 @@ Obtains the display number of the SIM card in the specified slot. This API uses
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1277,6 +1298,7 @@ Obtains the display number of the SIM card in the specified slot. This API uses ...@@ -1277,6 +1298,7 @@ Obtains the display number of the SIM card in the specified slot. This API uses
| Promise&lt;string&gt; | Promise used to return the result.| | Promise&lt;string&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1320,6 +1342,7 @@ Activates a SIM card in a specified card slot. This API uses an asynchronous cal ...@@ -1320,6 +1342,7 @@ Activates a SIM card in a specified card slot. This API uses an asynchronous cal
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1335,8 +1358,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1335,8 +1358,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
sim.activateSim(0, (err, data) => { sim.activateSim(0, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1366,6 +1389,7 @@ Activates the SIM card in the specified slot. This API uses a promise to return ...@@ -1366,6 +1389,7 @@ Activates the SIM card in the specified slot. This API uses a promise to return
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1382,9 +1406,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1382,9 +1406,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let promise = sim.activateSim(0); let promise = sim.activateSim(0);
promise.then(data => { promise.then(() => {
console.log(`activateSim success, promise: data->${JSON.stringify(data)}`); console.log(`activateSim success.`);
}).catch(err => { }).catch((err) => {
console.log(`activateSim failed, promise: err->${JSON.stringify(err)}`); console.log(`activateSim failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1409,6 +1433,7 @@ Disables the SIM card in the specified slot. This API uses an asynchronous callb ...@@ -1409,6 +1433,7 @@ Disables the SIM card in the specified slot. This API uses an asynchronous callb
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1424,8 +1449,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1424,8 +1449,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
sim.deactivateSim(0, (err, data) => { sim.deactivateSim(0, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1455,6 +1480,7 @@ Disables the SIM card in the specified slot. This API uses a promise to return t ...@@ -1455,6 +1480,7 @@ Disables the SIM card in the specified slot. This API uses a promise to return t
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1471,9 +1497,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -1471,9 +1497,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let promise = sim.deactivateSim(0); let promise = sim.deactivateSim(0);
promise.then(data => { promise.then(() => {
console.log(`deactivateSim success, promise: data->${JSON.stringify(data)}`); console.log(`deactivateSim success.`);
}).catch(err => { }).catch((err) => {
console.log(`deactivateSim failed, promise: err->${JSON.stringify(err)}`); console.log(`deactivateSim failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1499,6 +1525,7 @@ Sets the lock status of the SIM card in the specified slot. This API uses an asy ...@@ -1499,6 +1525,7 @@ Sets the lock status of the SIM card in the specified slot. This API uses an asy
| options | [LockInfo](#lockinfo8) | Yes | Lock information.<br>- lockType: [LockType](#locktype8)<br>- password: string<br>- state: [LockState](#lockstate8) | | options | [LockInfo](#lockinfo8) | Yes | Lock information.<br>- lockType: [LockType](#locktype8)<br>- password: string<br>- state: [LockState](#lockstate8) |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1552,6 +1579,7 @@ Sets the lock status of the SIM card in the specified slot. This API uses a prom ...@@ -1552,6 +1579,7 @@ Sets the lock status of the SIM card in the specified slot. This API uses a prom
| Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1602,6 +1630,7 @@ Obtains the lock status of the SIM card in the specified slot. This API uses an ...@@ -1602,6 +1630,7 @@ Obtains the lock status of the SIM card in the specified slot. This API uses an
| options | [LockType](#locktype8) | Yes | Lock type.<br>- **1**: PIN lock<br>- **2**: PIN 2 lock| | options | [LockType](#locktype8) | Yes | Lock type.<br>- **1**: PIN lock<br>- **2**: PIN 2 lock|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1650,6 +1679,7 @@ Obtains the lock status of the SIM card in the specified slot. This API uses a p ...@@ -1650,6 +1679,7 @@ Obtains the lock status of the SIM card in the specified slot. This API uses a p
| Promise<[LockState](#lockstate8)\> | Promise used to return the result.| | Promise<[LockState](#lockstate8)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1696,6 +1726,7 @@ Changes the PIN of the SIM card in the specified slot. This API uses an asynchro ...@@ -1696,6 +1726,7 @@ Changes the PIN of the SIM card in the specified slot. This API uses an asynchro
| oldPin | string | Yes | Old PIN. | | oldPin | string | Yes | Old PIN. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1745,6 +1776,7 @@ Changes the PIN of the SIM card in the specified slot. This API uses a promise t ...@@ -1745,6 +1776,7 @@ Changes the PIN of the SIM card in the specified slot. This API uses a promise t
| Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1791,6 +1823,7 @@ Changes PIN 2 of the SIM card in the specified slot. This API uses an asynchrono ...@@ -1791,6 +1823,7 @@ Changes PIN 2 of the SIM card in the specified slot. This API uses an asynchrono
| oldPin2 | string | Yes | Old PIN. | | oldPin2 | string | Yes | Old PIN. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1840,6 +1873,7 @@ Changes PIN 2 of the SIM card in the specified slot. This API uses a promise to ...@@ -1840,6 +1873,7 @@ Changes PIN 2 of the SIM card in the specified slot. This API uses a promise to
| Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1885,6 +1919,7 @@ Unlocks the PIN of the SIM card in the specified slot. This API uses an asynchro ...@@ -1885,6 +1919,7 @@ Unlocks the PIN of the SIM card in the specified slot. This API uses an asynchro
| callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)> | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1934,6 +1969,7 @@ Unlocks the PIN of the SIM card in the specified slot. This API uses a promise t ...@@ -1934,6 +1969,7 @@ Unlocks the PIN of the SIM card in the specified slot. This API uses a promise t
| Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1981,6 +2017,7 @@ Unlocks the PUK of the SIM card in the specified slot. This API uses an asynchro ...@@ -1981,6 +2017,7 @@ Unlocks the PUK of the SIM card in the specified slot. This API uses an asynchro
| callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2032,6 +2069,7 @@ Unlocks the PUK of the SIM card in the specified slot. This API uses a promise t ...@@ -2032,6 +2069,7 @@ Unlocks the PUK of the SIM card in the specified slot. This API uses a promise t
| Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2075,10 +2113,11 @@ Unlocks PIN 2 of the SIM card in the specified slot. This API uses an asynchrono ...@@ -2075,10 +2113,11 @@ Unlocks PIN 2 of the SIM card in the specified slot. This API uses an asynchrono
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------- | | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2| | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2|
| pin2 | string | Yes | PIN 2 of the SIM card. | | pin2 | string | Yes | PIN of the SIM card. |
| callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2119,7 +2158,7 @@ Unlocks PIN 2 of the SIM card in the specified slot. This API uses a promise to ...@@ -2119,7 +2158,7 @@ Unlocks PIN 2 of the SIM card in the specified slot. This API uses a promise to
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------------------------- | | ------ | ------ | ---- | -------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2| | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2|
| pin2 | string | Yes | PIN 2 of the SIM card. | | pin2 | string | Yes | PIN of the SIM card. |
**Return value** **Return value**
...@@ -2128,6 +2167,7 @@ Unlocks PIN 2 of the SIM card in the specified slot. This API uses a promise to ...@@ -2128,6 +2167,7 @@ Unlocks PIN 2 of the SIM card in the specified slot. This API uses a promise to
| Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2171,10 +2211,11 @@ Unlocks PUK 2 of the SIM card in the specified slot. This API uses an asynchrono ...@@ -2171,10 +2211,11 @@ Unlocks PUK 2 of the SIM card in the specified slot. This API uses an asynchrono
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------- | | -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2| | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2|
| newPin2 | string | Yes | New PIN 2. | | newPin2 | string | Yes | New PIN 2. |
| puk2 | string | Yes | PUK 2 of the SIM card. | | puk2 | string | Yes | PUK of the SIM card. |
| callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[LockStatusResponse](#lockstatusresponse7)&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2217,7 +2258,7 @@ Unlocks PUK 2 of the SIM card in the specified slot. This API uses a promise to ...@@ -2217,7 +2258,7 @@ Unlocks PUK 2 of the SIM card in the specified slot. This API uses a promise to
| ------- | ------ | ---- | -------------------------------------- | | ------- | ------ | ---- | -------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2| | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2|
| newPin2 | string | Yes | New PIN 2. | | newPin2 | string | Yes | New PIN 2. |
| puk2 | string | Yes | PUK 2 of the SIM card. | | puk2 | string | Yes | PUK of the SIM card. |
**Return value** **Return value**
...@@ -2226,6 +2267,7 @@ Unlocks PUK 2 of the SIM card in the specified slot. This API uses a promise to ...@@ -2226,6 +2267,7 @@ Unlocks PUK 2 of the SIM card in the specified slot. This API uses a promise to
| Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise\<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2292,6 +2334,7 @@ Obtains the ICCID of the SIM card in the specified slot. This API uses an asynch ...@@ -2292,6 +2334,7 @@ Obtains the ICCID of the SIM card in the specified slot. This API uses an asynch
| callback | AsyncCallback<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2338,6 +2381,7 @@ Obtains the ICCID of the SIM card in the specified slot. This API uses a promise ...@@ -2338,6 +2381,7 @@ Obtains the ICCID of the SIM card in the specified slot. This API uses a promise
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2381,6 +2425,7 @@ Obtains the voice mailbox alpha identifier of the SIM card in the specified slot ...@@ -2381,6 +2425,7 @@ Obtains the voice mailbox alpha identifier of the SIM card in the specified slot
| callback | AsyncCallback<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2427,6 +2472,7 @@ Obtains the voice mailbox alpha identifier of the SIM card in the specified slot ...@@ -2427,6 +2472,7 @@ Obtains the voice mailbox alpha identifier of the SIM card in the specified slot
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2470,6 +2516,7 @@ Obtains the voice mailbox number of the SIM card in the specified slot. This API ...@@ -2470,6 +2516,7 @@ Obtains the voice mailbox number of the SIM card in the specified slot. This API
| callback | AsyncCallback<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2516,6 +2563,7 @@ Obtains the voice mailbox number of the SIM card in the specified slot. This API ...@@ -2516,6 +2563,7 @@ Obtains the voice mailbox number of the SIM card in the specified slot. This API
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2562,6 +2610,7 @@ Sets voice mailbox information for the SIM card in the specified slot. This API ...@@ -2562,6 +2610,7 @@ Sets voice mailbox information for the SIM card in the specified slot. This API
| callback | AsyncCallback<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2578,8 +2627,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2578,8 +2627,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
sim.setVoiceMailInfo(0, "mail", "xxx@xxx.com", (err, data) => { sim.setVoiceMailInfo(0, "mail", "xxx@xxx.com", (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2611,6 +2660,7 @@ Sets voice mailbox information for the SIM card in the specified slot. This API ...@@ -2611,6 +2660,7 @@ Sets voice mailbox information for the SIM card in the specified slot. This API
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2628,9 +2678,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2628,9 +2678,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let promise = sim.setVoiceMailInfo(0, "mail", "xxx@xxx.com"); let promise = sim.setVoiceMailInfo(0, "mail", "xxx@xxx.com");
promise.then(data => { promise.then(() => {
console.log(`setVoiceMailInfo success, promise: data->${JSON.stringify(data)}`); console.log(`setVoiceMailInfo success.`);
}).catch(err => { }).catch((err) => {
console.log(`setVoiceMailInfo failed, promise: err->${JSON.stringify(err)}`); console.log(`setVoiceMailInfo failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -2655,6 +2705,7 @@ Obtains the MSISDN of the SIM card in the specified slot. This API uses an async ...@@ -2655,6 +2705,7 @@ Obtains the MSISDN of the SIM card in the specified slot. This API uses an async
| callback | AsyncCallback<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2701,6 +2752,7 @@ Obtains the MSISDN of the SIM card in the specified slot. This API uses a promis ...@@ -2701,6 +2752,7 @@ Obtains the MSISDN of the SIM card in the specified slot. This API uses a promis
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2744,6 +2796,7 @@ Obtains the group identifier level 1 (GID1) of the SIM card in the specified slo ...@@ -2744,6 +2796,7 @@ Obtains the group identifier level 1 (GID1) of the SIM card in the specified slo
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2790,6 +2843,7 @@ Obtains the GID1 of the SIM card in the specified slot. This API uses a promise ...@@ -2790,6 +2843,7 @@ Obtains the GID1 of the SIM card in the specified slot. This API uses a promise
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2799,7 +2853,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2799,7 +2853,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -2833,6 +2886,7 @@ Obtains the international mobile subscriber identity (IMSI) of the SIM card in t ...@@ -2833,6 +2886,7 @@ Obtains the international mobile subscriber identity (IMSI) of the SIM card in t
| callback | AsyncCallback\<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback\<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2842,7 +2896,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -2842,7 +2896,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -2879,6 +2932,7 @@ Obtains the IMSI of the SIM card in the specified slot. This API uses a promise ...@@ -2879,6 +2932,7 @@ Obtains the IMSI of the SIM card in the specified slot. This API uses a promise
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2922,6 +2976,7 @@ Obtains the carrier configuration of the SIM card in the specified slot. This AP ...@@ -2922,6 +2976,7 @@ Obtains the carrier configuration of the SIM card in the specified slot. This AP
| callback | AsyncCallback<Array<[OperatorConfig](#operatorconfig8)\>> | Yes | Callback used to return the result. | | callback | AsyncCallback<Array<[OperatorConfig](#operatorconfig8)\>> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -2968,6 +3023,7 @@ Obtains the carrier configuration of the SIM card in the specified slot. This AP ...@@ -2968,6 +3023,7 @@ Obtains the carrier configuration of the SIM card in the specified slot. This AP
| Promise<Array<[OperatorConfig](#operatorconfig8)\>> | Promise used to return the result.| | Promise<Array<[OperatorConfig](#operatorconfig8)\>> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3012,6 +3068,7 @@ Queries contact numbers of the SIM card in the specified slot. This API uses an ...@@ -3012,6 +3068,7 @@ Queries contact numbers of the SIM card in the specified slot. This API uses an
| callback | AsyncCallback<Array<[DiallingNumbersInfo](#diallingnumbersinfo8)\>> | Yes | Callback used to return the result. | | callback | AsyncCallback<Array<[DiallingNumbersInfo](#diallingnumbersinfo8)\>> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3060,6 +3117,7 @@ Queries contact numbers of the SIM card in the specified slot. This API uses a p ...@@ -3060,6 +3117,7 @@ Queries contact numbers of the SIM card in the specified slot. This API uses a p
| Promise<Array<[DiallingNumbersInfo](#diallingnumbersinfo8)\>> | Promise used to return the result.| | Promise<Array<[DiallingNumbersInfo](#diallingnumbersinfo8)\>> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3106,6 +3164,7 @@ Adds contact numbers for the SIM card in the specified slot. This API uses an as ...@@ -3106,6 +3164,7 @@ Adds contact numbers for the SIM card in the specified slot. This API uses an as
| callback | AsyncCallback<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3127,8 +3186,8 @@ let diallingNumbersInof = { ...@@ -3127,8 +3186,8 @@ let diallingNumbersInof = {
number: "138xxxxxxxx", number: "138xxxxxxxx",
pin2: "1234" pin2: "1234"
}; };
sim.addIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof, (err, data) => { sim.addIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3160,6 +3219,7 @@ Adds contact numbers for the SIM card in the specified slot. This API uses a pro ...@@ -3160,6 +3219,7 @@ Adds contact numbers for the SIM card in the specified slot. This API uses a pro
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3181,9 +3241,9 @@ let diallingNumbersInof = { ...@@ -3181,9 +3241,9 @@ let diallingNumbersInof = {
number: "138xxxxxxxx" number: "138xxxxxxxx"
}; };
let promise = sim.addIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof); let promise = sim.addIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof);
promise.then(data => { promise.then(() => {
console.log(`addIccDiallingNumbers success, promise: data->${JSON.stringify(data)}`); console.log(`addIccDiallingNumbers success.`);
}).catch(err => { }).catch((err) => {
console.log(`addIccDiallingNumbers failed, promise: err->${JSON.stringify(err)}`); console.log(`addIccDiallingNumbers failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3205,11 +3265,12 @@ Deletes contact numbers from the SIM card in the specified slot. This API uses a ...@@ -3205,11 +3265,12 @@ Deletes contact numbers from the SIM card in the specified slot. This API uses a
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- | | --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 | | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 |
| type | [ContactType](#contacttype8) | Yes | Contact type.<br>- 1 : GENERAL_CONTACT<br>- 2 : FIXED_DIALING | | type | [ContactType](#contacttype8) | Yes | Contact type.<br>- **1**: GENERAL_CONTACT<br>- **2**: FIXED_DIALING |
| diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. | | diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. |
| callback | AsyncCallback<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3232,8 +3293,8 @@ let diallingNumbersInof = { ...@@ -3232,8 +3293,8 @@ let diallingNumbersInof = {
recordNumber: 123, recordNumber: 123,
pin2: "1234" pin2: "1234"
}; };
sim.delIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof, (err, data) => { sim.delIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3255,7 +3316,7 @@ Deletes contact numbers from the SIM card in the specified slot. This API uses a ...@@ -3255,7 +3316,7 @@ Deletes contact numbers from the SIM card in the specified slot. This API uses a
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- | | --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 | | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 |
| type | [ContactType](#contacttype8) | Yes | Contact type.<br>- 1 : GENERAL_CONTACT<br>- 2 : FIXED_DIALING | | type | [ContactType](#contacttype8) | Yes | Contact type.<br>- **1**: GENERAL_CONTACT<br>- **2**: FIXED_DIALING |
| diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. | | diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. |
**Return value** **Return value**
...@@ -3265,6 +3326,7 @@ Deletes contact numbers from the SIM card in the specified slot. This API uses a ...@@ -3265,6 +3326,7 @@ Deletes contact numbers from the SIM card in the specified slot. This API uses a
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3286,9 +3348,9 @@ let diallingNumbersInof = { ...@@ -3286,9 +3348,9 @@ let diallingNumbersInof = {
number: "138xxxxxxxx" number: "138xxxxxxxx"
}; };
let promise = sim.delIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof); let promise = sim.delIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof);
promise.then(data => { promise.then(() => {
console.log(`delIccDiallingNumbers success, promise: data->${JSON.stringify(data)}`); console.log(`delIccDiallingNumbers success.`);
}).catch(err => { }).catch((err) => {
console.log(`delIccDiallingNumbers failed, promise: err->${JSON.stringify(err)}`); console.log(`delIccDiallingNumbers failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3310,11 +3372,12 @@ Updates contact numbers for the SIM card in the specified slot. This API uses an ...@@ -3310,11 +3372,12 @@ Updates contact numbers for the SIM card in the specified slot. This API uses an
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- | | --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 | | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 |
| type | [ContactType](#contacttype8) | Yes | Contact type.<br>- **1**: GENERAL_CONTACT<br>- **2**: FIXED_DIALING| | type | [ContactType](#contacttype8) | Yes | Contact type.<br>- **1**: GENERAL_CONTACT<br>- **2**: FIXED_DIALING |
| diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. | | diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. |
| callback | AsyncCallback<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3337,8 +3400,8 @@ let diallingNumbersInof = { ...@@ -3337,8 +3400,8 @@ let diallingNumbersInof = {
recordNumber: 123, recordNumber: 123,
pin2: "1234" pin2: "1234"
}; };
sim.updateIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof, (err, data) => { sim.updateIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3360,7 +3423,7 @@ Updates contact numbers for the SIM card in the specified slot. This API uses a ...@@ -3360,7 +3423,7 @@ Updates contact numbers for the SIM card in the specified slot. This API uses a
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- | | --------------- | -------------------------------------------- | ---- | ---------------------------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 | | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2 |
| type | [ContactType](#contacttype8) | Yes | Contact type.<br>- **1**: GENERAL_CONTACT<br>- **2**: FIXED_DIALING| | type | [ContactType](#contacttype8) | Yes | Contact type.<br>- **1**: GENERAL_CONTACT<br>- **2**: FIXED_DIALING |
| diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. | | diallingNumbers | [DiallingNumbersInfo](#diallingnumbersinfo8) | Yes | Contact number information. |
**Return value** **Return value**
...@@ -3370,6 +3433,7 @@ Updates contact numbers for the SIM card in the specified slot. This API uses a ...@@ -3370,6 +3433,7 @@ Updates contact numbers for the SIM card in the specified slot. This API uses a
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3392,9 +3456,9 @@ let diallingNumbersInof = { ...@@ -3392,9 +3456,9 @@ let diallingNumbersInof = {
recordNumber: 123 recordNumber: 123
}; };
let promise = sim.updateIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof); let promise = sim.updateIccDiallingNumbers(0, sim.ContactType.GENERAL_CONTACT, diallingNumbersInof);
promise.then(data => { promise.then(() => {
console.log(`updateIccDiallingNumbers success, promise: data->${JSON.stringify(data)}`); console.log(`updateIccDiallingNumbers success.`);
}).catch(err => { }).catch((err) => {
console.log(`updateIccDiallingNumbers failed, promise: err->${JSON.stringify(err)}`); console.log(`updateIccDiallingNumbers failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3420,6 +3484,7 @@ Sends an envelope command to the SIM card in the specified slot. This API uses a ...@@ -3420,6 +3484,7 @@ Sends an envelope command to the SIM card in the specified slot. This API uses a
| callback | AsyncCallback<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3435,8 +3500,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -3435,8 +3500,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
sim.sendEnvelopeCmd(0, "ls", (err, data) => { sim.sendEnvelopeCmd(0, "ls", (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3467,6 +3532,7 @@ Sends an envelope command to the SIM card in the specified slot. This API uses a ...@@ -3467,6 +3532,7 @@ Sends an envelope command to the SIM card in the specified slot. This API uses a
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3483,9 +3549,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -3483,9 +3549,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let promise = sim.sendEnvelopeCmd(0, "ls"); let promise = sim.sendEnvelopeCmd(0, "ls");
promise.then(data => { promise.then(() => {
console.log(`sendEnvelopeCmd success, promise: data->${JSON.stringify(data)}`); console.log(`sendEnvelopeCmd success.`);
}).catch(err => { }).catch((err) => {
console.log(`sendEnvelopeCmd failed, promise: err->${JSON.stringify(err)}`); console.log(`sendEnvelopeCmd failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3507,10 +3573,11 @@ Sends a terminal response command to the SIM card in the specified slot. This AP ...@@ -3507,10 +3573,11 @@ Sends a terminal response command to the SIM card in the specified slot. This AP
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| -------- | -------------------- | ---- | -------------------------------------- | | -------- | -------------------- | ---- | -------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2| | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2|
| cmd | string | Yes | Command. | | cmd | string | Yes | Envelope command. |
| callback | AsyncCallback<void\> | Yes | Callback used to return the result. | | callback | AsyncCallback<void\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3520,14 +3587,13 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -3520,14 +3587,13 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
```js ```js
sim.sendTerminalResponseCmd(0, "ls", (err, data) => { sim.sendTerminalResponseCmd(0, "ls", (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3549,7 +3615,7 @@ Sends a terminal response command to the SIM card in the specified slot. This AP ...@@ -3549,7 +3615,7 @@ Sends a terminal response command to the SIM card in the specified slot. This AP
| Name| Type | Mandatory| Description | | Name| Type | Mandatory| Description |
| ------ | ------ | ---- | -------------------------------------- | | ------ | ------ | ---- | -------------------------------------- |
| slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2| | slotId | number | Yes | Card slot ID.<br>- **0**: card slot 1<br>- **1**: card slot 2|
| cmd | string | Yes | Command. | | cmd | string | Yes | Envelope command. |
**Return value** **Return value**
...@@ -3558,6 +3624,7 @@ Sends a terminal response command to the SIM card in the specified slot. This AP ...@@ -3558,6 +3624,7 @@ Sends a terminal response command to the SIM card in the specified slot. This AP
| Promise<void\> | Promise used to return the result.| | Promise<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3567,16 +3634,15 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -3567,16 +3634,15 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
```js ```js
let promise = sim.sendTerminalResponseCmd(0, "ls"); let promise = sim.sendTerminalResponseCmd(0, "ls");
promise.then(data => { promise.then(() => {
console.log(`sendTerminalResponseCmd success, promise: data->${JSON.stringify(data)}`); console.log(`sendTerminalResponseCmd success.`);
}).catch(err => { }).catch((err) => {
console.log(`sendTerminalResponseCmd failed, promise: err->${JSON.stringify(err)}`); console.log(`sendTerminalResponseCmd failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3603,6 +3669,7 @@ Unlocks the SIM card in the specified slot. This API uses an asynchronous callba ...@@ -3603,6 +3669,7 @@ Unlocks the SIM card in the specified slot. This API uses an asynchronous callba
| callback | AsyncCallback<[LockStatusResponse](#lockstatusresponse7)\> | Yes | Callback used to return the result. | | callback | AsyncCallback<[LockStatusResponse](#lockstatusresponse7)\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3655,6 +3722,7 @@ Unlocks the SIM card in the specified slot. This API uses a promise to return th ...@@ -3655,6 +3722,7 @@ Unlocks the SIM card in the specified slot. This API uses a promise to return th
| Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.| | Promise<[LockStatusResponse](#lockstatusresponse7)\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3699,6 +3767,7 @@ Obtains the opkey of the SIM card in the specified slot. This API uses an asynch ...@@ -3699,6 +3767,7 @@ Obtains the opkey of the SIM card in the specified slot. This API uses an asynch
| callback | AsyncCallback<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3708,7 +3777,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -3708,7 +3777,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -3749,6 +3817,7 @@ Obtains the opkey of the SIM card in the specified slot. This API uses a promise ...@@ -3749,6 +3817,7 @@ Obtains the opkey of the SIM card in the specified slot. This API uses a promise
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3758,7 +3827,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -3758,7 +3827,6 @@ For details about the following error codes, see [Telephony Error Codes](../../r
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. | | 8300003 | System internal error. |
| 8300004 | Do not have sim card. |
| 8300999 | Unknown error code. | | 8300999 | Unknown error code. |
**Example** **Example**
...@@ -3788,6 +3856,7 @@ Obtains the OpName of the SIM card in the specified slot. This API uses an async ...@@ -3788,6 +3856,7 @@ Obtains the OpName of the SIM card in the specified slot. This API uses an async
| callback | AsyncCallback<string\> | Yes | Callback used to return the result. | | callback | AsyncCallback<string\> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3838,6 +3907,7 @@ Obtains the OpName of the SIM card in the specified slot. This API uses a promis ...@@ -3838,6 +3907,7 @@ Obtains the OpName of the SIM card in the specified slot. This API uses a promis
| Promise<string\> | Promise used to return the result.| | Promise<string\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -3930,12 +4000,12 @@ Enumerates personalized lock types. ...@@ -3930,12 +4000,12 @@ Enumerates personalized lock types.
**System capability**: SystemCapability.Telephony.CoreService **System capability**: SystemCapability.Telephony.CoreService
| Name | Value | Description | | Name | Value | Description |
| ------------ | ---- | ----------------------------------------------- | | ------------ | ---- | ------------------------------------------------ |
| PN_PIN_LOCK | 0 | Personalized network PIN lock. For details, see *3GPP TS 22.022 [33]*. | | PN_PIN_LOCK | 0 | Personalized network PIN lock. For details, see *3GPP TS 22.022 [33]*. |
| PN_PUK_LOCK | 1 | Personalized network PUK lock. | | PN_PUK_LOCK | 1 | Personalized network PUK lock. |
| PU_PIN_LOCK | 2 | Personalized network subset PIN lock. For details, see *3GPP TS 22.022 [33]*. | | PU_PIN_LOCK | 2 | Personalized network subset PIN lock. For details, see *3GPP TS 22.022 [33]*. |
| PU_PUK_LOCK | 3 | Personalized network subset PUK lock. | | PU_PUK_LOCK | 3 | Personalized network subset PUK lock. |
| PP_PIN_LOCK | 4 | Personalized service provider PIN lock. For details, see *3GPP TS 22.022 [33]*.| | PP_PIN_LOCK | 4 | Personalized service provider PIN lock. For details, see *3GPP TS 22.022 [33]*. |
| PP_PUK_LOCK | 5 | Personalized service provider PUK lock. | | PP_PUK_LOCK | 5 | Personalized service provider PUK lock. |
| PC_PIN_LOCK | 6 | Personalized corporate PIN lock. For details, see *3GPP TS 22.022 [33]*. | | PC_PIN_LOCK | 6 | Personalized corporate PIN lock. For details, see *3GPP TS 22.022 [33]*. |
| PC_PUK_LOCK | 7 | Personalized corporate PUK lock. | | PC_PUK_LOCK | 7 | Personalized corporate PUK lock. |
......
en/application-dev/reference/apis/js-apis-sms.md
浏览文件 @ 2c476b34
...@@ -91,6 +91,19 @@ Sends an SMS message. ...@@ -91,6 +91,19 @@ Sends an SMS message.
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | | ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [SendMessageOptions](#sendmessageoptions) | Yes | Options (including the callback) for sending an SMS message.| | options | [SendMessageOptions](#sendmessageoptions) | Yes | Options (including the callback) for sending an SMS message.|
**Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message |
| -------- | -------------------------------------------- |
| 201 | Permission denied. |
| 401 | Parameter error. |
| 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. |
| 8300999 | Unknown error code. |
**Example** **Example**
```js ```js
...@@ -178,6 +191,7 @@ Sets the default slot ID of the SIM card used to send SMS messages. This API use ...@@ -178,6 +191,7 @@ Sets the default slot ID of the SIM card used to send SMS messages. This API use
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -193,8 +207,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -193,8 +207,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
**Example** **Example**
```js ```js
sms.setDefaultSmsSlotId(0, (err, data) => { sms.setDefaultSmsSlotId(0, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}.`);
}); });
``` ```
...@@ -224,6 +238,7 @@ Sets the default slot ID of the SIM card used to send SMS messages. This API use ...@@ -224,6 +238,7 @@ Sets the default slot ID of the SIM card used to send SMS messages. This API use
| Promise\<void\> | Promise used to return the result.| | Promise\<void\> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -240,9 +255,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -240,9 +255,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let promise = sms.setDefaultSmsSlotId(0); let promise = sms.setDefaultSmsSlotId(0);
promise.then(data => { promise.then(() => {
console.log(`setDefaultSmsSlotId success, promise: data->${JSON.stringify(data)}`); console.log(`setDefaultSmsSlotId success.`);
}).catch(err => { }).catch((err) => {
console.error(`setDefaultSmsSlotId failed, promise: err->${JSON.stringify(err)}`); console.error(`setDefaultSmsSlotId failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -268,6 +283,7 @@ Sets the short message service center (SMSC) address. This API uses an asynchron ...@@ -268,6 +283,7 @@ Sets the short message service center (SMSC) address. This API uses an asynchron
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -284,8 +300,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -284,8 +300,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
let smscAddr = '+861xxxxxxxxxx'; let smscAddr = '+861xxxxxxxxxx';
sms.setSmscAddr(slotId, smscAddr, (err,data) => { sms.setSmscAddr(slotId, smscAddr, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -316,6 +332,7 @@ Sets the SMSC address. This API uses a promise to return the result. ...@@ -316,6 +332,7 @@ Sets the SMSC address. This API uses a promise to return the result.
| Promise&lt;void&gt; | Promise used to return the result.| | Promise&lt;void&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -333,9 +350,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -333,9 +350,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
let slotId = 0; let slotId = 0;
let smscAddr = '+861xxxxxxxxxx'; let smscAddr = '+861xxxxxxxxxx';
let promise = sms.setSmscAddr(slotId, smscAddr); let promise = sms.setSmscAddr(slotId, smscAddr);
promise.then(data => { promise.then(() => {
console.log(`setSmscAddr success, promise: data->${JSON.stringify(data)}`); console.log(`setSmscAddr success.`);
}).catch(err => { }).catch((err) => {
console.error(`setSmscAddr failed, promise: err->${JSON.stringify(err)}`); console.error(`setSmscAddr failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -361,6 +378,7 @@ Obtains the SMSC address. This API uses an asynchronous callback to return the r ...@@ -361,6 +378,7 @@ Obtains the SMSC address. This API uses an asynchronous callback to return the r
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -407,6 +425,7 @@ Obtains the SMSC address. This API uses a promise to return the result. ...@@ -407,6 +425,7 @@ Obtains the SMSC address. This API uses a promise to return the result.
| Promise&lt;string&gt; | Promise used to return the result.| | Promise&lt;string&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -469,6 +488,7 @@ Splits an SMS message into multiple segments. This API uses an asynchronous call ...@@ -469,6 +488,7 @@ Splits an SMS message into multiple segments. This API uses an asynchronous call
| callback | AsyncCallback<Array<string\>> | Yes | Callback used to return the result. | | callback | AsyncCallback<Array<string\>> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -515,6 +535,7 @@ Splits an SMS message into multiple segments. This API uses a promise to return ...@@ -515,6 +535,7 @@ Splits an SMS message into multiple segments. This API uses a promise to return
| Promise<Array<string\>> | Promise used to return the result.| | Promise<Array<string\>> | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -558,6 +579,7 @@ Adds a SIM message. This API uses an asynchronous callback to return the result. ...@@ -558,6 +579,7 @@ Adds a SIM message. This API uses an asynchronous callback to return the result.
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -578,8 +600,8 @@ let simMessageOptions = { ...@@ -578,8 +600,8 @@ let simMessageOptions = {
pdu: "xxxxxx", pdu: "xxxxxx",
status: sms.SimMessageStatus.SIM_MESSAGE_STATUS_READ status: sms.SimMessageStatus.SIM_MESSAGE_STATUS_READ
}; };
sms.addSimMessage(simMessageOptions, (err, data) => { sms.addSimMessage(simMessageOptions, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -609,6 +631,7 @@ Adds a SIM message. This API uses a promise to return the result. ...@@ -609,6 +631,7 @@ Adds a SIM message. This API uses a promise to return the result.
| Promise&lt;void&gt; | Promise used to return the result.| | Promise&lt;void&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -630,9 +653,9 @@ let simMessageOptions = { ...@@ -630,9 +653,9 @@ let simMessageOptions = {
status: sms.SimMessageStatus.SIM_MESSAGE_STATUS_READ status: sms.SimMessageStatus.SIM_MESSAGE_STATUS_READ
}; };
let promise = sms.addSimMessage(simMessageOptions); let promise = sms.addSimMessage(simMessageOptions);
promise.then(data => { promise.then(() => {
console.log(`addSimMessage success, promise: data->${JSON.stringify(data)}`); console.log(`addSimMessage success.`);
}).catch(err => { }).catch((err) => {
console.error(`addSimMessage failed, promise: err->${JSON.stringify(err)}`); console.error(`addSimMessage failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -658,6 +681,7 @@ Deletes a SIM message. This API uses an asynchronous callback to return the resu ...@@ -658,6 +681,7 @@ Deletes a SIM message. This API uses an asynchronous callback to return the resu
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -674,8 +698,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -674,8 +698,8 @@ For details about the following error codes, see [Telephony Error Codes](../../r
```js ```js
let slotId = 0; let slotId = 0;
let msgIndex = 1; let msgIndex = 1;
sms.delSimMessage(slotId, msgIndex, (err, data) => { sms.delSimMessage(slotId, msgIndex, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -706,6 +730,7 @@ Deletes a SIM message. This API uses a promise to return the result. ...@@ -706,6 +730,7 @@ Deletes a SIM message. This API uses a promise to return the result.
| Promise&lt;void&gt; | Promise used to return the result.| | Promise&lt;void&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -723,9 +748,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r ...@@ -723,9 +748,9 @@ For details about the following error codes, see [Telephony Error Codes](../../r
let slotId = 0; let slotId = 0;
let msgIndex = 1; let msgIndex = 1;
let promise = sms.delSimMessage(slotId, msgIndex); let promise = sms.delSimMessage(slotId, msgIndex);
promise.then(data => { promise.then(() => {
console.log(`delSimMessage success, promise: data->${JSON.stringify(data)}`); console.log(`delSimMessage success.`);
}).catch(err => { }).catch((err) => {
console.error(`delSimMessage failed, promise: err->${JSON.stringify(err)}`); console.error(`delSimMessage failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -750,6 +775,7 @@ Updates a SIM message. This API uses an asynchronous callback to return the resu ...@@ -750,6 +775,7 @@ Updates a SIM message. This API uses an asynchronous callback to return the resu
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -771,8 +797,8 @@ let updateSimMessageOptions = { ...@@ -771,8 +797,8 @@ let updateSimMessageOptions = {
pdu: "xxxxxxx", pdu: "xxxxxxx",
smsc: "test" smsc: "test"
}; };
sms.updateSimMessage(updateSimMessageOptions, (err, data) => { sms.updateSimMessage(updateSimMessageOptions, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -802,6 +828,7 @@ Updates a SIM message. This API uses a promise to return the result. ...@@ -802,6 +828,7 @@ Updates a SIM message. This API uses a promise to return the result.
| Promise&lt;void&gt; | Promise used to return the result.| | Promise&lt;void&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -824,9 +851,9 @@ let updateSimMessageOptions = { ...@@ -824,9 +851,9 @@ let updateSimMessageOptions = {
smsc: "test" smsc: "test"
}; };
let promise = sms.updateSimMessage(updateSimMessageOptions); let promise = sms.updateSimMessage(updateSimMessageOptions);
promise.then(data => { promise.then(() => {
console.log(`updateSimMessage success, promise: data->${JSON.stringify(data)}`); console.log(`updateSimMessage success.`);
}).catch(err => { }).catch((err) => {
console.error(`updateSimMessage failed, promise: err->${JSON.stringify(err)}`); console.error(`updateSimMessage failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -851,6 +878,7 @@ Obtains all SIM card messages. This API uses an asynchronous callback to return ...@@ -851,6 +878,7 @@ Obtains all SIM card messages. This API uses an asynchronous callback to return
| callback | AsyncCallback<Array<[SimShortMessage](#simshortmessage7)\>> | Yes | Callback used to return the result. | | callback | AsyncCallback<Array<[SimShortMessage](#simshortmessage7)\>> | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -897,6 +925,7 @@ Obtains all SIM card messages. This API uses a promise to return the result. ...@@ -897,6 +925,7 @@ Obtains all SIM card messages. This API uses a promise to return the result.
| PromiseArray<[SimShortMessage](#simshortmessage7)\>&gt; | Promise used to return the result.| | PromiseArray<[SimShortMessage](#simshortmessage7)\>&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -940,6 +969,7 @@ Sets the cell broadcast configuration. This API uses an asynchronous callback to ...@@ -940,6 +969,7 @@ Sets the cell broadcast configuration. This API uses an asynchronous callback to
| callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;void&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -961,8 +991,8 @@ let cbConfigOptions = { ...@@ -961,8 +991,8 @@ let cbConfigOptions = {
endMessageId: 200, endMessageId: 200,
ranType: sms.RanType.TYPE_GSM ranType: sms.RanType.TYPE_GSM
}; };
sms.setCBConfig(cbConfigOptions, (err, data) => { sms.setCBConfig(cbConfigOptions, (err) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -992,6 +1022,7 @@ Sets the cell broadcast configuration. This API uses a promise to return the res ...@@ -992,6 +1022,7 @@ Sets the cell broadcast configuration. This API uses a promise to return the res
| Promise&lt;void&gt; | Promise used to return the result.| | Promise&lt;void&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1014,9 +1045,9 @@ let cbConfigOptions = { ...@@ -1014,9 +1045,9 @@ let cbConfigOptions = {
ranType: sms.RanType.TYPE_GSM ranType: sms.RanType.TYPE_GSM
}; };
let promise = sms.setCBConfig(cbConfigOptions); let promise = sms.setCBConfig(cbConfigOptions);
promise.then(data => { promise.then(() => {
console.log(`setCBConfig success, promise: data->${JSON.stringify(data)}`); console.log(`setCBConfig success.`);
}).catch(err => { }).catch((err) => {
console.error(`setCBConfig failed, promise: err->${JSON.stringify(err)}`); console.error(`setCBConfig failed, promise: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -1041,6 +1072,7 @@ Obtains SMS message segment information. This API uses an asynchronous callback ...@@ -1041,6 +1072,7 @@ Obtains SMS message segment information. This API uses an asynchronous callback
| callback | AsyncCallback&lt;[SmsSegmentsInfo](#smssegmentsinfo8)&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[SmsSegmentsInfo](#smssegmentsinfo8)&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1086,6 +1118,7 @@ Obtains SMS message segment information. This API uses a promise to return the r ...@@ -1086,6 +1118,7 @@ Obtains SMS message segment information. This API uses a promise to return the r
| Promise&lt;[SmsSegmentsInfo](#smssegmentsinfo8)&gt; | Promise used to return the result.| | Promise&lt;[SmsSegmentsInfo](#smssegmentsinfo8)&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1126,6 +1159,7 @@ Checks whether SMS is supported on IMS. This API uses an asynchronous callback t ...@@ -1126,6 +1159,7 @@ Checks whether SMS is supported on IMS. This API uses an asynchronous callback t
| callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.| | callback | AsyncCallback&lt;boolean&gt; | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1169,6 +1203,7 @@ This API uses an asynchronous callback to return the result. This API uses a pro ...@@ -1169,6 +1203,7 @@ This API uses an asynchronous callback to return the result. This API uses a pro
| Promise&lt;boolean&gt; | Promise used to return the result.| | Promise&lt;boolean&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1208,11 +1243,11 @@ Obtains the SMS format supported by the IMS. This API uses an asynchronous callb ...@@ -1208,11 +1243,11 @@ Obtains the SMS format supported by the IMS. This API uses an asynchronous callb
| callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result.| | callback | AsyncCallback&lt;string&gt; | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
| -------- | -------------------------------------------- | | -------- | -------------------------------------------- |
| 201 | Permission denied. |
| 401 | Parameter error. | | 401 | Parameter error. |
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
...@@ -1245,11 +1280,11 @@ Obtains the SMS format supported by the IMS. This API uses a promise to return t ...@@ -1245,11 +1280,11 @@ Obtains the SMS format supported by the IMS. This API uses a promise to return t
| Promise&lt;string&gt; | Promise used to return the result. | | Promise&lt;string&gt; | Promise used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
| -------- | -------------------------------------------- | | -------- | -------------------------------------------- |
| 201 | Permission denied. |
| 401 | Parameter error. | | 401 | Parameter error. |
| 8300001 | Invalid parameter value. | | 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. | | 8300002 | Operation failed. Cannot connect to service. |
...@@ -1285,6 +1320,7 @@ Decodes MMS messages. This API uses an asynchronous callback to return the resul ...@@ -1285,6 +1320,7 @@ Decodes MMS messages. This API uses an asynchronous callback to return the resul
| callback | AsyncCallback&lt;[MmsInformation](#mmsinformation8)&gt; | Yes | Callback used to return the result. | | callback | AsyncCallback&lt;[MmsInformation](#mmsinformation8)&gt; | Yes | Callback used to return the result. |
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1328,6 +1364,7 @@ Decodes MMS messages. This API uses a promise to return the result. ...@@ -1328,6 +1364,7 @@ Decodes MMS messages. This API uses a promise to return the result.
| Promise&lt;&lt;[MmsInformation](#mmsinformation8)&gt;&gt; | Promise used to return the result.| | Promise&lt;&lt;[MmsInformation](#mmsinformation8)&gt;&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1368,6 +1405,7 @@ MMS message code. This API uses an asynchronous callback to return the result. ...@@ -1368,6 +1405,7 @@ MMS message code. This API uses an asynchronous callback to return the result.
| callback | AsyncCallback&lt;Array<number\>&gt; | Yes | Callback used to return the result.| | callback | AsyncCallback&lt;Array<number\>&gt; | Yes | Callback used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1419,6 +1457,7 @@ MMS message code. This API uses a promise to return the result. ...@@ -1419,6 +1457,7 @@ MMS message code. This API uses a promise to return the result.
| Promise&lt;Array<number\>&gt; | Promise used to return the result.| | Promise&lt;Array<number\>&gt; | Promise used to return the result.|
**Error codes** **Error codes**
For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md). For details about the following error codes, see [Telephony Error Codes](../../reference/errorcodes/errorcode-telephony.md).
| ID| Error Message | | ID| Error Message |
...@@ -1955,7 +1994,7 @@ Defines an MMS response index. ...@@ -1955,7 +1994,7 @@ Defines an MMS response index.
| Name | Type | Mandatory| Description | | Name | Type | Mandatory| Description |
| ------------- | ---------------------------------- | ---- | -------- | | ------------- | ---------------------------------- | ---- | -------- |
| transactionId | string | Yes | Event ID. | | transactionId | string | Yes | Event ID. |
| status | number | Yes | Status. | | status | number | Yes | Status |
| version | [MmsVersionType](#mmsversiontype8) | Yes | Version. | | version | [MmsVersionType](#mmsversiontype8) | Yes | Version. |
| reportAllowed | [ReportType](#reporttype8) | No | Report allowed.| | reportAllowed | [ReportType](#reporttype8) | No | Report allowed.|
......
en/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ 2c476b34
# # @ohos.net.socket (Socket Connection) # # @ohos.net.socket (Socket Connection)
The **socket** module implements data transfer over TCPSocket, UDPSocket, WebSocket, and TLSSocket connections.
> **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. > 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.
......
en/application-dev/website.md
浏览文件 @ 2c476b34
...@@ -1303,5 +1303,4 @@ ...@@ -1303,5 +1303,4 @@
- [Native API Usage](faqs/faqs-native.md) - [Native API Usage](faqs/faqs-native.md)
- [Usage of Third- and Fourth-Party Libraries](faqs/faqs-third-party-library.md) - [Usage of Third- and Fourth-Party Libraries](faqs/faqs-third-party-library.md)
- [IDE Usage](faqs/faqs-ide.md) - [IDE Usage](faqs/faqs-ide.md)
- [hdc_std Command Usage](faqs/faqs-hdc-std.md)
- [Development Board](faqs/faqs-development-board.md) - [Development Board](faqs/faqs-development-board.md)
en/device-dev/subsystems/Readme-EN.md
浏览文件 @ 2c476b34
...@@ -100,7 +100,6 @@ ...@@ -100,7 +100,6 @@
- [HiSysEvent Listening](subsys-dfx-hisysevent-listening.md) - [HiSysEvent Listening](subsys-dfx-hisysevent-listening.md)
- [HiSysEvent Query](subsys-dfx-hisysevent-query.md) - [HiSysEvent Query](subsys-dfx-hisysevent-query.md)
- [HiSysEvent Tool Usage](subsys-dfx-hisysevent-tool.md) - [HiSysEvent Tool Usage](subsys-dfx-hisysevent-tool.md)
- [HiDumper Development](subsys-dfx-hidumper.md)
- [HiChecker Development](subsys-dfx-hichecker.md) - [HiChecker Development](subsys-dfx-hichecker.md)
- [FaultLogger Development](subsys-dfx-faultlogger.md) - [FaultLogger Development](subsys-dfx-faultlogger.md)
- [Hiview Development](subsys-dfx-hiview.md) - [Hiview Development](subsys-dfx-hiview.md)
...@@ -108,3 +107,4 @@ ...@@ -108,3 +107,4 @@
- [bytrace](subsys-toolchain-bytrace-guide.md) - [bytrace](subsys-toolchain-bytrace-guide.md)
- [hdc](subsys-toolchain-hdc-guide.md) - [hdc](subsys-toolchain-hdc-guide.md)
- [hiperf](subsys-toolchain-hiperf.md) - [hiperf](subsys-toolchain-hiperf.md)
- [HiDumper](subsys-dfx-hidumper.md)
en/device-dev/subsystems/subsys-dfx-hicollie.md
浏览文件 @ 2c476b34
# HiCollie Development<a name="EN-US_TOPIC_0000001231255509"></a> # HiCollie Development
## Overview<a name="section3432134085116"></a>
## Overview
HiCollie provides the software watchdog function. It provides a unified framework for fault detection and fault log generation to help you locate software timeout faults resulting from system service deadlock, application main thread blocking, and service process timeout. HiCollie provides the software watchdog function. It provides a unified framework for fault detection and fault log generation to help you locate software timeout faults resulting from system service deadlock, application main thread blocking, and service process timeout.
## Available APIs<a name="section139261151145116"></a>
## Available APIs
**Table 1** Description of C++ APIs
**Table 1** Description of XCollieChecker APIs
<a name="table19452225011"></a>
<table><thead align="left"><tr id="row1517803543518"><th class="cellrowborder" valign="top" width="19.698030196980305%" id="mcps1.2.4.1.1"><p id="p484763319529"><a name="p484763319529"></a><a name="p484763319529"></a>Class</p> | API| Description|
</th> | -------- | -------- |
<th class="cellrowborder" valign="top" width="35.82641735826417%" id="mcps1.2.4.1.2"><p id="p1684719339523"><a name="p1684719339523"></a><a name="p1684719339523"></a>API</p> | virtual void CheckBlock() | Provides the callback of the suspension detection result.<br>Input arguments: none<br>Output arguments: none<br>Return value: none|
</th> | virtual void CheckThreadBlock() | Provides the callback of the thread suspension detection result.<br>Input arguments: none<br>Output arguments: none<br>Return value: none|
<th class="cellrowborder" valign="top" width="44.47555244475552%" id="mcps1.2.4.1.3"><p id="p284773315220"><a name="p284773315220"></a><a name="p284773315220"></a>Description</p>
</th>
</tr> **Table 2** Description of XCollie APIs
</thead>
<tbody><tr id="row1361184632117"><td class="cellrowborder" valign="top" width="19.698030196980305%" headers="mcps1.2.4.1.1 "><p id="p6700155032113"><a name="p6700155032113"></a><a name="p6700155032113"></a>XCollieChecker</p> | API| Description|
</td> | -------- | -------- |
<td class="cellrowborder" valign="top" width="35.82641735826417%" headers="mcps1.2.4.1.2 "><p id="p18699115019217"><a name="p18699115019217"></a><a name="p18699115019217"></a>virtual void CheckBlock()</p> | void RegisterXCollieChecker(const sptr&lt;XCollieChecker&gt; &amp;checker, unsigned int type) | Registers the callback of the thread suspension detection result.<br>Input arguments:<br>- **checker**: pointer to the XCollieChecker instance.<br>- **type**: suspension detection type. Set it to **XCOLLIE_THREAD**.<br>Output arguments: none<br>Return value: none|
</td> | int SetTimer(const std::string &amp;name, unsigned int timeout, std::function&lt;void(void*)&gt; func, void *arg, unsigned int flag) | Adds timers.<br>Input arguments:<br>- **name**: timer name.<br>- **timeout**: timeout duration, in seconds.<br>- **func**: timeout callback.<br>- **arg**: pointer to the timeout callback.<br>- **flag**: timer operation type.<br> - **XCOLLIE_FLAG_DEFAULT**: default flag, which is the combination of the other three options.<br> - **XCOLLIE_FLAG_NOOP**: Calls only the timeout callback.<br> - **XCOLLIE_FLAG_LOG**: Generates a timeout fault log.<br> - **XCOLLIE_FLAG_RECOVERY**: Exits the process.<br>Output arguments: none<br>Return value: timer ID if the operation is successful; **-1** otherwise.|
<td class="cellrowborder" valign="top" width="44.47555244475552%" headers="mcps1.2.4.1.3 "><p id="p18700175062115"><a name="p18700175062115"></a><a name="p18700175062115"></a>Provides the callback of the suspension detection result.</p> | bool UpdateTimer(int id, unsigned int timeout) | Updates timers.<br>Input arguments:<br>- **id**: timer ID.<br>- **timeout**: timeout duration, in seconds.<br>Output arguments: none<br>Return value: **true** if the operation is successful; **false** otherwise.|
<p id="p13700125012216"><a name="p13700125012216"></a><a name="p13700125012216"></a>Input arguments: none</p> | void CancelTimer(int id) | Cancels a timer.<br>Input arguments:<br>- **id**: timer ID.<br>Output arguments: none<br>Return value: none|
<p id="p13700650162114"><a name="p13700650162114"></a><a name="p13700650162114"></a>Output arguments: none</p>
<p id="p3700850192115"><a name="p3700850192115"></a><a name="p3700850192115"></a>Return value: none</p>
</td> ## How to Develop
</tr>
<tr id="row8945182185017"><td class="cellrowborder" valign="top" width="19.698030196980305%" headers="mcps1.2.4.1.1 "><p id="p79451227506"><a name="p79451227506"></a><a name="p79451227506"></a>XCollieChecker</p>
</td> ### Thread Suspension Monitoring
<td class="cellrowborder" valign="top" width="35.82641735826417%" headers="mcps1.2.4.1.2 "><p id="p647534064612"><a name="p647534064612"></a><a name="p647534064612"></a>virtual void CheckThreadBlock()</p>
</td>
<td class="cellrowborder" valign="top" width="44.47555244475552%" headers="mcps1.2.4.1.3 "><p id="p127630177475"><a name="p127630177475"></a><a name="p127630177475"></a>Provides the callback of the thread suspension detection result.</p>
<p id="p18763111794719"><a name="p18763111794719"></a><a name="p18763111794719"></a>Input arguments: none</p>
<p id="p87631176478"><a name="p87631176478"></a><a name="p87631176478"></a>Output arguments: none</p>
<p id="p3764111718473"><a name="p3764111718473"></a><a name="p3764111718473"></a>Return value: none</p>
</td>
</tr>
<tr id="row149924222486"><td class="cellrowborder" valign="top" width="19.698030196980305%" headers="mcps1.2.4.1.1 "><p id="p11643173114810"><a name="p11643173114810"></a><a name="p11643173114810"></a>XCollie</p>
</td>
<td class="cellrowborder" valign="top" width="35.82641735826417%" headers="mcps1.2.4.1.2 "><p id="p16289114074812"><a name="p16289114074812"></a><a name="p16289114074812"></a>void RegisterXCollieChecker(const sptr&lt;XCollieChecker&gt; &amp;checker, unsigned int type)</p>
</td>
<td class="cellrowborder" valign="top" width="44.47555244475552%" headers="mcps1.2.4.1.3 "><p id="p186437319482"><a name="p186437319482"></a><a name="p186437319482"></a>Registers the callback of the thread suspension detection result.</p>
<p id="p112011591133"><a name="p112011591133"></a><a name="p112011591133"></a>Input arguments:</p>
<a name="ul7783192181413"></a><a name="ul7783192181413"></a><ul id="ul7783192181413"><li><strong id="b64637561712"><a name="b64637561712"></a><a name="b64637561712"></a>checker</strong>: Indicates the pointer to the XCollieChecker instance.</li><li><strong id="b1947711661711"><a name="b1947711661711"></a><a name="b1947711661711"></a>type</strong>: Indicates the suspension detection type. Set it to <strong id="b259214119717"><a name="b259214119717"></a><a name="b259214119717"></a>XCOLLIE_THREAD</strong>.</li></ul>
<p id="p166439314482"><a name="p166439314482"></a><a name="p166439314482"></a>Output arguments: none</p>
<p id="p564393112485"><a name="p564393112485"></a><a name="p564393112485"></a>Return value: none</p>
</td>
</tr>
<tr id="row594519275012"><td class="cellrowborder" valign="top" width="19.698030196980305%" headers="mcps1.2.4.1.1 "><p id="p294512211505"><a name="p294512211505"></a><a name="p294512211505"></a>XCollie</p>
</td>
<td class="cellrowborder" valign="top" width="35.82641735826417%" headers="mcps1.2.4.1.2 "><p id="p81561310145215"><a name="p81561310145215"></a><a name="p81561310145215"></a>int SetTimer(const std::string &amp;name, unsigned int timeout, std::function&lt;void (void *)&gt; func, void *arg, unsigned int flag)</p>
</td>
<td class="cellrowborder" valign="top" width="44.47555244475552%" headers="mcps1.2.4.1.3 "><p id="p174279246538"><a name="p174279246538"></a><a name="p174279246538"></a>Adds timers.</p>
<p id="p1998141221410"><a name="p1998141221410"></a><a name="p1998141221410"></a>Input arguments:</p>
<a name="ul845512153147"></a><a name="ul845512153147"></a><ul id="ul845512153147"><li><strong id="b44651010141715"><a name="b44651010141715"></a><a name="b44651010141715"></a>name</strong>: Indicates the timer name.</li><li><strong id="b266981221717"><a name="b266981221717"></a><a name="b266981221717"></a>timeout</strong>: Indicates the timeout duration, in seconds.</li><li><strong id="b17158171421710"><a name="b17158171421710"></a><a name="b17158171421710"></a>func</strong>: Indicates the timeout callback.</li><li><strong id="b1950162581810"><a name="b1950162581810"></a><a name="b1950162581810"></a>arg</strong>: Indicates the pointer to the timeout callback.</li><li><strong id="b4949151521714"><a name="b4949151521714"></a><a name="b4949151521714"></a>flag</strong>: Indicates the timer operation type.<p id="p1242762435310"><a name="p1242762435310"></a><a name="p1242762435310"></a>XCOLLIE_FLAG_DEFAULT // Indicates the default flag, which is the combination of the other three options.</p>
<p id="p1542712435312"><a name="p1542712435312"></a><a name="p1542712435312"></a>XCOLLIE_FLAG_NOOP // Calls only the timeout callback.</p>
<p id="p15427112416531"><a name="p15427112416531"></a><a name="p15427112416531"></a>XCOLLIE_FLAG_LOG // Generates a timeout fault log.</p>
<p id="p242762455314"><a name="p242762455314"></a><a name="p242762455314"></a>XCOLLIE_FLAG_RECOVERY // Exits the process.</p>
</li></ul>
<p id="p15427102445311"><a name="p15427102445311"></a><a name="p15427102445311"></a>Output arguments: none</p>
<p id="p144271424155316"><a name="p144271424155316"></a><a name="p144271424155316"></a>Return value: Returns the timer ID if the operation is successful; returns <strong id="b2229713291"><a name="b2229713291"></a><a name="b2229713291"></a>-1</strong> otherwise.</p>
</td>
</tr>
<tr id="row1294692165010"><td class="cellrowborder" valign="top" width="19.698030196980305%" headers="mcps1.2.4.1.1 "><p id="p19461929506"><a name="p19461929506"></a><a name="p19461929506"></a>XCollie</p>
</td>
<td class="cellrowborder" valign="top" width="35.82641735826417%" headers="mcps1.2.4.1.2 "><p id="p119467215012"><a name="p119467215012"></a><a name="p119467215012"></a>bool UpdateTimer(int id, unsigned int timeout)</p>
</td>
<td class="cellrowborder" valign="top" width="44.47555244475552%" headers="mcps1.2.4.1.3 "><p id="p3831253185713"><a name="p3831253185713"></a><a name="p3831253185713"></a>Updates timers.</p>
<p id="p10649172815148"><a name="p10649172815148"></a><a name="p10649172815148"></a>Input arguments:</p>
<a name="ul1628783221411"></a><a name="ul1628783221411"></a><ul id="ul1628783221411"><li><strong id="b61651021161710"><a name="b61651021161710"></a><a name="b61651021161710"></a>id</strong>: Indicates the timer ID.</li><li><strong id="b24661423141717"><a name="b24661423141717"></a><a name="b24661423141717"></a>timeout</strong>: Indicates the timeout duration, in seconds.</li></ul>
<p id="p11831115375719"><a name="p11831115375719"></a><a name="p11831115375719"></a>Output arguments: none</p>
<p id="p38311853105716"><a name="p38311853105716"></a><a name="p38311853105716"></a>Return value: Returns <strong id="b95701352192819"><a name="b95701352192819"></a><a name="b95701352192819"></a>true</strong> if the operation is successful; returns <strong id="b175761652152814"><a name="b175761652152814"></a><a name="b175761652152814"></a>false</strong> otherwise.</p>
</td>
</tr>
<tr id="row594682175013"><td class="cellrowborder" valign="top" width="19.698030196980305%" headers="mcps1.2.4.1.1 "><p id="p194614212504"><a name="p194614212504"></a><a name="p194614212504"></a>XCollie</p>
</td>
<td class="cellrowborder" valign="top" width="35.82641735826417%" headers="mcps1.2.4.1.2 "><p id="p1435552713588"><a name="p1435552713588"></a><a name="p1435552713588"></a>void CancelTimer(int id)</p>
</td>
<td class="cellrowborder" valign="top" width="44.47555244475552%" headers="mcps1.2.4.1.3 "><p id="p06791131580"><a name="p06791131580"></a><a name="p06791131580"></a>Cancels timers.</p>
<p id="p868013165815"><a name="p868013165815"></a><a name="p868013165815"></a>Input arguments:</p>
<p id="p9311488283"><a name="p9311488283"></a><a name="p9311488283"></a><strong id="b9666749171816"><a name="b9666749171816"></a><a name="b9666749171816"></a>id</strong>: Indicates the timer ID.</p>
<p id="p12680537587"><a name="p12680537587"></a><a name="p12680537587"></a>Output arguments: none</p>
<p id="p768015317586"><a name="p768015317586"></a><a name="p768015317586"></a>Return value: none</p>
</td>
</tr>
</tbody>
</table>
## Example<a name="section1589120102458"></a>
Print logs.
```
timeout: TimeoutTimer start at 1611040305 to check 1s ago
----------StacktraceCatcher CurrentTime:2021-01-19 15:11:45 Unexecuted(-1)(LogType:Stacktrace Pid:27689 Process:XCollieTimeoutModuleTest)----------
----- pid 27689 at 2021-01-19 15:11:45 -----
Cmd line: ./XCollieTimeoutModuleTest
ABI: 'arm64'
"XCollieTimeoutM" sysTid=27689
#01 pc 00000000000174cc /data/test/XCollieTimeoutModuleTest
```
## How to Develop<a name="section13905646534"></a>
### C++<a name="section9797199145316"></a>
### Thread Suspension Monitoring<a name="section1734221332"></a>
This function requires you to implement two callback functions: **CheckBlock** and **CheckThreadBlock** of the **XCollieChecker** class. After the callbacks are implemented, you need to use the **RegisterXCollieChecker** function of the **XCollie** class to register their instances. The suspension monitoring thread periodically executes all successfully registered callbacks, checks the thread logic completion flag, and determines whether the service logic of any registered thread is suspended. This function requires you to implement two callback functions: **CheckBlock** and **CheckThreadBlock** of the **XCollieChecker** class. After the callbacks are implemented, you need to use the **RegisterXCollieChecker** function of the **XCollie** class to register their instances. The suspension monitoring thread periodically executes all successfully registered callbacks, checks the thread logic completion flag, and determines whether the service logic of any registered thread is suspended.
1. Develop the source code. 1. Develop the source code.
Include the **xcollie** header file in the source file. Include the **xcollie** header file in the source file.
``` ```
...@@ -124,6 +42,7 @@ This function requires you to implement two callback functions: **CheckBlock** ...@@ -124,6 +42,7 @@ This function requires you to implement two callback functions: **CheckBlock**
Add the following code to the service code: Add the following code to the service code:
``` ```
void MyXCollieChecker::CheckLock() void MyXCollieChecker::CheckLock()
{ {
...@@ -138,7 +57,7 @@ This function requires you to implement two callback functions: **CheckBlock** ...@@ -138,7 +57,7 @@ This function requires you to implement two callback functions: **CheckBlock**
sptr<XCollieChecker> checker = new MyXCollieChecker("MyXCollieChecker"); sptr<XCollieChecker> checker = new MyXCollieChecker("MyXCollieChecker");
XCollie::GetInstance().RegisterXCollieChecker(checker, XCollie::GetInstance().RegisterXCollieChecker(checker,
(XCOLLIE_LOCK | XCOLLIE_THREAD)); (XCOLLIE_LOCK | XCOLLIE_THREAD));
... ......
``` ```
2. Configure compilation information. Specifically, add the subsystem SDK dependency to **BUILD.gn**. 2. Configure compilation information. Specifically, add the subsystem SDK dependency to **BUILD.gn**.
...@@ -148,12 +67,11 @@ This function requires you to implement two callback functions: **CheckBlock** ...@@ -148,12 +67,11 @@ This function requires you to implement two callback functions: **CheckBlock**
``` ```
### Timeout Monitoring<a name="section2186947140"></a> ### Timeout Monitoring
You can add a maximum of 128 timers for a single process by using the **SetTimer** function. Adding timers will fail if the number of timers has reached the upper limit. You can add a maximum of 128 timers for a single process by using the **SetTimer** function. Adding timers will fail if the number of timers has reached the upper limit.
1. Develop the source code. 1. Develop the source code.
Include the **xcollie** header file in the source file. Include the **xcollie** header file in the source file.
``` ```
...@@ -173,7 +91,7 @@ You can add a maximum of 128 timers for a single process by using the **SetTime ...@@ -173,7 +91,7 @@ You can add a maximum of 128 timers for a single process by using the **SetTime
XCollie::GetInstance().UpdateTimer(id, 5); XCollie::GetInstance().UpdateTimer(id, 5);
/* time consuming job */ /* time consuming job */
XCollie::GetInstance().CancelTimer(id); XCollie::GetInstance().CancelTimer(id);
... ......
``` ```
2. Configure compilation information. Specifically, add the subsystem SDK dependency to **BUILD.gn**. 2. Configure compilation information. Specifically, add the subsystem SDK dependency to **BUILD.gn**.
...@@ -181,5 +99,3 @@ You can add a maximum of 128 timers for a single process by using the **SetTime ...@@ -181,5 +99,3 @@ You can add a maximum of 128 timers for a single process by using the **SetTime
``` ```
external_deps = [ "hiviewdfx:libxcollie" ] external_deps = [ "hiviewdfx:libxcollie" ]
``` ```
en/device-dev/subsystems/subsys-dfx-hidumper.md
浏览文件 @ 2c476b34
# HiDumper Development # HiDumper
## Overview ## Overview
### Introduction
HiDumper is a tool provided by OpenHarmony for developers, testers, and IDE tool engineers to obtain system information necessary for analyzing and locating faults. This section applies only to the standard system. HiDumper is a tool provided by OpenHarmony for developers, testers, and IDE tool engineers to obtain system information necessary for analyzing and locating faults. This section applies only to the standard system.
### Source Code Directories ## Source Code Directories
``` ```
...@@ -34,14 +31,14 @@ HiDumper is a tool provided by OpenHarmony for developers, testers, and IDE tool ...@@ -34,14 +31,14 @@ HiDumper is a tool provided by OpenHarmony for developers, testers, and IDE tool
``` ```
## Usage # Usage
### Command-Line Options ## Command-Line Options
**Table 1** HiDumper command-line options **Table 1** HiDumper command-line options
| Option| Description| | Option| **Description**|
| -------- | -------- | | -------- | -------- |
| -h | Shows the help Information.| | -h | Shows the help Information.|
| -t&nbsp;[timeout] | Specifies the timeout period, in seconds. The default value is **30**. Value **0** indicates no timeout limit.| | -t&nbsp;[timeout] | Specifies the timeout period, in seconds. The default value is **30**. Value **0** indicates no timeout limit.|
...@@ -56,14 +53,14 @@ HiDumper is a tool provided by OpenHarmony for developers, testers, and IDE tool ...@@ -56,14 +53,14 @@ HiDumper is a tool provided by OpenHarmony for developers, testers, and IDE tool
| --net | Exports network information.| | --net | Exports network information.|
| --storage | Exports storage information.| | --storage | Exports storage information.|
| -p | Exports the process list and all process information.| | -p | Exports the process list and all process information.|
| -p&nbsp;[pid] | Exports all information about a specified process.| | -p&nbsp;[pid] | Exports all information about the specified process.|
| --cpuusage&nbsp;[pid] | Exports the CPU usage information based on **pid**.| | --cpuusage&nbsp;[pid] | Exports the CPU usage information. If **pid** is specified, the CPU usage of the corresponding process is exported.|
| --cpufreq | Exports the actual CPU frequency.| | --cpufreq | Exports the actual CPU frequency.|
| --mem&nbsp;[pid] | Exports the memory usage information based on **pid**.| | --mem&nbsp;[pid] | Export memory usage information. If **pid** is specified, the memory usage of the corresponding process is exported.|
| --zip | Compresses the exported information to a specified folder.| | --zip | Compresses the exported information to a specified folder.|
### Development Example ## Development Example
HiDumper helps you export basic system information to locate and analyze faults. Complex parameters passed to sub-services and abilities must be enclosed in double quotation marks. HiDumper helps you export basic system information to locate and analyze faults. Complex parameters passed to sub-services and abilities must be enclosed in double quotation marks.
...@@ -118,7 +115,7 @@ The procedure is as follows: ...@@ -118,7 +115,7 @@ The procedure is as follows:
hidumper -s 3008 hidumper -s 3008
``` ```
9. Run the **hidumper -e** command to obtain the crash information generated by the FaultLogger module. 9. Run the **hidumper -e** command to obtain the crash information generated by the FaultLoger module.
``` ```
hidumper -e hidumper -e
...@@ -148,7 +145,7 @@ The procedure is as follows: ...@@ -148,7 +145,7 @@ The procedure is as follows:
hidumper -p 1024 hidumper -p 1024
``` ```
14. Run the **hidumper --cpuusage [pid]** command to obtain the CPU usage information of the process whose PID has been specified. 14. Run the **hidumper --cpuusage [pid]** command to obtain the CPU usage information. If the PID of a process is specified, only the CPU usage of the process is returned.
``` ```
hidumper --cpuusage hidumper --cpuusage
...@@ -161,7 +158,7 @@ The procedure is as follows: ...@@ -161,7 +158,7 @@ The procedure is as follows:
hidumper --cpufreq hidumper --cpufreq
``` ```
16. Run the **hidumper --mem [pid]** command to obtain all memory usage information of the process whose PID has been specified. 16. Run the **hidumper --mem [pid]** command to obtain all memory usage information. If the PID of a process is specified, only the memory usage of the process is returned.
``` ```
hidumper --mem [pid] hidumper --mem [pid]
......
en/device-dev/subsystems/subsys-dfx-hitracechain.md
浏览文件 @ 2c476b34
...@@ -4,496 +4,204 @@ ...@@ -4,496 +4,204 @@
HiTraceChain tracks the call chain with the same **traceid** throughout the inter-device, inter-process, and inter-thread service processes. It associates and displays the call relationship and various output information during the entire process, helping you analyze and locate faults and optimize the system. HiTraceChain tracks the call chain with the same **traceid** throughout the inter-device, inter-process, and inter-thread service processes. It associates and displays the call relationship and various output information during the entire process, helping you analyze and locate faults and optimize the system.
## Use Cases
## When to Use
HiTraceChain can be used for the following purposes: HiTraceChain can be used for the following purposes:
- Associates and reports service process information \(such as logs and events\) on the device. - Associates and reports service process information (such as logs and events) on the device.
- Displays and analyzes reported information on the cloud to facilitate fault location. - Displays and analyzes reported information on the cloud to facilitate fault location.
- Works with the IDE to debug the detailed service process and time consumption distribution for system optimization. - Works with the IDE to debug the detailed service process and time consumption distribution for system optimization.
**Figure 1** Use cases of HiTraceChain **Figure 1** Use cases of HiTraceChain
![](figures/use-cases-of-hitrace.png "use-cases-of-hitrace") ![](figures/use-cases-of-hitrace.png "use-cases-of-hitrace")
### Usage Example ### Usage Example
**Figure 2** Service calling process \(inter-device and inter-process synchronous call\) **Figure 2** Service calling process \(inter-device and inter-process synchronous call\)
![](figures/service-calling-process-(inter-device-and-inter-process-synchronous-call).png "service-calling-process-(inter-device-and-inter-process-synchronous-call)") ![](figures/service-calling-process-(inter-device-and-inter-process-synchronous-call).png "service-calling-process-(inter-device-and-inter-process-synchronous-call)")
1. Display the call relationship in the service process, analyze key paths and function dependency, and determine the time consumption and call frequency at each call point to detect performance bottlenecks. 1. Display the call relationship in the service process, analyze key paths and function dependency, and determine the time consumption and call frequency at each call point to detect performance bottlenecks.
**Figure 3** Service calling process **Figure 3** Service calling process
![](figures/service-calling-process.png "service-calling-process") ![](figures/service-calling-process.png "service-calling-process")
**Figure 4** Time delay in the service calling process
**Figure 4** Time delay in the service calling process
![](figures/time-delay-in-the-service-calling-process.png "time-delay-in-the-service-calling-process") ![](figures/time-delay-in-the-service-calling-process.png "time-delay-in-the-service-calling-process")
2. Add **traceid** to logs and events automatically to facilitate comprehensive analysis and quick fault location. 2. Add **traceid** to logs and events automatically to facilitate comprehensive analysis and quick fault location.
## Available APIs ## Available APIs
HiTraceChain provides C++ and C APIs. The upper-layer services mainly use HiTraceChain to start and stop call chain tracing. HiTraceChain provides C++ and C APIs. The upper-layer services mainly use HiTraceChain to start and stop call chain trace.
HiTraceChain is implemented at layer C. It works by transferring **traceid** throughout the service calling process. Before service processing, HiTrace sets **traceid** in the thread local storage (TLS) of the calling thread. During service processing, HiTrace obtains **traceid** from the contextual TLS of the calling thread and automatically adds it to the log and event information. After service processing is complete, HiTrace clears **traceid** from the TLS of the calling thread.
HiTraceChain is implemented at layer C. It works by transferring **traceid** throughout the service calling process. Before service processing, HiTraceChain sets **traceid** in the thread local storage \(TLS\) of the calling thread. During service processing, HiTraceChain obtains **traceid** from the contextual TLS of the calling thread and automatically adds it to the log and event information. After service processing is complete, HiTraceChain clears **traceid** from the TLS of the calling thread.
### Java, C++, and C APIs ### Java, C++, and C APIs
**Table 1** Description of C++ and C APIs **Table 1** Description of C++ and C APIs
<a name="table0218014155811"></a> | | **C++** | **C** |
<table><thead align="left"><tr id="row3218171455817"><th class="cellrowborder" valign="top" width="12.540000000000001%" id="mcps1.2.4.1.1">&nbsp;&nbsp;</th> | -------- | -------- | -------- |
<th class="cellrowborder" valign="top" width="41.42%" id="mcps1.2.4.1.2"><p id="p17257112417232"><a name="p17257112417232"></a><a name="p17257112417232"></a><strong id="b7257324122319"><a name="b7257324122319"></a><a name="b7257324122319"></a>C++</strong></p> | **Class**| **Function**| **Function**|
</th> | HiTraceChain | HiTraceId Begin(const std::string&amp; name, int flags) | HiTraceIdStruct HiTraceChainBegin(const char* name, int flags) |
<th class="cellrowborder" valign="top" width="46.04%" id="mcps1.2.4.1.3"><p id="p13218151413588"><a name="p13218151413588"></a><a name="p13218151413588"></a><strong id="b5218181416588"><a name="b5218181416588"></a><a name="b5218181416588"></a>C</strong></p> | | void End(const HiTraceId&amp; id) | void HiTraceChainEnd(const HiTraceIdStruct* pId) |
</th> | | HiTraceId GetId(); | HiTraceIdStruct HiTraceChainGetId() |
</tr> | | void SetId(const HiTraceId&amp; id) | void HiTraceChainSetId(const HiTraceIdStruct* pId) |
</thead> | | void ClearId() | void HiTraceChainClearId() |
<tbody><tr id="row1218714155816"><td class="cellrowborder" valign="top" width="12.540000000000001%" headers="mcps1.2.4.1.1 "><p id="p10218121475811"><a name="p10218121475811"></a><a name="p10218121475811"></a><strong id="b9680556"><a name="b9680556"></a><a name="b9680556"></a>Class</strong></p> | | HiTraceId CreateSpan() | HiTraceIdStruct HiTraceChainCreateSpan() |
</td> | | void Tracepoint(HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...) | void HiTraceChainTracepoint(HiTraceTracepointType type, const HiTraceIdStruct* pId, const char* fmt, ...) |
<td class="cellrowborder" valign="top" width="41.42%" headers="mcps1.2.4.1.2 "><p id="p112189146582"><a name="p112189146582"></a><a name="p112189146582"></a><strong id="b134318387"><a name="b134318387"></a><a name="b134318387"></a>API</strong></p> | | void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...) | void HiTraceChainTracepointEx(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceIdStruct* pId, const char* fmt, ...) |
</td> | HiTraceId | HiTraceId(); | void HiTraceChainInitId(HiTraceIdStruct* pId) |
<td class="cellrowborder" valign="top" width="46.04%" headers="mcps1.2.4.1.3 "><p id="p19219151413589"><a name="p19219151413589"></a><a name="p19219151413589"></a><strong id="b989888034"><a name="b989888034"></a><a name="b989888034"></a>API</strong></p> | | HiTraceId(const uint8_t* pIdArray, int len) | HiTraceIdStruct HiTraceChainBytesToId(const uint8_t* pIdArray, int len) |
</td> | | bool IsValid() | int HiTraceChainIsValid(const HiTraceIdStruct* pId) |
</tr> | | bool IsFlagEnabled(HiTraceFlag flag) | int HiTraceChainIsFlagEnabled(const HiTraceIdStruct* pId, HiTraceFlag flag) |
<tr id="row1219111415585"><td class="cellrowborder" rowspan="8" valign="top" width="12.540000000000001%" headers="mcps1.2.4.1.1 "><p id="p15219101455812"><a name="p15219101455812"></a><a name="p15219101455812"></a>HiTraceChain</p> | | void EnableFlag(HiTraceFlag flag) | void HiTraceChainEnableFlag(HiTraceIdStruct* pId, HiTraceFlag flag) |
<p id="p1945616211310"><a name="p1945616211310"></a><a name="p1945616211310"></a></p> | | int GetFlags() | int HiTraceChainGetFlags(const HiTraceIdStruct* pId) |
<p id="p1645619231317"><a name="p1645619231317"></a><a name="p1645619231317"></a></p> | | void SetFlags(int flags) | void HiTraceChainSetFlags(HiTraceIdStruct* pId, int flags) |
<p id="p94562024134"><a name="p94562024134"></a><a name="p94562024134"></a></p> | | uint64_t GetChainId() | uint64_t HiTraceChainGetChainId(const HiTraceIdStruct* pId) |
<p id="p745619221317"><a name="p745619221317"></a><a name="p745619221317"></a></p> | | void SetChainId(uint64_t chainId) | void HiTraceChainSetChainId(HiTraceIdStruct* pId, uint64_t chainId) |
<p id="p184562212136"><a name="p184562212136"></a><a name="p184562212136"></a></p> | | uint64_t GetSpanId() | uint64_t HiTraceChainGetSpanId(const HiTraceIdStruct* pId) |
<p id="p2045613210139"><a name="p2045613210139"></a><a name="p2045613210139"></a></p> | | void SetSpanId(uint64_t spanId) | void HiTraceChainSetSpanId(HiTraceIdStruct* pId, uint64_t spanId) |
<p id="p12456192161319"><a name="p12456192161319"></a><a name="p12456192161319"></a></p> | | uint64_t GetParentSpanId() | uint64_t HiTraceChainGetParentSpanId(const HiTraceIdStruct* pId) |
</td> | | void SetParentSpanId(uint64_t parentSpanId) | void HiTraceChainSetParentSpanId(HiTraceIdStruct* pId, uint64_t parentSpanId) |
<td class="cellrowborder" valign="top" width="41.42%" headers="mcps1.2.4.1.2 "><p id="p821971495820"><a name="p821971495820"></a><a name="p821971495820"></a>HiTraceId Begin(const std::string&amp; name, int flags)</p> | | int ToBytes(uint8_t* pIdArray, int len) | int HiTraceChainIdToBytes(const HiTraceIdStruct_ pId, uint8_t* pIdArray, int len) |
</td>
<td class="cellrowborder" valign="top" width="46.04%" headers="mcps1.2.4.1.3 "><p id="p2219914195817"><a name="p2219914195817"></a><a name="p2219914195817"></a>HiTraceIdStruct HiTraceChainBegin(const char* name, int flags)</p>
</td>
</tr>
<tr id="row16219171417584"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p021971414588"><a name="p021971414588"></a><a name="p021971414588"></a>void End(const HiTraceId&amp; id)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p16219191435814"><a name="p16219191435814"></a><a name="p16219191435814"></a>void HiTraceChainEnd(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row02191414115819"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p42191143585"><a name="p42191143585"></a><a name="p42191143585"></a>HiTraceId GetId();</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1221901419588"><a name="p1221901419588"></a><a name="p1221901419588"></a>HiTraceIdStruct HiTraceChainGetId()</p>
</td>
</tr>
<tr id="row11219131415582"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p6219111415812"><a name="p6219111415812"></a><a name="p6219111415812"></a>void SetId(const HiTraceId&amp; id)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p221971465818"><a name="p221971465818"></a><a name="p221971465818"></a>void HiTraceChainSetId(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row162191814105815"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p12191147586"><a name="p12191147586"></a><a name="p12191147586"></a>void ClearId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p18219181445813"><a name="p18219181445813"></a><a name="p18219181445813"></a>void HiTraceChainClearId()</p>
</td>
</tr>
<tr id="row12219151475812"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1721981418580"><a name="p1721981418580"></a><a name="p1721981418580"></a>HiTraceId CreateSpan()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1121981420584"><a name="p1121981420584"></a><a name="p1121981420584"></a>HiTraceIdStruct HiTraceChainCreateSpan()</p>
</td>
</tr>
<tr id="row1721911140582"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p18219514195814"><a name="p18219514195814"></a><a name="p18219514195814"></a>void Tracepoint(HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p3219914175813"><a name="p3219914175813"></a><a name="p3219914175813"></a>void HiTraceChainTracepoint(HiTraceTracepointType type, const HiTraceIdStruct* pId, const char* fmt, ...)</p>
</td>
</tr>
<tr id="row521911410582"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p2219101415814"><a name="p2219101415814"></a><a name="p2219101415814"></a>void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p2220141413584"><a name="p2220141413584"></a><a name="p2220141413584"></a>void HiTraceChainTracepointEx(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceIdStruct* pId, const char* fmt, ...)</p>
</td>
</tr>
<tr id="row8220181411586"><td class="cellrowborder" rowspan="14" valign="top" width="12.540000000000001%" headers="mcps1.2.4.1.1 "><p id="p522018149588"><a name="p522018149588"></a><a name="p522018149588"></a>HiTraceId</p>
<p id="p14704748133"><a name="p14704748133"></a><a name="p14704748133"></a></p>
<p id="p147041042134"><a name="p147041042134"></a><a name="p147041042134"></a></p>
<p id="p2070415431318"><a name="p2070415431318"></a><a name="p2070415431318"></a></p>
<p id="p870404101319"><a name="p870404101319"></a><a name="p870404101319"></a></p>
<p id="p27049417138"><a name="p27049417138"></a><a name="p27049417138"></a></p>
<p id="p870534121314"><a name="p870534121314"></a><a name="p870534121314"></a></p>
<p id="p370512420136"><a name="p370512420136"></a><a name="p370512420136"></a></p>
<p id="p197055481320"><a name="p197055481320"></a><a name="p197055481320"></a></p>
<p id="p970512471317"><a name="p970512471317"></a><a name="p970512471317"></a></p>
<p id="p1170554191318"><a name="p1170554191318"></a><a name="p1170554191318"></a></p>
<p id="p770564191312"><a name="p770564191312"></a><a name="p770564191312"></a></p>
<p id="p87057421315"><a name="p87057421315"></a><a name="p87057421315"></a></p>
<p id="p570518416139"><a name="p570518416139"></a><a name="p570518416139"></a></p>
</td>
<td class="cellrowborder" valign="top" width="41.42%" headers="mcps1.2.4.1.2 "><p id="p102201914105811"><a name="p102201914105811"></a><a name="p102201914105811"></a>HiTraceId();</p>
</td>
<td class="cellrowborder" valign="top" width="46.04%" headers="mcps1.2.4.1.3 "><p id="p16220161419581"><a name="p16220161419581"></a><a name="p16220161419581"></a>void HiTraceChainInitId(HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row8220191405817"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p162201314155813"><a name="p162201314155813"></a><a name="p162201314155813"></a>HiTraceId(const uint8_t* pIdArray, int len)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p122011425814"><a name="p122011425814"></a><a name="p122011425814"></a>HiTraceIdStruct HiTraceChainBytesToId(const uint8_t* pIdArray, int len)</p>
</td>
</tr>
<tr id="row1522041435820"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1422012146587"><a name="p1422012146587"></a><a name="p1422012146587"></a>bool IsValid()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1322016149586"><a name="p1322016149586"></a><a name="p1322016149586"></a>int HiTraceChainIsValid(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row8220714155810"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p322021485814"><a name="p322021485814"></a><a name="p322021485814"></a>bool IsFlagEnabled(HiTraceFlag flag)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p922010148583"><a name="p922010148583"></a><a name="p922010148583"></a>int HiTraceChainIsFlagEnabled(const HiTraceIdStruct* pId, HiTraceFlag flag)</p>
</td>
</tr>
<tr id="row12220161485814"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1122011140588"><a name="p1122011140588"></a><a name="p1122011140588"></a>void EnableFlag(HiTraceFlag flag)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p152201146583"><a name="p152201146583"></a><a name="p152201146583"></a>void HiTraceChainEnableFlag(HiTraceIdStruct* pId, HiTraceFlag flag)</p>
</td>
</tr>
<tr id="row922061411589"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p202208143588"><a name="p202208143588"></a><a name="p202208143588"></a>int GetFlags()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p182206142587"><a name="p182206142587"></a><a name="p182206142587"></a>int HiTraceChainGetFlags(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row82204145589"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p12201414205815"><a name="p12201414205815"></a><a name="p12201414205815"></a>void SetFlags(int flags)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p162201514175813"><a name="p162201514175813"></a><a name="p162201514175813"></a>void HiTraceChainSetFlags(HiTraceIdStruct* pId, int flags)</p>
</td>
</tr>
<tr id="row152204143585"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p722113147580"><a name="p722113147580"></a><a name="p722113147580"></a>uint64_t GetChainId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p322119149584"><a name="p322119149584"></a><a name="p322119149584"></a>uint64_t HiTraceChainGetChainId(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row1221214175815"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p922131445815"><a name="p922131445815"></a><a name="p922131445815"></a>void SetChainId(uint64_t chainId)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p922101411588"><a name="p922101411588"></a><a name="p922101411588"></a>void HiTraceChainSetChainId(HiTraceIdStruct* pId, uint64_t chainId)</p>
</td>
</tr>
<tr id="row1922115142588"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1122141414588"><a name="p1122141414588"></a><a name="p1122141414588"></a>uint64_t GetSpanId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p32211145584"><a name="p32211145584"></a><a name="p32211145584"></a>uint64_t HiTraceChainGetSpanId(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row4221171414587"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p10221191412588"><a name="p10221191412588"></a><a name="p10221191412588"></a>void SetSpanId(uint64_t spanId)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p42211614105810"><a name="p42211614105810"></a><a name="p42211614105810"></a>void HiTraceChainSetSpanId(HiTraceIdStruct* pId, uint64_t spanId)</p>
</td>
</tr>
<tr id="row322171425818"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1722111418582"><a name="p1722111418582"></a><a name="p1722111418582"></a>uint64_t GetParentSpanId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p8221314195817"><a name="p8221314195817"></a><a name="p8221314195817"></a>uint64_t HiTraceChainGetParentSpanId(const HiTraceIdStruct* pId)</p>
</td>
</tr>
<tr id="row622114147589"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p92219145589"><a name="p92219145589"></a><a name="p92219145589"></a>void SetParentSpanId(uint64_t parentSpanId)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p922191435813"><a name="p922191435813"></a><a name="p922191435813"></a>void HiTraceChainSetParentSpanId(HiTraceIdStruct* pId, uint64_t parentSpanId)</p>
</td>
</tr>
<tr id="row5221614135814"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p11221121435820"><a name="p11221121435820"></a><a name="p11221121435820"></a>int ToBytes(uint8_t* pIdArray, int len)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1122131415814"><a name="p1122131415814"></a><a name="p1122131415814"></a>int HiTraceChainIdToBytes(const HiTraceIdStruct* pId, uint8_t* pIdArray, int len)</p>
</td>
</tr>
</tbody>
</table>
### Parameters of C++ APIs ### Parameters of C++ APIs
**Table 2** Parameters of C++ APIs **Table 2** Trace flag combination types
<a name="table19597131833715"></a> | **Name**| **Value**| **Description**|
<table><thead align="left"><tr id="row7839141817375"><th class="cellrowborder" valign="top" width="9.8%" id="mcps1.2.4.1.1"><p id="p383919182379"><a name="p383919182379"></a><a name="p383919182379"></a><strong id="b18963437162313"><a name="b18963437162313"></a><a name="b18963437162313"></a>Class</strong></p> | -------- | -------- | -------- |
</th> | HITRACE_FLAG_DEFAULT | 0 | Default flag. |
<th class="cellrowborder" valign="top" width="31.430000000000003%" id="mcps1.2.4.1.2"><p id="p168392018203711"><a name="p168392018203711"></a><a name="p168392018203711"></a><strong id="b1368417396233"><a name="b1368417396233"></a><a name="b1368417396233"></a>API</strong></p> | HITRACE_FLAG_INCLUDE_ASYNC | 1 | Asynchronous call flag. By default, only synchronous calls are traced. If this flag is set, both synchronous and asynchronous calls will be traced. |
</th> | HITRACE_FLAG_DONOT_CREATE_SPAN | 1 << 1 | No span flag. By default, spans are created within a trace of synchronous and asynchronous service calls. If this flag is set, no spans are created. |
<th class="cellrowborder" valign="top" width="58.77%" id="mcps1.2.4.1.3"><p id="p168391618193717"><a name="p168391618193717"></a><a name="p168391618193717"></a><strong id="b1137714428236"><a name="b1137714428236"></a><a name="b1137714428236"></a>Description</strong></p> | HITRACE_FLAG_TP_INFO | 1 << 2 | Trace point flag. By default, no trace point is added when trace is enabled. This flag is used for debugging. If this flag is set, trace points will be automatically added on the TX and RX sides of synchronous and asynchronous calls to output trace point and timestamp information. Trace points are classified into four types: client send (CS), server receive (SR), server send (SS), and client receive (CR). For a synchronous call, the output trace points are CS, SR, SS, and CR; for an asynchronous call, the output trace points are CS, SR, and SS. |
</th> | HITRACE_FLAG_NO_BE_INFO | 1 << 3 | No begin/end flag. By default, information about the start and end of the trace task is printed. If this flag is set, information about the start and end of the trace task will not be printed.|
</tr> | HITRACE_FLAG_DONOT_ENABLE_LOG | 1 << 4 | Log association flag. If this flag is set, information about the trace task will not be printed. |
</thead> | HITRACE_FLAG_FAULT_TRIGGER | 1 << 5 | Failure trigger flag. This flag is reserved for future use. |
<tbody><tr id="row383911183378"><td class="cellrowborder" rowspan="8" valign="top" width="9.8%" headers="mcps1.2.4.1.1 "><p id="p10839318133713"><a name="p10839318133713"></a><a name="p10839318133713"></a>HiTraceChain</p> | HITRACE_FLAG_D2D_TP_INFO | 1 << 6 | Device-to-device trace point flag. It is a subset of **TP_INFO**. If this flag is set, trace points are added only for call chain trace between devices.|
<p id="p1544019164131"><a name="p1544019164131"></a><a name="p1544019164131"></a></p>
<p id="p14440191615134"><a name="p14440191615134"></a><a name="p14440191615134"></a></p> **Table 3** Trace point types
<p id="p6440161631310"><a name="p6440161631310"></a><a name="p6440161631310"></a></p>
<p id="p174411167135"><a name="p174411167135"></a><a name="p174411167135"></a></p> | **Name**| **Value**| **Description**|
<p id="p2441141651310"><a name="p2441141651310"></a><a name="p2441141651310"></a></p> | -------- | -------- | -------- |
<p id="p1944151618133"><a name="p1944151618133"></a><a name="p1944151618133"></a></p> | HITRACE_TP_CS | 0 | CS trace point. |
<p id="p1744121610131"><a name="p1744121610131"></a><a name="p1744121610131"></a></p> | HITRACE_TP_CR | 1 | CR trace point. |
</td> | HITRACE_TP_SS | 2 | SS trace point. |
<td class="cellrowborder" valign="top" width="31.430000000000003%" headers="mcps1.2.4.1.2 "><p id="p198391118193717"><a name="p198391118193717"></a><a name="p198391118193717"></a>HiTraceId Begin(const std::string&amp; name, int flags)</p> | HITRACE_TP_SR | 3 | SR trace point. |
</td> | HITRACE_TP_GENERAL | 4 | General trace points except CS, CR, SS, and SR.|
<td class="cellrowborder" valign="top" width="58.77%" headers="mcps1.2.4.1.3 "><p id="p684013182375"><a name="p684013182375"></a><a name="p684013182375"></a>Starts HiTraceChain, generates a <strong id="b2063619462230"><a name="b2063619462230"></a><a name="b2063619462230"></a>HiTraceId</strong> object, and sets it in the TLS of the calling thread.</p>
<p id="p1384081812377"><a name="p1384081812377"></a><a name="p1384081812377"></a>Input arguments:</p> **Table 4** Communication modes
<a name="ul1537854218177"></a><a name="ul1537854218177"></a><ul id="ul1537854218177"><li><strong id="b1566312131676"><a name="b1566312131676"></a><a name="b1566312131676"></a>name</strong>: Indicates the name of the service process.</li><li><strong id="b75512128711"><a name="b75512128711"></a><a name="b75512128711"></a>flags</strong>: Indicates tracing flags, which can be used in combination. <a name="ul18842248101915"></a><a name="ul18842248101915"></a><ul id="ul18842248101915"><li>HITRACE_FLAG_INCLUDE_ASYNC: Traces both synchronous and asynchronous calls. By default, only synchronous calls are traced.</li><li><strong id="b724616241477"><a name="b724616241477"></a><a name="b724616241477"></a>HITRACE_FLAG_DONOT_CREATE_SPAN</strong>: Do not create a span. By default, a span is created.</li><li><strong id="b136181926479"><a name="b136181926479"></a><a name="b136181926479"></a>HITRACE_FLAG_TP_INFO</strong>: Outputs the tracepoint information. By default, the information is not output.</li><li><strong id="b358818291777"><a name="b358818291777"></a><a name="b358818291777"></a>HITRACE_FLAG_NO_BE_INFO</strong>: Do not output the start and end information. By default, the information is output.</li><li><strong id="b38571331974"><a name="b38571331974"></a><a name="b38571331974"></a>HITRACE_FLAG_DONOT_ENABLE_LOG</strong>: Do not associate logs for output. By default, logs are associated for output.</li><li><strong id="b17320371870"><a name="b17320371870"></a><a name="b17320371870"></a>HITRACE_FLAG_FAULT_TRIGGER</strong>: Triggers tracing by fault. By default, tracing is triggered normally.</li><li><strong id="b876915381711"><a name="b876915381711"></a><a name="b876915381711"></a>HITRACE_FLAG_D2D_TP_INFO</strong>: Outputs the device-to-device tracepoint information. By default, the information is not output.</li><li><strong id="b66510421776"><a name="b66510421776"></a><a name="b66510421776"></a>HITRCE_FLAG_DEFAULT</strong>: Indicates the default flag.</li></ul>
</li><li>Output arguments: none</li><li>Return value: Returns a valid <strong id="b7411101522917"><a name="b7411101522917"></a><a name="b7411101522917"></a>HiTraceId</strong> object if call chain tracing is triggered successfully; returns an invalid object otherwise.</li></ul> | **Name**| **Value**| **Description**|
<p id="p188401918203713"><a name="p188401918203713"></a><a name="p188401918203713"></a>Note: In nested tracing mode, an invalid object will be returned if tracing is started at the nested layer.</p> | -------- | -------- | -------- |
</td> | HITRACE_CM_DEFAULT | 0 | Default communication mode. |
</tr> | HITRACE_CM_THREAD | 1 | Inter-thread communication. |
<tr id="row16840101803720"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p13840191893718"><a name="p13840191893718"></a><a name="p13840191893718"></a>void End(const HiTraceId&amp; id)</p> | HITRACE_CM_PROCESS | 2 | Inter-process communication. |
</td> | HITRACE_CM_DEVICE | 3 | Inter-device communication. |
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p3840181820372"><a name="p3840181820372"></a><a name="p3840181820372"></a>Stops HiTraceChain based on the <strong id="b1605239122415"><a name="b1605239122415"></a><a name="b1605239122415"></a>HiTraceId</strong> object returned by the <strong id="b7610183992419"><a name="b7610183992419"></a><a name="b7610183992419"></a>Begin</strong> API, and clears the <strong id="b1610173918241"><a name="b1610173918241"></a><a name="b1610173918241"></a>HiTraceId</strong> object in the TLS of the calling thread.</p>
<p id="p9840718103720"><a name="p9840718103720"></a><a name="p9840718103720"></a>Input arguments:</p> **Table 5** Description of C++ APIs
<a name="ul2917140133015"></a><a name="ul2917140133015"></a><ul id="ul2917140133015"><li><strong id="b8201185118711"><a name="b8201185118711"></a><a name="b8201185118711"></a>id</strong>: Indicates the <strong id="b2071183114331"><a name="b2071183114331"></a><a name="b2071183114331"></a>HiTraceId</strong> object.</li></ul>
<p id="p14840151803718"><a name="p14840151803718"></a><a name="p14840151803718"></a>Output arguments: none</p> | **Class**| **API**| **Description**|
<p id="p2840201893719"><a name="p2840201893719"></a><a name="p2840201893719"></a>Return value: none</p> | -------- | -------- | -------- |
</td> | HiTraceChain | HiTraceId Begin(const std::string&amp; name, int flags) | Starts HiTraceChain, generates a **HiTraceId** object, and sets it in the TLS of the calling thread.<br>Input arguments:<br>- **name**: name of the service process.<br>- **flags**: trace flags, which can be used in combination. For details, see Table 2.<br>Output arguments: none<br>Return value: a valid **HiTraceId** object if call chain trace is triggered successfully; returns an invalid object otherwise.<br>Note: In nested trace mode, an invalid object will be returned if trace is started at the nested layer.|
</tr> | | void End(const HiTraceId&amp; id) | Stops HiTraceChain based on the **HiTraceId** object returned by the **Begin** API, and clears the **HiTraceId** object in the TLS of the calling thread.<br>Input arguments:<br>- **id**: **HiTraceId** object.<br>Output arguments: none<br>Return value: none|
<tr id="row198401818193712"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p20840191893718"><a name="p20840191893718"></a><a name="p20840191893718"></a>HiTraceId GetId();</p> | | HiTraceId GetId(); | Obtains the **HiTraceId** object from the TLS of the calling thread.<br>Input arguments: none<br>Output arguments: none<br>Return value: **HiTraceId** object in the contextual TLS of the calling thread.|
</td> | | void SetId(const HiTraceId&amp; id) | Purpose: Sets the **HiTraceId** object in the TLS of the calling thread.<br>Input arguments:<br>- **id**: **HiTraceId** object.<br>Output arguments: none<br>Return value: none|
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p98401818123720"><a name="p98401818123720"></a><a name="p98401818123720"></a>Obtains the <strong id="b98371719256"><a name="b98371719256"></a><a name="b98371719256"></a>HiTraceId</strong> object from the TLS of the calling thread.</p> | | void ClearId() | Clears the **HiTraceId** object in the TLS of the calling thread.<br>Input arguments: none<br>Output arguments: none<br>Return value: none|
<p id="p984001893712"><a name="p984001893712"></a><a name="p984001893712"></a>Input arguments: none</p> | | HiTraceId CreateSpan() | Obtains the span ID from the current **HiTraceId** object.<br>Input arguments: none<br>Output arguments: none<br>Return value: current span ID.|
<p id="p2084021817379"><a name="p2084021817379"></a><a name="p2084021817379"></a>Output arguments: none</p> | | void Tracepoint(HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...) | Outputs HiTraceChain trace point information based on the information type. The information includes the timestamp and **HiTraceId** object of the span.<br>Input arguments:<br>- **type**: trace point type. For details, see Table 3.<br>- **id**: ID of the current span.<br>- **fmt**: string describing the format variable parameter.<br>- **args**: variable parameter.<br>Output arguments: none<br>Return value: none|
<p id="p9840418133716"><a name="p9840418133716"></a><a name="p9840418133716"></a>Return value: Returns the <strong id="b73911122162613"><a name="b73911122162613"></a><a name="b73911122162613"></a>HiTraceId</strong> object in the contextual TLS of the calling thread.</p> | | void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...) | Outputs HiTraceChain trace point information based on the communication mode and information type. The information includes the timestamp and **HiTraceId** object of the span.<br>Input arguments:<br>- **mode**: communication mode. For details, see Table 4.<br>- **type**: trace point type. For details, see Table 3.<br>- **id**: ID of the current span.<br>- **fmt**: string describing the format variable parameter.<br>- **args**: variable parameter.<br>Output arguments: none<br>Return value: none|
</td> | HiTraceId | HiTraceId(); | Represents the default constructor used to generate an invalid **HiTraceId** object. <br>Input arguments: none<br>Output arguments: none<br>Return value: none|
</tr> | | HiTraceId(const uint8_t* pIdArray, int len) | Represents the constructor used to create a **HiTraceId** object based on the specified byte array. <br>Input arguments:<br>- **pIdArray**: pointer to a byte array.<br>- **len**: length of the byte array.<br>Output arguments: none<br>Return value: none|
<tr id="row118401118203714"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1840151843715"><a name="p1840151843715"></a><a name="p1840151843715"></a>void SetId(const HiTraceId&amp; id)</p> | | bool IsValid() | Checks whether the **HiTraceId** object is valid.<br>Input arguments: none<br>Output arguments: none<br>Return value: **true** if the **HiTraceId** object is valid; **false** otherwise.|
</td> | | bool IsFlagEnabled(HiTraceFlag flag) | Checks whether the trace flag of the **HiTraceId** object is enabled.<br>Input arguments:<br>- **flag**: trace flag. For details, see the description in the **Begin** function.<br>Output arguments: none<br>Return value: **true** if the trace flag is enabled; **false** otherwise.|
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p384061893715"><a name="p384061893715"></a><a name="p384061893715"></a>Purpose: Sets the <strong id="b7405852152614"><a name="b7405852152614"></a><a name="b7405852152614"></a>HiTraceId</strong> object in the TLS of the calling thread.</p> | | void EnableFlag(HiTraceFlag flag) | Enables the trace flag of the **HiTraceId** object.<br>Input arguments:<br>- **flag**: trace flag. For details, see the description in the **Begin** function.<br>Output arguments: none<br>Return value: none|
<p id="p16840718153717"><a name="p16840718153717"></a><a name="p16840718153717"></a>Input arguments:</p> | | int GetFlags() | Obtains the trace flag set in the **HiTraceId** object.<br>Input arguments: none<br>Output arguments: none<br>Return value: Returns the combination of trace flags. For details, see the description in the **Begin** function.|
<a name="ul1355016467304"></a><a name="ul1355016467304"></a><ul id="ul1355016467304"><li><strong id="b648307174"><a name="b648307174"></a><a name="b648307174"></a>id</strong>: Indicates the <strong id="b492669584"><a name="b492669584"></a><a name="b492669584"></a>HiTraceId</strong> object.</li></ul> | | void SetFlags(int flags) | Sets a trace flag in the **HiTraceId** object.<br>Input arguments:<br>- **flags**: combination of trace flags. For details, see the description in the **Begin** function.<br>Output arguments: none<br>Return value: none|
<p id="p684051817376"><a name="p684051817376"></a><a name="p684051817376"></a>Output arguments: none</p> | | uint64_t GetChainId() | Obtains the call chain ID.<br>Input arguments: none<br>Output arguments: none<br>Return value: call chain ID.|
<p id="p884091812374"><a name="p884091812374"></a><a name="p884091812374"></a>Return value: none</p> | | void SetChainId(uint64_t chainId) | Sets the call chain ID in the **HiTraceId** object.<br>Input arguments:<br>- **chainId**: call chain ID.<br>Output arguments: none<br>Return value: none|
</td> | | uint64_t GetSpanId() | Obtains the span ID from the current **HiTraceId** object.<br>Input arguments: none<br>Output arguments: none<br>Return value: current span ID.|
</tr> | | void SetSpanId(uint64_t spanId) | Sets the span ID in the **HiTraceId** object.<br>Input arguments:<br>- **spanId**: span ID.<br>Output arguments: none<br>Return value: none|
<tr id="row3840171813374"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p18840131873717"><a name="p18840131873717"></a><a name="p18840131873717"></a>void ClearId()</p> | | uint64_t GetParentSpanId() | Obtains the parent span ID from the current **HiTraceId** object.<br>Input arguments: none<br>Output arguments: none<br>Return value: parent span ID.|
</td> | | void SetParentSpanId(uint64_t parentSpanId) | Sets the parent span ID in the **HiTraceId** object.<br>Input arguments:<br>- **parentSpanId**: parent span ID.<br>Output arguments: none<br>Return value: none|
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p584019184379"><a name="p584019184379"></a><a name="p584019184379"></a>Clears the <strong id="b8445182151511"><a name="b8445182151511"></a><a name="b8445182151511"></a>HiTraceId</strong> object in the TLS of the current thread.</p> | | int ToBytes(uint8_t* pIdArray, int len) | Converts the **HiTraceId** object into a byte array to facilitate caching or communication transfer.<br>Input arguments:<br>- **pIdArray**: pointer to a byte array. The minimum length of the byte array is **HITRACE_ID_LEN**.<br>- **len**: length of the byte array.<br>Output parameters:<br>- **pIdArray**: pointer to a byte array. If the object is valid, the object data after conversion is stored.<br>Return value: a value greater than **0** (indicating a valid array of object data) if the conversion is successful; **0** otherwise.|
<p id="p108401718173714"><a name="p108401718173714"></a><a name="p108401718173714"></a>Input arguments: none </p>
<p id="p1784014183377"><a name="p1784014183377"></a><a name="p1784014183377"></a>Output arguments: none</p>
<p id="p2084041811377"><a name="p2084041811377"></a><a name="p2084041811377"></a>Return value: none</p> ### Call Chain Processing
</td>
</tr> Inter-device, inter-process, and inter-thread calls are implemented through the communication mechanism. HiTraceChain requires transfer of **traceid** in the communication mechanism.
<tr id="row6840818193716"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p16840171823719"><a name="p16840171823719"></a><a name="p16840171823719"></a>HiTraceId CreateSpan()</p>
</td> Some built-in communication mechanisms (such as ZIDL) of OpenHarmony already support the transfer of **traceid**.
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p984031812378"><a name="p984031812378"></a><a name="p984031812378"></a>Obtains the span ID from the current <strong id="b186741420142718"><a name="b186741420142718"></a><a name="b186741420142718"></a>HiTraceId</strong> object.</p>
<p id="p5840101814371"><a name="p5840101814371"></a><a name="p5840101814371"></a>Input arguments: none</p>
<p id="p20840111843718"><a name="p20840111843718"></a><a name="p20840111843718"></a>Output arguments: none</p>
<p id="p88401218193710"><a name="p88401218193710"></a><a name="p88401218193710"></a>Return value: Returns the current span ID.</p>
</td>
</tr>
<tr id="row198401118123714"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p178411618183711"><a name="p178411618183711"></a><a name="p178411618183711"></a>void Tracepoint(HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p88419184373"><a name="p88419184373"></a><a name="p88419184373"></a>Outputs HiTraceChain call chain information based on the information type. The information includes the timestamp and <strong id="b185817437323"><a name="b185817437323"></a><a name="b185817437323"></a>HiTraceId</strong> object information of the span.</p>
<p id="p1984116184376"><a name="p1984116184376"></a><a name="p1984116184376"></a>Input arguments:</p>
<a name="ul18619103153812"></a><a name="ul18619103153812"></a><ul id="ul18619103153812"><li><strong id="b7818831083"><a name="b7818831083"></a><a name="b7818831083"></a>type</strong>: Indicates the information type. The options are as follows:<a name="ul1941510328297"></a><a name="ul1941510328297"></a><ul id="ul1941510328297"><li><strong id="b18809161180"><a name="b18809161180"></a><a name="b18809161180"></a>HITRACE_TP_CS</strong>: Client Send, which indicates the messages sent by the synchronous/asynchronous communication client.</li><li><strong id="b327281271319"><a name="b327281271319"></a><a name="b327281271319"></a>HITRACE_TP_SR</strong>: Server Receive, which indicates the messages received by the server in synchronous/asynchronous communication.</li><li><strong id="b10154742682"><a name="b10154742682"></a><a name="b10154742682"></a>HITRACE_TP_SS</strong>: Server Send, which indicates the response messages sent by the server in synchronous communication.</li><li><strong id="b152598127810"><a name="b152598127810"></a><a name="b152598127810"></a>HITRACE_TP_CR</strong>: Client Receive, which indicates the response messages received by the synchronous communication client.</li><li><strong id="b82631512817"><a name="b82631512817"></a><a name="b82631512817"></a>HITRACE_TP_GENERAL</strong>: Indicates the common output information.</li></ul>
</li><li><strong id="b117401716584"><a name="b117401716584"></a><a name="b117401716584"></a>id</strong>: Indicates the ID of the current span.</li><li><strong id="b392172019813"><a name="b392172019813"></a><a name="b392172019813"></a>fmt</strong>: Indicates the string describing the format variable parameter.</li><li><strong id="b986771717818"><a name="b986771717818"></a><a name="b986771717818"></a>args</strong>: Indicates the variable parameter.</li></ul>
<p id="p11841121863717"><a name="p11841121863717"></a><a name="p11841121863717"></a>Output arguments: none</p>
<p id="p16841161816376"><a name="p16841161816376"></a><a name="p16841161816376"></a>Return value: none</p>
</td>
</tr>
<tr id="row11841191811379"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p08411318163716"><a name="p08411318163716"></a><a name="p08411318163716"></a>void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p68411618153713"><a name="p68411618153713"></a><a name="p68411618153713"></a>Outputs HiTraceChain call chain information based on the communication mode and information type. The information includes the timestamp and <strong id="b8151210123912"><a name="b8151210123912"></a><a name="b8151210123912"></a>HiTraceId</strong> object information of the span.</p>
<p id="p98418189375"><a name="p98418189375"></a><a name="p98418189375"></a>Input arguments:</p>
<a name="ul914264413811"></a><a name="ul914264413811"></a><ul id="ul914264413811"><li><strong id="b76471824183"><a name="b76471824183"></a><a name="b76471824183"></a>mode</strong>: Indicates the communication mode. The options are as follows:<a name="ul137382469451"></a><a name="ul137382469451"></a><ul id="ul137382469451"><li><strong id="b13732297812"><a name="b13732297812"></a><a name="b13732297812"></a>HITRACE_CM_DEFAULT</strong>: default communication mode used when no communication mode is specified</li><li><strong id="b1820115271789"><a name="b1820115271789"></a><a name="b1820115271789"></a>HITRACE_CM_THREAD</strong>: inter-thread communication</li><li><strong id="b27781831488"><a name="b27781831488"></a><a name="b27781831488"></a>HITRACE_CM_PROCESS</strong>: inter-process communication</li><li><strong id="b15657113313819"><a name="b15657113313819"></a><a name="b15657113313819"></a>HITRACE_CM_DEVICE</strong>: inter-device communication</li></ul>
</li><li><strong id="b172723513812"><a name="b172723513812"></a><a name="b172723513812"></a>type</strong>: Indicates the information type. The options are as follows:<a name="ul19648426458"></a><a name="ul19648426458"></a><ul id="ul19648426458"><li><strong id="b26421037382"><a name="b26421037382"></a><a name="b26421037382"></a>HITRACE_TP_CS</strong>: Client Send, which indicates the messages sent by the synchronous/asynchronous communication client.</li><li><strong id="b66504018818"><a name="b66504018818"></a><a name="b66504018818"></a>HITRACE_TP_SR</strong>: Server Receive, which indicates the messages received by the server in synchronous/asynchronous communication.</li><li><strong id="b285283761"><a name="b285283761"></a><a name="b285283761"></a>HITRACE_TP_SS</strong>: Server Send, which indicates the response messages sent by the server in synchronous communication.</li><li><strong id="b148684447814"><a name="b148684447814"></a><a name="b148684447814"></a>HITRACE_TP_CR</strong>: Client Receive, which indicates the response messages received by the synchronous communication client.</li><li><strong id="b17875164618816"><a name="b17875164618816"></a><a name="b17875164618816"></a>HITRACE_TP_GENERAL</strong>: Indicates the common output information.</li></ul>
</li><li><strong id="b1216749882"><a name="b1216749882"></a><a name="b1216749882"></a>id</strong>: Indicates the ID of the current span.</li><li><strong id="b82757501383"><a name="b82757501383"></a><a name="b82757501383"></a>fmt</strong>: Indicates the string describing the format variable parameter.</li><li><strong id="b15518145114817"><a name="b15518145114817"></a><a name="b15518145114817"></a>args</strong>: Indicates the variable parameter.</li></ul>
<p id="p784111810377"><a name="p784111810377"></a><a name="p784111810377"></a>Output arguments: none</p>
<p id="p1984181810374"><a name="p1984181810374"></a><a name="p1984181810374"></a>Return value: none</p>
</td>
</tr>
<tr id="row15841191813371"><td class="cellrowborder" rowspan="14" valign="top" width="9.8%" headers="mcps1.2.4.1.1 "><p id="p28411718143712"><a name="p28411718143712"></a><a name="p28411718143712"></a>HiTraceId</p>
<p id="p8337626151312"><a name="p8337626151312"></a><a name="p8337626151312"></a></p>
<p id="p16337182615134"><a name="p16337182615134"></a><a name="p16337182615134"></a></p>
<p id="p333712613136"><a name="p333712613136"></a><a name="p333712613136"></a></p>
<p id="p1337192616133"><a name="p1337192616133"></a><a name="p1337192616133"></a></p>
<p id="p203373267134"><a name="p203373267134"></a><a name="p203373267134"></a></p>
<p id="p23371265134"><a name="p23371265134"></a><a name="p23371265134"></a></p>
<p id="p173372267139"><a name="p173372267139"></a><a name="p173372267139"></a></p>
<p id="p143377266138"><a name="p143377266138"></a><a name="p143377266138"></a></p>
<p id="p13374265133"><a name="p13374265133"></a><a name="p13374265133"></a></p>
<p id="p18337162610137"><a name="p18337162610137"></a><a name="p18337162610137"></a></p>
<p id="p1833742613131"><a name="p1833742613131"></a><a name="p1833742613131"></a></p>
<p id="p93371026101319"><a name="p93371026101319"></a><a name="p93371026101319"></a></p>
<p id="p13337426121311"><a name="p13337426121311"></a><a name="p13337426121311"></a></p>
</td>
<td class="cellrowborder" valign="top" width="31.430000000000003%" headers="mcps1.2.4.1.2 "><p id="p158414182379"><a name="p158414182379"></a><a name="p158414182379"></a>HiTraceId();</p>
</td>
<td class="cellrowborder" valign="top" width="58.77%" headers="mcps1.2.4.1.3 "><p id="p48419181372"><a name="p48419181372"></a><a name="p48419181372"></a>Represents the default constructor used to generate an invalid <strong id="b1235325844115"><a name="b1235325844115"></a><a name="b1235325844115"></a>HiTraceId</strong> object. </p>
<p id="p16841121815372"><a name="p16841121815372"></a><a name="p16841121815372"></a>Input arguments: none</p>
<p id="p17841161803713"><a name="p17841161803713"></a><a name="p17841161803713"></a>Output arguments: none</p>
<p id="p1884121818375"><a name="p1884121818375"></a><a name="p1884121818375"></a>Return value: none</p>
</td>
</tr>
<tr id="row138418186374"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p19841111813712"><a name="p19841111813712"></a><a name="p19841111813712"></a>HiTraceId(const uint8_t* pIdArray, int len)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p684110183377"><a name="p684110183377"></a><a name="p684110183377"></a>Represents the constructor used to create a <strong id="b1488144194216"><a name="b1488144194216"></a><a name="b1488144194216"></a>HiTraceId</strong> object based on the specified byte array. </p>
<div class="p" id="p9841151833711"><a name="p9841151833711"></a><a name="p9841151833711"></a>Input arguments:<a name="ul783818256482"></a><a name="ul783818256482"></a><ul id="ul783818256482"><li><strong id="b1725445715818"><a name="b1725445715818"></a><a name="b1725445715818"></a>pIdArray</strong>: Indicates the pointer to a byte array.</li><li><strong id="b3437458486"><a name="b3437458486"></a><a name="b3437458486"></a>len</strong>: Indicates the length of the byte array.</li></ul>
</div>
<p id="p484121893716"><a name="p484121893716"></a><a name="p484121893716"></a>Output arguments: none</p>
<p id="p984161813376"><a name="p984161813376"></a><a name="p984161813376"></a>Return value: none</p>
</td>
</tr>
<tr id="row2084112189377"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p1184271814377"><a name="p1184271814377"></a><a name="p1184271814377"></a>bool IsValid()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1084251893713"><a name="p1084251893713"></a><a name="p1084251893713"></a>Checks whether the <strong id="b18546440145116"><a name="b18546440145116"></a><a name="b18546440145116"></a>HiTraceId</strong> object is valid.</p>
<p id="p1084231815374"><a name="p1084231815374"></a><a name="p1084231815374"></a>Input arguments: none</p>
<p id="p15842121815376"><a name="p15842121815376"></a><a name="p15842121815376"></a>Output arguments: none</p>
<p id="p884261893710"><a name="p884261893710"></a><a name="p884261893710"></a>Return value: Returns <strong id="b20386195514314"><a name="b20386195514314"></a><a name="b20386195514314"></a>true</strong> if the <strong id="b1899544174516"><a name="b1899544174516"></a><a name="b1899544174516"></a>HiTraceId</strong> object is valid; returns <strong id="b1273655294313"><a name="b1273655294313"></a><a name="b1273655294313"></a>false</strong> otherwise.</p>
</td>
</tr>
<tr id="row7842161873716"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p88422188379"><a name="p88422188379"></a><a name="p88422188379"></a>bool IsFlagEnabled(HiTraceFlag flag)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p128421518153712"><a name="p128421518153712"></a><a name="p128421518153712"></a>Checks whether the tracing flag of the <strong id="b1014619442447"><a name="b1014619442447"></a><a name="b1014619442447"></a>HiTraceId</strong> object is enabled.</p>
<p id="p12842518113714"><a name="p12842518113714"></a><a name="p12842518113714"></a>Input arguments:</p>
<a name="ul9760031103115"></a><a name="ul9760031103115"></a><ul id="ul9760031103115"><li><strong id="b136731441791"><a name="b136731441791"></a><a name="b136731441791"></a>flag</strong>: Indicates the tracing flag. For details, see the description in the <strong id="b186672319452"><a name="b186672319452"></a><a name="b186672319452"></a>Begin</strong> function.</li></ul>
<p id="p784217189379"><a name="p784217189379"></a><a name="p784217189379"></a>Output arguments: none</p>
<p id="p98421318143720"><a name="p98421318143720"></a><a name="p98421318143720"></a>Return value: Returns <strong id="b151944819455"><a name="b151944819455"></a><a name="b151944819455"></a>true</strong> if the tracing flag is enabled; returns <strong id="b1619204874513"><a name="b1619204874513"></a><a name="b1619204874513"></a>false</strong> otherwise.</p>
</td>
</tr>
<tr id="row4842318123713"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p8842818103712"><a name="p8842818103712"></a><a name="p8842818103712"></a>void EnableFlag(HiTraceFlag flag)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1084221893717"><a name="p1084221893717"></a><a name="p1084221893717"></a>Enables the tracing flag of the <strong id="b118041135213"><a name="b118041135213"></a><a name="b118041135213"></a>HiTraceId</strong> object.</p>
<p id="p484241853710"><a name="p484241853710"></a><a name="p484241853710"></a>Input arguments:</p>
<a name="ul144862816319"></a><a name="ul144862816319"></a><ul id="ul144862816319"><li><strong id="b430319434"><a name="b430319434"></a><a name="b430319434"></a>flag</strong>: Indicates the tracing flag. For details, see the description in the <strong id="b1067701187"><a name="b1067701187"></a><a name="b1067701187"></a>Begin</strong> function.</li></ul>
<p id="p18421018153710"><a name="p18421018153710"></a><a name="p18421018153710"></a>Output arguments: none</p>
<p id="p138421618163715"><a name="p138421618163715"></a><a name="p138421618163715"></a>Return value: none</p>
</td>
</tr>
<tr id="row128421918153717"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p4842218193714"><a name="p4842218193714"></a><a name="p4842218193714"></a>int GetFlags()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p12842151803718"><a name="p12842151803718"></a><a name="p12842151803718"></a>Obtains the tracing flag set in the <strong id="b36515674811"><a name="b36515674811"></a><a name="b36515674811"></a>HiTraceId</strong> object.</p>
<p id="p108421018193716"><a name="p108421018193716"></a><a name="p108421018193716"></a>Input arguments: none</p>
<p id="p284271843715"><a name="p284271843715"></a><a name="p284271843715"></a>Output arguments: none</p>
<p id="p19842101853716"><a name="p19842101853716"></a><a name="p19842101853716"></a>Return value: Returns the combination of tracing flags. For details, see the description in the <strong id="b12693139144817"><a name="b12693139144817"></a><a name="b12693139144817"></a>Begin</strong> function.</p>
</td>
</tr>
<tr id="row18842181863712"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p13842718153717"><a name="p13842718153717"></a><a name="p13842718153717"></a>void SetFlags(int flags)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p7842141823718"><a name="p7842141823718"></a><a name="p7842141823718"></a>Sets a tracing flag in the <strong id="b9174314814"><a name="b9174314814"></a><a name="b9174314814"></a>HiTraceId</strong> object.</p>
<p id="p784214187374"><a name="p784214187374"></a><a name="p784214187374"></a>Input arguments:</p>
<a name="ul6490121183115"></a><a name="ul6490121183115"></a><ul id="ul6490121183115"><li><strong id="b1556719154919"><a name="b1556719154919"></a><a name="b1556719154919"></a>flags</strong>: Indicates the combination of tracing flags. For details, see the description in the <strong id="b469312329341"><a name="b469312329341"></a><a name="b469312329341"></a>Begin</strong> function.</li></ul>
<p id="p17842141833710"><a name="p17842141833710"></a><a name="p17842141833710"></a>Output arguments: none</p>
<p id="p1842718203716"><a name="p1842718203716"></a><a name="p1842718203716"></a>Return value: none</p>
</td>
</tr>
<tr id="row68421418163715"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p484221810371"><a name="p484221810371"></a><a name="p484221810371"></a>uint64_t GetChainId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1784231833713"><a name="p1784231833713"></a><a name="p1784231833713"></a>Obtains the call chain ID.</p>
<p id="p48428188373"><a name="p48428188373"></a><a name="p48428188373"></a>Input arguments: none</p>
<p id="p158421418163710"><a name="p158421418163710"></a><a name="p158421418163710"></a>Output arguments: none</p>
<p id="p1484217183376"><a name="p1484217183376"></a><a name="p1484217183376"></a>Return value: Returns the call chain ID.</p>
</td>
</tr>
<tr id="row2842818153719"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p158422182376"><a name="p158422182376"></a><a name="p158422182376"></a>void SetChainId(uint64_t chainId)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p784271815372"><a name="p784271815372"></a><a name="p784271815372"></a>Sets the call chain ID in the <strong id="b1319041125416"><a name="b1319041125416"></a><a name="b1319041125416"></a>HiTraceId</strong> object.</p>
<p id="p3842131883718"><a name="p3842131883718"></a><a name="p3842131883718"></a>Input arguments:</p>
<a name="ul45791717103118"></a><a name="ul45791717103118"></a><ul id="ul45791717103118"><li><strong id="b492411164116"><a name="b492411164116"></a><a name="b492411164116"></a>chainId</strong>: Indicates the call chain ID.</li></ul>
<p id="p9842171818371"><a name="p9842171818371"></a><a name="p9842171818371"></a>Output arguments: none</p>
<p id="p2842141853718"><a name="p2842141853718"></a><a name="p2842141853718"></a>Return value: none</p>
</td>
</tr>
<tr id="row1484217185372"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p12843161817378"><a name="p12843161817378"></a><a name="p12843161817378"></a>uint64_t GetSpanId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1484351820374"><a name="p1484351820374"></a><a name="p1484351820374"></a>Obtains the span ID from the current <strong id="b8123101515516"><a name="b8123101515516"></a><a name="b8123101515516"></a>HiTraceId</strong> object.</p>
<p id="p584391823715"><a name="p584391823715"></a><a name="p584391823715"></a>Input arguments: none</p>
<p id="p198431418153714"><a name="p198431418153714"></a><a name="p198431418153714"></a>Output arguments: none</p>
<p id="p19843161833719"><a name="p19843161833719"></a><a name="p19843161833719"></a>Return value: Returns the current span ID.</p>
</td>
</tr>
<tr id="row48438182378"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p184361810373"><a name="p184361810373"></a><a name="p184361810373"></a>void SetSpanId(uint64_t spanId)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p14843171816375"><a name="p14843171816375"></a><a name="p14843171816375"></a>Sets the span ID in the <strong id="b13643024185512"><a name="b13643024185512"></a><a name="b13643024185512"></a>HiTraceId</strong> object.</p>
<p id="p1684381811375"><a name="p1684381811375"></a><a name="p1684381811375"></a>Input arguments:</p>
<a name="ul1799516134316"></a><a name="ul1799516134316"></a><ul id="ul1799516134316"><li><strong id="b43891187116"><a name="b43891187116"></a><a name="b43891187116"></a>spanId</strong>: Indicates the span ID.</li></ul>
<p id="p6843181820372"><a name="p6843181820372"></a><a name="p6843181820372"></a>Output arguments: none</p>
<p id="p8843518113714"><a name="p8843518113714"></a><a name="p8843518113714"></a>Return value: none</p>
</td>
</tr>
<tr id="row178435181375"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p10843141816371"><a name="p10843141816371"></a><a name="p10843141816371"></a>uint64_t GetParentSpanId()</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p884381819373"><a name="p884381819373"></a><a name="p884381819373"></a>Obtains the parent span ID from the current <strong id="b5851839615"><a name="b5851839615"></a><a name="b5851839615"></a>HiTraceId</strong> object.</p>
<p id="p1684321812371"><a name="p1684321812371"></a><a name="p1684321812371"></a>Input arguments: none</p>
<p id="p8843131803711"><a name="p8843131803711"></a><a name="p8843131803711"></a>Output arguments: none</p>
<p id="p1584371833710"><a name="p1584371833710"></a><a name="p1584371833710"></a>Return value: Returns the parent span ID.</p>
</td>
</tr>
<tr id="row18843161893718"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p6843151819377"><a name="p6843151819377"></a><a name="p6843151819377"></a>void SetParentSpanId(uint64_t parentSpanId)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p1884361803719"><a name="p1884361803719"></a><a name="p1884361803719"></a>Sets the parent span ID in the <strong id="b1660960324"><a name="b1660960324"></a><a name="b1660960324"></a>HiTraceId</strong> object.</p>
<p id="p0843318113715"><a name="p0843318113715"></a><a name="p0843318113715"></a>Input arguments:</p>
<a name="ul1393128173120"></a><a name="ul1393128173120"></a><ul id="ul1393128173120"><li><strong id="b1923980171114"><a name="b1923980171114"></a><a name="b1923980171114"></a>parentSpanId</strong>: Indicates the parent span ID.</li></ul>
<p id="p138431518153712"><a name="p138431518153712"></a><a name="p138431518153712"></a>Output arguments: none</p>
<p id="p108431418163710"><a name="p108431418163710"></a><a name="p108431418163710"></a>Return value: none</p>
</td>
</tr>
<tr id="row128435182379"><td class="cellrowborder" valign="top" headers="mcps1.2.4.1.1 "><p id="p5843181816371"><a name="p5843181816371"></a><a name="p5843181816371"></a>int ToBytes(uint8_t* pIdArray, int len)</p>
</td>
<td class="cellrowborder" valign="top" headers="mcps1.2.4.1.2 "><p id="p8843171818378"><a name="p8843171818378"></a><a name="p8843171818378"></a>Converts the <strong id="b68851225439"><a name="b68851225439"></a><a name="b68851225439"></a>HiTraceId</strong> object into a byte array to facilitate caching or communication transfer.</p>
<p id="p1884391819376"><a name="p1884391819376"></a><a name="p1884391819376"></a>Input arguments:</p>
<a name="ul169461002314"></a><a name="ul169461002314"></a><ul id="ul169461002314"><li><strong id="b960934311010"><a name="b960934311010"></a><a name="b960934311010"></a>pIdArray</strong>: Indicates the pointer to a byte array. The minimum length of the byte array is <strong id="b96124430106"><a name="b96124430106"></a><a name="b96124430106"></a>HITRACE_ID_LEN</strong>.</li><li><strong id="b13672164941019"><a name="b13672164941019"></a><a name="b13672164941019"></a>len</strong>: Indicates the length of the byte array.</li></ul>
<p id="p8843101819379"><a name="p8843101819379"></a><a name="p8843101819379"></a>Output arguments</p>
<a name="ul116274319312"></a><a name="ul116274319312"></a><ul id="ul116274319312"><li><strong id="b12376938695"><a name="b12376938695"></a><a name="b12376938695"></a>pIdArray</strong>: Indicates the pointer to a byte array. If the object is valid, the object data after conversion is stored.</li></ul>
<p id="p8843618143720"><a name="p8843618143720"></a><a name="p8843618143720"></a>Return value: Returns a value greater than 0 (indicating a valid array of object data) if the conversion is successful; returns <strong id="b2156170234"><a name="b2156170234"></a><a name="b2156170234"></a>0</strong> otherwise.</p>
</td>
</tr>
</tbody>
</table>
## Call Chain Processing
Inter-device, inter-process, and inter-thread calls are implemented through the communication mechanism. **HiTraceChain** requires transfer of **traceid** in the communication mechanism.
Some built-in communication mechanisms \(such as ZIDL\) of OpenHarmony already support the transfer of **traceid**.
The following figure shows the process of transferring **traceid** in synchronous call. The process of transferring **traceid** in asynchronous call is similar. The following figure shows the process of transferring **traceid** in synchronous call. The process of transferring **traceid** in asynchronous call is similar.
Extended communication mechanisms can also follow this implementation. Extended communication mechanisms can also follow this implementation.
**Figure 5** Call chain trace in synchronous communication
**Figure 5** Call chain tracing in synchronous communication ![](figures/call-chain-trace-in-synchronous-communication.png "call-chain-trace-in-synchronous-communication")
![](figures/call-chain-tracing-in-synchronous-communication.png "call-chain-tracing-in-synchronous-communication")
The process is as follows: The process is as follows:
1. The service module on the client calls the **begin\(\)** function to start call chain tracing. 1. The service module on the client calls the **begin()** function to start call chain trace.
2. The service module on the client synchronously calls the **transact** function to the communication component on the client. 2. The service module on the client synchronously calls the **transact** function to the communication component on the client.
3. The communication component on the client performs the following: 3. The communication component on the client performs the following:
1. Obtains **traceid** from the TLS of the calling thread. 1. Obtains **traceid** from the TLS of the calling thread.
2. Generates child **traceid**. 2. Generates child **traceid**.
3. Writes child **traceid** into the transaction data \(synchronous communication data\). 3. Writes child **traceid** into the transaction data (synchronous communication data).
4. Performs Client Send \(CS\) tracing. 4. Performs CS trace.
5. Sends communication data to the communication component on the server. 5. Sends communication data to the communication component on the server.
4. On receiving the communication data, the communication component on the server performs the following: 4. On receiving the communication data, the communication component on the server performs the following:
1. Obtains **traceid** from the data message package. 1. Obtains **traceid** from the data message package.
2. Sets **traceid** in the TLS of the calling thread. 2. Sets **traceid** in the TLS of the calling thread.
3. Performs Server Receive \(SR\) tracing. 3. Performs SR trace.
4. Synchronously call the **onTransact** callback to the service module on the server. 4. Synchronously calls the **onTransact** callback to the service module on the server.
5. The service module on the server processes the service and sends the transact reply message carrying the processing result to the communication component. 5. The service module on the server processes the service and sends the transact reply message carrying the processing result to the communication component.
6. The communication component on the server performs the following: 6. The communication component on the server performs the following:
1. Performs Server Send \(SS\) tracing. 1. Performs SS trace.
2. Sends communication data to the communication component on the client. 2. Sends communication data to the communication component on the client.
3. Clears **traceid** from the TLS of the calling thread. 3. Clears **traceid** from the TLS of the calling thread.
7. On receiving the communication data, the communication component on the client performs the following: 7. On receiving the communication data, the communication component on the client performs the following:
1. Performs Client Receive \(CR\) tracing. 1. Performs CR trace.
2. Sends a transact reply response to the service module on the client. 2. Sends a transact reply response to the service module on the client.
8. The service module on the client processes the transact reply response. 8. The service module on the client processes the transact reply response.
9. When the process ends, the service module on the client calls the **end\(\)** function to stop call chain tracing.
9. When the process ends, the service module on the client calls the **end()** function to stop call chain trace.
## How to Develop ## How to Develop
### C++
1. Develop the source code. ### **C++**
1. Develop the source code.
Include the **hitracechain** header file in the class definition header file or class implementation source file. For example: Include the **hitracechain** header file in the class definition header file or class implementation source file. For example:
``` ```
#include "hitrace/tracechain.h" #include "hitrace/tracechain.h"
``` ```
Add the code to start and stop call chain tracing in the class implementation source file. Add the code to start and stop call chain trace in the class implementation source file.
``` ```
using namespace OHOS::HiviewDFX; using namespace OHOS::HiviewDFX;
auto traceId = HiTraceChain::Begin("MyServiceFlow", HITRACE_FLAG_DEFAULT); auto traceId = HiTraceChain::Begin("MyServiceFlow", HITRACE_FLAG_DEFAULT);
... ......
HiTraceChain::End(traceId); HiTraceChain::End(traceId);
``` ```
...@@ -504,21 +212,20 @@ The process is as follows: ...@@ -504,21 +212,20 @@ The process is as follows:
``` ```
### C ### **C**
1. Develop the source code. 1. Develop the source code.
Include the **hitracechain** header file in the source file. Include the **hitracechain** header file in the source file.
``` ```
#include "hitrace/tracechain.h" #include "hitrace/tracechain.h"
``` ```
Add the code to start and stop call chain tracing in the class implementation source file. Add the code to start and stop call chain trace in the class implementation source file.
``` ```
HiTraceIdStruct traceId = HiTraceChainBegin("MyServiceFlow", HITRACE_FLAG_DEFAULT); HiTraceIdStruct traceId = HiTraceChainBegin("MyServiceFlow", HITRACE_FLAG_DEFAULT);
... ......
HiTraceChainEnd(traceId); HiTraceChainEnd(traceId);
``` ```
...@@ -527,5 +234,3 @@ The process is as follows: ...@@ -527,5 +234,3 @@ The process is as follows:
``` ```
external_deps = [ "hiviewdfx:libhitracechain" ] external_deps = [ "hiviewdfx:libhitracechain" ]
``` ```
en/device-dev/subsystems/subsys-dfx-hitracemeter.md
浏览文件 @ 2c476b34
...@@ -2,16 +2,17 @@ ...@@ -2,16 +2,17 @@
## Introduction ## Introduction
HiTraceMeter is the OpenHarmony subsystem that provides APIs to implement call chain trace throughout a service process. With HiTraceMeter, you can quickly obtain the run log specific to the call chain of a service process and locate faults in inter-device, inter-process, or inter-thread communications. HiTraceMeter supports event logging in user mode and can collect trace data in user mode and kernel mode for performance tracing and analysis. HiTraceMeter is the OpenHarmony subsystem that provides APIs to implement call chain trace throughout a service process. With HiTraceMeter, you can quickly obtain the run log specific to the call chain of a service process and locate faults in inter-device, inter-process, or inter-thread communications. HiTraceMeter supports event logging in user mode and can collect trace data in user mode and kernel mode for performance trace and analysis.
## Basic Concepts ## Basic Concepts
The HiTraceMeter subsystem consists of three parts: The HiTraceMeter subsystem consists of three parts:
- JS/C++ HiTraceMeter APIs for application logging - JS/C++ HiTraceMeter APIs for application logging
- hitrace CLI tool for data collection - hitrace CLI tool for data collection
- smartperf tool for graphical data analysis - smartperf tool for graphical data analysis
Wherein, HiTraceMeter APIs and the hitrace CLI tool run on the device side, and the smartperf tool runs on the PC side. HiTraceMeter APIs are provided in C++ and JS for event logging, which aims to generate the trace data necessary for performance tracing and analysis during the development process. Wherein, HiTraceMeter APIs and the hitrace CLI tool run on the device side, and the smartperf tool runs on the PC side. HiTraceMeter APIs are provided in C++ and JS for event logging, which aims to generate the trace data necessary for performance trace and analysis during the development process.
The hitrace CLI tool is used to collect trace data. It captures trace data flows and saves the data as a text file. The hitrace CLI tool is used to collect trace data. It captures trace data flows and saves the data as a text file.
...@@ -80,7 +81,6 @@ HiTraceMeter provides the hitrace CLI tool for capturing trace data in user mode ...@@ -80,7 +81,6 @@ HiTraceMeter provides the hitrace CLI tool for capturing trace data in user mode
## Constraints ## Constraints
- The implementation of HiTraceMeter functions and APIs depends on the ftrace functionality, a framework provided by the kernel. It enables developers to add more trace functions via plug-ins. Therefore, make sure that ftrace is enabled before you use HiTraceMeter. - The implementation of HiTraceMeter functions and APIs depends on the ftrace functionality, a framework provided by the kernel. It enables developers to add more trace functions via plug-ins. Therefore, make sure that ftrace is enabled before you use HiTraceMeter.
...@@ -95,7 +95,6 @@ HiTraceMeter development focuses on two parts: JS/C++ event logging APIs and the ...@@ -95,7 +95,6 @@ HiTraceMeter development focuses on two parts: JS/C++ event logging APIs and the
## When to Use ## When to Use
You may encounter unexpected issues like app freezing during app development or need to view the code's call chain during code debugging. With the APIs provided by HiTraceMeter, you'll be able to trace the application delay and call chain to identify performance problems. You may encounter unexpected issues like app freezing during app development or need to view the code's call chain during code debugging. With the APIs provided by HiTraceMeter, you'll be able to trace the application delay and call chain to identify performance problems.
...@@ -106,18 +105,17 @@ Only C++ APIs are now open for system developers. If you're developing a JS app, ...@@ -106,18 +105,17 @@ Only C++ APIs are now open for system developers. If you're developing a JS app,
**Table 1** Sync APIs **Table 1** Sync APIs
| Sync trace | Function |Parameter Description | | Sync trace | Function | Parameter Description |
| :----------------------------------------------------------- | ------------- |------------- | |:---------------------------------------------------------------------------- | --------- | --------------------------------------------------------------------- |
| void StartTrace(uint64_t label, const std::string& value, float limit = -1); | Starts a synchronous trace.|**label**: trace category.<br>**value**: trace data that indicates the specific status, such as the memory size and queue length.| | void StartTrace(uint64_t label, const std::string& value, float limit = -1); | Starts a synchronous trace.| **label**: trace category.<br>**value**: trace data that indicates the specific status, such as the memory size and queue length.|
| void FinishTrace(uint64_t label); | Stops a synchronous trace.|**label**: trace category.| | void FinishTrace(uint64_t label); | Stops a synchronous trace.| **label**: trace category. |
**StartTrace** and **FinishTrace** must be used in pairs, and **FinishTrace** matches the latest **StartTrace**. The two APIs can be used in nested mode. The stack data structure is used for matching during trace data parsing. The **limit** parameter is used for flow control, and you are advised to use the default value. **StartTrace** and **FinishTrace** must be used in pairs, and **FinishTrace** matches the latest **StartTrace**. The two APIs can be used in nested mode. The stack data structure is used for matching during trace data parsing. The **limit** parameter is used for flow control, and you are advised to use the default value.
**Table 2** Async APIs **Table 2** Async APIs
| Async trace | Function |Parameter Description | | Async trace | Function | Parameter Description |
| ------------------------------------------------------------ | ------------- |------------- | | ------------------------------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------- |
| void StartAsyncTrace(uint64_t label, const std::string& value, int32_t taskId, float limit = -1); | Starts an asynchronous trace.| **label**: trace category.<br>**value**: trace data that indicates the specific status, such as the memory size and queue length.<br>**taskId**: ID used to indicate the association of APIs in an asynchronous trace.| | void StartAsyncTrace(uint64_t label, const std::string& value, int32_t taskId, float limit = -1); | Starts an asynchronous trace.| **label**: trace category.<br>**value**: trace data that indicates the specific status, such as the memory size and queue length.<br>**taskId**: ID used to indicate the association of APIs in an asynchronous trace.|
| void FinishAsyncTrace(uint64_t label, const std::string& value, int32_t taskId); | Stops an asynchronous trace.| **label**: trace category.<br>**value**: trace data that indicates the specific status, such as the memory size and queue length.<br>**taskId**: ID used to indicate the association of APIs in an asynchronous trace.| | void FinishAsyncTrace(uint64_t label, const std::string& value, int32_t taskId); | Stops an asynchronous trace.| **label**: trace category.<br>**value**: trace data that indicates the specific status, such as the memory size and queue length.<br>**taskId**: ID used to indicate the association of APIs in an asynchronous trace.|
...@@ -127,17 +125,18 @@ The trace data of **StartAsyncTrace** and **FinishAsyncTrace** is matched based ...@@ -127,17 +125,18 @@ The trace data of **StartAsyncTrace** and **FinishAsyncTrace** is matched based
**Table 3** Counter APIs **Table 3** Counter APIs
| Counter Trace | Function |Parameter Description | | Counter Trace | Function | Parameter Description |
| ------------------------------------------------------------ | --------- |--------- | | ------------------------------------------------------------------ | ------- | -------------------------------------------------------------- |
| void CountTrace(uint64_t label, const std::string& name, int64_t); | Count trace.|**label**: trace category.<br>**name**: trace name displayed in the IDE.| | void CountTrace(uint64_t label, const std::string& name, int64_t); | Count trace.| **label**: trace category.<br>**name**: trace name displayed in the IDE.|
## How to Develop ## How to Develop
1. Add the build dependencies to the build configuration file **base\hiviewdfx\hitrace\cmd\BUILD.gn**. 1. Add the build dependencies to the build configuration file **base\hiviewdfx\hitrace\cmd\BUILD.gn**.
``` ```
external_deps = [ "hitrace_native:hitrace_meter"] external_deps = [ "hitrace_native:hitrace_meter"]
``` ```
2. Add the header file dependencies. 2. Add the header file dependencies.
```cpp ```cpp
...@@ -146,13 +145,12 @@ The trace data of **StartAsyncTrace** and **FinishAsyncTrace** is matched based ...@@ -146,13 +145,12 @@ The trace data of **StartAsyncTrace** and **FinishAsyncTrace** is matched based
3. When calling an API, pass the trace value as an input parameter. The trace tags currently supported are listed in **hitrace_meter.h**. Assume that the trace tag is **OHOS** and trace data of **func1** and **func2** needs to be captured. After the hitrace command is executed in the shell, the trace data is automatically captured. The captured data includes the function call process and the memory and time consumed during this process. You can use the data to analyze the call process to identify performance problems. 3. When calling an API, pass the trace value as an input parameter. The trace tags currently supported are listed in **hitrace_meter.h**. Assume that the trace tag is **OHOS** and trace data of **func1** and **func2** needs to be captured. After the hitrace command is executed in the shell, the trace data is automatically captured. The captured data includes the function call process and the memory and time consumed during this process. You can use the data to analyze the call process to identify performance problems.
```cpp
#include "hitrace_meter.h" // Include hitrace_meter.h
using namespace std;
```cpp int main()
#include "hitrace_meter.h" // Include hitrace_meter.h {
using namespace std;
int main()
{
uint64_t label = BYTRACE_TAG_OHOS; uint64_t label = BYTRACE_TAG_OHOS;
sleep(1); sleep(1);
CountTrace(label, "count number", 2000); // Integer trace CountTrace(label, "count number", 2000); // Integer trace
...@@ -166,7 +164,7 @@ int main() ...@@ -166,7 +164,7 @@ int main()
FinishTrace(label); // Trace end point of func1Trace FinishTrace(label); // Trace end point of func1Trace
StartAsyncTrace(label, "asyncTrace1", 1234); // Trace start point of asyncTrace1 StartAsyncTrace(label, "asyncTrace1", 1234); // Trace start point of asyncTrace1
FinishAsyncTrace(label, "asyncTrace1", 1234); // Trace end point of asyncTrace2 FinishAsyncTrace(label, "asyncTrace1", 1234); // Trace end point of asyncTrace1
return 0; return 0;
} }
...@@ -180,7 +178,6 @@ int main() ...@@ -180,7 +178,6 @@ int main()
You can open the captured data by clicking **Open trace file** in the smartperf tool or dragging the data to the graphics area. For details, see [smartperf](https://toscode.gitee.com/openharmony-sig/smartperf). You can open the captured data by clicking **Open trace file** in the smartperf tool or dragging the data to the graphics area. For details, see [smartperf](https://toscode.gitee.com/openharmony-sig/smartperf).
## Verification ## Verification
The following is a demo debugging process, where the **StartTrace** and **FinishTrace** APIs are used in synchronization mode. The following is a demo debugging process, where the **StartTrace** and **FinishTrace** APIs are used in synchronization mode.
...@@ -274,10 +271,10 @@ The hitrace CLI tool is an executable binary program. On an OpenHarmony-powered ...@@ -274,10 +271,10 @@ The hitrace CLI tool is an executable binary program. On an OpenHarmony-powered
**Table 4** Command list **Table 4** Command list
| Option | Description | | Option | Description |
| ------------------------------ | ------------------------------------------------------------ | | ----------------------------- | -------------------------------------------------------- |
| -h, --help | Views the help Information. | | -h, --help | Views the help Information. |
| -b *n*, --buffer_size *n* | Sets the buffer size for trace data in KB. The default value is **2048**. | | -b *n*, --buffer_size *n* | Sets the buffer size for trace data in KB. The default value is **2048**. |
| -t *n*, --time *n* | Sets the trace uptime in seconds, which depends on the time required for analysis.| | -t *n*, --time *n* | Sets the trace uptime in seconds, which depends on the time required for analysis. |
| --trace_clock clock | Sets the type of the clock for adding a timestamp to a trace. The value can be **boot** (default), **global**, **mono**, **uptime**, or **perf**.| | --trace_clock clock | Sets the type of the clock for adding a timestamp to a trace. The value can be **boot** (default), **global**, **mono**, **uptime**, or **perf**.|
| --trace_begin | Starts capturing trace data. | | --trace_begin | Starts capturing trace data. |
| --trace_dump | Dumps trace data to the specified position. The default position is the console. | | --trace_dump | Dumps trace data to the specified position. The default position is the console. |
...@@ -292,34 +289,41 @@ Examples: ...@@ -292,34 +289,41 @@ Examples:
- Query supported labels. - Query supported labels.
``` ```
hitrace -l hitrace -l
``` ```
Alternatively, run the following command: Alternatively, run the following command:
``` ```
hitrace --list_categories hitrace --list_categories
```
```
- Trace ability information for 10 seconds and store the trace data in a buffer of 4 MB. - Trace ability information for 10 seconds and store the trace data in a buffer of 4 MB.
``` ```
hitrace -b 4096 -t 10 --overwrite ability > /data/log/mytrace.ftrace hitrace -b 4096 -t 10 --overwrite ability > /data/log/mytrace.ftrace
```
```
- Set the clock type to **mono**. - Set the clock type to **mono**.
``` ```
hitrace --trace_clock mono -b 4096 -t 10 --overwrite ability > /data/log/mytrace.ftrace hitrace --trace_clock mono -b 4096 -t 10 --overwrite ability > /data/log/mytrace.ftrace
```
```
- Compress the trace data. - Compress the trace data.
``` ```
hitrace -z -b 4096 -t 10 --overwrite ability > /data/log/mytrace.ftrace hitrace -z -b 4096 -t 10 --overwrite ability > /data/log/mytrace.ftrace
``` ```
...@@ -330,14 +334,18 @@ Examples: ...@@ -330,14 +334,18 @@ Examples:
#### Symptom #### Symptom
The data captured by running the hitrace command is incomplete or no data is captured. The data captured by running the hitrace command is incomplete or no data is captured.
#### **Root Cause**
The value of **-t** or **-b** buffer is too small, leading to data loss.
#### Solution #### Solution
Check the value of the **-t** and **-b** parameters. If the value is too small, data loss will occur. You are advised to set **-t** to **60** and **-b** to **204800** to increase the trace capture time and buffer, respectively. You can set **-t** to **60** and **-b** to **204800** to increase the trace time and buffer size.
# Reference # Reference
For details about HiTraceMeter, see [hiviewdfx_hitrace: A Lightweight Distributed Tracing](https://gitee.com/openharmony/hiviewdfx_hitrace). For details about HiTraceMeter, see [hiviewdfx_hitrace: Lightweight Distributed Trace](https://gitee.com/openharmony/hiviewdfx_hitrace).
en/device-dev/subsystems/subsys-dfx-overview.md
浏览文件 @ 2c476b34
# DFX Overview<a name="EN-US_TOPIC_0000001185974398"></a> # DFX Overview
## Introduction
[Design for X](https://en.wikipedia.org/wiki/Design_for_X) \(DFX\) refers to the software design that aims to improve the quality attributes in OpenHarmony. It mainly consists of two parts: design for reliability \(DFR\) and design for testability \(DFT\). [Design for X](https://en.wikipedia.org/wiki/Design_for_X) \(DFX\) refers to the software design that aims to improve the quality attributes in OpenHarmony. It mainly consists of two parts: design for reliability \(DFR\) and design for testability \(DFT\).
The DFX subsystem provides the following functions: The DFX subsystem provides the following functions:
- HiLog: implements the logging function. It is applicable to mini-system devices \(reference memory ≥ 128 KiB\), small-system devices \(reference memory ≥ 1 MiB\), and standard-system devices \(reference memory ≥ 128 MB\). - HiLog: implements the logging function. It is applicable to mini-system devices \(reference memory ≥ 128 KiB\), small-system devices \(reference memory ≥ 1 MiB\), and standard-system devices \(reference memory ≥ 128 MiB\).
- HiTraceChain: implements distributed call chain tracing. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- HiTraceChain: implements distributed call chain trace. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- HiTraceMeter: implements performance trace. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\). - HiTraceMeter: implements performance trace. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- HiCollie: implements thread suspension detection. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\). - HiCollie: implements thread suspension detection. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- HiSysEvent: implements system event logging. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\). - HiSysEvent: implements system event logging. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- HiDumper: exports system information. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\). - HiDumper: exports system information. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- FaultLogger: implements crash detection. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- Faultlogger: implements crash detection. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- Hiview: implements device maintenance across different platforms. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\). - Hiview: implements device maintenance across different platforms. It is applicable to standard-system devices \(reference memory ≥ 128 MiB\).
- HiAppEvent and HiChecker are only hap developer oriented。
- HiAppEvent and HiChecker are applicable only for HAP developers.
![dfx features overview](figure/dfx-overview.png) ![dfx features overview](figure/dfx-overview.png)
## Basic Concepts<a name="section5635178134811"></a> ## Basic Concepts
**Logging** **Logging**
Logging means to record the log information generated during system running so you can understand the running process and status of the system or applications. Logging means to record the log information generated during system running so you can understand the running process and status of the system or applications.
**Distributed call chain tracing** **Distributed call chain trace**
In a distributed system, the initiation of a service may involve multiple software modules, with control commands and data transmitted over intra-process, inter-process, and inter-device communication interfaces. To help you understand such complex communication processes and locate service faults efficiently, the DFX subsystem provides a distributed call chain tracing framework. In a distributed system, the initiation of a service may involve multiple software modules, with control commands and data transmitted over intra-process, inter-process, and inter-device communication interfaces. To help you understand such complex communication processes and locate service faults efficiently, the DFX subsystem provides a distributed call chain trace framework.
**Thread suspension detection** **Thread suspension detection**
If a thread is trapped in an infinite loop or the kernel state \(for example, Uninterruptable Sleep, Traced, Zombie, or synchronous wait\) when it is running, the thread cannot respond to normal service requests and cannot detect and recover from faults by itself. To detect and locate this type of faults, the DFX subsystem provides a simple watchdog mechanism by inserting detection probes to the process nodes that are prone to suspension. This ensures that suspension faults can be detected and logs can be collected. If a thread is trapped in an infinite loop or the kernel state (for example, Uninterruptable Sleep, Traced, Zombie, or synchronous wait) when it is running, the thread cannot respond to normal service requests and cannot detect and recover from faults by itself. To detect and locate this type of faults, the DFX subsystem provides a simple watchdog mechanism by inserting detection probes to the process nodes that are prone to suspension. This ensures that suspension faults can be detected and logs can be collected.
**Event logging** **Logging**
Event logging means to collect and log events reported during system running. The log information will help you better analyze the product usage. Event logging means to collect and log events reported during system running. The log information will help you better analyze the product usage.
**System event** **System event**
A system event is an indication of the system status at a given time point during system running. You can use these events to analyze the status change of the system. A system event is an indication of the system status at a given time point during system running. You can use these events to analyze the status change of the system.
<!--no_check-->
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或