diff --git a/en/application-dev/reference/apis/Readme-EN.md b/en/application-dev/reference/apis/Readme-EN.md index f9f0247e9fff7af42e5d4ba0e57bec7750d41fa5..b33bcf666262b6c1b98d4ed734c08b4a2a6d03bc 100644 --- a/en/application-dev/reference/apis/Readme-EN.md +++ b/en/application-dev/reference/apis/Readme-EN.md @@ -45,8 +45,13 @@ - [SMS](js-apis-sms.md) - [SIM Management](js-apis-sim.md) - [Radio](js-apis-radio.md) - - [observer](js-apis-observer.md) + - [Observer](js-apis-observer.md) - [Cellular Data](js-apis-telephony-data.md) +- Network Management + - [Network Connection Management](js-apis-net-connection.md) + - [Socket Connection](js-apis-socket.md) + - [WebSocket Connection](js-apis-webSocket.md) + - [Data Request](js-apis-http.md) - Network and Connectivity - [WLAN](js-apis-wifi.md) - [Bluetooth](js-apis-bluetooth.md) diff --git a/en/application-dev/reference/apis/js-apis-call.md b/en/application-dev/reference/apis/js-apis-call.md index 33ea80fda600d889e265ace58cb3de2b5f0d19fb..4d2b6c07f8170d6f930fc6522095967c3f608f92 100644 --- a/en/application-dev/reference/apis/js-apis-call.md +++ b/en/application-dev/reference/apis/js-apis-call.md @@ -11,11 +11,11 @@ import call from '@ohos.telephony.call'; ``` -## call.dial +## call.dial dial\(phoneNumber: string, callback: AsyncCallback\): void -Initiates a call. This function uses an asynchronous callback to return the execution result. +Initiates a call. This API uses an asynchronous callback to return the execution result. **Required permission**: ohos.permission.PLACE\_CALL (a system permission) @@ -23,7 +23,7 @@ Initiates a call. This function uses an asynchronous callback to return the exec **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ------------------------------------------------- | | phoneNumber | string | Yes | Phone number. | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: success
- **false**: failure| @@ -37,11 +37,11 @@ call.dial("138xxxxxxxx", (err, data) => { ``` -## call.dial +## call.dial dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback\): void -Initiates a call. You can set call options as needed. This function uses an asynchronous callback to return the execution result. +Initiates a call. You can set call options as needed. This API uses an asynchronous callback to return the execution result. **Required permission**: ohos.permission.PLACE\_CALL (a system permission) @@ -49,10 +49,10 @@ Initiates a call. You can set call options as needed. This function uses an asyn **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ------------------------------------------------- | | phoneNumber | string | Yes | Phone number. | -| options | DialOptions | Yes | Call options. For details, see [DialOptions](#DialOptions). | +| options | DialOptions | Yes | Call options defined in [DialOptions](#dialoptions). | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: success
- **false**: failure| **Example** @@ -66,11 +66,11 @@ call.dial("138xxxxxxxx", { ``` -## call.dial +## call.dial dial\(phoneNumber: string, options?: DialOptions\): Promise -Initiates a call. You can set call options as needed. This function uses a promise to return the execution result. +Initiates a call. You can set call options as needed. This API uses a promise to return the execution result. **Required permission**: ohos.permission.PLACE\_CALL (a system permission) @@ -78,10 +78,10 @@ Initiates a call. You can set call options as needed. This function uses a promi **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ----------- | ---- | ------------------------------------------- | | phoneNumber | string | Yes | Phone number. | -| options | DialOptions | Yes | Call options. For details, see [DialOptions](#DialOptions).| +| options | DialOptions | Yes | Call options defined in [DialOptions](#dialoptions).| **Return Value** @@ -102,17 +102,19 @@ promise.then(data => { }); ``` -## call.makeCall7+ +## call.makeCall7+ -makeCall(phoneNumber: string, callback: AsyncCallback): void +makeCall(phoneNumber: string, callback: AsyncCallback\): void -Launches the call screen and displays the dialed number. This method uses an asynchronous callback to return the result. +Launches the call screen and displays the dialed number. This API uses an asynchronous callback to return the result. -**System capability**: SystemCapability.Telephony.CallManager +This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. + +**System capability**: SystemCapability.Applications.Contacts **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ------------------------- | ---- | ------------------------------------------ | | phoneNumber | string | Yes | Phone number. | | callback | AsyncCallback<void> | Yes | Callback used to return the result.| @@ -126,17 +128,19 @@ call.makeCall("138xxxxxxxx", err => { ``` -## call.makeCall7+ +## call.makeCall7+ -makeCall(phoneNumber: string): Promise +makeCall(phoneNumber: string): Promise\ -Launches the call screen and displays the dialed number. This method uses a promise to return the result. +Launches the call screen and displays the dialed number. This API uses a promise to return the result. -**System capability**: SystemCapability.Telephony.CallManager +This API is defined but not implemented in OpenHarmony 3.1 Release. It will be available for use in OpenHarmony 3.1 MR. + +**System capability**: SystemCapability.Applications.Contacts **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------- | | phoneNumber | string | Yes | Phone number.| @@ -157,17 +161,17 @@ promise.then(() => { }); ``` -## call.hasCall +## call.hasCall hasCall\(callback: AsyncCallback\): void -Checks whether a call is in progress. This function uses an asynchronous callback to return the result. +Checks whether a call is in progress. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | -------- | ---------------------------- | ---- | ------------------------------------------------------------ | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: A call is in progress.
- **false**: No call is in progress.| @@ -180,11 +184,11 @@ call.hasCall((err, data) => { ``` -## call.hasCall +## call.hasCall hasCall\(\): Promise -Checks whether a call is in progress. This function uses a promise to return the result. +Checks whether a call is in progress. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CallManager @@ -206,19 +210,19 @@ promise.then(data => { ``` -## call.getCallState +## call.getCallState getCallState\(callback: AsyncCallback\): void -Obtains the call status. This function uses an asynchronous callback to return the result. +Obtains the call status. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | -------- | -------------------------------------------- | ---- | ------------------------------------ | -| callback | AsyncCallback<[CallState](#CallState)> | Yes | Callback used to return the result.| +| callback | AsyncCallback<[CallState](#callstate)> | Yes | Callback used to return the result.| **Example** @@ -229,11 +233,11 @@ call.getCallState((err, data) => { ``` -## call.getCallState +## call.getCallState getCallState\(\): Promise -Obtains the call status. This function uses a promise to return the result. +Obtains the call status. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CallManager @@ -241,7 +245,7 @@ Obtains the call status. This function uses a promise to return the result. | Type | Description | | -------------------------------------- | ----------------------------------------- | -| Promise<[CallState](#CallState)> | Promise used to return the result.| +| Promise<[CallState](#callstate)> | Promise used to return the result.| **Example** @@ -254,11 +258,11 @@ promise.then(data => { }); ``` -## call.hasVoiceCapability7+ +## call.hasVoiceCapability7+ hasVoiceCapability(): boolean -Checks whether a device supports voice calls. This function works in synchronous mode. +Checks whether a device supports voice calls. This API works in synchronous mode. **System capability**: SystemCapability.Telephony.CallManager @@ -273,17 +277,17 @@ let result = call.hasVoiceCapability(); console.log(`hasVoiceCapability: ${JSON.stringify(result)}`); ``` -## call.isEmergencyPhoneNumber7+ +## call.isEmergencyPhoneNumber7+ isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback\): void -Checks whether the call number of the SIM card in the specified slot is an emergency number. This function uses an asynchronous callback to return the result. +Checks whether the call number of the SIM card in the specified slot is an emergency number. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | | phoneNumber | string | Yes | Phone number. | | callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: The called number is an emergency number.
- **false**: The called number is not an emergency number.| @@ -297,20 +301,20 @@ call.isEmergencyPhoneNumber("138xxxxxxxx", (err, data) => { ``` -## call.isEmergencyPhoneNumber7+ +## call.isEmergencyPhoneNumber7+ isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, callback: AsyncCallback\): void -Checks whether the call number of the SIM card in the specified slot is an emergency number. This function uses an asynchronous callback to return the result. +Checks whether the call number of the SIM card in the specified slot is an emergency number. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ---------------------------- | ---- | ------------------------------------------------------------ | | phoneNumber | string | Yes | Phone number. | -| options | EmergencyNumberOptions | Yes | Emergency number options defined in [EmergencyNumberOptions](#EmergencyNumberOptions).| +| options | EmergencyNumberOptions | Yes | Emergency number options defined in [EmergencyNumberOptions](#emergencynumberoptions7).| | callback | AsyncCallback<boolean> | Yes | Callback used to return the result.
- **true**: The called number is an emergency number.
- **false**: The called number is not an emergency number.| **Example** @@ -322,20 +326,20 @@ call.isEmergencyPhoneNumber("112", {slotId: 1}, (err, value) => { ``` -## call.isEmergencyPhoneNumber7+ +## call.isEmergencyPhoneNumber7+ isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): Promise -Checks whether the call number of the SIM card in the specified slot is an emergency number. This function uses a promise to return the result. +Checks whether the call number of the SIM card in the specified slot is an emergency number. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ---------------------- | ---- | ------------------------------------------------------------ | | phoneNumber | string | Yes | Phone number. | -| options | EmergencyNumberOptions | Yes | Emergency number options defined in [EmergencyNumberOptions](#EmergencyNumberOptions).| +| options | EmergencyNumberOptions | Yes | Emergency number options defined in [EmergencyNumberOptions](#emergencynumberoptions7).| **Return Value** @@ -354,17 +358,17 @@ promise.then(data => { }); ``` -## call.formatPhoneNumber7+ +## call.formatPhoneNumber7+ formatPhoneNumber\(phoneNumber: string, callback: AsyncCallback\): void -Formats a phone number based on the specified ISO country code. This function uses an asynchronous callback to return the result. +Formats a phone number based on the specified ISO country code. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | --------------------------- | ---- | ------------------------------------ | | phoneNumber | string | Yes | Phone number. | | callback | AsyncCallback<string> | Yes | Callback used to return the result.| @@ -378,20 +382,20 @@ call.formatPhoneNumber("138xxxxxxxx", (err, data) => { ``` -## call.formatPhoneNumber7+ +## call.formatPhoneNumber7+ formatPhoneNumber\(phoneNumber: string, options: NumberFormatOptions, callback: AsyncCallback\): void -Formats a phone number based on specified formatting options. This function uses an asynchronous callback to return the result. +Formats a phone number based on specified formatting options. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | --------------------------- | ---- | ------------------------------------------------------------ | | phoneNumber | string | Yes | Phone number. | -| options | NumberFormatOptions | Yes | Number formatting options defined in [NumberFormatOptions](#NumberFormatOptions).| +| options | NumberFormatOptions | Yes | Number formatting options defined in [NumberFormatOptions](#numberformatoptions7).| | callback | AsyncCallback<string> | Yes | Callback used to return the result. | **Example** @@ -405,20 +409,20 @@ call.formatPhoneNumber("138xxxxxxxx",{ ``` -## call.formatPhoneNumber7+ +## call.formatPhoneNumber7+ formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise -Formats a phone number based on specified formatting options. This function uses a promise to return the result. +Formats a phone number based on specified formatting options. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CallManager **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ------------------- | ---- | ------------------------------------------------------------ | | phoneNumber | string | Yes | Phone number. | -| options | NumberFormatOptions | Yes | Number formatting options defined in [NumberFormatOptions](#NumberFormatOptions).| +| options | NumberFormatOptions | Yes | Number formatting options defined in [NumberFormatOptions](#numberformatoptions7).| **Return Value** @@ -439,11 +443,11 @@ promise.then(data => { }); ``` -## call.formatPhoneNumberToE1647+ +## call.formatPhoneNumberToE1647+ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: AsyncCallback\): void -Converts a phone number into the E.164 format. This function uses an asynchronous callback to return the result. +Converts a phone number into the E.164 format. This API uses an asynchronous callback to return the result. The phone number must match the specified country code. For example, for a China phone number, the country code must be **CN**. Otherwise, **null** will be returned. @@ -453,7 +457,7 @@ All country codes are supported. **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | --------------------------- | ---- | ----------------------------------------------------- | | phoneNumber | string | Yes | Phone number. | | countryCode | string | Yes | Country code, for example, **CN** (China). All country codes are supported. | @@ -470,11 +474,11 @@ call.formatPhoneNumberToE164("138xxxxxxxx",{ ``` -## call.formatPhoneNumberToE1647+ +## call.formatPhoneNumberToE1647+ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise -Converts a phone number into the E.164 format. This function uses a promise to return the result. +Converts a phone number into the E.164 format. This API uses a promise to return the result. The phone number must match the specified country code. For example, for a China phone number, the country code must be **CN**. Otherwise, **null** will be returned. @@ -484,7 +488,7 @@ All country codes are supported. **Parameters** -| Name | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------------------------------------- | | phoneNumber | string | Yes | Phone number. | | countryCode | string | Yes | Country code, for example, **CN** (China). All country codes are supported.| @@ -508,43 +512,45 @@ promise.then(data => { }); ``` -## DialOptions +## DialOptions Provides an option for determining whether a call is a video call. **System capability**: SystemCapability.Telephony.CallManager -| Parameter | Type | Mandatory| Description | +| Name| Type | Mandatory| Description | | ------ | ------- | ---- | ------------------------------------------------------------ | | extras | boolean | No | Indication of a video call.
- **true**: video call
- **false** (default): voice call| -## CallState +## CallState Enumerates call states. -| Variable | Value | Description | +**System capability**: SystemCapability.Telephony.CallManager + +| Name | Value | Description | | ------------------ | ---- | ------------------------------------------------------------ | -| CALL_STATE_UNKNOWN | -1 | The call status fails to be obtained and is unknown.
**System capability**: SystemCapability.Telephony.CallManager| -| CALL_STATE_IDLE | 0 | No call is in progress.
**System capability**: SystemCapability.Telephony.CallManager| -| CALL_STATE_RINGING | 1 | The call is in the ringing or waiting state.
**System capability**: SystemCapability.Telephony.CallManager| -| CALL_STATE_OFFHOOK | 2 | At least one call is in dialing, active, or on hold, and no new incoming call is ringing or waiting.
**System capability**: SystemCapability.Telephony.CallManager| +| CALL_STATE_UNKNOWN | -1 | The call status fails to be obtained and is unknown. | +| CALL_STATE_IDLE | 0 | No call is in progress. | +| CALL_STATE_RINGING | 1 | The call is in the ringing or waiting state. | +| CALL_STATE_OFFHOOK | 2 | At least one call is in dialing, active, or on hold, and no new incoming call is ringing or waiting.| -## EmergencyNumberOptions7+ +## EmergencyNumberOptions7+ Provides an option for determining whether a number is an emergency number for the SIM card in the specified slot. **System capability**: SystemCapability.Telephony.CallManager -| Parameter | Type | Mandatory| Description | +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------------------------------ | | slotId | number | No | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| -## NumberFormatOptions7+ +## NumberFormatOptions7+ Provides an option for number formatting. **System capability**: SystemCapability.Telephony.CallManager -| Parameter | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ----------- | ------ | ---- | ---------------------------------------------------------- | | countryCode | string | No | Country code, for example, **CN** (China). All country codes are supported. The default value is **CN**.| diff --git a/en/application-dev/reference/apis/js-apis-http.md b/en/application-dev/reference/apis/js-apis-http.md index 3956505f311775d34c41c3e98b41b8d7ab882243..b3986832237d649e34dff9ed546378504fa9db78 100644 --- a/en/application-dev/reference/apis/js-apis-http.md +++ b/en/application-dev/reference/apis/js-apis-http.md @@ -37,8 +37,8 @@ httpRequest.request( extraData: { "data": "data to send", }, - connectTimeout: 60000, // Optional. The default value is **60000**, in ms. - readTimeout: 60000, // Optional. The default value is **60000**, in ms. + connectTimeout: 60000, // Optional. The default value is 60000, in ms. + readTimeout: 60000, // Optional. The default value is 60000, in ms. },(err, data) => { if (!err) { // data.result contains the HTTP response. It is up to you whether to parse the content. @@ -60,7 +60,7 @@ httpRequest.request( createHttp\(\): HttpRequest -Creates an HTTP request. You can use this API to initiate or destroy an HTTP request, or enable or disable listening for HTTP Response Header events. An HttpRequest object corresponds to an HTTP request. To initiate multiple HTTP requests, you must create an HttpRequest object for each HTTP request. +Creates an HTTP request. You can use this API to initiate or destroy an HTTP request, or enable or disable listening for HTTP Response Header events. An HttpRequest object corresponds to an HTTP request. To initiate multiple HTTP requests, you must create an **HttpRequest** object for each HTTP request. **System capability**: SystemCapability.Communication.NetStack @@ -68,7 +68,7 @@ Creates an HTTP request. You can use this API to initiate or destroy an HTTP req | Type | Description | | :---------- | :----------------------------------------------------------- | -| HttpRequest | An **HttpRequest **object, which contains the **request**, **destroy**, **on**, or **off** method.| +| HttpRequest | An **HttpRequest** object, which contains the **request**, **destroy**, **on**, or **off** method.| **Example** @@ -137,25 +137,25 @@ Initiates an HTTP request containing specified options to a given URL. This API ``` httpRequest.request("EXAMPLE_URL", { - method: 'GET', - header: { - 'Content-Type': 'application/json' - }, - readTimeout: 60000, - connectTimeout: 60000 -},(err, data) => { - if (!err) { - console.info('Result:' + data.result); - console.info('code:' + data.responseCode); - console.info('header:' + data.header); - console.info('cookies:' + data.cookies); // 8+ - console.info('header['Content-Type']:' + data.header['Content-Type']); - console.info('header['Status-Line']:' + data.header['Status-Line']); - console.info('header.Date:' + data.header.Date); - console.info('header.Server:' + data.header.Server); - } else { - console.info('error:' + err.data); - } + method: 'GET', + header: { + 'Content-Type': 'application/json' + }, + readTimeout: 60000, + connectTimeout: 60000 +}, (err, data) => { + if (!err) { + console.info('Result:' + data.result); + console.info('code:' + data.responseCode); + console.info('header:' + data.header); + console.info('cookies:' + data.cookies); // 8+ + console.info('header.Content-Type:' + data.header['Content-Type']); + console.info('header.Status-Line:' + data.header['Status-Line']); + console.info('header.Date:' + data.header.Date); + console.info('header.Server:' + data.header.Server); + } else { + console.info('error:' + err.data); + } }); ``` @@ -188,24 +188,24 @@ Initiates an HTTP request to a given URL. This API uses a promise to return the ``` let promise = httpRequest.request("EXAMPLE_URL", { - method: "GET", - connectTimeout: 60000, - readTimeout: 60000, - header: { - 'Content-Type': 'application/json' - } + method: "GET", + connectTimeout: 60000, + readTimeout: 60000, + header: { + 'Content-Type': 'application/json' + } }); promise.then((value) => { - console.info('Result:' + value.result); - console.info('code:' + value.responseCode); - console.info('header:' + value.header); - console.info('cookies:' + value.cookies); // 8+ - console.info('header['Content-Type']:' + value.header['Content-Type']); - console.info('header['Status-Line']:' + value.header['Status-Line']); - console.info('header.Date:' + value.header.Date); - console.info('header.Server:' + value.header.Server); + console.info('Result:' + value.result); + console.info('code:' + value.responseCode); + console.info('header:' + value.header); + console.info('cookies:' + value.cookies); // 8+ + console.info('header.Content-Type:' + value.header['Content-Type']); + console.info('header.Status-Line:' + value.header['Status-Line']); + console.info('header.Date:' + value.header.Date); + console.info('header.Server:' + value.header.Server); }).catch((err) => { - console.error(`errCode:${err.code}, errMessage:${err.data}`); + console.error(`errCode:${err.code}, errMessage:${err.data}`); }); ``` @@ -246,9 +246,9 @@ Registers an observer for HTTP Response Header events. ``` httpRequest.on('headerReceive', (err, data) => { if (!err) { - console.info('header: ' + data.header); + console.info('header: ' + data.header); } else { - console.info('error:' + err.data); + console.info('error:' + err.data); } }); ``` @@ -280,9 +280,9 @@ Unregisters the observer for HTTP Response Header events. ``` httpRequest.on('headerReceive', (err, data) => { if (!err) { - console.info('header: ' + data.header); + console.info('header: ' + data.header); } else { - console.info('error:' + err.data); + console.info('error:' + err.data); } }); httpRequest.off('headerReceive'); diff --git a/en/application-dev/reference/apis/js-apis-net-connection.md b/en/application-dev/reference/apis/js-apis-net-connection.md index 7e14306d2f67145b4e0d28d6fc532cb925729175..c0d9c297f77b71cff69ee91d920e0721ea93725d 100644 --- a/en/application-dev/reference/apis/js-apis-net-connection.md +++ b/en/application-dev/reference/apis/js-apis-net-connection.md @@ -1,7 +1,7 @@ # Network Connection Management -> **NOTE**
+> **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. @@ -17,7 +17,7 @@ getDefaultNet(callback: AsyncCallback\): void Obtains the default active data network. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -42,11 +42,11 @@ getDefaultNet(): Promise\ Obtains the default active data network. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core -**Return value** +**Return Value** | Type | Description | | --------------------------------- | ------------------------------------- | @@ -91,7 +91,7 @@ Checks whether the default data network is activated. This API uses a promise to **System capability**: SystemCapability.Communication.NetManager.Core -**Return value** +**Return Value** | Type | Description | | ----------------- | ----------------------------------------------- | @@ -111,7 +111,7 @@ getAllNets(callback: AsyncCallback<Array<NetHandle>>): void Obtains the list of all active data networks. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -136,11 +136,11 @@ getAllNets(): Promise<Array<NetHandle>> Obtains the list of all active data networks. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core -**Return value** +**Return Value** | Type| Description| | -------- | -------- | | Promise<Array<[NetHandle](#nethandle)>> | Promise used to return the result.| @@ -157,9 +157,9 @@ connection.getAllNets().then(function (nets) { getConnectionProperties(netHandle: NetHandle, callback: AsyncCallback\): void -Obtains connection properties of the network corresponding to the **netHandle**. This API uses an asynchronous callback to return the result. +Obtains connection properties of the network corresponding to given network handle. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -185,9 +185,9 @@ connection.getDefaultNet().then(function (netHandle) { getConnectionProperties(netHandle: NetHandle): Promise\ -Obtains connection properties of the network corresponding to the **netHandle**. This API uses a promise to return the result. +Obtains connection properties of the network corresponding to **netHandle**. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -197,7 +197,7 @@ Obtains connection properties of the network corresponding to the **netHandle**. | --------- | ----------------------- | ---- | ---------------- | | netHandle | [NetHandle](#nethandle) | Yes | Network handle.| -**Return value** +**Return Value** | Type | Description | | ------------------------------------------------------- | --------------------------------- | @@ -217,9 +217,9 @@ connection.getDefaultNet().then(function (netHandle) { getNetCapabilities(netHandle: NetHandle, callback: AsyncCallback\): void -Obtains capability information of the network corresponding to the **netHandle**. This API uses an asynchronous callback to return the result. +Obtains capability information of the network corresponding to **netHandle**. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -245,9 +245,9 @@ connection.getDefaultNet().then(function (netHandle) { getNetCapabilities(netHandle: NetHandle): Promise\ -Obtains capability information of the network corresponding to the **netHandle**. This API uses a promise to return the result. +Obtains capability information of the network corresponding to **netHandle**. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -257,7 +257,7 @@ Obtains capability information of the network corresponding to the **netHandle** | --------- | ----------------------- | ---- | ---------------- | | netHandle | [NetHandle](#nethandle) | Yes | Network handle.| -**Return value** +**Return Value** | Type | Description | | --------------------------------------------- | --------------------------------- | @@ -279,7 +279,7 @@ reportNetConnected(netHandle: NetHandle, callback: AsyncCallback<void>): v Reports connection of the data network. This API uses an asynchronous callback to return the result. -**Required permissions** : ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET +**Permission required**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET **System capability**: SystemCapability.Communication.NetManager.Core @@ -306,7 +306,7 @@ reportNetConnected(netHandle: NetHandle): Promise<void> Reports connection of the data network. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET +**Permission required**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET **System capability**: SystemCapability.Communication.NetManager.Core @@ -315,7 +315,7 @@ Reports connection of the data network. This API uses a promise to return the re | -------- | -------- | -------- | -------- | | netHandle | [NetHandle](#nethandle) | Yes| Handle of the data network. For details, see [NetHandle](#nethandle).| -**Return value** +**Return Value** | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| @@ -337,7 +337,7 @@ reportNetDisconnected(netHandle: NetHandle, callback: AsyncCallback<void>) Reports disconnection of the data network. This API uses an asynchronous callback to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET +**Permission required**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET **System capability**: SystemCapability.Communication.NetManager.Core @@ -364,7 +364,7 @@ reportNetDisconnected(netHandle: NetHandle): Promise<void> Reports disconnection of the data network. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET +**Permission required**: ohos.permission.GET_NETWORK_INFO and ohos.permission.INTERNET **System capability**: SystemCapability.Communication.NetManager.Core @@ -373,7 +373,7 @@ Reports disconnection of the data network. This API uses a promise to return the | -------- | -------- | -------- | -------- | | netHandle | [NetHandle](#nethandle) | Yes| Handle of the data network. For details, see [NetHandle](#nethandle).| -**Return value** +**Return Value** | Type| Description| | -------- | -------- | | Promise<void> | Promise used to return the result.| @@ -394,7 +394,7 @@ getAddressesByName(host: string, callback: AsyncCallback\>): 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 permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -402,7 +402,7 @@ Resolves the host name by using the default network to obtain all IP addresses. | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------- | ---- | ------------------ | -| host | string | Yes | Host name to resolve.| +| host | string | Yes | Host name to be resolved.| | callback | AsyncCallback\> | Yes | Callback used to return the result. | **Example** @@ -421,7 +421,7 @@ getAddressesByName(host: string): Promise\> Resolves the host name by using the default network to obtain all IP addresses. This API uses a promise to return the result. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -429,13 +429,13 @@ Resolves the host name by using the default network to obtain all IP addresses. | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------ | -| host | string | Yes | Host name to resolve.| +| host | string | Yes | Host name to be resolved.| -**Return value** +**Return Value** | Type | Description | | ------------------------------------------- | ----------------------------- | -| Promise\> | Promise used to return the IP addresses obtained.| +| Promise\> | Promise used to return the result.| **Example** @@ -461,7 +461,7 @@ Obtains the handle of the network specified by **netSpecifier**. | netSpecifier | [NetSpecifier](#netspecifier) | No | Network specifier. If this parameter is not set, the default network is used. | | timeout | number | No | Timeout interval for obtaining the network specified by **netSpecifier**. This parameter is valid only when **netSpecifier** is set.| -**Return value** +**Return Value** | Type | Description | | ------------------------------- | -------------------- | @@ -520,7 +520,7 @@ Registers a listener for **netCapabilitiesChange** events. | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | -| type | string | Yes | Event type. The value is fixed to **netCapabilitiesChange**.
**netCapabilitiesChange**: event indicating that the network capabilities have changed.| +| type | string | Yes | Event type. The value is fixed to **netCapabilitiesChange**.
**netCapabilitiesChange**: event indicating that he network capabilities have changed.| | callback | Callback<{ netHandle: [NetHandle](#nethandle), netCap: [NetCapabilities](#netcapabilities) }> | Yes | Callback used to return the result. | **Example** @@ -630,7 +630,7 @@ register(callback: AsyncCallback\): void Registers a listener for network status changes. -**Required permissions**: ohos.permission.GET_NETWORK_INFO +**Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Communication.NetManager.Core @@ -674,15 +674,15 @@ netConnection.unregister(function (error) { Defines the handle of the data network. -Before invoking **NetHandle** APIs, call **getNetHandle** to obtain a **NetHandle** object. +Before invoking NetHandle APIs, call **getNetHandle** to obtain a **NetHandle** object. **System capability**: SystemCapability.Communication.NetManager.Core -### Attributes +### Parameters | Name| Type | Description | | ------ | ------ | ------------------------- | -| netId | number | Network ID. The value must be greater than or equal to **100**.| +| netId | number | Network ID. The value must be greater than or equal to 100.| ### bindSocket @@ -731,7 +731,7 @@ Binds a **TCPSocket** or **UDPSocket** object to the data network. This API uses | ----------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | socketParam | TCPSocket \| UDPSocket | Yes | **TCPSocket** or **UDPSocket** object.| -**Return value** +**Return Value** | Type | Description | | ------------------- | --------------------------- | | Promise<void> | Promise used to return the result.| @@ -767,7 +767,7 @@ Resolves the host name by using the corresponding network to obtain all IP addre | Name | Type | Mandatory| Description | | -------- | ------------------------------------------------- | ---- | ------------------ | -| host | string | Yes | Host name to resolve.| +| host | string | Yes | Host name to be resolved.| | callback | AsyncCallback\> | Yes | Callback used to return the result. | **Example** @@ -794,9 +794,9 @@ Resolves the host name by using the corresponding network to obtain all IP addre | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------ | -| host | string | Yes | Host name to resolve.| +| host | string | Yes | Host name to be resolved.| -**Return value** +**Return Value** | Type | Description | | ------------------------------------------- | ----------------------------- | @@ -825,7 +825,7 @@ Resolves the host name by using the corresponding network to obtain the first IP | Name | Type | Mandatory| Description | | -------- | ----------------------------------------- | ---- | ------------------ | -| host | string | Yes | Host name to resolve.| +| host | string | Yes | Host name to be resolved.| | callback | AsyncCallback\<[NetAddress](#netaddress)> | Yes | Callback used to return the result. | **Example** @@ -852,9 +852,9 @@ Resolves the host name by using the corresponding network to obtain the first IP | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ------------------ | -| host | string | Yes | Host name to resolve.| +| host | string | Yes | Host name to be resolved.| -**Return value** +**Return Value** | Type | Description | | ----------------------------------- | ------------------------------- | @@ -901,7 +901,7 @@ Defines the network capability. **System capability**: SystemCapability.Communication.NetManager.Core -| Name | Value α | Description | +| Name | Value | Description | | ------------------------ | ---- | ---------------------- | | NET_CAPABILITY_MMS | 0 | The network can connect to the carrier's Multimedia Messaging Service Center (MMSC) to send and receive multimedia messages.| | NET_CAPABILITY_NOT_METERED | 11 | The network traffic is not metered.| @@ -915,7 +915,7 @@ Defines the network type. **System capability**: SystemCapability.Communication.NetManager.Core -| Name | Value α | Description | +| Name | Value | Description | | --------------- | ---- | ----------- | | BEARER_CELLULAR | 0 | Cellular network | | BEARER_WIFI | 1 | Wi-Fi network| @@ -938,7 +938,7 @@ Defines the network connection properties. ## LinkAddress -Defines network link information. +Network link information. **System capability**: SystemCapability.Communication.NetManager.Core @@ -949,7 +949,7 @@ Defines network link information. ## RouteInfo -Defines network route information. +Network route information. **System capability**: SystemCapability.Communication.NetManager.Core @@ -971,4 +971,4 @@ Defines the network address. | ------- | ------ | ------------------------------ | | address | string | Network address. | | family | number | Address family identifier. The value is **1** for IPv4 and **2** for IPv6. The default value is **1**.| -| port | number | Port number. The value range is 0 to 65535. | +| port | number | Port number. The value ranges from **0** to **65535**. | diff --git a/en/application-dev/reference/apis/js-apis-radio.md b/en/application-dev/reference/apis/js-apis-radio.md index f8f768ecc656722305f32f6f5c1e568e8cc37777..86090ef47d9add9dba3d2c0836e76b8d7f6ab989 100644 --- a/en/application-dev/reference/apis/js-apis-radio.md +++ b/en/application-dev/reference/apis/js-apis-radio.md @@ -600,13 +600,13 @@ Defines the network type. | Name | Value | Description | | -------------------- | ---- | ------------------------------------------------------------ | -| NETWORK_TYPE_UNKNOWN | 0 | Unknown network | -| NETWORK_TYPE_GSM | 1 | GSM network | -| NETWORK_TYPE_CDMA | 2 | CDMA network | -| NETWORK_TYPE_WCDMA | 3 | WCDMA network | -| NETWORK_TYPE_TDSCDMA | 4 | TD-SCDMA network| -| NETWORK_TYPE_LTE | 5 | LTE network | -| NETWORK_TYPE_NR | 6 | 5G NR network | +| NETWORK_TYPE_UNKNOWN | 0 | Unknown network. | +| NETWORK_TYPE_GSM | 1 | GSM network. | +| NETWORK_TYPE_CDMA | 2 | CDMA network. | +| NETWORK_TYPE_WCDMA | 3 | WCDMA network. | +| NETWORK_TYPE_TDSCDMA | 4 | TD-SCDMA network.| +| NETWORK_TYPE_LTE | 5 | LTE network. | +| NETWORK_TYPE_NR | 6 | 5G NR network. | ## NetworkState diff --git a/en/application-dev/reference/apis/js-apis-sim.md b/en/application-dev/reference/apis/js-apis-sim.md index 3421e50e7d1df9cd8dca76edf6edd5b3334daaef..b5e188671584289f3a36396e98b0a0f99ed790c2 100644 --- a/en/application-dev/reference/apis/js-apis-sim.md +++ b/en/application-dev/reference/apis/js-apis-sim.md @@ -15,7 +15,7 @@ import sim from '@ohos.telephony.sim'; isSimActive\(slotId: number, callback: AsyncCallback\): void -Checks whether the SIM card in the specified slot is activated. This function uses an asynchronous callback to return the result. +Checks whether the SIM card in the specified slot is activated. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -23,7 +23,7 @@ Checks whether the SIM card in the specified slot is activated. This function us | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. | **Example** @@ -39,7 +39,7 @@ sim.isSimActive(0, (err, data) => { isSimActive\(slotId: number\): Promise -Checks whether the SIM card in the specified slot is activated. This function uses a promise to return the result. +Checks whether the SIM card in the specified slot is activated. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -47,9 +47,9 @@ Checks whether the SIM card in the specified slot is activated. This function us | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | --------------------- | ---------------------------------- | @@ -71,7 +71,7 @@ promise.then(data => { getDefaultVoiceSlotId\(callback: AsyncCallback\): void -Obtains the default slot ID of the SIM card that provides voice services. This function uses an asynchronous callback to return the result. +Obtains the default slot ID of the SIM card that provides voice services. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -94,11 +94,11 @@ sim.getDefaultVoiceSlotId((err, data) => { getDefaultVoiceSlotId\(\): Promise -Obtains the default slot ID of the SIM card that provides voice services. This function uses a promise to return the result. +Obtains the default slot ID of the SIM card that provides voice services. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService -**Return Value** +**Return value** | Type | Description | | ----------------- | --------------------------------------- | @@ -119,7 +119,7 @@ promise.then(data => { hasOperatorPrivileges(slotId: number, callback: AsyncCallback\): void -Checks whether the application (caller) has been granted the operator permission. This function uses an asynchronous callback to return the result. +Checks whether the application (caller) has been granted the operator permission. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -127,7 +127,7 @@ Checks whether the application (caller) has been granted the operator permission | Name | Type | Mandatory| Description | | -------- | ------------------------ | ---- | ---------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback\ | Yes | Callback used to return the result. | **Example** @@ -140,9 +140,9 @@ sim.hasOperatorPrivileges(0, (err, data) => { ## sim.hasOperatorPrivileges7+ -hasOperatorPrivileges(slotId: number): Promise +hasOperatorPrivileges(slotId: number): Promise -Checks whether the application (caller) has been granted the operator permission. This function uses a promise to return the result. +Checks whether the application (caller) has been granted the operator permission. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -150,9 +150,9 @@ Checks whether the application (caller) has been granted the operator permission | Name| Type | Mandatory| Description | | ------ | ------ | ---- | ---------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | :----------------- | :---------------------------------------------------------- | @@ -173,7 +173,7 @@ promise.then(data => { getISOCountryCodeForSim\(slotId: number, callback: AsyncCallback\): void -Obtains the ISO country code of the SIM card in the specified slot. This function uses an asynchronous callback to return the result. +Obtains the ISO country code of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -181,7 +181,7 @@ Obtains the ISO country code of the SIM card in the specified slot. This functio | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | ---------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2 | +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2 | | callback | AsyncCallback\ | Yes | Callback used to return the result, which is a country code, for example, **CN** (China).| **Example** @@ -197,7 +197,7 @@ sim.getISOCountryCodeForSim(0, (err, data) => { getISOCountryCodeForSim\(slotId: number\): Promise -Obtains the ISO country code of the SIM card in the specified slot. This function uses a promise to return the result. +Obtains the ISO country code of the SIM card in the specified slot. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -205,9 +205,9 @@ Obtains the ISO country code of the SIM card in the specified slot. This functio | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | ----------------- | ------------------------------------------------------------ | @@ -229,7 +229,7 @@ promise.then(data => { getSimOperatorNumeric\(slotId: number, callback: AsyncCallback\): void -Obtains the public land mobile network (PLMN) ID of the SIM card in the specified slot. This function uses an asynchronous callback to return the result. +Obtains the public land mobile network (PLMN) ID of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -237,7 +237,7 @@ Obtains the public land mobile network (PLMN) ID of the SIM card in the specifie | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback\ | Yes | Callback used to return the result. | **Example** @@ -253,7 +253,7 @@ sim.getSimOperatorNumeric(0, (err, data) => { getSimOperatorNumeric\(slotId: number\): Promise -Obtains the PLMN ID of the SIM card in the specified slot. This function uses a promise to return the result. +Obtains the PLMN ID of the SIM card in the specified slot. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -261,9 +261,9 @@ Obtains the PLMN ID of the SIM card in the specified slot. This function uses a | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | ----------------- | ------------------------------------------------ | @@ -285,7 +285,7 @@ promise.then(data => { getSimSpn\(slotId: number, callback: AsyncCallback\): void -Obtains the service provider name (SPN) of the SIM card in the specified slot. This function uses an asynchronous callback to return the result. +Obtains the service provider name (SPN) of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -293,7 +293,7 @@ Obtains the service provider name (SPN) of the SIM card in the specified slot. T | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback\ | Yes | Callback used to return the result. | **Example** @@ -309,7 +309,7 @@ sim.getSimSpn(0, (err, data) => { getSimSpn\(slotId: number\): Promise -Obtains the SPN of the SIM card in the specified slot. This function uses a promise to return the result. +Obtains the SPN of the SIM card in the specified slot. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -317,9 +317,9 @@ Obtains the SPN of the SIM card in the specified slot. This function uses a prom | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | ----------------- | ----------------------------------------- | @@ -341,7 +341,7 @@ promise.then(data => { getSimState\(slotId: number, callback: AsyncCallback\): void -Obtains the status of the SIM card in the specified slot. This function uses an asynchronous callback to return the result. +Obtains the status of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -349,7 +349,7 @@ Obtains the status of the SIM card in the specified slot. This function uses an | Name | Type | Mandatory| Description | | -------- | -------------------------------------- | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback\<[SimState](#simState)\> | Yes | Callback used to return the result. For details, see [SimState](#simState). | **Example** @@ -365,7 +365,7 @@ sim.getSimState(0, (err, data) => { getSimState\(slotId: number\): Promise -Obtains the status of the SIM card in the specified slot. This function uses a promise to return the result. +Obtains the status of the SIM card in the specified slot. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -373,9 +373,9 @@ Obtains the status of the SIM card in the specified slot. This function uses a p | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | -------------------------------- | ------------------------------------------ | @@ -396,7 +396,7 @@ promise.then(data => { getCardType\(slotId: number, callback: AsyncCallback\): void -Obtains the type of the SIM card in the specified slot. This function uses an asynchronous callback to return the result. +Obtains the type of the SIM card in the specified slot. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -404,7 +404,7 @@ Obtains the type of the SIM card in the specified slot. This function uses an as | Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback\<[CardType](#cardtype7)\> | Yes | Callback used to return the result. | **Example** @@ -420,7 +420,7 @@ sim.getCardType(0, (err, data) => { getCardType\(slotId: number\): Promise -Obtains the type of the SIM card in the specified slot. This function uses a promise to return the result. +Obtains the type of the SIM card in the specified slot. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -428,9 +428,9 @@ Obtains the type of the SIM card in the specified slot. This function uses a pro | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | ----------------- | ------------------------------------------------------------ | @@ -452,7 +452,7 @@ promise.then(data => { hasSimCard\(slotId: number, callback: AsyncCallback\): void -Checks whether the SIM card in the specified slot is installed. This function uses an asynchronous callback to return the result. +Checks whether the SIM card in the specified slot is installed. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -460,7 +460,7 @@ Checks whether the SIM card in the specified slot is installed. This function us | Name | Type | Mandatory| Description | | -------- | --------------------------- | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| | callback | AsyncCallback<boolean> | Yes | Callback used to return the result. | **Example** @@ -476,7 +476,7 @@ sim.hasSimCard(0, (err, data) => { hasSimCard\(slotId: number\): Promise -Checks whether the SIM card in the specified slot is installed. This function uses a promise to return the result. +Checks whether the SIM card in the specified slot is installed. This API uses a promise to return the result. **System capability**: SystemCapability.Communication.CoreService @@ -484,9 +484,9 @@ Checks whether the SIM card in the specified slot is installed. This function us | Name| Type | Mandatory| Description | | ------ | ------ | ---- | -------------------------------------- | -| slotId | number | Yes | Card slot ID.
- **0**: card slot 1
- **1**: card slot 2| +| slotId | number | Yes | Card slot ID. The options are as follows:
- **0**: card slot 1
- **1**: card slot 2| -**Return Value** +**Return value** | Type | Description | | --------------------- | ---------------------------------- | @@ -512,7 +512,7 @@ Obtains the number of card slots. **System capability**: SystemCapability.Communication.CoreService -**Return Value** +**Return value** | Type | Description | | ----------------- | ------------------------------------------------------------ | @@ -557,4 +557,4 @@ Enumerates card types. |CU_DUAL_MODE_CARD | 42 | China Unicom dual-mode card| |DUAL_MODE_TELECOM_LTE_CARD | 43 | China Telecom dual-mode LTE card| |DUAL_MODE_UG_CARD | 50 | Dual-mode card (UMTS+GSM)| -|SINGLE_MODE_ISIM_CARD | 60 | Single-card (ISIM)| +|SINGLE_MODE_ISIM_CARD8+ | 60 | Single-card (ISIM)| diff --git a/en/application-dev/reference/apis/js-apis-sms.md b/en/application-dev/reference/apis/js-apis-sms.md index 22ed6555ba33c13893bcbaa2c318b358e0ae98d3..e874588b5e209f5386a34c4fc8e10f2b5fc6aef0 100644 --- a/en/application-dev/reference/apis/js-apis-sms.md +++ b/en/application-dev/reference/apis/js-apis-sms.md @@ -10,11 +10,11 @@ import sms from '@ohos.telephony.sms'; ``` -## sms.createMessage +## sms.createMessage createMessage\(pdu: Array, specification: string, callback: AsyncCallback\): void -Creates an SMS message instance based on the protocol data unit (PDU) and the specified SMS protocol. This function uses an asynchronous callback to return the result. +Creates an SMS message instance based on the protocol data unit (PDU) and the specified SMS protocol. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.SmsMms @@ -24,7 +24,7 @@ Creates an SMS message instance based on the protocol data unit (PDU) and the sp | ------------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | | pdu | Array<number> | Yes | PDU, which is obtained from the received SMS message. | | specification | string | Yes | SMS protocol type.
- **3gpp**: GSM/UMTS/LTE SMS
- **3gpp2**: CDMA SMS| -| callback | AsyncCallback<[ShortMessage](#ShortMessage)> | Yes | Callback used to return the result. | +| callback | AsyncCallback<[ShortMessage](#shortmessage)> | Yes | Callback used to return the result. | **Example** @@ -38,11 +38,11 @@ sms.createMessage(pdu, specification, (err, data) => { ``` -## sms.createMessage +## sms.createMessage createMessage\(pdu: Array, specification: string\): Promise -Creates an SMS message instance based on the PDU and the specified SMS protocol. This function uses a promise to return the result. +Creates an SMS message instance based on the PDU and the specified SMS protocol. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.SmsMms @@ -57,7 +57,7 @@ Creates an SMS message instance based on the PDU and the specified SMS protocol. | Type | Description | | -------------------------------------------- | --------------------------------- | -| Promise<[ShortMessage](#ShortMessage)> | Promise used to return the result.| +| Promise<[ShortMessage](#shortmessage)> | Promise used to return the result.| **Example** @@ -87,7 +87,7 @@ Sends an SMS message. | Name | Type | Mandatory| Description | | ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ | -| options | [SendMessageOptions](#SendMessageOptions) | Yes | Options (including the callback) for sending an SMS message. For details, see [SendMessageOptions](#SendMessageOptions).| +| options | [SendMessageOptions](#sendmessageoptions) | Yes | Options (including the callback) for sending an SMS message. For details, see [SendMessageOptions](#sendmessageoptions).| **Example** @@ -108,11 +108,11 @@ sms.sendMessage(options); ``` -## sms.getDefaultSmsSlotId7+ +## sms.getDefaultSmsSlotId7+ getDefaultSmsSlotId\(callback: AsyncCallback\): void -Obtains the default slot of the SIM card used to send SMS messages. This function uses an asynchronous callback to return the result. +Obtains the default slot of the SIM card used to send SMS messages. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.SmsMms @@ -131,11 +131,11 @@ sms.getDefaultSmsSlotId((err, data) => { ``` -## sms.getDefaultSmsSlotId7+ +## sms.getDefaultSmsSlotId7+ getDefaultSmsSlotId\(\): Promise -Obtains the default slot of the SIM card used to send SMS messages. This function uses a promise to return the result. +Obtains the default slot of the SIM card used to send SMS messages. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.SmsMms @@ -157,16 +157,18 @@ promise.then(data => { ``` -## sms.setSmscAddr7+ +## sms.setSmscAddr7+ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback\): void -Sets the short message service center (SMSC) address. This function uses an asynchronous callback to return the result. +Sets the short message service center (SMSC) address. This API uses an asynchronous callback to return the result. **Required permission**: ohos.permission.SET_TELEPHONY_STATE (a system permission) **System capability**: SystemCapability.Telephony.SmsMms +This is a system API and cannot be called by third-party applications. + **Parameters** | Name | Type | Mandatory| Description | @@ -186,16 +188,18 @@ sms.setSmscAddr(slotId, smscAddr, (err,data) => { ``` -## sms.setSmscAddr7+ +## sms.setSmscAddr7+ setSmscAddr\(slotId: number, smscAddr: string\): Promise -Sets the SMSC address. This function uses a promise to return the result. +Sets the SMSC address. This API uses a promise to return the result. **Required permission**: ohos.permission.SET_TELEPHONY_STATE (a system permission) **System capability**: SystemCapability.Telephony.SmsMms +This is a system API and cannot be called by third-party applications. + **Parameters** | Name | Type | Mandatory| Description | @@ -223,17 +227,17 @@ promise.then(data => { ``` -## sms.getSmscAddr7+ +## sms.getSmscAddr7+ getSmscAddr\(slotId: number, callback: AsyncCallback\): void -Obtains the SMSC address. This function uses an asynchronous callback to return the result. +Obtains the SMSC address. This API uses an asynchronous callback to return the result. **Required permission**: ohos.permission.GET_TELEPHONY_STATE (a system permission) **System capability**: SystemCapability.Telephony.SmsMms -**Note:** This is a system API and it is used only for system applications. +This is a system API and cannot be called by third-party applications. **Parameters** @@ -252,17 +256,17 @@ sms.getSmscAddr(slotId, (err, data) => { ``` -## sms.getSmscAddr7+ +## sms.getSmscAddr7+ getSmscAddr\(slotId: number\): Promise -Obtains the SMSC address. This function uses a promise to return the result. +Obtains the SMSC address. This API uses a promise to return the result. **Required permission**: ohos.permission.GET_TELEPHONY_STATE (a system permission) **System capability**: SystemCapability.Telephony.SmsMms -**Note:** This is a system API and it is used only for system applications. +This is a system API and cannot be called by third-party applications. **Parameters** @@ -288,11 +292,11 @@ promise.then(data => { }); ``` -## sms.hasSmsCapability7+ +## sms.hasSmsCapability7+ hasSmsCapability(): boolean -Checks whether the current device can send and receive SMS messages. This function works in synchronous mode. +Checks whether the current device can send and receive SMS messages. This API works in synchronous mode. **System capability**: SystemCapability.Telephony.SmsMms @@ -307,18 +311,18 @@ let result = sms.hasSmsCapability(); console.log(`hasSmsCapability: ${JSON.stringify(result)}`); ``` -## ShortMessage +## ShortMessage Defines an SMS message instance. **System capability**: SystemCapability.Telephony.SmsMms -| Variable | Type | Description | +| Name | Type | Description | | ------------------------ | --------------------------------------- | ------------------------------------------------------------ | | hasReplyPath | boolean | Whether the received SMS contains **TP-Reply-Path**. The default value is **false**.
**TP-Reply-Path**: the path in which the mobile phone can reply to the SMS message through the originating SMSC.| | isReplaceMessage | boolean | Whether the received SMS message is a **replace short message**. The default value is **false**.
For details, see section 9.2.3.9 in **3GPP TS 23.040**.| | isSmsStatusReportMessage | boolean | Whether the received SMS message is an SMS delivery status report. The default value is **false**.
**SMS-Status-Report**: a message sent from the SMSC to the mobile station to show the SMS message delivery status.| -| messageClass | [ShortMessageClass](#ShortMessageClass) | SMS message type. | +| messageClass | [ShortMessageClass](#shortmessageclass) | SMS message type. | | pdu | Array<number> | PDU in the SMS message. | | protocolId | number | ID of the protocol used for sending SMS messages. | | scAddress | string | Address of the short message service center (SMSC). | @@ -328,69 +332,69 @@ Defines an SMS message instance. | visibleRawAddress | string | Sender address. | -## ShortMessageClass +## ShortMessageClass -Enumerates SMS message types. +SMS message type. -| Variable | Value | Description | -| ---------------- | ---- | ------------------------------------------------------------ | -| UNKNOWN | 0 | Unknown type.
**System capability**: SystemCapability.Telephony.SmsMms| -| INSTANT_MESSAGE | 1 | Instant message, which is displayed immediately after being received.
**System capability**: SystemCapability.Telephony.SmsMms| -| OPTIONAL_MESSAGE | 2 | Message stored in the device or SIM card.
**System capability**: SystemCapability.Telephony.SmsMms| -| SIM_MESSAGE | 3 | Message containing SIM card information, which is to be stored in the SIM card.
**System capability**: SystemCapability.Telephony.SmsMms| -| FORWARD_MESSAGE | 4 | Message to be forwarded to another device.
**System capability**: SystemCapability.Telephony.SmsMms| +**System capability**: SystemCapability.Telephony.SmsMms +| Name | Value | Description | +| ---------------- | ---- | ---------------------------------------- | +| UNKNOWN | 0 | Unknown type. | +| INSTANT_MESSAGE | 1 | Instant message, which is displayed immediately after being received. | +| OPTIONAL_MESSAGE | 2 | Message stored in the device or SIM card. | +| SIM_MESSAGE | 3 | Message containing SIM card information, which is to be stored in the SIM card.| +| FORWARD_MESSAGE | 4 | Message to be forwarded to another device. | -## SendMessageOptions -Provides the options (including callbacks) for sending an SMS message. +## SendMessageOptions -For example, you can specify the SMS message type by the optional parameter **content**. +Provides the options (including callbacks) for sending an SMS message. For example, you can specify the SMS message type by the optional parameter **content**. **System capability**: SystemCapability.Telephony.SmsMms -| Parameter | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | slotId | number | Yes | Slot ID of the SIM card used for sending SMS messages.
- **0**: card slot 1
- **1**: card slot 2 | | destinationHost | string | Yes | Destination address of the SMS message. | | content | string \| Array<number> | Yes | SMS message type. If the content is composed of character strings, the SMS message is a text message. If the content is composed of byte arrays, the SMS message is a data message.| | serviceCenter | string | No | SMSC address. By default, the SMSC address in the SIM card is used. | | destinationPort | number | No | Destination port of the SMS message. This field is mandatory only for a data message. Otherwise, it is optional. | -| sendCallback | AsyncCallback<[ISendShortMessageCallback](#ISendShortMessageCallback)> | No | Callback used to return the SMS message sending result. For details, see [ISendShortMessageCallback](#ISendShortMessageCallback).| -| deliveryCallback | AsyncCallback<[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)> | No | Callback used to return the SMS message delivery report. For details, see [IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback).| +| sendCallback | AsyncCallback<[ISendShortMessageCallback](#isendshortmessagecallback)> | No | Callback used to return the SMS message sending result. For details, see [ISendShortMessageCallback](#isendshortmessagecallback).| +| deliveryCallback | AsyncCallback<[IDeliveryShortMessageCallback](#ideliveryshortmessagecallback)> | No | Callback used to return the SMS message delivery report. For details, see [IDeliveryShortMessageCallback](#ideliveryshortmessagecallback).| -## ISendShortMessageCallback +## ISendShortMessageCallback Provides the callback for the SMS message sending result. It consists of three parts: SMS message sending result, URI for storing the sent SMS message, and whether the SMS message is the last part of a long SMS message. **System capability**: SystemCapability.Telephony.SmsMms -| Parameter | Type | Mandatory| Description | +| Name | Type | Mandatory| Description | | ---------- | ------------------------------- | ---- | ------------------------------------------------------------ | | isLastPart | boolean | No | Whether this SMS message is the last part of a long SMS message. The value **true** indicates that this SMS message is the last part of a long SMS message, and value **false** indicates the opposite. The default value is **false**.| -| result | [SendSmsResult](#SendSmsResult) | Yes | SMS message sending result. | +| result | [SendSmsResult](#sendsmsresult) | Yes | SMS message sending result. | | url | string | Yes | URI for storing sent SMS messages. | -## IDeliveryShortMessageCallback +## IDeliveryShortMessageCallback Provides the callback for the SMS message sending result. Return the SMS delivery report. **System capability**: SystemCapability.Telephony.SmsMms -| Parameter| Type | Mandatory| Description | +| Name| Type | Mandatory| Description | | ------ | ------------------- | ---- | -------------- | | pdu | Array<number> | Yes | SMS message delivery report.| -## SendSmsResult +## SendSmsResult -Enumerates SMS message sending results. +SMS message sending result. **System capability**: SystemCapability.Telephony.SmsMms -| Parameter | Value | Description | +| Name | Value | Description | | ------------------------------------ | ---- | ------------------------------------------------------ | | SEND_SMS_SUCCESS | 0 | SMS message sent successfully. | | SEND_SMS_FAILURE_UNKNOWN | 1 | Failed to send the SMS message due to unknown reasons. | diff --git a/en/application-dev/reference/apis/js-apis-socket.md b/en/application-dev/reference/apis/js-apis-socket.md index 1cf0e0c7d4fb1fd4e1c90ab0b55c561f437a3d47..34116c7c04b96f45167a8896710017851779d349 100644 --- a/en/application-dev/reference/apis/js-apis-socket.md +++ b/en/application-dev/reference/apis/js-apis-socket.md @@ -1,4 +1,4 @@ -# Socket +# Socket Connection >![](public_sys-resources/icon-note.gif) **NOTE:** > diff --git a/en/application-dev/reference/apis/js-apis-telephony-data.md b/en/application-dev/reference/apis/js-apis-telephony-data.md index 8cb2951bda1838891021ab653db926958859786c..b6bdef1d34b9f544e1380d3d4a9a7cd7d1d293b7 100644 --- a/en/application-dev/reference/apis/js-apis-telephony-data.md +++ b/en/application-dev/reference/apis/js-apis-telephony-data.md @@ -10,11 +10,11 @@ import data from '@ohos.telephony.data'; ``` -## data.getDefaultCellularDataSlotId +## data.getDefaultCellularDataSlotId getDefaultCellularDataSlotId(callback: AsyncCallback\): void -Obtains the default SIM card used for mobile data. This function uses an asynchronous callback to return the result. +Obtains the default SIM card used for mobile data. This API uses an asynchronous callback to return the result. **Required permission**: ohos.permission.GET_NETWORK_INFO @@ -22,9 +22,9 @@ Obtains the default SIM card used for mobile data. This function uses an asynchr **Parameters** -| Name| Type| Mandatory| Description| +| Name | Type | Mandatory| Description | | -------- | ----------------------- | ---- | ------------------------------------------ | -| callback | AsyncCallback\ | Yes| Callback used to return the result.
**0**: slot 1
**1**: slot 2| +| callback | AsyncCallback\ | Yes | Callback used to return the result.
**0**: card slot 1
**1**: card slot 2| **Example** @@ -34,21 +34,21 @@ data.getDefaultCellularDataSlotId((err, data) => { }); ``` -## data.getDefaultCellularDataSlotId +## data.getDefaultCellularDataSlotId getDefaultCellularDataSlotId(): Promise\ -Obtains the default SIM card used for mobile data. This function uses a promise to return the result. +Obtains the default SIM card used for mobile data. This API uses a promise to return the result. **Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Telephony.CellularData -**Return value** +**Return Value** -| Type| Description| +| Type | Description | | ----------------- | ------------------------------------------------------------ | -| Promise\ | Promise used to return the result, wherein:
**0**: slot 1
**1**: slot 2| +| Promise\ | Promise used to return the result.
**0**: card slot 1
**1**: card slot 2| **Example** @@ -61,19 +61,19 @@ promise.then((data) => { }); ``` -## data.getCellularDataFlowType +## data.getCellularDataFlowType getCellularDataFlowType(callback: AsyncCallback\): void -Obtains the cellular data flow type, which can be uplink or downlink. This function uses an asynchronous callback to return the result. +Obtains the cellular data flow type, which can be uplink or downlink. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CellularData **Parameters** -| Name| Type| Mandatory| Description| +| Name | Type | Mandatory| Description | | -------- | ---------------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\<[DataFlowType](#DataFlowType)\> | Yes| Callback used to return the result.| +| callback | AsyncCallback\<[DataFlowType](#dataflowtype)\> | Yes | Callback used to return the result.| **Example** @@ -83,19 +83,19 @@ data.getCellularDataFlowType((err, data) => { }); ``` -## data.getCellularDataFlowType +## data.getCellularDataFlowType getCellularDataFlowType(): Promise\ -Obtains the cellular data flow type, which can be uplink or downlink. This function uses a promise to return the result. +Obtains the cellular data flow type, which can be uplink or downlink. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CellularData -**Return value** +**Return Value** -| Type| Description| +| Type | Description | | ---------------------------------------- | ----------------------------------------------- | -| Promise\<[DataFlowType](#DataFlowType)\> | Promise used to return the result. | +| Promise\<[DataFlowType](#dataflowtype)\> | Promise used to return the result. | **Example** @@ -108,19 +108,19 @@ promise.then((data) => { }); ``` -## data.getCellularDataState +## data.getCellularDataState getCellularDataState(callback: AsyncCallback\): void -Obtains the connection status of the packet switched (PS) domain. This function uses an asynchronous callback to return the result. +Obtains the connection status of the packet switched (PS) domain. This API uses an asynchronous callback to return the result. **System capability**: SystemCapability.Telephony.CellularData **Parameters** -| Name| Type| Mandatory| Description| +| Name | Type | Mandatory| Description | | -------- | ------------------------------------------------------ | ---- | ---------- | -| callback | AsyncCallback\<[DataConnectState](#DataConnectState)\> | Yes| Callback used to return the result.| +| callback | AsyncCallback\<[DataConnectState](#dataconnectstate)\> | Yes | Callback used to return the result.| **Example** @@ -130,19 +130,19 @@ data.getCellularDataState((err, data) => { }); ``` -## data.getCellularDataState +## data.getCellularDataState getCellularDataState(): Promise\ -Obtains the connection status of the PS domain. This function uses a promise to return the result. +Obtains the connection status of the PS domain. This API uses a promise to return the result. **System capability**: SystemCapability.Telephony.CellularData -**Return value** +**Return Value** -| Type| Description| +| Type | Description | | ------------------------------------------------ | ------------------------------------- | -| Promise\<[DataConnectState](#DataConnectState)\> | Promise used to return the result.| +| Promise\<[DataConnectState](#dataconnectstate)\> | Promise used to return the result.| **Example** @@ -155,11 +155,11 @@ promise.then((data) => { }); ``` -## data.isCellularDataEnabled +## data.isCellularDataEnabled isCellularDataEnabled(callback: AsyncCallback\): void -Checks whether the cellular data service is enabled. This function uses an asynchronous callback to return the result. +Checks whether the cellular data service is enabled. This API uses an asynchronous callback to return the result. **Required permission**: ohos.permission.GET_NETWORK_INFO @@ -167,9 +167,9 @@ Checks whether the cellular data service is enabled. This function uses an async **Parameters** -| Name| Type| Mandatory| Description| +| Name | Type | Mandatory| Description | | -------- | ------------------------ | ---- | ------------------------------------------------------------ | -| callback | AsyncCallback\ | Yes| Callback used to return the result.
**true**: The cellular data service is enabled.
**false**: The cellular data service is disabled.| +| callback | AsyncCallback\ | Yes | Callback used to return the result.
**true**: The cellular data service is enabled.
**false**: The cellular data service is disabled.| **Example** @@ -179,21 +179,21 @@ data.isCellularDataEnabled((err, data) => { }); ``` -## data.isCellularDataEnabled +## data.isCellularDataEnabled isCellularDataEnabled(): Promise\ -Checks whether the cellular data service is enabled. This function uses a promise to return the result. +Checks whether the cellular data service is enabled. This API uses a promise to return the result. **Required permission**: ohos.permission.GET_NETWORK_INFO **System capability**: SystemCapability.Telephony.CellularData -**Return value** +**Return Value** -| Type| Description| +| Type | Description | | ------------------ | ------------------------------------------------------------ | -| Promise\ | Promise used to return the result, wherein:
**true**: The cellular data service is enabled.
**false**: The cellular data service is disabled.| +| Promise\ | Promise used to return the result.
**true**: The cellular data service is enabled.
**false**: The cellular data service is disabled.| **Example** @@ -206,11 +206,11 @@ promise.then((data) => { }); ``` -## data.isCellularDataRoamingEnabled +## data.isCellularDataRoamingEnabled isCellularDataRoamingEnabled(slotId: number, callback: AsyncCallback\): void -Checks whether roaming is enabled for the cellular data service. This function uses an asynchronous callback to return the result. +Checks whether roaming is enabled for the cellular data service. This API uses an asynchronous callback to return the result. **Required permission**: ohos.permission.GET_NETWORK_INFO @@ -218,10 +218,10 @@ Checks whether roaming is enabled for the cellular data service. This function u **Parameters** -| Name| Type| Mandatory| Description| +| Name | Type | Mandatory| Description | | -------- | ------------------------ | ---- | ------------------------------------------------------------ | -| slotId | number | Yes| Card slot ID. The options are as follows:
**0**: slot 1
**1**: slot 2| -| callback | AsyncCallback\ | Yes| Callback used to return the result.
**true**: Roaming is enabled for the cellular data service.
**false**: Roaming is disabled for the cellular data service.| +| slotId | number | Yes | Card slot ID.
**0**: card slot 1
**1**: card slot 2 | +| callback | AsyncCallback\ | Yes | Callback used to return the result.
**true**: Roaming is enabled for the cellular data service.
**false**: Roaming is disabled for the cellular data service.| **Example** @@ -231,11 +231,11 @@ data.isCellularDataRoamingEnabled(0,(err, data) => { }); ``` -## data.isCellularDataRoamingEnabled +## data.isCellularDataRoamingEnabled isCellularDataRoamingEnabled(slotId: number): Promise\ -Checks whether roaming is enabled for the cellular data service. This method uses a promise to return the result. +Checks whether roaming is enabled for the cellular data service. This API uses a promise to return the result. **Required permission**: ohos.permission.GET_NETWORK_INFO @@ -243,15 +243,15 @@ Checks whether roaming is enabled for the cellular data service. This method use **Parameters** -| Name| Type| Mandatory| Description| +| Name| Type | Mandatory| Description | | ------ | ------ | ---- | ---------------------------------------- | -| slotId | number | Yes| Card slot ID. The options are as follows:
**0**: slot 1
**1**: slot 2| +| slotId | number | Yes | Card slot ID.
**0**: card slot 1
**1**: card slot 2| -**Return value** +**Return Value** -| Type| Description| +| Type | Description | | ------------------ | ------------------------------------------------------------ | -| Promise\ | Promise used to return the result, wherein:
**true**: Roaming is enabled for the cellular data service.
**false**: Roaming is disabled for the cellular data service.| +| Promise\ | Promise used to return the result.
**true**: Roaming is enabled for the cellular data service.
**false**: Roaming is disabled for the cellular data service.| **Example** @@ -264,26 +264,30 @@ promise.then((data) => { }); ``` -## DataFlowType +## DataFlowType - Defines the cellular data flow type. +Defines the cellular data flow type. -| Name| Value| Description| -| ------ | ---------------------- | ------------------------------------------------------------ | -| 0 | DATA_FLOW_TYPE_NONE | No uplink or downlink data is available.
**System capability**: SystemCapability.Telephony.CellularData| -| 1 | DATA_FLOW_TYPE_DOWN | Only the downlink data is available.
**System capability**: SystemCapability.Telephony.CellularData| -| 2 | DATA_FLOW_TYPE_UP | Only the uplink data is available.
**System capability**: SystemCapability.Telephony.CellularData| -| 3 | DATA_FLOW_TYPE_UP_DOWN | Both uplink data and downlink data are available.
**System capability**: SystemCapability.Telephony.CellularData| -| 4 | DATA_FLOW_TYPE_DORMANT | No uplink or downlink data is available because the lower-layer link is in the dormant state.
**System capability**: SystemCapability.Telephony.CellularData| +**System capability**: SystemCapability.Telephony.CellularData + +| Name | Value | Description | +| ---------------------- | ---- | ------------------------------------------ | +| DATA_FLOW_TYPE_NONE | 0 | No uplink or downlink data is available. | +| DATA_FLOW_TYPE_DOWN | 1 | Only the downlink data is available. | +| DATA_FLOW_TYPE_UP | 2 | Only the uplink data is available. | +| DATA_FLOW_TYPE_UP_DOWN | 3 | Both uplink data and downlink data are available. | +| DATA_FLOW_TYPE_DORMANT | 4 | No uplink or downlink data is available because the lower-layer link is in the dormant state.| -## DataConnectState +## DataConnectState - Describes the connection status of a cellular data link. +Describes the connection status of a cellular data link. + +**System capability**: SystemCapability.Telephony.CellularData -| Name| Value| Description| -| ------ | ----------------------- | ------------------------------------------------------------ | -| -1 | DATA_STATE_UNKNOWN| The status of the cellular data link is unknown.
**System capability**: SystemCapability.Telephony.CellularData| -| 0 | DATA_STATE_DISCONNECTED | The cellular data link is disconnected.
**System capability**: SystemCapability.Telephony.CellularData| -| 1 | DATA_STATE_CONNECTING | The cellular data link is being connected.
**System capability**: SystemCapability.Telephony.CellularData| -| 2 | DATA_STATE_CONNECTED | The cellular data link is connected.
**System capability**: SystemCapability.Telephony.CellularData| -| 3 | DATA_STATE_SUSPENDED | The cellular data link is suspended.
**System capability**: SystemCapability.Telephony.CellularData| +| Name | Value | Description | +| ----------------------- | ---- | -------------------------- | +| DATA_STATE_UNKNOWN | -1 | The status of the cellular data link is unknown. | +| DATA_STATE_DISCONNECTED | 0 | The cellular data link is disconnected. | +| DATA_STATE_CONNECTING | 1 | The cellular data link is being connected.| +| DATA_STATE_CONNECTED | 2 | The cellular data link is connected. | +| DATA_STATE_SUSPENDED | 3 | The cellular data link is suspended. | diff --git a/en/application-dev/reference/apis/js-apis-webSocket.md b/en/application-dev/reference/apis/js-apis-webSocket.md index 65d7eeb5c49fbe9a0b456333dd043d17835aeaea..7ffb3babc8171c25ffb2e1814e69e150870071e9 100644 --- a/en/application-dev/reference/apis/js-apis-webSocket.md +++ b/en/application-dev/reference/apis/js-apis-webSocket.md @@ -1,4 +1,4 @@ -# WebSocket +# WebSocket Connection >![](public_sys-resources/icon-note.gif) **NOTE:** >The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.