Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 b5160e59 编写于 作者: C clevercong
浏览文件
操作

format js api docs. 

Signed-off-by: Nclevercong <lichunlin2@huawei.com>
上级 fe8373c5
隐藏空白更改
内联 并排
Showing with 681 addition and 405 deletion
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ b5160e59
......@@ -51,6 +51,9 @@
- [蜂窝数据](js-apis-telephony-data.md)
- 网络管理
- [网络连接管理](js-apis-net-connection.md)
- [Socket连接](js-apis-socket.md)
- [WebSocket连接](js-apis-webSocket.md)
- [数据请求](js-apis-http.md)
- 通信与连接
- [WLAN](js-apis-wifi.md)
- [Bluetooth](js-apis-bluetooth.md)
......
zh-cn/application-dev/reference/apis/js-apis-call.md
浏览文件 @ b5160e59
......@@ -11,7 +11,7 @@
import call from '@ohos.telephony.call';
```
## call.dial<a name=call.dial-callback1></a>
## call.dial
dial\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void
......@@ -23,7 +23,7 @@ dial\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------- | ---- | ------------------------------------------------- |
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数：<br/>- true：成功。<br/>- false：失败。 |
......@@ -37,7 +37,7 @@ call.dial("138xxxxxxxx", (err, data) => {
```
## call.dial<a name=call.dial-callback2></a>
## call.dial
dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback<boolean\>\): void
......@@ -49,10 +49,10 @@ dial\(phoneNumber: string, options: DialOptions, callback: AsyncCallback<boolean
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------- | ---- | ------------------------------------------------- |
| phoneNumber | string | 是 | 电话号码。 |
| options | DialOptions | 是 | 通话参数，参考[DialOptions](#DialOptions)。 |
| options | DialOptions | 是 | 通话参数，参考[DialOptions](#dialoptions)。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数：<br/>- true：成功。<br/>- false：失败。 |
**示例：**
......@@ -66,7 +66,7 @@ call.dial("138xxxxxxxx", {
```
## call.dial<a name=call.dial-promise></a>
## call.dial
dial\(phoneNumber: string, options?: DialOptions\): Promise<boolean\>
......@@ -78,10 +78,10 @@ dial\(phoneNumber: string, options?: DialOptions\): Promise<boolean\>
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ----------- | ---- | ------------------------------------------- |
| phoneNumber | string | 是 | 电话号码。 |
| options | DialOptions | 是 | 通话参数，参考[DialOptions](#DialOptions)。 |
| options | DialOptions | 是 | 通话参数，参考[DialOptions](#dialoptions)。 |
**返回值：**
......@@ -102,17 +102,19 @@ promise.then(data => {
});
```
## call.makeCall<sup>7+</sup><a name=call.makeCall-callback></a>
## call.makeCall<sup>7+</sup>
makeCall(phoneNumber: string, callback: AsyncCallback<void>): void
makeCall(phoneNumber: string, callback: AsyncCallback\<void\>): void
跳转到拨号界面，并显示拨号的号码，使用callback方式作为异步方法。
**系统能力**：SystemCapability.Telephony.CallManager
本接口在Openharmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------------- | ---- | ------------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 以callback形式异步返回跳转拨号界面的结果。 |
......@@ -126,17 +128,19 @@ call.makeCall("138xxxxxxxx", err => {
```
## call.makeCall<sup>7+</sup><a name=call.makeCall-promise></a>
## call.makeCall<sup>7+</sup>
makeCall(phoneNumber: string): Promise<void>
makeCall(phoneNumber: string): Promise\<void\>
跳转到拨号界面，并显示拨号的号码，使用Promise方式作为异步方法。
**系统能力**：SystemCapability.Telephony.CallManager
本接口在Openharmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力**：SystemCapability.Applications.Contacts
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------- |
| phoneNumber | string | 是 | 电话号码。 |
......@@ -157,7 +161,7 @@ promise.then(() => {
});
```
## call.hasCall<a name=call.hasCall-callback></a>
## call.hasCall
hasCall\(callback: AsyncCallback<boolean\>\): void
......@@ -167,7 +171,7 @@ hasCall\(callback: AsyncCallback<boolean\>\): void
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数：<br/>- true：当前存在通话。<br/>- false：当前不存在通话。 |
......@@ -180,7 +184,7 @@ call.hasCall((err, data) => {
```
## call.hasCall<a name=call.hasCall-promise></a>
## call.hasCall
hasCall\(\): Promise<boolean\>
......@@ -206,7 +210,7 @@ promise.then(data => {
```
## call.getCallState<a name=call.getCallState-callback></a>
## call.getCallState
getCallState\(callback: AsyncCallback<CallState\>\): void
......@@ -216,9 +220,9 @@ getCallState\(callback: AsyncCallback<CallState\>\): void
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;[CallState](#CallState)&gt; | 是 | 回调函数：异步返回获取到的通话状态。 |
| callback | AsyncCallback&lt;[CallState](#callstate)&gt; | 是 | 回调函数：异步返回获取到的通话状态。 |
**示例：**
......@@ -229,7 +233,7 @@ call.getCallState((err, data) => {
```
## call.getCallState<a name="call.getCallState-promise"></a>
## call.getCallState
getCallState\(\): Promise<CallState\>
......@@ -241,7 +245,7 @@ getCallState\(\): Promise<CallState\>
| 类型 | 说明 |
| -------------------------------------- | ----------------------------------------- |
| Promise&lt;[CallState](#CallState)&gt; | 以Promise形式异步返回获取通话状态的结果。 |
| Promise&lt;[CallState](#callstate)&gt; | 以Promise形式异步返回获取通话状态的结果。 |
**示例：**
......@@ -254,7 +258,7 @@ promise.then(data => {
});
```
## call.hasVoiceCapability<sup>7+</sup><a name=call.hasVoiceCapability></a>
## call.hasVoiceCapability<sup>7+</sup>
hasVoiceCapability(): boolean
......@@ -273,7 +277,7 @@ let result = call.hasVoiceCapability();
console.log(`hasVoiceCapability: ${JSON.stringify(result)}`);
```
## call.isEmergencyPhoneNumber<sup>7+</sup><a name=call.isEmergencyPhoneNumber-callback1></a>
## call.isEmergencyPhoneNumber<sup>7+</sup>
isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback<boolean\>\): void
......@@ -283,7 +287,7 @@ isEmergencyPhoneNumber\(phoneNumber: string, callback: AsyncCallback<boolean\>\)
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回判断是否是紧急电话号码的结果：<br/>- true：是紧急电话号码。<br/>- false：不是紧急电话号码。 |
......@@ -297,7 +301,7 @@ call.isEmergencyPhoneNumber("138xxxxxxxx", (err, data) => {
```
## call.isEmergencyPhoneNumber<sup>7+</sup><a name=call.isEmergencyPhoneNumber-callback2></a>
## call.isEmergencyPhoneNumber<sup>7+</sup>
isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, callback: AsyncCallback<boolean\>\): void
......@@ -307,10 +311,10 @@ isEmergencyPhoneNumber\(phoneNumber: string, options: EmergencyNumberOptions, ca
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| options | EmergencyNumberOptions | 是 | 手机参数，参考[EmergencyNumberOptions](#EmergencyNumberOptions)。 |
| options | EmergencyNumberOptions | 是 | 手机参数，参考[EmergencyNumberOptions](#emergencynumberoptions7)。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，返回判断是否是紧急电话号码的结果：<br/>- true：是紧急电话号码。<br/>- false：不是紧急电话号码。 |
**示例：**
......@@ -322,7 +326,7 @@ call.isEmergencyPhoneNumber("112", {slotId: 1}, (err, value) => {
```
## call.isEmergencyPhoneNumber<sup>7+</sup><a name=call.isEmergencyPhoneNumber-promise></a>
## call.isEmergencyPhoneNumber<sup>7+</sup>
isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\): Promise<boolean\>
......@@ -332,10 +336,10 @@ isEmergencyPhoneNumber\(phoneNumber: string, options?: EmergencyNumberOptions\):
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| options | EmergencyNumberOptions | 是 | 手机参数，参考[EmergencyNumberOptions](#EmergencyNumberOptions)。 |
| options | EmergencyNumberOptions | 是 | 手机参数，参考[EmergencyNumberOptions](#emergencynumberoptions7)。 |
**返回值：**
......@@ -354,7 +358,7 @@ promise.then(data => {
});
```
## call.formatPhoneNumber<sup>7+</sup><a name=call.formatPhoneNumber-callback1></a>
## call.formatPhoneNumber<sup>7+</sup>
formatPhoneNumber\(phoneNumber: string, callback: AsyncCallback<string\>\): void
......@@ -364,7 +368,7 @@ formatPhoneNumber\(phoneNumber: string, callback: AsyncCallback<string\>\): void
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回格式化电话号码的结果。 |
......@@ -378,7 +382,7 @@ call.formatPhoneNumber("138xxxxxxxx", (err, data) => {
```
## call.formatPhoneNumber<sup>7+</sup><a name=call.formatPhoneNumber-callback2></a>
## call.formatPhoneNumber<sup>7+</sup>
formatPhoneNumber\(phoneNumber: string, options: NumberFormatOptions, callback: AsyncCallback<string\>\): void
......@@ -388,10 +392,10 @@ formatPhoneNumber\(phoneNumber: string, options: NumberFormatOptions, callback:
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| options | NumberFormatOptions | 是 | 格式化参数，参考[NumberFormatOptions](#NumberFormatOptions)。 |
| options | NumberFormatOptions | 是 | 格式化参数，参考[NumberFormatOptions](#numberformatoptions7)。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回格式化电话号码的结果。 |
**示例：**
......@@ -405,7 +409,7 @@ call.formatPhoneNumber("138xxxxxxxx",{
```
## call.formatPhoneNumber<sup>7+</sup><a name=call.formatPhoneNumber-promise></a>
## call.formatPhoneNumber<sup>7+</sup>
formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise<string\>
......@@ -415,10 +419,10 @@ formatPhoneNumber\(phoneNumber: string, options?: NumberFormatOptions\): Promise
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------- | ---- | ------------------------------------------------------------ |
| phoneNumber | string | 是 | 电话号码。 |
| options | NumberFormatOptions | 是 | 格式化参数，参考[NumberFormatOptions](#NumberFormatOptions)。 |
| options | NumberFormatOptions | 是 | 格式化参数，参考[NumberFormatOptions](#numberformatoptions7)。 |
**返回值：**
......@@ -439,7 +443,7 @@ promise.then(data => {
});
```
## call.formatPhoneNumberToE164<sup>7+</sup><a name=call.formatPhoneNumberToE164-callback></a>
## call.formatPhoneNumberToE164<sup>7+</sup>
formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: AsyncCallback<string\>\): void
......@@ -453,7 +457,7 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string, callback: Asy
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | --------------------------- | ---- | ----------------------------------------------------- |
| phoneNumber | string | 是 | 电话号码。 |
| countryCode | string | 是 | 国家码，支持所有国家码，如：中国（CN）。 |
......@@ -470,7 +474,7 @@ call.formatPhoneNumberToE164("138xxxxxxxx",{
```
## call.formatPhoneNumberToE164<sup>7+</sup><a name=call.formatPhoneNumberToE164-promise></a>
## call.formatPhoneNumberToE164<sup>7+</sup>
formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise<string\>
......@@ -484,7 +488,7 @@ formatPhoneNumberToE164\(phoneNumber: string, countryCode: string\): Promise<str
**参数：**
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------------------------------------- |
| phoneNumber | string | 是 | 电话号码。 |
| countryCode | string | 是 | 国家码，支持所有国家码，如：中国（CN）。 |
......@@ -508,43 +512,45 @@ promise.then(data => {
});
```
## DialOptions<a name=DialOptions></a>
## DialOptions
拨打电话的可选参数。
**系统能力**：SystemCapability.Telephony.CallManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------- | ---- | ------------------------------------------------------------ |
| extras | boolean | 否 | 根据extras的值判断是否为视频通话，默认为语音通话。<br/>- true：视频通话。<br/>- fasle：语音通话。 |
## CallState<a name=CallState></a>
## CallState
通话状态码。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。
| 名称 | 值 | 说明 |
| ------------------ | ---- | ------------------------------------------------------------ |
| CALL_STATE_UNKNOWN | -1 | 无效状态，当获取呼叫状态失败时返回。<br />**系统能力**：SystemCapability.Telephony.CallManager |
| CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。<br />**系统能力**：SystemCapability.Telephony.CallManager |
| CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。<br />**系统能力**：SystemCapability.Telephony.CallManager |
| CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号、通话中或呼叫保持状态，并且没有新的来电振铃或等待。<br />**系统能力**：SystemCapability.Telephony.CallManager |
| CALL_STATE_UNKNOWN | -1 | 无效状态，当获取呼叫状态失败时返回。 |
| CALL_STATE_IDLE | 0 | 表示没有正在进行的呼叫。 |
| CALL_STATE_RINGING | 1 | 表示来电正在振铃或等待。 |
| CALL_STATE_OFFHOOK | 2 | 表示至少有一个呼叫处于拨号、通话中或呼叫保持状态，并且没有新的来电振铃或等待。 |
## EmergencyNumberOptions<sup>7+</sup><a name=EmergencyNumberOptions></a>
## EmergencyNumberOptions<sup>7+</sup>
判断是否是紧急电话号码的可选参数。
**系统能力**：SystemCapability.Telephony.CallManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------ |
| slotId | number | 否 | 卡槽ID：<br/>- 0：卡槽1。<br/>- 1：卡槽2。 |
## NumberFormatOptions<sup>7+</sup><a name=NumberFormatOptions></a>
## NumberFormatOptions<sup>7+</sup>
格式化号码的可选参数。
**系统能力**：SystemCapability.Telephony.CallManager
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CallManager。
| 参数 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---------------------------------------------------------- |
| countryCode | string | 否 | 国家码，支持所有国家的国家码，如：中国（CN）。默认为：CN。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ b5160e59
......@@ -4,7 +4,6 @@
>
>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>本模块所有接口需要设备具有系统能力：SystemCapability.Communication.NetStack
## 导入模块
......@@ -63,6 +62,8 @@ createHttp\(\): HttpRequest
创建一个http，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header 事件。每一个HttpRequest对象对应一个Http请求。如需发起多个Http请求，须为每个Http请求创建对应HttpRequest对象。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**返回值：**
| 类型 | 说明 |
......@@ -89,6 +90,8 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
**需要权限**：ohos.permission.INTERNET
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -99,7 +102,6 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
**示例：**
```
let httpRequest = http.createHttp();
httpRequest.request("EXAMPLE_URL", (err, data) => {
if (!err) {
console.info('Result:' + data.result);
......@@ -120,6 +122,8 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
**需要权限**：ohos.permission.INTERNET
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -131,7 +135,6 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.request("EXAMPLE_URL",
{
method: 'GET',
......@@ -165,6 +168,8 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
**需要权限**：ohos.permission.INTERNET
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -182,7 +187,6 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
**示例：**
```
let httpRequest= http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", {
method: "GET",
connectTimeout: 60000,
......@@ -211,22 +215,25 @@ destroy\(\): void
中断请求任务。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.destroy();
```
### on\('headerReceive'\)
on\(type: 'headerReceive', callback: AsyncCallback<Object\>\):void
on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void
订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明：**
> 此接口已废弃，建议使用[on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8)替代。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -237,7 +244,6 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\):void
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => {
if (!err) {
console.info('header: ' + data.header);
......@@ -250,7 +256,7 @@ httpRequest.on('headerReceive', (err, data) => {
### off\('headerReceive'\)
off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void
off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void
取消订阅HTTP Response Header 事件。
......@@ -260,6 +266,8 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void
>
>2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -270,7 +278,6 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => {
if (!err) {
console.info('header: ' + data.header);
......@@ -283,10 +290,12 @@ httpRequest.off('headerReceive');
### on\('headersReceive'\)<sup>8+</sup>
on\(type: 'headersReceive', callback: Callback<Object\>\):void
on\(type: 'headersReceive', callback: Callback<Object\>\): void
订阅HTTP Response Header 事件。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -297,7 +306,6 @@ on\(type: 'headersReceive', callback: Callback<Object\>\):void
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.on('headersReceive', (data) => {
console.info('header: ' + data.header);
});
......@@ -306,13 +314,15 @@ httpRequest.on('headersReceive', (data) => {
### off\('headersReceive'\)<sup>8+</sup>
off\(type: 'headersReceive', callback?: Callback<Object\>\):void
off\(type: 'headersReceive', callback?: Callback<Object\>\): void
取消订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -323,16 +333,17 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\):void
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.off('headersReceive');
```
### once\('headersReceive'\)<sup>8+</sup>
once\(type: "headersReceive", callback: Callback<Object\>\): void
once\(type: 'headersReceive', callback: Callback<Object\>\): void
订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -343,7 +354,6 @@ once\(type: "headersReceive", callback: Callback<Object\>\): void
**示例：**
```
let httpRequest= http.createHttp();
httpRequest.once('headersReceive', (data) => {
console.info('header: ' + data.header);
});
......@@ -353,7 +363,9 @@ httpRequest.once('headersReceive', (data) => {
发起请求可选参数的类型和取值范围。
| 参数 | 类型 | 必填 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------ | ---- | ---------------------------------------------------------- |
| method | [RequestMethod](#requestmethod) | 否 | 请求方式。 |
| extraData | string \| Object \| ArrayBuffer<sup>8+</sup> | 否 | 发送请求的额外数据。<br />- 当HTTP请求为POST、PUT等方法时，此字段为HTTP请求的content。<br />- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时，此字段为HTTP请求的参数补充，参数内容会拼接到URL中进行发送。<sup>8+</sup><br />- 开发者传入string对象，开发者需要自行编码，将编码后的string传入。<sup>8+</sup> |
......@@ -365,22 +377,26 @@ httpRequest.once('headersReceive', (data) => {
HTTP 请求方法。
| **method 的合法值** | 说明 |
| :------------------ | :------------------ |
| OPTIONS | HTTP 请求 OPTIONS。 |
| GET | HTTP 请求 GET。 |
| HEAD | HTTP 请求 HEAD。 |
| POST | HTTP 请求 POST。 |
| PUT | HTTP 请求 PUT。 |
| DELETE | HTTP 请求 DELETE。 |
| TRACE | HTTP 请求 TRACE。 |
| CONNECT | HTTP 请求 CONNECT。 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 名称 | 值 | 说明 |
| :------ | ------- | :------------------ |
| OPTIONS | OPTIONS | HTTP 请求 OPTIONS。 |
| GET | GET | HTTP 请求 GET。 |
| HEAD | HEAD | HTTP 请求 HEAD。 |
| POST | POST | HTTP 请求 POST。 |
| PUT | PUT | HTTP 请求 PUT。 |
| DELETE | DELETE | HTTP 请求 DELETE。 |
| TRACE | TRACE | HTTP 请求 TRACE。 |
| CONNECT | CONNECT | HTTP 请求 CONNECT。 |
## ResponseCode
发起请求返回的响应码。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 名称 | 值 | 说明 |
| ----------------- | ---- | ------------------------------------------------------------ |
| OK | 200 | 请求成功。一般用于GET与POST请求。 |
| CREATED | 201 | 已创建。成功请求并创建了新的资源。 |
......@@ -422,6 +438,8 @@ HTTP 请求方法。
request方法回调函数的返回值类型。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| result | string \| Object \| ArrayBuffer<sup>8+</sup> | 是 | Http请求根据响应头中Content-type类型返回对应的响应格式内容：<br />- application/json：返回JSON格式的字符串，如需Http响应具体内容，需开发者自行解析<br />- application/octet-stream：ArrayBuffer<br />- 其他：string |
......
zh-cn/application-dev/reference/apis/js-apis-net-connection.md
浏览文件 @ b5160e59
......@@ -676,11 +676,13 @@ netConnection.unregister(function (error) {
在调用NetHandle的方法之前，需要先获取NetHandle对象。
**系统能力**：SystemCapability.Communication.NetManager.Core
### 属性
| 变量 | 类型 | 说明 |
| ----- | ------ | ------------------------- |
| netId | number | 网络ID，必须大于等于100。 |
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------- |
| netId | number | 网络ID，必须大于等于100。 |
### bindSocket
......@@ -782,7 +784,7 @@ connection.getDefaultNet().then(function (netHandle) {
### getAddressesByName
getAddressesByName(netHandle: NetHandle): Promise\<Array\<NetAddress>>
getAddressesByName(host: string): Promise\<Array\<NetAddress>>
使用对应网络解析主机名以获取所有IP地址，使用Promise方式作为异步方法。
......@@ -840,7 +842,7 @@ connection.getDefaultNet().then(function (netHandle) {
### getAddressByName
getAddressByName(netHandle: NetHandle): Promise\<NetAddress>
getAddressByName(host: string): Promise\<NetAddress>
使用对应网络解析主机名以获取第一个IP地址，使用Promise方式作为异步方法。
......@@ -873,7 +875,9 @@ connection.getDefaultNet().then(function (netHandle) {
提供承载数据网络能力的实例。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ----------------------- | ----------------------------------- | ------------------------------------------------------------ |
| netCapabilities | [NetCapabilities](#netcapabilities) | 存储数据网络的传输能力和承载类型。 |
| bearerPrivateIdentifier | string | 网络标识符，WIFI网络的标识符是"wifi"，蜂窝网络的标识符是"slot0"（对应SIM卡1）。 |
......@@ -882,7 +886,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络的能力集。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| --------------------- | ---------------------------------- | ------------------------ |
| linkUpBandwidthKbps | number | 上行（设备到网络）带宽。 |
| linkDownBandwidthKbps | number | 下行（网络到设备）带宽。 |
......@@ -893,7 +899,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络具体能力。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| NET_CAPABILITY_MMS | 0 | 表示网络可以访问运营商的MMSC（Multimedia&nbsp;Message&nbsp;Service，多媒体短信服务）发送和接收彩信。 |
| NET_CAPABILITY_NOT_METERED | 11 | 表示网络流量未被计费。 |
......@@ -905,7 +913,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络类型。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 名称 | 值 | 说明 |
| --------------- | ---- | ----------- |
| BEARER_CELLULAR | 0 | 蜂窝网络。 |
| BEARER_WIFI | 1 | Wi-Fi网络。 |
......@@ -915,7 +925,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络连接信息。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------------- | ---------------------------------- | ---------------- |
| interfaceName | string | 网卡名称。 |
| domains | string | 所属域，默认""。 |
......@@ -928,7 +940,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络链路信息。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------------ | ------------------------- | -------------------- |
| address | [NetAddress](#netaddress) | 链路地址。 |
| prefixLength | number | 链路地址前缀的长度。 |
......@@ -937,7 +951,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络路由信息。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| -------------- | --------------------------- | ---------------- |
| interface | string | 网卡名称。 |
| destination | [LinkAddress](#linkaddress) | 目的地址。 |
......@@ -949,7 +965,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络地址。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------- | ------ | ------------------------------ |
| address | string | 地址。 |
| family | number | IPv4 = 1，IPv6 = 2，默认IPv4。 |
......
zh-cn/application-dev/reference/apis/js-apis-observer.md
浏览文件 @ b5160e59
......@@ -11,22 +11,22 @@
import observer from '@ohos.telephony.observer'
```
## observer.on('networkStateChange')<a name=observer.on.networkStateChange-callback></a>
## observer.on('networkStateChange')
on\(type: \'networkStateChange\', callback: Callback<NetworkState\>\): void;
订阅网络状态变化事件，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.StateRegistry
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------- | ---- | --------------------------------- |
| type | string | 是 | 网络状态变化事件 |
| callback | Callback\<[NetworkState](js-apis-radio.md#NetworkState)\> | 是 | 回调函数。参考radio的[NetworkState](js-apis-radio.md#NetworkState) |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 网络状态变化事件 |
| callback | Callback\<[NetworkState](js-apis-radio.md#networkstate)\> | 是 | 回调函数。参考radio的[NetworkState](js-apis-radio.md#networkstate) |
**示例：**
......@@ -37,13 +37,13 @@ observer.on('networkStateChange', data =>{
```
## observer.on('networkStateChange')<a name=observer.on.networkStateChange.options-callback></a>
## observer.on('networkStateChange')
on\(type: \'networkStateChange\', options: { slotId: number }, callback: Callback<NetworkState\>\): void;
订阅指定卡槽位的网络状态变化事件，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.StateRegistry
......@@ -53,7 +53,7 @@ on\(type: \'networkStateChange\', options: { slotId: number }, callback: Callbac
| ------ | ------ | ---- | -------------------------------------- |
| type | string | 是 | 网络状态变化事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | Callback\<[NetworkState](js-apis-radio.md#NetworkState)\> | 是 | 回调函数。参考radio的[NetworkState](js-apis-radio.md#NetworkState) |
| callback | Callback\<[NetworkState](js-apis-radio.md#networkstate)\> | 是 | 回调函数。参考radio的[NetworkState](js-apis-radio.md#networkstate) |
**示例：**
......@@ -64,13 +64,13 @@ observer.on('networkStateChange', {slotId: 0}, data =>{
```
## observer.off('networkStateChange')<a name=observer.off.networkStateChange-callback></a>
## observer.off('networkStateChange')
off\(type: \'networkStateChange\', callback?: Callback<NetworkState\>\): void;
取消订阅网络状态变化事件，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
>**说明：**
>
......@@ -80,10 +80,10 @@ off\(type: \'networkStateChange\', callback?: Callback<NetworkState\>\): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | --------------------------------- |
| type | string | 是 | 网络状态变化事件 |
| callback | Callback\<[NetworkState](js-apis-radio.md#NetworkState)\> | 否 | 回调函数。参考radio的[NetworkState](js-apis-radio.md#NetworkState) |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 网络状态变化事件 |
| callback | Callback\<[NetworkState](js-apis-radio.md#networkstate)\> | 否 | 回调函数。参考radio的[NetworkState](js-apis-radio.md#networkstate) |
**示例：**
......@@ -97,7 +97,7 @@ observer.off('networkStateChange', callback);
observer.off('networkStateChange');
```
## observer.on('signalInfoChange')<a name=observer.on.signalInfoChange-callback></a>
## observer.on('signalInfoChange')
on\(type: \'signalInfoChange\', callback: Callback<Array<SignalInformation\>\>): void;
......@@ -110,7 +110,7 @@ on\(type: \'signalInfoChange\', callback: Callback<Array<SignalInformation\>\>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 信号状态变化事件 |
| callback | Callback<Array<[SignalInformation](js-apis-radio.md#SignalInformation)\>\> | 是 | 回调函数。参考radio的[SignalInformation](js-apis-radio.md#SignalInformation) |
| callback | Callback<Array<[SignalInformation](js-apis-radio.md#signalinformation)\>\> | 是 | 回调函数。参考radio的[SignalInformation](js-apis-radio.md#signalinformation) |
**示例：**
......@@ -121,7 +121,7 @@ observer.on('signalInfoChange', data =>{
```
## observer.on('signalInfoChange')<a name=observer.on.signalInfoChange.options-callback></a>
## observer.on('signalInfoChange')
on\(type: \'signalInfoChange\', options: { slotId: number }, callback: Callback<Array<SignalInformation\>\>): void;
......@@ -135,7 +135,7 @@ on\(type: \'signalInfoChange\', options: { slotId: number }, callback: Callback<
| ------ | ------ | ---- | -------------------------------------- |
| type | string | 是 | 信号状态变化事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | Callback<Array<[SignalInformation](js-apis-radio.md#SignalInformation)\>\> | 是 | 回调函数。参考radio的[SignalInformation](js-apis-radio.md#SignalInformation) |
| callback | Callback<Array<[SignalInformation](js-apis-radio.md#signalinformation)\>\> | 是 | 回调函数。参考radio的[SignalInformation](js-apis-radio.md#signalinformation) |
**示例：**
......@@ -146,7 +146,7 @@ observer.on('signalInfoChange', {slotId: 0}, data =>{
```
## observer.off('signalInfoChange')<a name=observer.off.signalInfoChange-callback></a>
## observer.off('signalInfoChange')
off\(type: \'signalInfoChange\', callback?: Callback<Array<SignalInformation\>\>): void;
......@@ -163,7 +163,7 @@ off\(type: \'signalInfoChange\', callback?: Callback<Array<SignalInformation\>\>
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 信号状态变化事件 |
| callback | Callback<Array<[SignalInformation](js-apis-radio.md#SignalInformation)\>\> | 否 | 回调函数。参考radio的[SignalInformation](js-apis-radio.md#SignalInformation) |
| callback | Callback<Array<[SignalInformation](js-apis-radio.md#signalinformation)\>\> | 否 | 回调函数。参考radio的[SignalInformation](js-apis-radio.md#signalinformation) |
**示例：**
......@@ -178,9 +178,9 @@ observer.off('signalInfoChange');
```
## observer.on('callStateChange')<a name=observer.on.callStateChange-callback></a>
## observer.on('callStateChange')
on(type: 'callStateChange', callback: Callback\<{ state: [CallState](js-apis-call.md#CallState), number: string }\>): void;
on(type: 'callStateChange', callback: Callback\<{ state: CallState, number: string }\>): void;
订阅通话状态变化事件，使用callback方式作为异步方法。
......@@ -193,7 +193,7 @@ on(type: 'callStateChange', callback: Callback\<{ state: [CallState](js-apis-cal
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 通话状态变化事件 |
| callback | Callback\<{ state: [CallState](js-apis-call.md#CallState), number: string }\> | 是 | 回调函数，参考call的[CallState](js-apis-call.md#CallState)<br />number：电话号码 |
| callback | Callback\<{ state: [CallState](js-apis-call.md#callstate), number: string }\> | 是 | 回调函数，参考call的[CallState](js-apis-call.md#callstate)<br />number：电话号码 |
**示例：**
......@@ -204,9 +204,9 @@ observer.on('callStateChange', value =>{
```
## observer.on('callStateChange')<a name=observer.on.callStateChange.options-callback></a>
## observer.on('callStateChange')
on(type: 'callStateChange', options: { slotId: number }, callback: Callback<{ state: [CallState](js-apis-call.md#CallState), number: string }>): void;
on(type: 'callStateChange', options: { slotId: number }, callback: Callback<{ state:CallState, number: string }>): void;
订阅通话状态变化事件，使用callback方式作为异步方法。
......@@ -220,7 +220,7 @@ on(type: 'callStateChange', options: { slotId: number }, callback: Callback<{ st
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 通话状态变化事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | Callback\<{ state: [CallState](js-apis-call.md#CallState), number: string }\> | 是 | 回调函数，参考call的[CallState](js-apis-call.md#CallState)<br />number：电话号码 |
| callback | Callback\<{ state: [CallState](js-apis-call.md#callstate), number: string }\> | 是 | 回调函数，参考call的[CallState](js-apis-call.md#callstate)<br />number：电话号码 |
**示例：**
......@@ -231,9 +231,9 @@ observer.on('callStateChange', {slotId: 0}, value =>{
```
## observer.off('callStateChange')<a name=observer.off.callStateChange-callback></a>
## observer.off('callStateChange')
off(type: 'callStateChange', callback?: Callback<{ state: [CallState](js-apis-call.md#CallState), number: string }>): void;
off(type: 'callStateChange', callback?: Callback<{ state: CallState, number: string }>): void;
取消订阅通话状态变化事件，使用callback方式作为异步方法。
......@@ -250,7 +250,7 @@ off(type: 'callStateChange', callback?: Callback<{ state: [CallState](js-apis-ca
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 通话状态变化事件 |
| callback | Callback\<{ state: [CallState](js-apis-call.md#CallState), number: string }\> | 否 | 回调函数，参考call的[CallState](js-apis-call.md#CallState)<br />number：电话号码 |
| callback | Callback\<{ state: [CallState](js-apis-call.md#callstate), number: string }\> | 否 | 回调函数，参考call的[CallState](js-apis-call.md#callstate)<br />number：电话号码 |
**示例：**
......@@ -265,9 +265,9 @@ observer.off('callStateChange');
```
## observer.on('cellularDataConnectionStateChange')<sup>7+</sup><a name=observer.on.cellularDataConnectionStateChange-callback></a>
## observer.on('cellularDataConnectionStateChange')<sup>7+</sup>
on\(type: 'cellularDataConnectionStateChange', callback: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void;
on\(type: 'cellularDataConnectionStateChange', callback: Callback\<{ state: DataConnectState, network: RatType}\>\): void;
订阅蜂窝数据链路连接状态，使用callback方式作为异步方法。
......@@ -278,7 +278,7 @@ on\(type: 'cellularDataConnectionStateChange', callback: Callback\<{ state: Data
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#DataConnectState), network: [RadioTechnology](js-apis-radio.md#RadioTechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#DataConnectState)，radio的[RadioTechnology](js-apis-radio.md#RadioTechnology)。 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectState), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
**示例：**
......@@ -289,9 +289,9 @@ observer.on('cellularDataConnectionStateChange', value =>{
```
## observer.on('cellularDataConnectionStateChange')<sup>7+</sup><a name=observer.on.cellularDataConnectionStateChange.options-callback></a>
## observer.on('cellularDataConnectionStateChange')<sup>7+</sup>
on\(type: 'cellularDataConnectionStateChange', options: { slotId: number }, callback: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void;
on\(type: 'cellularDataConnectionStateChange', options: { slotId: number }, callback: Callback\<{ state: DataConnectState, network: RatType }\>\): void;
订阅指定卡槽位的蜂窝数据链路连接状态，使用callback方式作为异步方法。
......@@ -303,7 +303,7 @@ on\(type: 'cellularDataConnectionStateChange', options: { slotId: number }, call
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#DataConnectState), network: [RadioTechnology](js-apis-radio.md#RadioTechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#DataConnectState)，radio的[RadioTechnology](js-apis-radio.md#RadioTechnology)。 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectState), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 是 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
**示例：**
......@@ -314,9 +314,9 @@ observer.on('cellularDataConnectionStateChange', {slotId: 0}, value =>{
```
## observer.off('cellularDataConnectionStateChange')<sup>7+</sup><a name=observer.off.cellularDataConnectionStateChange-callback></a>
## observer.off('cellularDataConnectionStateChange')<sup>7+</sup>
off\(type: 'cellularDataConnectionStateChange', callback?: Callback\<{ state: DataConnectState, network: RadioTechnology }\>\): void;
off\(type: 'cellularDataConnectionStateChange', callback?: Callback\<{ state: DataConnectState, network: RatType}\>\): void;
移除订阅蜂窝数据链路连接状态，使用callback方式作为异步方法。
......@@ -331,7 +331,7 @@ off\(type: 'cellularDataConnectionStateChange', callback?: Callback\<{ state: D
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据链路连接状态事件 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#DataConnectState), network: [RadioTechnology](js-apis-radio.md#RadioTechnology) }\> | 否 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#DataConnectState)，radio的[RadioTechnology](js-apis-radio.md#RadioTechnology)。 |
| callback | Callback\<{ state: [DataConnectState](js-apis-telephony-data.md#dataconnectState), network: [RatType](js-apis-radio.md#radiotechnology) }\> | 否 | 回调函数，参考data的[DataConnectState](js-apis-telephony-data.md#dataconnectstate)，radio的[RadioTechnology](js-apis-radio.md#radiotechnology)。 |
**示例：**
......@@ -346,7 +346,7 @@ observer.off('cellularDataConnectionStateChange');
```
## observer.on('cellularDataFlowChange')<sup>7+</sup><a name=observer.on.cellularDataFlowChange-callback></a>
## observer.on('cellularDataFlowChange')<sup>7+</sup>
on\(type: 'cellularDataFlowChange', callback: Callback\<DataFlowType\>\): void;
......@@ -358,8 +358,8 @@ on\(type: 'cellularDataFlowChange', callback: Callback\<DataFlowType\>\): void;
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态状态事件 |
| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#DataFlowType)\> | 是 | 回调函数，参考data的[DataFlowType](js-apis-telephony-data.md#DataFlowType)。 |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态状态事件 |
| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#dataflowtype)\> | 是 | 回调函数，参考data的[DataFlowType](js-apis-telephony-data.md#dataflowtype)。 |
**示例：**
......@@ -370,7 +370,7 @@ observer.on('cellularDataFlowChange', data =>{
```
## observer.on('cellularDataFlowChange')<sup>7+</sup><a name=observer.on.cellularDataFlowChange.options-callback></a>
## observer.on('cellularDataFlowChange')<sup>7+</sup>
on\(type: 'cellularDataFlowChange', options: { slotId: number }, callback: Callback\<DataFlowType\>\): void;
......@@ -382,9 +382,9 @@ on\(type: 'cellularDataFlowChange', options: { slotId: number }, callback: Call
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#DataFlowType)\> | 是 | 回调函数，参考data的[DataFlowType](js-apis-telephony-data.md#DataFlowType)。 |
| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#dataflowtype)\> | 是 | 回调函数，参考data的[DataFlowType](js-apis-telephony-data.md#dataflowtype)。 |
**示例：**
......@@ -395,7 +395,7 @@ observer.on('cellularDataFlowChange', {slotId: 0}, data =>{
```
## observer.off('cellularDataFlowChange')<sup>7+</sup><a name=observer.off.cellularDataFlowChange-callback></a>
## observer.off('cellularDataFlowChange')<sup>7+</sup>
off\(type: 'cellularDataFlowChange', callback?: Callback\<DataFlowType\>\): void;
......@@ -411,8 +411,8 @@ off\(type: 'cellularDataFlowChange', callback?: Callback\<DataFlowType\>\): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 |
| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#DataFlowType)\> | 否 | 回调函数，参考data的[DataFlowType](js-apis-telephony-data.md#DataFlowType)。 |
| type | string | 是 | 蜂窝数据业务的上下行数据流状态事件 |
| callback | Callback\<[DataFlowType](js-apis-telephony-data.md#dataflowtype)\> | 否 | 回调函数，参考data的[DataFlowType](js-apis-telephony-data.md#dataflowtype)。 |
**示例：**
......@@ -427,7 +427,7 @@ observer.off('cellularDataFlowChange');
```
## observer.on('simStateChange')<sup>7+</sup><a name=observer.on.simStateChange-callback></a>
## observer.on('simStateChange')<sup>7+</sup>
on\(type: 'simStateChange', callback: Callback\<SimStateData\>\): void;
......@@ -451,7 +451,7 @@ observer.on('simStateChange', data =>{
```
## observer.on('simStateChange')<sup>7+</sup><a name=observer.on.simStateChange.options-callback></a>
## observer.on('simStateChange')<sup>7+</sup>
on\(type: 'simStateChange', options: { slotId: number }, callback: Callback\<SimStateData\>\): void;
......@@ -476,7 +476,7 @@ observer.on('simStateChange', {slotId: 0}, data =>{
```
## observer.off('simStateChange')<sup>7+</sup><a name=observer.off.simStateChange-callback></a>
## observer.off('simStateChange')<sup>7+</sup>
off\(type: 'simStateChange', callback?: Callback\<SimStateData\>\): void;
......@@ -512,30 +512,34 @@ observer.off('simStateChange');
SIM卡锁类型。
| 变量 | 值 | 说明 |
| ----------- | ---- | ------------------------------------------------------------ |
| SIM_NONE | 0 | 无锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PIN | 1 | PIN锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PUK | 2 | PUK锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PN_PIN | 3 | 网络PIN锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PN_PUK | 4 | 网络PUK锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PU_PIN | 5 | 子网PIN锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PU_PUK | 6 | 子网PUK锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PP_PIN | 7 | 服务提供商PIN锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PP_PUK | 8 | 服务提供商PUK锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PC_PIN | 9 | 组织PIN锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_PC_PUK | 10 | 组织PUK锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_SIM_PIN | 11 | SIM PIN锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| SIM_SIM_PUK | 12 | SIM PUK锁。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.StateRegistry。
| 名称 | 值 | 说明 |
| ----------- | ---- | ----------------- |
| SIM_NONE | 0 | 无锁。 |
| SIM_PIN | 1 | PIN锁。 |
| SIM_PUK | 2 | PUK锁。 |
| SIM_PN_PIN | 3 | 网络PIN锁。 |
| SIM_PN_PUK | 4 | 网络PUK锁。 |
| SIM_PU_PIN | 5 | 子网PIN锁。 |
| SIM_PU_PUK | 6 | 子网PUK锁。 |
| SIM_PP_PIN | 7 | 服务提供商PIN锁。 |
| SIM_PP_PUK | 8 | 服务提供商PUK锁。 |
| SIM_PC_PIN | 9 | 组织PIN锁。 |
| SIM_PC_PUK | 10 | 组织PUK锁。 |
| SIM_SIM_PIN | 11 | SIM PIN锁。 |
| SIM_SIM_PUK | 12 | SIM PUK锁。 |
## SimStateData<sup>7+</sup>
SIM卡类型和状态。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.StateRegistry。
| 名称 | 类型 | 说明 |
| ----------------- | --------------------- | ------------------------------------------------------------ |
| type | [CardType](js-apis-sim.md#cardtype) | SIM卡类型，参考sim的[CardType](js-apis-sim.md#cardtype)。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| state | [SimState](js-apis-sim.md#SimState) | SIM卡状态，参考sim的[SimState](js-apis-sim.md#SimState)。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| reason<sup>8+</sup> | [LockReason](#lockreason8) | SIM卡锁类型。<br/>**系统能力**：SystemCapability.Telephony.StateRegistry |
| type | [CardType](js-apis-sim.md#cardtype) | SIM卡类型，参考sim的[CardType](js-apis-sim.md#cardtype)。 |
| state | [SimState](js-apis-sim.md#simstate) | SIM卡状态，参考sim的[SimState](js-apis-sim.md#simstate)。 |
| reason<sup>8+</sup> | [LockReason](#lockreason8) | SIM卡锁类型。 |
zh-cn/application-dev/reference/apis/js-apis-radio.md
浏览文件 @ b5160e59
......@@ -11,13 +11,13 @@
import radio from '@ohos.telephony.radio'
```
## radio.getRadioTech<a name=radio.getRadioTech-callback></a>
## radio.getRadioTech
getRadioTech\(slotId: number, callback: AsyncCallback<\{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology\}\>\): void
获取当前接入的CS域和PS域无线接入技术，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -26,7 +26,7 @@ getRadioTech\(slotId: number, callback: AsyncCallback<\{psRadioTech: RadioTechno
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<{psRadioTech: [RadioTechnology](#RadioTechnology), csRadioTech:[RadioTechnology](#RadioTechnology)}\> | 是 | 回调函数。 |
| callback | AsyncCallback\<{psRadioTech: [RadioTechnology](#radiotechnology), csRadioTech:[RadioTechnology](#radiotechnology)}\> | 是 | 回调函数。 |
**示例：**
......@@ -38,13 +38,13 @@ radio.getRadioTech(slotId, (err, data) =>{
```
## radio.getRadioTech<a name=radio.getRadioTech-promise></a>
## radio.getRadioTech
getRadioTech\(slotId: number\): Promise<\{psRadioTech: RadioTechnology, csRadioTech: RadioTechnology\}\>
获取当前接入的CS域和PS域无线接入技术，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -58,7 +58,7 @@ getRadioTech\(slotId: number\): Promise<\{psRadioTech: RadioTechnology, csRadioT
| 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------------------- |
| Promise<{psRadioTech: [RadioTechnology](#RadioTechnology), csRadioTech: [RadioTechnology](#RadioTechnology)}> | 以Promise形式返回获取当前接入的CS域和PS域技术。 |
| Promise<{psRadioTech: [RadioTechnology](#radiotechnology), csRadioTech: [RadioTechnology](#radiotechnology)}> | 以Promise形式返回获取当前接入的CS域和PS域技术。 |
**示例：**
......@@ -73,13 +73,13 @@ promise.then(data => {
```
## radio.getNetworkState<a name=radio.getNetworkState-callback1></a>
## radio.getNetworkState
getNetworkState\(callback: AsyncCallback<NetworkState\>\): void
获取网络状态，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -87,7 +87,7 @@ getNetworkState\(callback: AsyncCallback<NetworkState\>\): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<[NetworkState](#NetworkState)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[NetworkState](#networkstate)\> | 是 | 回调函数。 |
**示例：**
......@@ -98,13 +98,13 @@ radio.getNetworkState((err, data) =>{
```
## radio.getNetworkState<a name=radio.getNetworkState-callback2></a>
## radio.getNetworkState
getNetworkState\(slotId: number, callback: AsyncCallback<NetworkState\>\): void
获取网络状态，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -113,7 +113,7 @@ getNetworkState\(slotId: number, callback: AsyncCallback<NetworkState\>\): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<[NetworkState](#NetworkState)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[NetworkState](#networkstate)\> | 是 | 回调函数。 |
**示例：**
......@@ -125,13 +125,13 @@ radio.getNetworkState(slotId, (err, data) => {
```
## radio.getNetworkState<a name=radio.getNetworkState-promise></a>
## radio.getNetworkState
getNetworkState\(slotId?: number\): Promise<NetworkState\>
获取网络状态，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -145,7 +145,7 @@ getNetworkState\(slotId?: number\): Promise<NetworkState\>
| 类型 | 说明 |
| ---------------------------------------- | --------------------------- |
| Promise\<[NetworkState](#NetworkState)\> | 以Promise形式返回网络状态。 |
| Promise\<[NetworkState](#networkstate)\> | 以Promise形式返回网络状态。 |
**示例：**
......@@ -160,7 +160,7 @@ promise.then(data => {
```
## radio.getNetworkSelectionMode<a name=radio.getNetworkSelectionMode-callback></a>
## radio.getNetworkSelectionMode
getNetworkSelectionMode\(slotId: number, callback: AsyncCallback<NetworkSelectionMode\>\): void
......@@ -173,7 +173,7 @@ getNetworkSelectionMode\(slotId: number, callback: AsyncCallback<NetworkSelectio
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<[NetworkSelectionMode](#NetworkSelectionMode)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[NetworkSelectionMode](#networkselectionMode)\> | 是 | 回调函数。 |
**示例：**
......@@ -185,7 +185,7 @@ radio.getNetworkSelectionMode(slotId, (err, data) => {
```
## radio.getNetworkSelectionMode<a name=radio.getNetworkSelectionMode-promise></a>
## radio.getNetworkSelectionMode
getNetworkSelectionMode\(slotId: number\): Promise<NetworkSelectionMode\>
......@@ -203,7 +203,7 @@ getNetworkSelectionMode\(slotId: number\): Promise<NetworkSelectionMode\>
| 类型 | 说明 |
| -------------------------------------------------------- | ------------------------------- |
| Promise\<[NetworkSelectionMode](#NetworkSelectionMode)\> | 以Promise形式返回当前选网模式。 |
| Promise\<[NetworkSelectionMode](#networkselectionmode)\> | 以Promise形式返回当前选网模式。 |
**示例：**
......@@ -218,7 +218,7 @@ promise.then(data => {
```
## radio.getISOCountryCodeForNetwork<sup>7+</sup><a name=radio.getISOCountryCodeForNetwork-callback></a>
## radio.getISOCountryCodeForNetwork<sup>7+</sup>
getISOCountryCodeForNetwork\(slotId: number, callback: AsyncCallback<string\>\): void
......@@ -243,7 +243,7 @@ radio.getISOCountryCodeForNetwork(slotId, (err, data) => {
```
## radio.getISOCountryCodeForNetwork<sup>7+</sup><a name=radio.getISOCountryCodeForNetwork-promise></a>
## radio.getISOCountryCodeForNetwork<sup>7+</sup>
getISOCountryCodeForNetwork\(slotId: number\): Promise<string\>
......@@ -276,7 +276,7 @@ promise.then(data => {
```
## radio.getPrimarySlotId<sup>7+</sup><a name=radio.getPrimarySlotId-callback></a>
## radio.getPrimarySlotId<sup>7+</sup>
getPrimarySlotId\(callback: AsyncCallback\<number\>\): void
......@@ -299,7 +299,7 @@ radio.getPrimarySlotId((err, data) => {
```
## radio.getPrimarySlotId<sup>7+</sup><a name=radio.getPrimarySlotId-promise></a>
## radio.getPrimarySlotId<sup>7+</sup>
getPrimarySlotId\(\): Promise\<number\>
......@@ -325,7 +325,7 @@ promise.then(data => {
```
## radio.getSignalInformation<sup>7+</sup><a name=radio.getSignalInformation-callback></a>
## radio.getSignalInformation<sup>7+</sup>
getSignalInformation\(slotId: number, callback: AsyncCallback<Array<SignalInformation\>\>\): void
......@@ -338,7 +338,7 @@ getSignalInformation\(slotId: number, callback: AsyncCallback<Array<SignalInform
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<Array\<[SignalInformation](#SignalInformation)\>\> | 是 | 回调函数，返回[SignalInformation](#SignalInformation)对象的数组。 |
| callback | AsyncCallback\<Array\<[SignalInformation](#signalinformation)\>\> | 是 | 回调函数，返回[SignalInformation](#signalinformation)对象的数组。 |
**示例：**
......@@ -350,7 +350,7 @@ radio.getSignalInformation(slotId, (err, data) => {
```
## radio.getSignalInformation<sup>7+</sup><a name=radio.getSignalInformation-promise></a>
## radio.getSignalInformation<sup>7+</sup>
getSignalInformation\(slotId: number\): Promise<Array<SignalInformation\>\>
......@@ -368,7 +368,7 @@ getSignalInformation\(slotId: number\): Promise<Array<SignalInformation\>\>
| 类型 | 说明 |
| ----------------------------------------------------------- | ------------------------------------------------------------ |
| Promise\<Array\<[SignalInformation](#SignalInformation)\>\> | 以Promise形式返回网络信号强度[SignalInformation](#SignalInformation)对象的数组。 |
| Promise\<Array\<[SignalInformation](#signalinformation)\>\> | 以Promise形式返回网络信号强度[SignalInformation](#signalinformation)对象的数组。 |
**示例：**
......@@ -383,7 +383,7 @@ promise.then(data => {
```
## radio.isNrSupported<sup>8+</sup><a name=radio.isNrSupported.slot></a>
## radio.isNrSupported<sup>8+</sup>
isNrSupported\(slotId: number\): boolean
......@@ -412,13 +412,13 @@ console.log(result);
```
## radio.isRadioOn<sup>7+</sup><a name=radio.isRadioOn-callback></a>
## radio.isRadioOn<sup>7+</sup>
isRadioOn\(callback: AsyncCallback<boolean\>\): void
判断主卡的Radio是否打开，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -437,13 +437,13 @@ radio.isRadioOn((err, data) => {
```
## radio.isRadioOn<sup>7+</sup><a name=radio.isRadioOn.slot-callback></a>
## radio.isRadioOn<sup>7+</sup>
isRadioOn\(slotId: number, callback: AsyncCallback<boolean\>\): void
判断指定卡槽位的Radio是否打开，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -464,13 +464,13 @@ radio.isRadioOn(slotId, (err, data) => {
```
## radio.isRadioOn<sup>7+</sup><a name=radio.isRadioOn.slot-promise></a>
## radio.isRadioOn<sup>7+</sup>
isRadioOn\(slotId?: number\): Promise<boolean\>
判断Radio是否打开，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_NETWORK_INFO。
**需要权限**：ohos.permission.GET_NETWORK_INFO
**系统能力**：SystemCapability.Telephony.CoreService
......@@ -499,7 +499,7 @@ promise.then(data => {
```
## radio.getOperatorName<sup>7+</sup><a name=radio.getOperatorName-callback></a>
## radio.getOperatorName<sup>7+</sup>
getOperatorName\(slotId: number, callback: AsyncCallback<string\>\): void
......@@ -524,7 +524,7 @@ radio.getOperatorName(slotId, (err, data) => {
```
## radio.getOperatorName<sup>7+</sup><a name=radio.getOperatorName-promise></a>
## radio.getOperatorName<sup>7+</sup>
getOperatorName\(slotId: number\): Promise<string\>
......@@ -557,101 +557,115 @@ promise.then(data => {
```
## RadioTechnology<a name=RadioTechnology></a>
## RadioTechnology
无线接入技术。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ------------------------- | ---- | ------------------------------------------------------------ |
| RADIO_TECHNOLOGY_UNKNOWN | 0 | 未知无线接入技术（RAT）。<br>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_GSM | 1 | 无线接入技术GSM（Global System For Mobile Communication）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_1XRTT | 2 | 无线接入技术1XRTT（Single-Carrier Radio Transmission Technology）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_WCDMA | 3 | 无线接入技术WCDMA（Wideband Code Division Multiple Access）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_HSPA | 4 | 无线接入技术HSPA（High Speed Packet Access）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_HSPAP | 5 | 无线接入技术HSPAP（High Speed packet access (HSPA+) ）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_TD_SCDMA | 6 | 无线接入技术TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_EVDO | 7 | 无线接入技术EVDO（Evolution、Data Only）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_EHRPD | 8 | 无线接入技术EHRPD（Evolved High Rate Package Data）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_LTE | 9 | 无线接入技术LTE（Long Term Evolution）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_LTE_CA | 10 | 无线接入技术LTE_CA（Long Term Evolution_Carrier Aggregation）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_IWLAN | 11 | 无线接入技术IWLAN（Industrial Wireless LAN）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| RADIO_TECHNOLOGY_NR | 12 | 无线接入技术NR（New Radio）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
## SignalInformation<a name=SignalInformation></a>
| RADIO_TECHNOLOGY_UNKNOWN | 0 | 未知无线接入技术（RAT）。 |
| RADIO_TECHNOLOGY_GSM | 1 | 无线接入技术GSM（Global System For Mobile Communication）。 |
| RADIO_TECHNOLOGY_1XRTT | 2 | 无线接入技术1XRTT（Single-Carrier Radio Transmission Technology）。 |
| RADIO_TECHNOLOGY_WCDMA | 3 | 无线接入技术WCDMA（Wideband Code Division Multiple Access）。 |
| RADIO_TECHNOLOGY_HSPA | 4 | 无线接入技术HSPA（High Speed Packet Access）。 |
| RADIO_TECHNOLOGY_HSPAP | 5 | 无线接入技术HSPAP（High Speed packet access (HSPA+) ）。 |
| RADIO_TECHNOLOGY_TD_SCDMA | 6 | 无线接入技术TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。 |
| RADIO_TECHNOLOGY_EVDO | 7 | 无线接入技术EVDO（Evolution、Data Only）。 |
| RADIO_TECHNOLOGY_EHRPD | 8 | 无线接入技术EHRPD（Evolved High Rate Package Data）。 |
| RADIO_TECHNOLOGY_LTE | 9 | 无线接入技术LTE（Long Term Evolution）。 |
| RADIO_TECHNOLOGY_LTE_CA | 10 | 无线接入技术LTE_CA（Long Term Evolution_Carrier Aggregation）。 |
| RADIO_TECHNOLOGY_IWLAN | 11 | 无线接入技术IWLAN（Industrial Wireless LAN）。 |
| RADIO_TECHNOLOGY_NR | 12 | 无线接入技术NR（New Radio）。 |
## SignalInformation
网络信号强度信息对象。
| 属性名 | 类型 | 说明 |
| ----------- | --------------------------- | ------------------------------------------------------------ |
| signalType | [NetworkType](#NetworkType) | 网络信号强度类型。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| signalLevel | number | 网络信号强度等级。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 参数名 | 类型 | 说明 |
| ----------- | --------------------------- | ------------------ |
| signalType | [NetworkType](#networktype) | 网络信号强度类型。 |
| signalLevel | number | 网络信号强度等级。 |
## NetworkType<a name=NetworkType></a>
## NetworkType
网络类型。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| -------------------- | ---- | ------------------------------------------------------------ |
| NETWORK_TYPE_UNKNOWN | 0 | 未知网络类型。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_GSM | 1 | 网络类型为GSM（Global System For Mobile Communication）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_CDMA | 2 | 网络类型为CDMA（Code Division Multiple Access）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_WCDMA | 3 | 网络类型为WCDMA（Wideband Code Division Multiple Access）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_TDSCDMA | 4 | 网络类型为TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_LTE | 5 | 网络类型为LTE（Long Term Evolution）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_NR | 6 | 网络类型为5G NR（New Radio）。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_TYPE_UNKNOWN | 0 | 未知网络类型。 |
| NETWORK_TYPE_GSM | 1 | 网络类型为GSM（Global System For Mobile Communication）。 |
| NETWORK_TYPE_CDMA | 2 | 网络类型为CDMA（Code Division Multiple Access）。 |
| NETWORK_TYPE_WCDMA | 3 | 网络类型为WCDMA（Wideband Code Division Multiple Access）。 |
| NETWORK_TYPE_TDSCDMA | 4 | 网络类型为TDSCDMA（TimeDivision-Synchronous Code Division Multiple Access）。 |
| NETWORK_TYPE_LTE | 5 | 网络类型为LTE（Long Term Evolution）。 |
| NETWORK_TYPE_NR | 6 | 网络类型为5G NR（New Radio）。 |
## NetworkState<a name=NetworkState></a>
## NetworkState
网络注册状态。
| 变量 | 类型 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 类型 | 说明 |
| ----------------- | --------------------- | ------------------------------------------------------------ |
| longOperatorName | string | 注册网络的长运营商名称。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| shortOperatorName | string | 注册网络的短运营商名称。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| plmnNumeric | string | 注册网络的PLMN码。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| isRoaming | boolean | 是否处于漫游状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| regState | [RegState](#RegState) | 设备的网络注册状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| cfgTech<sup>8+</sup> | [RadioTechnology](#RadioTechnology) | 设备的无线接入技术。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| nsaState | [NsaState](#NsaState) | 设备的NSA网络注册状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| isCaActive | boolean | CA的状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| isEmergency | boolean | 此设备是否只允许拨打紧急呼叫。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| longOperatorName | string | 注册网络的长运营商名称。 |
| shortOperatorName | string | 注册网络的短运营商名称。 |
| plmnNumeric | string | 注册网络的PLMN码。 |
| isRoaming | boolean | 是否处于漫游状态。 |
| regState | [RegState](#regstate) | 设备的网络注册状态。 |
| cfgTech<sup>8+</sup> | [RadioTechnology](#radiotechnology) | 设备的无线接入技术。 |
| nsaState | [NsaState](#nsaState) | 设备的NSA网络注册状态。 |
| isCaActive | boolean | CA的状态。 |
| isEmergency | boolean | 此设备是否只允许拨打紧急呼叫。 |
## RegState<a name=RegState></a>
## RegState
网络注册状态。
| 变量 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
| REG_STATE_NO_SERVICE | 0 | 设备不能使用任何服务。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| REG_STATE_IN_SERVICE | 1 | 设备可以正常使用业务。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| REG_STATE_EMERGENCY_CALL_ONLY | 2 | 设备只能使用紧急呼叫业务。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| REG_STATE_POWER_OFF | 3 | 蜂窝无线电已关闭。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | -------------------------- |
| REG_STATE_NO_SERVICE | 0 | 设备不能使用任何服务。 |
| REG_STATE_IN_SERVICE | 1 | 设备可以正常使用业务。 |
| REG_STATE_EMERGENCY_CALL_ONLY | 2 | 设备只能使用紧急呼叫业务。 |
| REG_STATE_POWER_OFF | 3 | 蜂窝无线电已关闭。 |
## NsaState<a name=NsaState></a>
## NsaState
非独立组网状态。
| 变量 | 值 | 说明 |
| -------------------------- | ---- | ------------------------------------------------------------ |
| NSA_STATE_NOT_SUPPORT | 1 | 设备在不支持NSA的LTE小区下处于空闲状态或连接状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NSA_STATE_NO_DETECT | 2 | 在支持NSA但不支持NR覆盖检测的LTE小区下，设备处于空闲状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NSA_STATE_CONNECTED_DETECT | 3 | 设备在LTE小区下连接到LTE网络支持NSA和NR覆盖检测。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NSA_STATE_IDLE_DETECT | 4 | 支持NSA和NR覆盖检测的LTE小区下设备处于空闲状态。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NSA_STATE_DUAL_CONNECTED | 5 | 设备在支持NSA的LTE小区下连接到LTE + NR网络。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NSA_STATE_SA_ATTACHED | 6 | 设备在5GC附着时在NG-RAN小区下空闲或连接到NG-RAN小区。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| -------------------------- | ---- | ---------------------------------------------------------- |
| NSA_STATE_NOT_SUPPORT | 1 | 设备在不支持NSA的LTE小区下处于空闲状态或连接状态。 |
| NSA_STATE_NO_DETECT | 2 | 在支持NSA但不支持NR覆盖检测的LTE小区下，设备处于空闲状态。 |
| NSA_STATE_CONNECTED_DETECT | 3 | 设备在LTE小区下连接到LTE网络支持NSA和NR覆盖检测。 |
| NSA_STATE_IDLE_DETECT | 4 | 支持NSA和NR覆盖检测的LTE小区下设备处于空闲状态。 |
| NSA_STATE_DUAL_CONNECTED | 5 | 设备在支持NSA的LTE小区下连接到LTE + NR网络。 |
| NSA_STATE_SA_ATTACHED | 6 | 设备在5GC附着时在NG-RAN小区下空闲或连接到NG-RAN小区。 |
## NetworkSelectionMode<a name=NetworkSelectionMode></a>
## NetworkSelectionMode
选网模式。
| 变量 | 值 | 说明 |
| --------------------------- | ---- | ------------------------------------------------------------ |
| NETWORK_SELECTION_UNKNOWN | 0 | 未知选网模式。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_SELECTION_AUTOMATIC | 1 | 自动选网模式。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
| NETWORK_SELECTION_MANUAL | 2 | 手动选网模式。<br/>**系统能力**：SystemCapability.Telephony.CoreService |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| --------------------------- | ---- | -------------- |
| NETWORK_SELECTION_UNKNOWN | 0 | 未知选网模式。 |
| NETWORK_SELECTION_AUTOMATIC | 1 | 自动选网模式。 |
| NETWORK_SELECTION_MANUAL | 2 | 手动选网模式。 |
zh-cn/application-dev/reference/apis/js-apis-sim.md
浏览文件 @ b5160e59
......@@ -3,6 +3,7 @@
>**说明：**
>
>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
## 导入模块
......@@ -10,13 +11,13 @@
import sim from '@ohos.telephony.sim';
```
## sim.isSimActive<a name=sim.isSimActive-callback></a>
## sim.isSimActive<sup>7+</sup>
isSimActive\(slotId: number, callback: AsyncCallback<boolean\>\): void
获取指定卡槽SIM卡是否激活，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
......@@ -34,13 +35,13 @@ sim.isSimActive(0, (err, data) => {
```
## sim.isSimActive<a name=sim.isSimActive-promise></a>
## sim.isSimActive<sup>7+</sup>
isSimActive\(slotId: number\): Promise<string\>
isSimActive\(slotId: number\): Promise<boolean\>
获取指定卡槽SIM卡是否激活，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
......@@ -66,12 +67,14 @@ promise.then(data => {
```
## sim.getDefaultVoiceSlotId<sup>7+</sup><a name= sim.getDefaultVoiceSlotId-callback></a>
## sim.getDefaultVoiceSlotId<sup>7+</sup>
getDefaultVoiceSlotId\(callback: AsyncCallback<number\>\): void
获取默认语音业务的卡槽ID，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -87,12 +90,14 @@ sim.getDefaultVoiceSlotId((err, data) => {
```
## sim.getDefaultVoiceSlotId<sup>7+</sup><a name=sim.getDefaultVoiceSlotId-promise></a>
## sim.getDefaultVoiceSlotId<sup>7+</sup>
getDefaultVoiceSlotId\(\): Promise<number\>
获取默认语音业务的卡槽ID，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**返回值：**
| 类型 | 说明 |
......@@ -110,13 +115,68 @@ promise.then(data => {
});
```
## sim.hasOperatorPrivileges<sup>7+</sup>
hasOperatorPrivileges(slotId: number, callback: AsyncCallback\<boolean\>): void
检查应用（调用者）是否已被授予运营商权限，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br />- 0：卡槽1<br />- 1：卡槽2 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
**示例：**
```
sim.hasOperatorPrivileges(0, (err, data) => {
console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```
## sim.hasOperatorPrivileges<sup>7+</sup>
hasOperatorPrivileges(slotId: number): Promise<boolean>
检查应用（调用者）是否已被授予运营商权限，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ---------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br />- 0：卡槽1<br />- 1：卡槽2 |
**返回值：**
| 类型 | 说明 |
| :----------------- | :---------------------------------------------------------- |
| Promise\<boolean\> | 以Promise形式返回检查应用（调用者）是否已被授予运营商权限。 |
**示例：**
```
let promise = sim.hasOperatorPrivileges(0);
promise.then(data => {
console.log(`hasOperatorPrivileges success, promise: data->${JSON.stringify(data)}`);
}).catch(err => {
console.log(`hasOperatorPrivileges fail, promise: err->${JSON.stringify(err)}`);
});
```
## sim.getISOCountryCodeForSim<a name=sim.getISOCountryCodeForSim-callback></a>
## sim.getISOCountryCodeForSim
getISOCountryCodeForSim\(slotId: number, callback: AsyncCallback<string\>\): void
获取指定卡槽SIM卡的ISO国家码，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -133,12 +193,14 @@ sim.getISOCountryCodeForSim(0, (err, data) => {
```
## sim.getISOCountryCodeForSim<a name=sim.getISOCountryCodeForSim-promise></a>
## sim.getISOCountryCodeForSim
getISOCountryCodeForSim\(slotId: number\): Promise<string\>
获取指定卡槽SIM卡的ISO国家码，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -163,12 +225,14 @@ promise.then(data => {
```
## sim.getSimOperatorNumeric<a name=sim.getSimOperatorNumeric-callback></a>
## sim.getSimOperatorNumeric
getSimOperatorNumeric\(slotId: number, callback: AsyncCallback<string\>\): void
获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -185,12 +249,14 @@ sim.getSimOperatorNumeric(0, (err, data) => {
```
## sim.getSimOperatorNumeric<a name=sim.getSimOperatorNumeric-promise></a>
## sim.getSimOperatorNumeric
getSimOperatorNumeric\(slotId: number\): Promise<string\>
获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -215,12 +281,14 @@ promise.then(data => {
```
## sim.getSimSpn<a name=sim.getSimSpn-callback></a>
## sim.getSimSpn
getSimSpn\(slotId: number, callback: AsyncCallback<string\>\): void
获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -237,12 +305,14 @@ sim.getSimSpn(0, (err, data) => {
```
## sim.getSimSpn<a name=sim.getSimSpn-promise></a>
## sim.getSimSpn
getSimSpn\(slotId: number\): Promise<string\>
获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -267,18 +337,20 @@ promise.then(data => {
```
## sim.getSimState<a name=sim.getSimState-callback></a>
## sim.getSimState
getSimState\(slotId: number, callback: AsyncCallback<SimState\>\): void
获取指定卡槽的SIM卡状态，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<[SimState](#SimState)\> | 是 | 回调函数。参考[SimState](#SimState)。 |
| callback | AsyncCallback\<[SimState](#simState)\> | 是 | 回调函数。参考[SimState](#simState)。 |
**示例：**
......@@ -289,12 +361,14 @@ sim.getSimState(0, (err, data) => {
```
## sim.getSimState<a name=sim.getSimState-promise></a>
## sim.getSimState
getSimState\(slotId: number\): Promise<SimState\>
获取指定卡槽的SIM卡状态，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -305,7 +379,7 @@ getSimState\(slotId: number\): Promise<SimState\>
| 类型 | 说明 |
| -------------------------------- | ------------------------------------------ |
| Promise\<[SimState](#SimState)\> | 以Promise形式返回获取指定卡槽的SIM卡状态。 |
| Promise\<[SimState](#simState)\> | 以Promise形式返回获取指定卡槽的SIM卡状态。 |
**示例：**
......@@ -318,20 +392,20 @@ promise.then(data => {
});
```
## sim.getCardType<a name=sim.getCardType-callback></a>
## sim.getCardType<sup>7+</sup>
getCardType\(slotId: number, callback: AsyncCallback<CardType\>\): void
获取指定卡槽SIM卡的卡类型，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| callback | AsyncCallback\<[CardType](#cardtype)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[CardType](#cardtype7)\> | 是 | 回调函数。 |
**示例：**
......@@ -342,13 +416,13 @@ sim.getCardType(0, (err, data) => {
```
## sim.getCardType<a name=sim.getCardType-promise></a>
## sim.getCardType<sup>7+</sup>
getCardType\(slotId: number\): Promise<CardType\>
获取指定卡槽SIM卡的卡类型，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
......@@ -360,7 +434,7 @@ getCardType\(slotId: number\): Promise<CardType\>
| 类型 | 说明 |
| ----------------- | ------------------------------------------------------------ |
| Promise\<[CardType](#cardtype)\> | 以Promise形式返回指定卡槽SIM卡的卡类型。 |
| Promise\<[CardType](#cardtype7)\> | 以Promise形式返回指定卡槽SIM卡的卡类型。 |
**示例：**
......@@ -374,13 +448,13 @@ promise.then(data => {
```
## sim.hasSimCard<a name=sim.hasSimCard-callback></a>
## sim.hasSimCard<sup>7+</sup>
hasSimCard\(slotId: number, callback: AsyncCallback<boolean\>\): void
获取指定卡槽SIM卡是否插卡，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
......@@ -398,13 +472,13 @@ sim.hasSimCard(0, (err, data) => {
```
## sim.hasSimCard<a name=sim.hasSimCard-promise></a>
## sim.hasSimCard<sup>7+</sup>
hasSimCard\(slotId: number\): Promise<string\>
hasSimCard\(slotId: number\): Promise<boolean\>
获取指定卡槽SIM卡是否插卡，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**参数：**
......@@ -430,13 +504,13 @@ promise.then(data => {
```
## sim.getMaxSimCount
## sim.getMaxSimCount<sup>7+</sup>
getMaxSimCount\(\): number
获取卡槽数量。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE
**系统能力：**SystemCapability.Communication.CoreService
**返回值：**
......@@ -451,32 +525,36 @@ console.log(sim.getMaxSimCount())
```
## SimState<a name=SimState></a>
## SimState
SIM卡状态。
| 变量 | 说明 |
| --------------------- | ---------------------------------------------------------- |
| SIM_STATE_UNKNOWN | SIM卡状态未知，即无法获取准确的状态。 |
| SIM_STATE_NOT_PRESENT | 表示SIM卡处于not present状态，即卡槽中没有插入SIM卡。 |
| SIM_STATE_LOCKED | 表示SIM卡处于locked状态，即SIM卡被PIN、PUK或网络锁锁定。 |
| SIM_STATE_NOT_READY | 表示SIM卡处于not ready状态，即SIM卡在位但无法正常工作。 |
| SIM_STATE_READY | 表示SIM卡处于ready状态，即SIM卡在位且工作正常。 |
| SIM_STATE_LOADED | 表示SIM卡处于loaded状态，即SIM卡在位且所有卡文件加载完毕。 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
## CardType
| 名称 | 值 | 说明 |
| --------------------- | ---- | ---------------------------------------------------------- |
| SIM_STATE_UNKNOWN | 0 | SIM卡状态未知，即无法获取准确的状态。 |
| SIM_STATE_NOT_PRESENT | 1 | 表示SIM卡处于not present状态，即卡槽中没有插入SIM卡。 |
| SIM_STATE_LOCKED | 2 | 表示SIM卡处于locked状态，即SIM卡被PIN、PUK或网络锁锁定。 |
| SIM_STATE_NOT_READY | 3 | 表示SIM卡处于not ready状态，即SIM卡在位但无法正常工作。 |
| SIM_STATE_READY | 4 | 表示SIM卡处于ready状态，即SIM卡在位且工作正常。 |
| SIM_STATE_LOADED | 5 | 表示SIM卡处于loaded状态，即SIM卡在位且所有卡文件加载完毕。 |
## CardType<sup>7+</sup>
卡类型。
| 变量 | 值 | 说明 |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| 名称 | 值 | 说明 |
| ----- | ----- | ----- |
UNKNOWN_CARD | -1 | 未知类型 |
SINGLE_MODE_SIM_CARD | 10 | 单SIM卡 |
SINGLE_MODE_USIM_CARD | 20 | 单USIM卡 |
SINGLE_MODE_RUIM_CARD | 30 | 单RUIM卡 |
DUAL_MODE_CG_CARD | 40 | 双卡模式C+G |
CT_NATIONAL_ROAMING_CARD | 41 | 中国电信内部漫游卡 |
CU_DUAL_MODE_CARD | 42 | 中国联通双模卡 |
DUAL_MODE_TELECOM_LTE_CARD | 43 | 双模式电信LTE卡 |
DUAL_MODE_UG_CARD | 50 | 双模式UG卡 |
SINGLE_MODE_ISIM_CARD | 60 | 单一ISIM卡类型 |
\ No newline at end of file
|UNKNOWN_CARD | -1 | 未知类型 |
|SINGLE_MODE_SIM_CARD | 10 | 单SIM卡 |
|SINGLE_MODE_USIM_CARD | 20 | 单USIM卡 |
|SINGLE_MODE_RUIM_CARD | 30 | 单RUIM卡 |
|DUAL_MODE_CG_CARD | 40 | 双卡模式C+G |
|CT_NATIONAL_ROAMING_CARD | 41 | 中国电信内部漫游卡 |
|CU_DUAL_MODE_CARD | 42 | 中国联通双模卡 |
|DUAL_MODE_TELECOM_LTE_CARD | 43 | 双模式电信LTE卡 |
|DUAL_MODE_UG_CARD | 50 | 双模式UG卡 |
|SINGLE_MODE_ISIM_CARD | 60 | 单一ISIM卡类型 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-sms.md
浏览文件 @ b5160e59
......@@ -10,7 +10,7 @@
import sms from '@ohos.telephony.sms';
```
## sms.createMessage<a name=sms.createMessage-callback></a>
## sms.createMessage
createMessage\(pdu: Array<number\>, specification: string, callback: AsyncCallback<ShortMessage\>\): void
......@@ -24,7 +24,7 @@ createMessage\(pdu: Array<number\>, specification: string, callback: AsyncCallba
| ------------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
| pdu | Array&lt;number&gt; | 是 | 协议数据单元，从收到的信息中获取。 |
| specification | string | 是 | 短信协议类型。<br/>- 3gpp表示GSM/UMTS/LTE SMS<br/>- 3gpp2表示CDMA SMS |
| callback | AsyncCallback&lt;[ShortMessage](#ShortMessage)&gt; | 是 | 回调函数。 |
| callback | AsyncCallback&lt;[ShortMessage](#shortmessage)&gt; | 是 | 回调函数。 |
**示例：**
......@@ -38,7 +38,7 @@ sms.createMessage(pdu, specification, (err, data) => {
```
## sms.createMessage<a name=sms.createMessage-promise></a>
## sms.createMessage
createMessage\(pdu: Array<number\>, specification: string\): Promise<ShortMessage\>
......@@ -57,7 +57,7 @@ createMessage\(pdu: Array<number\>, specification: string\): Promise<ShortMessag
| 类型 | 说明 |
| -------------------------------------------- | --------------------------------- |
| Promise&lt;[ShortMessage](#ShortMessage)&gt; | 以Promise形式返回创建的短信实例。 |
| Promise&lt;[ShortMessage](#shortmessage)&gt; | 以Promise形式返回创建的短信实例。 |
**示例：**
......@@ -87,7 +87,7 @@ sendMessage(options: SendMessageOptions): void
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ----------------------------------------- | ---- | ------------------------------------------------------------ |
| options | [SendMessageOptions](#SendMessageOptions) | 是 | 发送短信的参数和回调，参考[SendMessageOptions](#SendMessageOptions)。 |
| options | [SendMessageOptions](#sendmessageoptions) | 是 | 发送短信的参数和回调，参考[SendMessageOptions](#sendmessageoptions)。 |
**示例：**
......@@ -108,7 +108,7 @@ sms.sendMessage(options);
```
## sms.getDefaultSmsSlotId<sup>7+</sup><a name=sms.getDefaultSmsSlotId-callback></a>
## sms.getDefaultSmsSlotId<sup>7+</sup>
getDefaultSmsSlotId\(callback: AsyncCallback<number\>\): void
......@@ -131,7 +131,7 @@ sms.getDefaultSmsSlotId((err, data) => {
```
## sms.getDefaultSmsSlotId<sup>7+</sup><a name=sms.getDefaultSmsSlotId-promise></a>
## sms.getDefaultSmsSlotId<sup>7+</sup>
getDefaultSmsSlotId\(\): Promise<number\>
......@@ -157,7 +157,7 @@ promise.then(data => {
```
## sms.setSmscAddr<sup>7+</sup><a name=sms.setSmscAddr-callback></a>
## sms.setSmscAddr<sup>7+</sup>
setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback<void\>\): void
......@@ -167,6 +167,8 @@ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback<void\>\):
**系统能力**：SystemCapability.Telephony.SmsMms
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -186,7 +188,7 @@ sms.setSmscAddr(slotId, smscAddr, (err,data) => {
```
## sms.setSmscAddr<sup>7+</sup><a name=sms.setSmscAddr-promise></a>
## sms.setSmscAddr<sup>7+</sup>
setSmscAddr\(slotId: number, smscAddr: string\): Promise<void\>
......@@ -196,6 +198,8 @@ setSmscAddr\(slotId: number, smscAddr: string\): Promise<void\>
**系统能力**：SystemCapability.Telephony.SmsMms
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -223,7 +227,7 @@ promise.then(data => {
```
## sms.getSmscAddr<sup>7+</sup><a name=sms.getSmscAddr-callback></a>
## sms.getSmscAddr<sup>7+</sup>
getSmscAddr\(slotId: number, callback: AsyncCallback<string\>\): void
......@@ -233,7 +237,7 @@ getSmscAddr\(slotId: number, callback: AsyncCallback<string\>\): void
**系统能力**：SystemCapability.Telephony.SmsMms
**补充说明**：该接口为systemapi，仅供系统应用使用
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
......@@ -252,7 +256,7 @@ sms.getSmscAddr(slotId, (err, data) => {
```
## sms.getSmscAddr<sup>7+</sup><a name=sms.getSmscAddr-promise></a>
## sms.getSmscAddr<sup>7+</sup>
getSmscAddr\(slotId: number\): Promise<string\>
......@@ -262,7 +266,7 @@ getSmscAddr\(slotId: number\): Promise<string\>
**系统能力**：SystemCapability.Telephony.SmsMms
**补充说明**：该接口为systemapi，仅供系统应用使用
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：**
......@@ -288,7 +292,7 @@ promise.then(data => {
});
```
## sms.hasSmsCapability<sup>7+</sup><a name=sms.hasSmsCapability></a>
## sms.hasSmsCapability<sup>7+</sup>
hasSmsCapability(): boolean
......@@ -307,18 +311,18 @@ let result = sms.hasSmsCapability();
console.log(`hasSmsCapability: ${JSON.stringify(result)}`);
```
## ShortMessage<a name=ShortMessage></a>
## ShortMessage
短信实例。
**系统能力**：SystemCapability.Telephony.SmsMms
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 变量 | 类型 | 说明 |
| 参数名 | 类型 | 说明 |
| ------------------------ | --------------------------------------- | ------------------------------------------------------------ |
| hasReplyPath | boolean | 收到的短信是否包含“TP-Reply-Path”，默认为false。<br/>“TP-Reply-Path”：移动电话根据发送SMS消息的短消息中心进行回复。 |
| isReplaceMessage | boolean | 收到的短信是否为“替换短信”，默认为false。<br/>“替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。 |
| isSmsStatusReportMessage | boolean | 当前消息是否为“短信状态报告”，默认为false。<br/>“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。 |
| messageClass | [ShortMessageClass](#ShortMessageClass) | 短信类型。 |
| messageClass | [ShortMessageClass](#shortmessageclass) | 短信类型。 |
| pdu | Array&lt;number&gt; | SMS消息中的协议数据单元 （PDU）。 |
| protocolId | number | 发送短信时使用的协议标识。 |
| scAddress | string | 短消息服务中心（SMSC）地址。 |
......@@ -328,26 +332,26 @@ console.log(`hasSmsCapability: ${JSON.stringify(result)}`);
| visibleRawAddress | string | 发送者地址。 |
## ShortMessageClass<a name=ShortMessageClass></a>
## ShortMessageClass
短信类型。
| 变量 | 值 | 说明 |
| ---------------- | ---- | ------------------------------------------------------------ |
| UNKNOWN | 0 | 未知类型。<br />**系统能力**：SystemCapability.Telephony.SmsMms |
| INSTANT_MESSAGE | 1 | 即时消息，收到后立即显示。<br />**系统能力**：SystemCapability.Telephony.SmsMms |
| OPTIONAL_MESSAGE | 2 | 存储在设备或SIM卡上的短信。<br />**系统能力**：SystemCapability.Telephony.SmsMms |
| SIM_MESSAGE | 3 | 包含SIM卡信息的短信，需要存储在SIM卡中。<br />**系统能力**：SystemCapability.Telephony.SmsMms |
| FORWARD_MESSAGE | 4 | 要转发到另一台设备的短信。<br />**系统能力**：SystemCapability.Telephony.SmsMms |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 名称 | 值 | 说明 |
| ---------------- | ---- | ---------------------------------------- |
| UNKNOWN | 0 | 未知类型。 |
| INSTANT_MESSAGE | 1 | 即时消息，收到后立即显示。 |
| OPTIONAL_MESSAGE | 2 | 存储在设备或SIM卡上的短信。 |
| SIM_MESSAGE | 3 | 包含SIM卡信息的短信，需要存储在SIM卡中。 |
| FORWARD_MESSAGE | 4 | 要转发到另一台设备的短信。 |
## SendMessageOptions<a name=SendMessageOptions></a>
发送短信的参数和回调。
## SendMessageOptions
根据SendMessageOptions中的可选参数content的值判断短信类型。
发送短信的参数和回调。根据SendMessageOptions中的可选参数content的值判断短信类型。
**系统能力**：SystemCapability.Telephony.SmsMms
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 类型 | 必填 | 说明 |
| ---------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
......@@ -356,41 +360,41 @@ console.log(`hasSmsCapability: ${JSON.stringify(result)}`);
| content | string \| Array&lt;number&gt; | 是 | 如果内容是字符串，则这是一条文本短信。如果内容是字节数组，则这是一条数据短信。 |
| serviceCenter | string | 否 | 短信中心地址。默认使用SIM卡中的短信中心地址。 |
| destinationPort | number | 否 | 如果发送数据消息，destinationPort 是必需的。否则是可选的。 |
| sendCallback | AsyncCallback&lt;[ISendShortMessageCallback](#ISendShortMessageCallback)&gt; | 否 | 短信发送结果回调，返回短信发送的结果，参考[ISendShortMessageCallback](#ISendShortMessageCallback)。 |
| deliveryCallback | AsyncCallback&lt;[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)&gt; | 否 | 短信送达结果回调，返回短信递送报告，参考[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)。 |
| sendCallback | AsyncCallback&lt;[ISendShortMessageCallback](#isendshortmessagecallback)&gt; | 否 | 短信发送结果回调，返回短信发送的结果，参考[ISendShortMessageCallback](#isendshortmessagecallback)。 |
| deliveryCallback | AsyncCallback&lt;[IDeliveryShortMessageCallback](#ideliveryshortmessagecallback)&gt; | 否 | 短信送达结果回调，返回短信递送报告，参考[IDeliveryShortMessageCallback](#ideliveryshortmessagecallback)。 |
## ISendShortMessageCallback<a name=ISendShortMessageCallback></a>
## ISendShortMessageCallback
回调实例。返回短信发送结果、存储已发送短信的URI和是否为长短信的最后一部分。
**系统能力**：SystemCapability.Telephony.SmsMms
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| isLastPart | boolean | 否 | 指定这是否是长短信的最后一部分。true表示这是长短信的最后一部分，false表示不是。默认为false。 |
| result | [SendSmsResult](#SendSmsResult) | 是 | 短信发送结果。 |
| result | [SendSmsResult](#sendsmsresult) | 是 | 短信发送结果。 |
| url | string | 是 | 存储发送短信的URI。 |
## IDeliveryShortMessageCallback<a name=IDeliveryShortMessageCallback></a>
## IDeliveryShortMessageCallback
回调实例。返回短信送达报告。
**系统能力**：SystemCapability.Telephony.SmsMms
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | -------------- |
| pdu | Array&lt;number&gt; | 是 | 短信送达报告。 |
## SendSmsResult<a name=SendSmsResult></a>
## SendSmsResult
短信发送结果。
**系统能力**：SystemCapability.Telephony.SmsMms
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------------------ | ---- | ------------------------------------------------------ |
| SEND_SMS_SUCCESS | 0 | 发送短信成功。 |
| SEND_SMS_FAILURE_UNKNOWN | 1 | 发送短信失败，原因未知。 |
......
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ b5160e59
......@@ -4,7 +4,6 @@
>
>本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
>本模块所有接口需要设备具有系统能力：SystemCapability.Communication.NetStack
## 导入模块
......@@ -12,16 +11,14 @@
import socket from '@ohos.net.socket';
```
## 权限列表
ohos.permission.INTERNET
## socket.constructUDPSocketInstance
constructUDPSocketInstance\(\): UDPSocket
创建一个UDPSocket对象。
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -48,6 +45,8 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -77,6 +76,8 @@ bind\(address: NetAddress\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -111,6 +112,8 @@ send\(options: UDPSendOptions, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -147,6 +150,8 @@ send\(options: UDPSendOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -187,6 +192,8 @@ close\(callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -215,6 +222,8 @@ close\(\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -245,6 +254,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -283,6 +294,8 @@ getState\(\): Promise<SocketStateBase\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -320,6 +333,8 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -366,6 +381,8 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -409,6 +426,8 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -421,7 +440,7 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
```
let udp = socket.constructUDPSocketInstance();
udp.on('message', value => {
console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo);
console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
});
```
......@@ -435,6 +454,8 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -447,7 +468,7 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
```
let udp = socket.constructUDPSocketInstance();
let callback = value =>{
console.log("on message, message:" + value.message) + ", remoteInfo:" + value.remoteInfo);
console.log("on message, message:" + value.message + ", remoteInfo:" + value.remoteInfo);
}
udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
......@@ -462,6 +483,8 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void
订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -474,7 +497,7 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void
```
let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => {
console.log("on listening success"));
console.log("on listening success");
});
udp.on('close', () => {
console.log("on close success" );
......@@ -491,6 +514,8 @@ off\(type: 'listening' | 'close', callback?: Callback<void\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -525,6 +550,8 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -552,6 +579,8 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -577,6 +606,8 @@ udp.off('error');
目标地址信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 |
......@@ -587,6 +618,8 @@ udp.off('error');
UDPSocket发送参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------- |
| data | string | 是 | 发送的数据。 |
......@@ -596,6 +629,8 @@ UDPSocket发送参数。
UDPSocket连接的其他属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | -------------------------------- |
| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
......@@ -608,6 +643,8 @@ UDPSocket连接的其他属性。
Socket的状态信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | ---------- |
| isBound | boolean | 是 | 是否绑定。 |
......@@ -618,6 +655,8 @@ Socket的状态信息。
Socket的连接信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 |
......@@ -631,6 +670,8 @@ constructTCPSocketInstance\(\): TCPSocket
创建一个TCPSocket对象。
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -656,6 +697,8 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -680,12 +723,14 @@ tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### bind
bind\(address NetAddress\): Promise<void\>
bind\(address: NetAddress\): Promise<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -719,6 +764,8 @@ connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -748,6 +795,8 @@ connect\(options: TCPConnectOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -784,6 +833,8 @@ send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -824,6 +875,8 @@ send\(options: TCPSendOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -865,6 +918,8 @@ close\(callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -894,6 +949,8 @@ close\(\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -924,6 +981,8 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -961,6 +1020,8 @@ getRemoteAddress\(\): Promise<NetAddress\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -997,6 +1058,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1035,6 +1098,8 @@ getState\(\): Promise<SocketStateBase\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -1072,6 +1137,8 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1090,7 +1157,7 @@ promise.then(() => {
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: { on:true, linger:10 }
socketLinger: { on:true, linger:10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
......@@ -1119,6 +1186,8 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1143,7 +1212,7 @@ promise.then(() => {
keepAlive: true,
OOBInline: true,
TCPNoDelay: true,
socketLinger: { on:true, linger:10 }
socketLinger: { on:true, linger:10 },
receiveBufferSize: 1000,
sendBufferSize: 1000,
reuseAddress: true,
......@@ -1166,6 +1235,8 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1192,6 +1263,8 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1219,6 +1292,8 @@ on\(type: 'connect' | 'close', callback: Callback<void\>\): void
订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1242,13 +1317,15 @@ tcp.on('close', data => {
### off\('connect' | 'close'\)
off\(type: 'connect' | 'close', callback: Callback<void\>\): void
off\(type: 'connect' | 'close', callback?: Callback<void\>\): void
取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1283,6 +1360,8 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1309,6 +1388,8 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -1334,6 +1415,8 @@ tcp.off('error');
TCPSocket连接的参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------------------- |
| address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 |
......@@ -1343,6 +1426,8 @@ TCPSocket连接的参数。
TCPSocket发送请求的参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| data | string | 是 | 发送的数据。 |
......@@ -1352,6 +1437,8 @@ TCPSocket发送请求的参数。
TCPSocket连接的其他属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | ------------------------------------------------------------ |
| keepAlive | boolean | 否 | 是否保持连接。默认为false。 |
......
zh-cn/application-dev/reference/apis/js-apis-telephony-data.md
浏览文件 @ b5160e59
......@@ -10,7 +10,7 @@
import data from '@ohos.telephony.data';
```
## data.getDefaultCellularDataSlotId<a name=data.getDefaultCellularDataSlotId-callback></a>
## data.getDefaultCellularDataSlotId
getDefaultCellularDataSlotId(callback: AsyncCallback\<number\>): void
......@@ -34,7 +34,7 @@ data.getDefaultCellularDataSlotId((err, data) => {
});
```
## data.getDefaultCellularDataSlotId<a name=data.getDefaultCellularDataSlotId-promise></a>
## data.getDefaultCellularDataSlotId
getDefaultCellularDataSlotId(): Promise\<number\>
......@@ -61,7 +61,7 @@ promise.then((data) => {
});
```
## data.getCellularDataFlowType<a name=data.getCellularDataFlowType-callback></a>
## data.getCellularDataFlowType
getCellularDataFlowType(callback: AsyncCallback\<DataFlowType\>): void
......@@ -73,7 +73,7 @@ getCellularDataFlowType(callback: AsyncCallback\<DataFlowType\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<[DataFlowType](#DataFlowType)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[DataFlowType](#dataflowtype)\> | 是 | 回调函数。 |
**示例：**
......@@ -83,7 +83,7 @@ data.getCellularDataFlowType((err, data) => {
});
```
## data.getCellularDataFlowType<a name=data.getCellularDataFlowType-promise></a>
## data.getCellularDataFlowType
getCellularDataFlowType(): Promise\<DataFlowType\>
......@@ -95,7 +95,7 @@ getCellularDataFlowType(): Promise\<DataFlowType\>
| 类型 | 说明 |
| ---------------------------------------- | ----------------------------------------------- |
| Promise\<[DataFlowType](#DataFlowType)\> | 以Promise形式返回获取蜂窝数据业务的上下行状态。 |
| Promise\<[DataFlowType](#dataflowtype)\> | 以Promise形式返回获取蜂窝数据业务的上下行状态。 |
**示例：**
......@@ -108,7 +108,7 @@ promise.then((data) => {
});
```
## data.getCellularDataState<a name=data.getCellularDataState-callback></a>
## data.getCellularDataState
getCellularDataState(callback: AsyncCallback\<DataConnectState\>): void
......@@ -120,7 +120,7 @@ getCellularDataState(callback: AsyncCallback\<DataConnectState\>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------ | ---- | ---------- |
| callback | AsyncCallback\<[DataConnectState](#DataConnectState)\> | 是 | 回调函数。 |
| callback | AsyncCallback\<[DataConnectState](#dataconnectstate)\> | 是 | 回调函数。 |
**示例：**
......@@ -130,7 +130,7 @@ data.getCellularDataState((err, data) => {
});
```
## data.getCellularDataState<a name=data.getCellularDataState-promise></a>
## data.getCellularDataState
getCellularDataState(): Promise\<DataConnectState\>
......@@ -142,7 +142,7 @@ getCellularDataState(): Promise\<DataConnectState\>
| 类型 | 说明 |
| ------------------------------------------------ | ------------------------------------- |
| Promise\<[DataConnectState](#DataConnectState)\> | 以Promise形式返回获取PS域的连接状态。 |
| Promise\<[DataConnectState](#dataconnectstate)\> | 以Promise形式返回获取PS域的连接状态。 |
**示例：**
......@@ -155,7 +155,7 @@ promise.then((data) => {
});
```
## data.isCellularDataEnabled<a name=data.isCellularDataEnabled-callback></a>
## data.isCellularDataEnabled
isCellularDataEnabled(callback: AsyncCallback\<boolean\>): void
......@@ -179,7 +179,7 @@ data.isCellularDataEnabled((err, data) => {
});
```
## data.isCellularDataEnabled<a name=data.isCellularDataEnabled-promise></a>
## data.isCellularDataEnabled
isCellularDataEnabled(): Promise\<boolean\>
......@@ -206,7 +206,7 @@ promise.then((data) => {
});
```
## data.isCellularDataRoamingEnabled<a name=data.isCellularDataRoamingEnabled-callback></a>
## data.isCellularDataRoamingEnabled
isCellularDataRoamingEnabled(slotId: number, callback: AsyncCallback\<boolean\>): void
......@@ -231,7 +231,7 @@ data.isCellularDataRoamingEnabled(0,(err, data) => {
});
```
## data.isCellularDataRoamingEnabled<a name=data.isCellularDataRoamingEnabled-promise></a>
## data.isCellularDataRoamingEnabled
isCellularDataRoamingEnabled(slotId: number): Promise\<boolean\>
......@@ -264,26 +264,30 @@ promise.then((data) => {
});
```
## DataFlowType<a name=DataFlowType></a>
## DataFlowType
描述蜂窝数据流类型。
描述蜂窝数据流类型。
| 参数名 | 值 | 说明 |
| ------ | ---------------------- | ------------------------------------------------------------ |
| 0 | DATA_FLOW_TYPE_NONE | 表示没有上行或下行数据。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 1 | DATA_FLOW_TYPE_DOWN | 表示只有下行数据。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 2 | DATA_FLOW_TYPE_UP | 表示只有上行数据。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 3 | DATA_FLOW_TYPE_UP_DOWN | 表示有上下行数据。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 4 | DATA_FLOW_TYPE_DORMANT | 表示没有上下行数据，底层链路处于休眠状态。<br />**系统能力**：SystemCapability.Telephony.CellularData |
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CellularData。
## DataConnectState<a name=DataConnectState></a>
| 参数名 | 值 | 说明 |
| ---------------------- | ---- | ------------------------------------------ |
| DATA_FLOW_TYPE_NONE | 0 | 表示没有上行或下行数据。 |
| DATA_FLOW_TYPE_DOWN | 1 | 表示只有下行数据。 |
| DATA_FLOW_TYPE_UP | 2 | 表示只有上行数据。 |
| DATA_FLOW_TYPE_UP_DOWN | 3 | 表示有上下行数据。 |
| DATA_FLOW_TYPE_DORMANT | 4 | 表示没有上下行数据，底层链路处于休眠状态。 |
描述蜂窝数据链路连接状态。
## DataConnectState
| 参数名 | 值 | 说明 |
| ------ | ----------------------- | ------------------------------------------------------------ |
| -1 | DATA_STATE_UNKNOWN | 表示蜂窝数据链路未知。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 0 | DATA_STATE_DISCONNECTED | 表示蜂窝数据链路断开。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 1 | DATA_STATE_CONNECTING | 表示正在连接蜂窝数据链路。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 2 | DATA_STATE_CONNECTED | 表示蜂窝数据链路已连接。<br />**系统能力**：SystemCapability.Telephony.CellularData |
| 3 | DATA_STATE_SUSPENDED | 表示蜂窝数据链路被挂起。<br />**系统能力**：SystemCapability.Telephony.CellularData |
\ No newline at end of file
描述蜂窝数据链路连接状态。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CellularData。
| 参数名 | 值 | 说明 |
| ----------------------- | ---- | -------------------------- |
| DATA_STATE_UNKNOWN | -1 | 表示蜂窝数据链路未知。 |
| DATA_STATE_DISCONNECTED | 0 | 表示蜂窝数据链路断开。 |
| DATA_STATE_CONNECTING | 1 | 表示正在连接蜂窝数据链路。 |
| DATA_STATE_CONNECTED | 2 | 表示蜂窝数据链路已连接。 |
| DATA_STATE_SUSPENDED | 3 | 表示蜂窝数据链路被挂起。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @ b5160e59
......@@ -68,6 +68,8 @@ createWebSocket\(\): WebSocket
创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。
**系统能力：**SystemCapability.Communication.NetStack
**返回值：**
| 类型 | 说明 |
......@@ -93,6 +95,8 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -124,6 +128,8 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -161,6 +167,8 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -196,6 +204,8 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -228,6 +238,8 @@ send\(data: string | ArrayBuffer\): Promise<boolean\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -264,6 +276,8 @@ close\(callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -293,6 +307,8 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -326,6 +342,8 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\>
**需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -361,6 +379,8 @@ on\(type: 'open', callback: AsyncCallback<Object\>\): void
订阅WebSocket的打开事件，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -388,6 +408,8 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -417,6 +439,8 @@ on\(type: 'message', callback: AsyncCallback<string | ArrayBuffer\>\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -445,6 +469,8 @@ off\(type: 'message', callback?: AsyncCallback<string | ArrayBuffer\>\): void
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -466,6 +492,8 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\
订阅WebSocket的关闭事件，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -492,6 +520,8 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -514,6 +544,8 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅WebSocket的Error事件，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -541,6 +573,8 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -560,6 +594,8 @@ ws.off('error');
建立WebSocket连接时，可选参数的类型和说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| header | Object | 否 | 建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。 |
......@@ -569,6 +605,8 @@ ws.off('error');
关闭WebSocket连接时，可选参数的类型和说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| code | number | 否 | 错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。 |
......@@ -578,6 +616,8 @@ ws.off('error');
发送给服务端的错误码可以自行定义，下面的列表仅供参考。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 值 | 说明 |
| :-------- | :----------------- |
| 1000 | 正常关闭 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或