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 @@ ...@@ -51,6 +51,9 @@
- [蜂窝数据](js-apis-telephony-data.md) - [蜂窝数据](js-apis-telephony-data.md)
- 网络管理 - 网络管理
- [网络连接管理](js-apis-net-connection.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) - [WLAN](js-apis-wifi.md)
- [Bluetooth](js-apis-bluetooth.md) - [Bluetooth](js-apis-bluetooth.md)
......
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ b5160e59
...@@ -4,7 +4,6 @@ ...@@ -4,7 +4,6 @@
> >
>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> >
>本模块所有接口需要设备具有系统能力：SystemCapability.Communication.NetStack
## 导入模块 ## 导入模块
...@@ -63,6 +62,8 @@ createHttp\(\): HttpRequest ...@@ -63,6 +62,8 @@ createHttp\(\): HttpRequest
创建一个http，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header 事件。每一个HttpRequest对象对应一个Http请求。如需发起多个Http请求，须为每个Http请求创建对应HttpRequest对象。 创建一个http，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header 事件。每一个HttpRequest对象对应一个Http请求。如需发起多个Http请求，须为每个Http请求创建对应HttpRequest对象。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -89,6 +90,8 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void ...@@ -89,6 +90,8 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -99,7 +102,6 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void ...@@ -99,7 +102,6 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
**示例：** **示例：**
``` ```
let httpRequest = http.createHttp();
httpRequest.request("EXAMPLE_URL", (err, data) => { httpRequest.request("EXAMPLE_URL", (err, data) => {
if (!err) { if (!err) {
console.info('Result:' + data.result); console.info('Result:' + data.result);
...@@ -120,6 +122,8 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR ...@@ -120,6 +122,8 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -131,7 +135,6 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR ...@@ -131,7 +135,6 @@ request\(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpR
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.request("EXAMPLE_URL", httpRequest.request("EXAMPLE_URL",
{ {
method: 'GET', method: 'GET',
...@@ -165,6 +168,8 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\> ...@@ -165,6 +168,8 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -182,7 +187,6 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\> ...@@ -182,7 +187,6 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
let promise = httpRequest.request("EXAMPLE_URL", { let promise = httpRequest.request("EXAMPLE_URL", {
method: "GET", method: "GET",
connectTimeout: 60000, connectTimeout: 60000,
...@@ -211,22 +215,25 @@ destroy\(\): void ...@@ -211,22 +215,25 @@ destroy\(\): void
中断请求任务。 中断请求任务。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.destroy(); httpRequest.destroy();
``` ```
### on\('headerReceive'\) ### on\('headerReceive'\)
on\(type: 'headerReceive', callback: AsyncCallback<Object\>\):void on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void
订阅HTTP Response Header 事件。 订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
> 此接口已废弃，建议使用[on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8)替代。 > 此接口已废弃，建议使用[on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8)替代。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -237,7 +244,6 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\):void ...@@ -237,7 +244,6 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\):void
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => { httpRequest.on('headerReceive', (err, data) => {
if (!err) { if (!err) {
console.info('header: ' + data.header); console.info('header: ' + data.header);
...@@ -250,7 +256,7 @@ httpRequest.on('headerReceive', (err, data) => { ...@@ -250,7 +256,7 @@ httpRequest.on('headerReceive', (err, data) => {
### off\('headerReceive'\) ### off\('headerReceive'\)
off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void
取消订阅HTTP Response Header 事件。 取消订阅HTTP Response Header 事件。
...@@ -260,6 +266,8 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void ...@@ -260,6 +266,8 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void
> >
>2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -270,7 +278,6 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void ...@@ -270,7 +278,6 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\):void
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.on('headerReceive', (err, data) => { httpRequest.on('headerReceive', (err, data) => {
if (!err) { if (!err) {
console.info('header: ' + data.header); console.info('header: ' + data.header);
...@@ -283,10 +290,12 @@ httpRequest.off('headerReceive'); ...@@ -283,10 +290,12 @@ httpRequest.off('headerReceive');
### on\('headersReceive'\)<sup>8+</sup> ### on\('headersReceive'\)<sup>8+</sup>
on\(type: 'headersReceive', callback: Callback<Object\>\):void on\(type: 'headersReceive', callback: Callback<Object\>\): void
订阅HTTP Response Header 事件。 订阅HTTP Response Header 事件。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -297,7 +306,6 @@ on\(type: 'headersReceive', callback: Callback<Object\>\):void ...@@ -297,7 +306,6 @@ on\(type: 'headersReceive', callback: Callback<Object\>\):void
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.on('headersReceive', (data) => { httpRequest.on('headersReceive', (data) => {
console.info('header: ' + data.header); console.info('header: ' + data.header);
}); });
...@@ -306,13 +314,15 @@ httpRequest.on('headersReceive', (data) => { ...@@ -306,13 +314,15 @@ httpRequest.on('headersReceive', (data) => {
### off\('headersReceive'\)<sup>8+</sup> ### off\('headersReceive'\)<sup>8+</sup>
off\(type: 'headersReceive', callback?: Callback<Object\>\):void off\(type: 'headersReceive', callback?: Callback<Object\>\): void
取消订阅HTTP Response Header 事件。 取消订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -323,16 +333,17 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\):void ...@@ -323,16 +333,17 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\):void
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.off('headersReceive'); httpRequest.off('headersReceive');
``` ```
### once\('headersReceive'\)<sup>8+</sup> ### once\('headersReceive'\)<sup>8+</sup>
once\(type: "headersReceive", callback: Callback<Object\>\): void once\(type: 'headersReceive', callback: Callback<Object\>\): void
订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。 订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -343,7 +354,6 @@ once\(type: "headersReceive", callback: Callback<Object\>\): void ...@@ -343,7 +354,6 @@ once\(type: "headersReceive", callback: Callback<Object\>\): void
**示例：** **示例：**
``` ```
let httpRequest= http.createHttp();
httpRequest.once('headersReceive', (data) => { httpRequest.once('headersReceive', (data) => {
console.info('header: ' + data.header); console.info('header: ' + data.header);
}); });
...@@ -353,7 +363,9 @@ httpRequest.once('headersReceive', (data) => { ...@@ -353,7 +363,9 @@ httpRequest.once('headersReceive', (data) => {
发起请求可选参数的类型和取值范围。 发起请求可选参数的类型和取值范围。
| 参数 | 类型 | 必填 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------ | ---- | ---------------------------------------------------------- | | -------------- | ------------------------------------ | ---- | ---------------------------------------------------------- |
| method | [RequestMethod](#requestmethod) | 否 | 请求方式。 | | 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> | | 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) => { ...@@ -365,22 +377,26 @@ httpRequest.once('headersReceive', (data) => {
HTTP 请求方法。 HTTP 请求方法。
| **method 的合法值** | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| :------------------ | :------------------ |
| OPTIONS | HTTP 请求 OPTIONS。 | | 名称 | 值 | 说明 |
| GET | HTTP 请求 GET。 | | :------ | ------- | :------------------ |
| HEAD | HTTP 请求 HEAD。 | | OPTIONS | OPTIONS | HTTP 请求 OPTIONS。 |
| POST | HTTP 请求 POST。 | | GET | GET | HTTP 请求 GET。 |
| PUT | HTTP 请求 PUT。 | | HEAD | HEAD | HTTP 请求 HEAD。 |
| DELETE | HTTP 请求 DELETE。 | | POST | POST | HTTP 请求 POST。 |
| TRACE | HTTP 请求 TRACE。 | | PUT | PUT | HTTP 请求 PUT。 |
| CONNECT | HTTP 请求 CONNECT。 | | DELETE | DELETE | HTTP 请求 DELETE。 |
| TRACE | TRACE | HTTP 请求 TRACE。 |
| CONNECT | CONNECT | HTTP 请求 CONNECT。 |
## ResponseCode ## ResponseCode
发起请求返回的响应码。 发起请求返回的响应码。
| 变量 | 值 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 名称 | 值 | 说明 |
| ----------------- | ---- | ------------------------------------------------------------ | | ----------------- | ---- | ------------------------------------------------------------ |
| OK | 200 | 请求成功。一般用于GET与POST请求。 | | OK | 200 | 请求成功。一般用于GET与POST请求。 |
| CREATED | 201 | 已创建。成功请求并创建了新的资源。 | | CREATED | 201 | 已创建。成功请求并创建了新的资源。 |
...@@ -422,6 +438,8 @@ HTTP 请求方法。 ...@@ -422,6 +438,8 @@ HTTP 请求方法。
request方法回调函数的返回值类型。 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 | | 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) { ...@@ -676,11 +676,13 @@ netConnection.unregister(function (error) {
在调用NetHandle的方法之前，需要先获取NetHandle对象。 在调用NetHandle的方法之前，需要先获取NetHandle对象。
**系统能力**：SystemCapability.Communication.NetManager.Core
### 属性 ### 属性
| 变量 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
| ----- | ------ | ------------------------- | | ------ | ------ | ------------------------- |
| netId | number | 网络ID，必须大于等于100。 | | netId | number | 网络ID，必须大于等于100。 |
### bindSocket ### bindSocket
...@@ -782,7 +784,7 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -782,7 +784,7 @@ connection.getDefaultNet().then(function (netHandle) {
### getAddressesByName ### getAddressesByName
getAddressesByName(netHandle: NetHandle): Promise\<Array\<NetAddress>> getAddressesByName(host: string): Promise\<Array\<NetAddress>>
使用对应网络解析主机名以获取所有IP地址，使用Promise方式作为异步方法。 使用对应网络解析主机名以获取所有IP地址，使用Promise方式作为异步方法。
...@@ -840,7 +842,7 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -840,7 +842,7 @@ connection.getDefaultNet().then(function (netHandle) {
### getAddressByName ### getAddressByName
getAddressByName(netHandle: NetHandle): Promise\<NetAddress> getAddressByName(host: string): Promise\<NetAddress>
使用对应网络解析主机名以获取第一个IP地址，使用Promise方式作为异步方法。 使用对应网络解析主机名以获取第一个IP地址，使用Promise方式作为异步方法。
...@@ -873,7 +875,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -873,7 +875,9 @@ connection.getDefaultNet().then(function (netHandle) {
提供承载数据网络能力的实例。 提供承载数据网络能力的实例。
| 变量 | 类型 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ----------------------- | ----------------------------------- | ------------------------------------------------------------ | | ----------------------- | ----------------------------------- | ------------------------------------------------------------ |
| netCapabilities | [NetCapabilities](#netcapabilities) | 存储数据网络的传输能力和承载类型。 | | netCapabilities | [NetCapabilities](#netcapabilities) | 存储数据网络的传输能力和承载类型。 |
| bearerPrivateIdentifier | string | 网络标识符，WIFI网络的标识符是"wifi"，蜂窝网络的标识符是"slot0"（对应SIM卡1）。 | | bearerPrivateIdentifier | string | 网络标识符，WIFI网络的标识符是"wifi"，蜂窝网络的标识符是"slot0"（对应SIM卡1）。 |
...@@ -882,7 +886,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -882,7 +886,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络的能力集。 网络的能力集。
| 变量 | 类型 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| --------------------- | ---------------------------------- | ------------------------ | | --------------------- | ---------------------------------- | ------------------------ |
| linkUpBandwidthKbps | number | 上行（设备到网络）带宽。 | | linkUpBandwidthKbps | number | 上行（设备到网络）带宽。 |
| linkDownBandwidthKbps | number | 下行（网络到设备）带宽。 | | linkDownBandwidthKbps | number | 下行（网络到设备）带宽。 |
...@@ -893,7 +899,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -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_MMS | 0 | 表示网络可以访问运营商的MMSC（Multimedia&nbsp;Message&nbsp;Service，多媒体短信服务）发送和接收彩信。 |
| NET_CAPABILITY_NOT_METERED | 11 | 表示网络流量未被计费。 | | NET_CAPABILITY_NOT_METERED | 11 | 表示网络流量未被计费。 |
...@@ -905,7 +913,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -905,7 +913,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络类型。 网络类型。
| 变量 | 值 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 名称 | 值 | 说明 |
| --------------- | ---- | ----------- | | --------------- | ---- | ----------- |
| BEARER_CELLULAR | 0 | 蜂窝网络。 | | BEARER_CELLULAR | 0 | 蜂窝网络。 |
| BEARER_WIFI | 1 | Wi-Fi网络。 | | BEARER_WIFI | 1 | Wi-Fi网络。 |
...@@ -915,7 +925,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -915,7 +925,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络连接信息。 网络连接信息。
| 变量 | 类型 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------------- | ---------------------------------- | ---------------- | | ------------- | ---------------------------------- | ---------------- |
| interfaceName | string | 网卡名称。 | | interfaceName | string | 网卡名称。 |
| domains | string | 所属域，默认""。 | | domains | string | 所属域，默认""。 |
...@@ -928,7 +940,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -928,7 +940,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络链路信息。 网络链路信息。
| 变量 | 类型 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------------ | ------------------------- | -------------------- | | ------------ | ------------------------- | -------------------- |
| address | [NetAddress](#netaddress) | 链路地址。 | | address | [NetAddress](#netaddress) | 链路地址。 |
| prefixLength | number | 链路地址前缀的长度。 | | prefixLength | number | 链路地址前缀的长度。 |
...@@ -937,7 +951,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -937,7 +951,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络路由信息。 网络路由信息。
| 变量 | 类型 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| -------------- | --------------------------- | ---------------- | | -------------- | --------------------------- | ---------------- |
| interface | string | 网卡名称。 | | interface | string | 网卡名称。 |
| destination | [LinkAddress](#linkaddress) | 目的地址。 | | destination | [LinkAddress](#linkaddress) | 目的地址。 |
...@@ -949,7 +965,9 @@ connection.getDefaultNet().then(function (netHandle) { ...@@ -949,7 +965,9 @@ connection.getDefaultNet().then(function (netHandle) {
网络地址。 网络地址。
| 变量 | 类型 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------- | ------ | ------------------------------ | | ------- | ------ | ------------------------------ |
| address | string | 地址。 | | address | string | 地址。 |
| family | number | IPv4 = 1，IPv6 = 2，默认IPv4。 | | family | number | IPv4 = 1，IPv6 = 2，默认IPv4。 |
......
zh-cn/application-dev/reference/apis/js-apis-sim.md
浏览文件 @ b5160e59
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
>**说明：** >**说明：**
> >
>本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
## 导入模块 ## 导入模块
...@@ -10,13 +11,13 @@ ...@@ -10,13 +11,13 @@
import sim from '@ohos.telephony.sim'; 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 isSimActive\(slotId: number, callback: AsyncCallback<boolean\>\): void
获取指定卡槽SIM卡是否激活，使用callback方式作为异步方法。 获取指定卡槽SIM卡是否激活，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
...@@ -34,13 +35,13 @@ sim.isSimActive(0, (err, data) => { ...@@ -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方式作为异步方法。 获取指定卡槽SIM卡是否激活，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
...@@ -66,12 +67,14 @@ promise.then(data => { ...@@ -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 getDefaultVoiceSlotId\(callback: AsyncCallback<number\>\): void
获取默认语音业务的卡槽ID，使用callback方式作为异步方法。 获取默认语音业务的卡槽ID，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -87,12 +90,14 @@ sim.getDefaultVoiceSlotId((err, data) => { ...@@ -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\> getDefaultVoiceSlotId\(\): Promise<number\>
获取默认语音业务的卡槽ID，使用Promise方式作为异步方法。 获取默认语音业务的卡槽ID，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -110,13 +115,68 @@ promise.then(data => { ...@@ -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 getISOCountryCodeForSim\(slotId: number, callback: AsyncCallback<string\>\): void
获取指定卡槽SIM卡的ISO国家码，使用callback方式作为异步方法。 获取指定卡槽SIM卡的ISO国家码，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -133,12 +193,14 @@ sim.getISOCountryCodeForSim(0, (err, data) => { ...@@ -133,12 +193,14 @@ sim.getISOCountryCodeForSim(0, (err, data) => {
``` ```
## sim.getISOCountryCodeForSim<a name=sim.getISOCountryCodeForSim-promise></a> ## sim.getISOCountryCodeForSim
getISOCountryCodeForSim\(slotId: number\): Promise<string\> getISOCountryCodeForSim\(slotId: number\): Promise<string\>
获取指定卡槽SIM卡的ISO国家码，使用Promise方式作为异步方法。 获取指定卡槽SIM卡的ISO国家码，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -163,12 +225,14 @@ promise.then(data => { ...@@ -163,12 +225,14 @@ promise.then(data => {
``` ```
## sim.getSimOperatorNumeric<a name=sim.getSimOperatorNumeric-callback></a> ## sim.getSimOperatorNumeric
getSimOperatorNumeric\(slotId: number, callback: AsyncCallback<string\>\): void getSimOperatorNumeric\(slotId: number, callback: AsyncCallback<string\>\): void
获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用callback方式作为异步方法。 获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -185,12 +249,14 @@ sim.getSimOperatorNumeric(0, (err, data) => { ...@@ -185,12 +249,14 @@ sim.getSimOperatorNumeric(0, (err, data) => {
``` ```
## sim.getSimOperatorNumeric<a name=sim.getSimOperatorNumeric-promise></a> ## sim.getSimOperatorNumeric
getSimOperatorNumeric\(slotId: number\): Promise<string\> getSimOperatorNumeric\(slotId: number\): Promise<string\>
获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用Promise方式作为异步方法。 获取指定卡槽SIM卡的归属PLMN（Public Land Mobile Network）号，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -215,12 +281,14 @@ promise.then(data => { ...@@ -215,12 +281,14 @@ promise.then(data => {
``` ```
## sim.getSimSpn<a name=sim.getSimSpn-callback></a> ## sim.getSimSpn
getSimSpn\(slotId: number, callback: AsyncCallback<string\>\): void getSimSpn\(slotId: number, callback: AsyncCallback<string\>\): void
获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用callback方式作为异步方法。 获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -237,12 +305,14 @@ sim.getSimSpn(0, (err, data) => { ...@@ -237,12 +305,14 @@ sim.getSimSpn(0, (err, data) => {
``` ```
## sim.getSimSpn<a name=sim.getSimSpn-promise></a> ## sim.getSimSpn
getSimSpn\(slotId: number\): Promise<string\> getSimSpn\(slotId: number\): Promise<string\>
获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用Promise方式作为异步方法。 获取指定卡槽SIM卡的服务提供商名称（Service Provider Name，SPN），使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -267,18 +337,20 @@ promise.then(data => { ...@@ -267,18 +337,20 @@ promise.then(data => {
``` ```
## sim.getSimState<a name=sim.getSimState-callback></a> ## sim.getSimState
getSimState\(slotId: number, callback: AsyncCallback<SimState\>\): void getSimState\(slotId: number, callback: AsyncCallback<SimState\>\): void
获取指定卡槽的SIM卡状态，使用callback方式作为异步方法。 获取指定卡槽的SIM卡状态，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------- | ---- | -------------------------------------- | | -------- | -------------------------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 | | 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) => { ...@@ -289,12 +361,14 @@ sim.getSimState(0, (err, data) => {
``` ```
## sim.getSimState<a name=sim.getSimState-promise></a> ## sim.getSimState
getSimState\(slotId: number\): Promise<SimState\> getSimState\(slotId: number\): Promise<SimState\>
获取指定卡槽的SIM卡状态，使用Promise方式作为异步方法。 获取指定卡槽的SIM卡状态，使用Promise方式作为异步方法。
**系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -305,7 +379,7 @@ getSimState\(slotId: number\): Promise<SimState\> ...@@ -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 => { ...@@ -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 getCardType\(slotId: number, callback: AsyncCallback<CardType\>\): void
获取指定卡槽SIM卡的卡类型，使用callback方式作为异步方法。 获取指定卡槽SIM卡的卡类型，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- | | -------- | ----------------------- | ---- | -------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 | | 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) => { ...@@ -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\> getCardType\(slotId: number\): Promise<CardType\>
获取指定卡槽SIM卡的卡类型，使用Promise方式作为异步方法。 获取指定卡槽SIM卡的卡类型，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
...@@ -360,7 +434,7 @@ getCardType\(slotId: number\): Promise<CardType\> ...@@ -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 => { ...@@ -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 hasSimCard\(slotId: number, callback: AsyncCallback<boolean\>\): void
获取指定卡槽SIM卡是否插卡，使用callback方式作为异步方法。 获取指定卡槽SIM卡是否插卡，使用callback方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
...@@ -398,13 +472,13 @@ sim.hasSimCard(0, (err, data) => { ...@@ -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方式作为异步方法。 获取指定卡槽SIM卡是否插卡，使用Promise方式作为异步方法。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**参数：** **参数：**
...@@ -430,13 +504,13 @@ promise.then(data => { ...@@ -430,13 +504,13 @@ promise.then(data => {
``` ```
## sim.getMaxSimCount ## sim.getMaxSimCount<sup>7+</sup>
getMaxSimCount\(\): number getMaxSimCount\(\): number
获取卡槽数量。 获取卡槽数量。
**需要权限**：ohos.permission.GET_TELEPHONY_STATE **系统能力：**SystemCapability.Communication.CoreService
**返回值：** **返回值：**
...@@ -451,32 +525,36 @@ console.log(sim.getMaxSimCount()) ...@@ -451,32 +525,36 @@ console.log(sim.getMaxSimCount())
``` ```
## SimState<a name=SimState></a> ## SimState
SIM卡状态。 SIM卡状态。
| 变量 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CoreService。
| --------------------- | ---------------------------------------------------------- |
| 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卡在位且所有卡文件加载完毕。 |
## 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 | 未知类型 | |UNKNOWN_CARD | -1 | 未知类型 |
SINGLE_MODE_SIM_CARD | 10 | 单SIM卡 | |SINGLE_MODE_SIM_CARD | 10 | 单SIM卡 |
SINGLE_MODE_USIM_CARD | 20 | 单USIM卡 | |SINGLE_MODE_USIM_CARD | 20 | 单USIM卡 |
SINGLE_MODE_RUIM_CARD | 30 | 单RUIM卡 | |SINGLE_MODE_RUIM_CARD | 30 | 单RUIM卡 |
DUAL_MODE_CG_CARD | 40 | 双卡模式C+G | |DUAL_MODE_CG_CARD | 40 | 双卡模式C+G |
CT_NATIONAL_ROAMING_CARD | 41 | 中国电信内部漫游卡 | |CT_NATIONAL_ROAMING_CARD | 41 | 中国电信内部漫游卡 |
CU_DUAL_MODE_CARD | 42 | 中国联通双模卡 | |CU_DUAL_MODE_CARD | 42 | 中国联通双模卡 |
DUAL_MODE_TELECOM_LTE_CARD | 43 | 双模式电信LTE卡 | |DUAL_MODE_TELECOM_LTE_CARD | 43 | 双模式电信LTE卡 |
DUAL_MODE_UG_CARD | 50 | 双模式UG卡 | |DUAL_MODE_UG_CARD | 50 | 双模式UG卡 |
SINGLE_MODE_ISIM_CARD | 60 | 单一ISIM卡类型 | |SINGLE_MODE_ISIM_CARD | 60 | 单一ISIM卡类型 |
\ No newline at end of file \ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-sms.md
浏览文件 @ b5160e59
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
import sms from '@ohos.telephony.sms'; 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 createMessage\(pdu: Array<number\>, specification: string, callback: AsyncCallback<ShortMessage\>\): void
...@@ -24,7 +24,7 @@ createMessage\(pdu: Array<number\>, specification: string, callback: AsyncCallba ...@@ -24,7 +24,7 @@ createMessage\(pdu: Array<number\>, specification: string, callback: AsyncCallba
| ------------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ | | ------------- | -------------------------------------------------- | ---- | ------------------------------------------------------------ |
| pdu | Array&lt;number&gt; | 是 | 协议数据单元，从收到的信息中获取。 | | pdu | Array&lt;number&gt; | 是 | 协议数据单元，从收到的信息中获取。 |
| specification | string | 是 | 短信协议类型。<br/>- 3gpp表示GSM/UMTS/LTE SMS<br/>- 3gpp2表示CDMA SMS | | 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) => { ...@@ -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\> createMessage\(pdu: Array<number\>, specification: string\): Promise<ShortMessage\>
...@@ -57,7 +57,7 @@ createMessage\(pdu: Array<number\>, specification: string\): Promise<ShortMessag ...@@ -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 ...@@ -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); ...@@ -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 getDefaultSmsSlotId\(callback: AsyncCallback<number\>\): void
...@@ -131,7 +131,7 @@ sms.getDefaultSmsSlotId((err, data) => { ...@@ -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\> getDefaultSmsSlotId\(\): Promise<number\>
...@@ -157,7 +157,7 @@ promise.then(data => { ...@@ -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 setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback<void\>\): void
...@@ -167,6 +167,8 @@ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback<void\>\): ...@@ -167,6 +167,8 @@ setSmscAddr\(slotId: number, smscAddr: string, callback: AsyncCallback<void\>\):
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：SystemCapability.Telephony.SmsMms
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -186,7 +188,7 @@ sms.setSmscAddr(slotId, smscAddr, (err,data) => { ...@@ -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\> setSmscAddr\(slotId: number, smscAddr: string\): Promise<void\>
...@@ -196,6 +198,8 @@ setSmscAddr\(slotId: number, smscAddr: string\): Promise<void\> ...@@ -196,6 +198,8 @@ setSmscAddr\(slotId: number, smscAddr: string\): Promise<void\>
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：SystemCapability.Telephony.SmsMms
**系统API**：该接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -223,7 +227,7 @@ promise.then(data => { ...@@ -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 getSmscAddr\(slotId: number, callback: AsyncCallback<string\>\): void
...@@ -233,7 +237,7 @@ getSmscAddr\(slotId: number, callback: AsyncCallback<string\>\): void ...@@ -233,7 +237,7 @@ getSmscAddr\(slotId: number, callback: AsyncCallback<string\>\): void
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：SystemCapability.Telephony.SmsMms
**补充说明**：该接口为systemapi，仅供系统应用使用 **系统API**：该接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
...@@ -252,7 +256,7 @@ sms.getSmscAddr(slotId, (err, data) => { ...@@ -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\> getSmscAddr\(slotId: number\): Promise<string\>
...@@ -262,7 +266,7 @@ getSmscAddr\(slotId: number\): Promise<string\> ...@@ -262,7 +266,7 @@ getSmscAddr\(slotId: number\): Promise<string\>
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：SystemCapability.Telephony.SmsMms
**补充说明**：该接口为systemapi，仅供系统应用使用 **系统API**：该接口为系统接口，三方应用不支持调用。
**参数：** **参数：**
...@@ -288,7 +292,7 @@ promise.then(data => { ...@@ -288,7 +292,7 @@ promise.then(data => {
}); });
``` ```
## sms.hasSmsCapability<sup>7+</sup><a name=sms.hasSmsCapability></a> ## sms.hasSmsCapability<sup>7+</sup>
hasSmsCapability(): boolean hasSmsCapability(): boolean
...@@ -307,18 +311,18 @@ let result = sms.hasSmsCapability(); ...@@ -307,18 +311,18 @@ let result = sms.hasSmsCapability();
console.log(`hasSmsCapability: ${JSON.stringify(result)}`); 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消息的短消息中心进行回复。 | | hasReplyPath | boolean | 收到的短信是否包含“TP-Reply-Path”，默认为false。<br/>“TP-Reply-Path”：移动电话根据发送SMS消息的短消息中心进行回复。 |
| isReplaceMessage | boolean | 收到的短信是否为“替换短信”，默认为false。<br/>“替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。 | | isReplaceMessage | boolean | 收到的短信是否为“替换短信”，默认为false。<br/>“替换短信”有关详细信息，参见 “3GPP TS 23.040 9.2.3.9”。 |
| isSmsStatusReportMessage | boolean | 当前消息是否为“短信状态报告”，默认为false。<br/>“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。 | | isSmsStatusReportMessage | boolean | 当前消息是否为“短信状态报告”，默认为false。<br/>“短信状态报告”是一种特定格式的短信，被用来从Service Center到Mobile Station传送状态报告。 |
| messageClass | [ShortMessageClass](#ShortMessageClass) | 短信类型。 | | messageClass | [ShortMessageClass](#shortmessageclass) | 短信类型。 |
| pdu | Array&lt;number&gt; | SMS消息中的协议数据单元 （PDU）。 | | pdu | Array&lt;number&gt; | SMS消息中的协议数据单元 （PDU）。 |
| protocolId | number | 发送短信时使用的协议标识。 | | protocolId | number | 发送短信时使用的协议标识。 |
| scAddress | string | 短消息服务中心（SMSC）地址。 | | scAddress | string | 短消息服务中心（SMSC）地址。 |
...@@ -328,26 +332,26 @@ console.log(`hasSmsCapability: ${JSON.stringify(result)}`); ...@@ -328,26 +332,26 @@ console.log(`hasSmsCapability: ${JSON.stringify(result)}`);
| visibleRawAddress | string | 发送者地址。 | | visibleRawAddress | string | 发送者地址。 |
## ShortMessageClass<a name=ShortMessageClass></a> ## ShortMessageClass
短信类型。 短信类型。
| 变量 | 值 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| ---------------- | ---- | ------------------------------------------------------------ |
| 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 |
| 名称 | 值 | 说明 |
| ---------------- | ---- | ---------------------------------------- |
| 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)}`); ...@@ -356,41 +360,41 @@ console.log(`hasSmsCapability: ${JSON.stringify(result)}`);
| content | string \| Array&lt;number&gt; | 是 | 如果内容是字符串，则这是一条文本短信。如果内容是字节数组，则这是一条数据短信。 | | content | string \| Array&lt;number&gt; | 是 | 如果内容是字符串，则这是一条文本短信。如果内容是字节数组，则这是一条数据短信。 |
| serviceCenter | string | 否 | 短信中心地址。默认使用SIM卡中的短信中心地址。 | | serviceCenter | string | 否 | 短信中心地址。默认使用SIM卡中的短信中心地址。 |
| destinationPort | number | 否 | 如果发送数据消息，destinationPort 是必需的。否则是可选的。 | | destinationPort | number | 否 | 如果发送数据消息，destinationPort 是必需的。否则是可选的。 |
| sendCallback | AsyncCallback&lt;[ISendShortMessageCallback](#ISendShortMessageCallback)&gt; | 否 | 短信发送结果回调，返回短信发送的结果，参考[ISendShortMessageCallback](#ISendShortMessageCallback)。 | | sendCallback | AsyncCallback&lt;[ISendShortMessageCallback](#isendshortmessagecallback)&gt; | 否 | 短信发送结果回调，返回短信发送的结果，参考[ISendShortMessageCallback](#isendshortmessagecallback)。 |
| deliveryCallback | AsyncCallback&lt;[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)&gt; | 否 | 短信送达结果回调，返回短信递送报告，参考[IDeliveryShortMessageCallback](#IDeliveryShortMessageCallback)。 | | deliveryCallback | AsyncCallback&lt;[IDeliveryShortMessageCallback](#ideliveryshortmessagecallback)&gt; | 否 | 短信送达结果回调，返回短信递送报告，参考[IDeliveryShortMessageCallback](#ideliveryshortmessagecallback)。 |
## ISendShortMessageCallback<a name=ISendShortMessageCallback></a> ## ISendShortMessageCallback
回调实例。返回短信发送结果、存储已发送短信的URI和是否为长短信的最后一部分。 回调实例。返回短信发送结果、存储已发送短信的URI和是否为长短信的最后一部分。
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------- | ---- | ------------------------------------------------------------ | | ---------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| isLastPart | boolean | 否 | 指定这是否是长短信的最后一部分。true表示这是长短信的最后一部分，false表示不是。默认为false。 | | isLastPart | boolean | 否 | 指定这是否是长短信的最后一部分。true表示这是长短信的最后一部分，false表示不是。默认为false。 |
| result | [SendSmsResult](#SendSmsResult) | 是 | 短信发送结果。 | | result | [SendSmsResult](#sendsmsresult) | 是 | 短信发送结果。 |
| url | string | 是 | 存储发送短信的URI。 | | url | string | 是 | 存储发送短信的URI。 |
## IDeliveryShortMessageCallback<a name=IDeliveryShortMessageCallback></a> ## IDeliveryShortMessageCallback
回调实例。返回短信送达报告。 回调实例。返回短信送达报告。
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------------------- | ---- | -------------- | | ------ | ------------------- | ---- | -------------- |
| pdu | Array&lt;number&gt; | 是 | 短信送达报告。 | | pdu | Array&lt;number&gt; | 是 | 短信送达报告。 |
## SendSmsResult<a name=SendSmsResult></a> ## SendSmsResult
短信发送结果。 短信发送结果。
**系统能力**：SystemCapability.Telephony.SmsMms **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.SmsMms。
| 参数名 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------------------------ | ---- | ------------------------------------------------------ | | ------------------------------------ | ---- | ------------------------------------------------------ |
| SEND_SMS_SUCCESS | 0 | 发送短信成功。 | | SEND_SMS_SUCCESS | 0 | 发送短信成功。 |
| SEND_SMS_FAILURE_UNKNOWN | 1 | 发送短信失败，原因未知。 | | SEND_SMS_FAILURE_UNKNOWN | 1 | 发送短信失败，原因未知。 |
......
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ b5160e59
...@@ -4,7 +4,6 @@ ...@@ -4,7 +4,6 @@
> >
>本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> >
>本模块所有接口需要设备具有系统能力：SystemCapability.Communication.NetStack
## 导入模块 ## 导入模块
...@@ -12,16 +11,14 @@ ...@@ -12,16 +11,14 @@
import socket from '@ohos.net.socket'; import socket from '@ohos.net.socket';
``` ```
## 权限列表
ohos.permission.INTERNET
## socket.constructUDPSocketInstance ## socket.constructUDPSocketInstance
constructUDPSocketInstance\(\): UDPSocket constructUDPSocketInstance\(\): UDPSocket
创建一个UDPSocket对象。 创建一个UDPSocket对象。
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -48,6 +45,8 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void ...@@ -48,6 +45,8 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -77,6 +76,8 @@ bind\(address: NetAddress\): Promise<void\> ...@@ -77,6 +76,8 @@ bind\(address: NetAddress\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -111,6 +112,8 @@ send\(options: UDPSendOptions, callback: AsyncCallback<void\>\): void ...@@ -111,6 +112,8 @@ send\(options: UDPSendOptions, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -147,6 +150,8 @@ send\(options: UDPSendOptions\): Promise<void\> ...@@ -147,6 +150,8 @@ send\(options: UDPSendOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -187,6 +192,8 @@ close\(callback: AsyncCallback<void\>\): void ...@@ -187,6 +192,8 @@ close\(callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -215,6 +222,8 @@ close\(\): Promise<void\> ...@@ -215,6 +222,8 @@ close\(\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -245,6 +254,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void ...@@ -245,6 +254,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -283,6 +294,8 @@ getState\(\): Promise<SocketStateBase\> ...@@ -283,6 +294,8 @@ getState\(\): Promise<SocketStateBase\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -320,6 +333,8 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi ...@@ -320,6 +333,8 @@ setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): voi
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -366,6 +381,8 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\> ...@@ -366,6 +381,8 @@ setExtraOptions\(options: UDPExtraOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -409,6 +426,8 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock ...@@ -409,6 +426,8 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。 订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -421,7 +440,7 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock ...@@ -421,7 +440,7 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
``` ```
let udp = socket.constructUDPSocketInstance(); let udp = socket.constructUDPSocketInstance();
udp.on('message', value => { 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 ...@@ -435,6 +454,8 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -447,7 +468,7 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So ...@@ -447,7 +468,7 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
``` ```
let udp = socket.constructUDPSocketInstance(); let udp = socket.constructUDPSocketInstance();
let callback = value =>{ 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); udp.on('message', callback);
// 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 // 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
...@@ -462,6 +483,8 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void ...@@ -462,6 +483,8 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void
订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。 订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -474,7 +497,7 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void ...@@ -474,7 +497,7 @@ on\(type: 'listening' | 'close', callback: Callback<void\>\): void
``` ```
let udp = socket.constructUDPSocketInstance(); let udp = socket.constructUDPSocketInstance();
udp.on('listening', () => { udp.on('listening', () => {
console.log("on listening success")); console.log("on listening success");
}); });
udp.on('close', () => { udp.on('close', () => {
console.log("on close success" ); console.log("on close success" );
...@@ -491,6 +514,8 @@ off\(type: 'listening' | 'close', callback?: Callback<void\>\): void ...@@ -491,6 +514,8 @@ off\(type: 'listening' | 'close', callback?: Callback<void\>\): void
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -525,6 +550,8 @@ on\(type: 'error', callback: ErrorCallback\): void ...@@ -525,6 +550,8 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅UDPSocket连接的error事件。使用callback方式作为异步方法。 订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -552,6 +579,8 @@ off\(type: 'error', callback?: ErrorCallback\): void ...@@ -552,6 +579,8 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -577,6 +606,8 @@ udp.off('error'); ...@@ -577,6 +606,8 @@ udp.off('error');
目标地址信息。 目标地址信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ | | ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 | | address | string | 是 | 本地绑定的ip地址。 |
...@@ -587,6 +618,8 @@ udp.off('error'); ...@@ -587,6 +618,8 @@ udp.off('error');
UDPSocket发送参数。 UDPSocket发送参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------- | | ------- | ---------------------------------- | ---- | -------------- |
| data | string | 是 | 发送的数据。 | | data | string | 是 | 发送的数据。 |
...@@ -596,6 +629,8 @@ UDPSocket发送参数。 ...@@ -596,6 +629,8 @@ UDPSocket发送参数。
UDPSocket连接的其他属性。 UDPSocket连接的其他属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | -------------------------------- | | ----------------- | ------- | ---- | -------------------------------- |
| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 | | broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
...@@ -608,6 +643,8 @@ UDPSocket连接的其他属性。 ...@@ -608,6 +643,8 @@ UDPSocket连接的其他属性。
Socket的状态信息。 Socket的状态信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | ---------- | | ----------- | ------- | ---- | ---------- |
| isBound | boolean | 是 | 是否绑定。 | | isBound | boolean | 是 | 是否绑定。 |
...@@ -618,6 +655,8 @@ Socket的状态信息。 ...@@ -618,6 +655,8 @@ Socket的状态信息。
Socket的连接信息。 Socket的连接信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ | | ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 | | address | string | 是 | 本地绑定的ip地址。 |
...@@ -631,6 +670,8 @@ constructTCPSocketInstance\(\): TCPSocket ...@@ -631,6 +670,8 @@ constructTCPSocketInstance\(\): TCPSocket
创建一个TCPSocket对象。 创建一个TCPSocket对象。
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -656,6 +697,8 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void ...@@ -656,6 +697,8 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -680,12 +723,14 @@ tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { ...@@ -680,12 +723,14 @@ tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### bind ### bind
bind\(address NetAddress\): Promise<void\> bind\(address: NetAddress\): Promise<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。 绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -719,6 +764,8 @@ connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void ...@@ -719,6 +764,8 @@ connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -748,6 +795,8 @@ connect\(options: TCPConnectOptions\): Promise<void\> ...@@ -748,6 +795,8 @@ connect\(options: TCPConnectOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -784,6 +833,8 @@ send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void ...@@ -784,6 +833,8 @@ send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -824,6 +875,8 @@ send\(options: TCPSendOptions\): Promise<void\> ...@@ -824,6 +875,8 @@ send\(options: TCPSendOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -865,6 +918,8 @@ close\(callback: AsyncCallback<void\>\): void ...@@ -865,6 +918,8 @@ close\(callback: AsyncCallback<void\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -894,6 +949,8 @@ close\(\): Promise<void\> ...@@ -894,6 +949,8 @@ close\(\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -924,6 +981,8 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void ...@@ -924,6 +981,8 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -961,6 +1020,8 @@ getRemoteAddress\(\): Promise<NetAddress\> ...@@ -961,6 +1020,8 @@ getRemoteAddress\(\): Promise<NetAddress\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -997,6 +1058,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void ...@@ -997,6 +1058,8 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1035,6 +1098,8 @@ getState\(\): Promise<SocketStateBase\> ...@@ -1035,6 +1098,8 @@ getState\(\): Promise<SocketStateBase\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -1072,6 +1137,8 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi ...@@ -1072,6 +1137,8 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1090,7 +1157,7 @@ promise.then(() => { ...@@ -1090,7 +1157,7 @@ promise.then(() => {
keepAlive: true, keepAlive: true,
OOBInline: true, OOBInline: true,
TCPNoDelay: true, TCPNoDelay: true,
socketLinger: { on:true, linger:10 } socketLinger: { on:true, linger:10 },
receiveBufferSize: 1000, receiveBufferSize: 1000,
sendBufferSize: 1000, sendBufferSize: 1000,
reuseAddress: true, reuseAddress: true,
...@@ -1119,6 +1186,8 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\> ...@@ -1119,6 +1186,8 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1143,7 +1212,7 @@ promise.then(() => { ...@@ -1143,7 +1212,7 @@ promise.then(() => {
keepAlive: true, keepAlive: true,
OOBInline: true, OOBInline: true,
TCPNoDelay: true, TCPNoDelay: true,
socketLinger: { on:true, linger:10 } socketLinger: { on:true, linger:10 },
receiveBufferSize: 1000, receiveBufferSize: 1000,
sendBufferSize: 1000, sendBufferSize: 1000,
reuseAddress: true, reuseAddress: true,
...@@ -1166,6 +1235,8 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock ...@@ -1166,6 +1235,8 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。 订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1192,6 +1263,8 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So ...@@ -1192,6 +1263,8 @@ off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: So
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1219,6 +1292,8 @@ on\(type: 'connect' | 'close', callback: Callback<void\>\): void ...@@ -1219,6 +1292,8 @@ on\(type: 'connect' | 'close', callback: Callback<void\>\): void
订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。 订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1242,13 +1317,15 @@ tcp.on('close', data => { ...@@ -1242,13 +1317,15 @@ tcp.on('close', data => {
### off\('connect' | 'close'\) ### off\('connect' | 'close'\)
off\(type: 'connect' | 'close', callback: Callback<void\>\): void off\(type: 'connect' | 'close', callback?: Callback<void\>\): void
取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。 取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1283,6 +1360,8 @@ on\(type: 'error', callback: ErrorCallback\): void ...@@ -1283,6 +1360,8 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅TCPSocket连接的error事件。使用callback方式作为异步方法。 订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1309,6 +1388,8 @@ off\(type: 'error', callback?: ErrorCallback\): void ...@@ -1309,6 +1388,8 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -1334,6 +1415,8 @@ tcp.off('error'); ...@@ -1334,6 +1415,8 @@ tcp.off('error');
TCPSocket连接的参数。 TCPSocket连接的参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------------------- | | ------- | ---------------------------------- | ---- | -------------------------- |
| address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 | | address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 |
...@@ -1343,6 +1426,8 @@ TCPSocket连接的参数。 ...@@ -1343,6 +1426,8 @@ TCPSocket连接的参数。
TCPSocket发送请求的参数。 TCPSocket发送请求的参数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ | | -------- | ------ | ---- | ------------------------------------------------------------ |
| data | string | 是 | 发送的数据。 | | data | string | 是 | 发送的数据。 |
...@@ -1352,6 +1437,8 @@ TCPSocket发送请求的参数。 ...@@ -1352,6 +1437,8 @@ TCPSocket发送请求的参数。
TCPSocket连接的其他属性。 TCPSocket连接的其他属性。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | ------------------------------------------------------------ | | ----------------- | ------- | ---- | ------------------------------------------------------------ |
| keepAlive | boolean | 否 | 是否保持连接。默认为false。 | | keepAlive | boolean | 否 | 是否保持连接。默认为false。 |
......
zh-cn/application-dev/reference/apis/js-apis-telephony-data.md
浏览文件 @ b5160e59
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
import data from '@ohos.telephony.data'; import data from '@ohos.telephony.data';
``` ```
## data.getDefaultCellularDataSlotId<a name=data.getDefaultCellularDataSlotId-callback></a> ## data.getDefaultCellularDataSlotId
getDefaultCellularDataSlotId(callback: AsyncCallback\<number\>): void getDefaultCellularDataSlotId(callback: AsyncCallback\<number\>): void
...@@ -34,7 +34,7 @@ data.getDefaultCellularDataSlotId((err, data) => { ...@@ -34,7 +34,7 @@ data.getDefaultCellularDataSlotId((err, data) => {
}); });
``` ```
## data.getDefaultCellularDataSlotId<a name=data.getDefaultCellularDataSlotId-promise></a> ## data.getDefaultCellularDataSlotId
getDefaultCellularDataSlotId(): Promise\<number\> getDefaultCellularDataSlotId(): Promise\<number\>
...@@ -61,7 +61,7 @@ promise.then((data) => { ...@@ -61,7 +61,7 @@ promise.then((data) => {
}); });
``` ```
## data.getCellularDataFlowType<a name=data.getCellularDataFlowType-callback></a> ## data.getCellularDataFlowType
getCellularDataFlowType(callback: AsyncCallback\<DataFlowType\>): void getCellularDataFlowType(callback: AsyncCallback\<DataFlowType\>): void
...@@ -73,7 +73,7 @@ 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) => { ...@@ -83,7 +83,7 @@ data.getCellularDataFlowType((err, data) => {
}); });
``` ```
## data.getCellularDataFlowType<a name=data.getCellularDataFlowType-promise></a> ## data.getCellularDataFlowType
getCellularDataFlowType(): Promise\<DataFlowType\> getCellularDataFlowType(): Promise\<DataFlowType\>
...@@ -95,7 +95,7 @@ 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) => { ...@@ -108,7 +108,7 @@ promise.then((data) => {
}); });
``` ```
## data.getCellularDataState<a name=data.getCellularDataState-callback></a> ## data.getCellularDataState
getCellularDataState(callback: AsyncCallback\<DataConnectState\>): void getCellularDataState(callback: AsyncCallback\<DataConnectState\>): void
...@@ -120,7 +120,7 @@ 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) => { ...@@ -130,7 +130,7 @@ data.getCellularDataState((err, data) => {
}); });
``` ```
## data.getCellularDataState<a name=data.getCellularDataState-promise></a> ## data.getCellularDataState
getCellularDataState(): Promise\<DataConnectState\> getCellularDataState(): Promise\<DataConnectState\>
...@@ -142,7 +142,7 @@ 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) => { ...@@ -155,7 +155,7 @@ promise.then((data) => {
}); });
``` ```
## data.isCellularDataEnabled<a name=data.isCellularDataEnabled-callback></a> ## data.isCellularDataEnabled
isCellularDataEnabled(callback: AsyncCallback\<boolean\>): void isCellularDataEnabled(callback: AsyncCallback\<boolean\>): void
...@@ -179,7 +179,7 @@ data.isCellularDataEnabled((err, data) => { ...@@ -179,7 +179,7 @@ data.isCellularDataEnabled((err, data) => {
}); });
``` ```
## data.isCellularDataEnabled<a name=data.isCellularDataEnabled-promise></a> ## data.isCellularDataEnabled
isCellularDataEnabled(): Promise\<boolean\> isCellularDataEnabled(): Promise\<boolean\>
...@@ -206,7 +206,7 @@ promise.then((data) => { ...@@ -206,7 +206,7 @@ promise.then((data) => {
}); });
``` ```
## data.isCellularDataRoamingEnabled<a name=data.isCellularDataRoamingEnabled-callback></a> ## data.isCellularDataRoamingEnabled
isCellularDataRoamingEnabled(slotId: number, callback: AsyncCallback\<boolean\>): void isCellularDataRoamingEnabled(slotId: number, callback: AsyncCallback\<boolean\>): void
...@@ -231,7 +231,7 @@ data.isCellularDataRoamingEnabled(0,(err, data) => { ...@@ -231,7 +231,7 @@ data.isCellularDataRoamingEnabled(0,(err, data) => {
}); });
``` ```
## data.isCellularDataRoamingEnabled<a name=data.isCellularDataRoamingEnabled-promise></a> ## data.isCellularDataRoamingEnabled
isCellularDataRoamingEnabled(slotId: number): Promise\<boolean\> isCellularDataRoamingEnabled(slotId: number): Promise\<boolean\>
...@@ -264,26 +264,30 @@ promise.then((data) => { ...@@ -264,26 +264,30 @@ promise.then((data) => {
}); });
``` ```
## DataFlowType<a name=DataFlowType></a> ## DataFlowType
描述蜂窝数据流类型。 描述蜂窝数据流类型。
| 参数名 | 值 | 说明 | **系统能力**：以下各项对应的系统能力均为SystemCapability.Telephony.CellularData。
| ------ | ---------------------- | ------------------------------------------------------------ |
| 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 |
## 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 | **系统能力**：以下各项对应的系统能力均为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 | | DATA_STATE_UNKNOWN | -1 | 表示蜂窝数据链路未知。 |
\ No newline at end of file | 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 ...@@ -68,6 +68,8 @@ createWebSocket\(\): WebSocket
创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。 创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。
**系统能力：**SystemCapability.Communication.NetStack
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -93,6 +95,8 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void ...@@ -93,6 +95,8 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -124,6 +128,8 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback< ...@@ -124,6 +128,8 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -161,6 +167,8 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\> ...@@ -161,6 +167,8 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -196,6 +204,8 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void ...@@ -196,6 +204,8 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -228,6 +238,8 @@ send\(data: string | ArrayBuffer\): Promise<boolean\> ...@@ -228,6 +238,8 @@ send\(data: string | ArrayBuffer\): Promise<boolean\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -264,6 +276,8 @@ close\(callback: AsyncCallback<boolean\>\): void ...@@ -264,6 +276,8 @@ close\(callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -293,6 +307,8 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void ...@@ -293,6 +307,8 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -326,6 +342,8 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\> ...@@ -326,6 +342,8 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\>
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -361,6 +379,8 @@ on\(type: 'open', callback: AsyncCallback<Object\>\): void ...@@ -361,6 +379,8 @@ on\(type: 'open', callback: AsyncCallback<Object\>\): void
订阅WebSocket的打开事件，使用callback方式作为异步方法。 订阅WebSocket的打开事件，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -388,6 +408,8 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void ...@@ -388,6 +408,8 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -417,6 +439,8 @@ on\(type: 'message', callback: AsyncCallback<string | ArrayBuffer\>\): void ...@@ -417,6 +439,8 @@ on\(type: 'message', callback: AsyncCallback<string | ArrayBuffer\>\): void
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。 >AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -445,6 +469,8 @@ off\(type: 'message', callback?: AsyncCallback<string | ArrayBuffer\>\): void ...@@ -445,6 +469,8 @@ off\(type: 'message', callback?: AsyncCallback<string | ArrayBuffer\>\): void
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。 >AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -466,6 +492,8 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\ ...@@ -466,6 +492,8 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\
订阅WebSocket的关闭事件，使用callback方式作为异步方法。 订阅WebSocket的关闭事件，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -492,6 +520,8 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\ ...@@ -492,6 +520,8 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -514,6 +544,8 @@ on\(type: 'error', callback: ErrorCallback\): void ...@@ -514,6 +544,8 @@ on\(type: 'error', callback: ErrorCallback\): void
订阅WebSocket的Error事件，使用callback方式作为异步方法。 订阅WebSocket的Error事件，使用callback方式作为异步方法。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -541,6 +573,8 @@ off\(type: 'error', callback?: ErrorCallback\): void ...@@ -541,6 +573,8 @@ off\(type: 'error', callback?: ErrorCallback\): void
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力：**SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -560,6 +594,8 @@ ws.off('error'); ...@@ -560,6 +594,8 @@ ws.off('error');
建立WebSocket连接时，可选参数的类型和说明。 建立WebSocket连接时，可选参数的类型和说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| header | Object | 否 | 建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。 | | header | Object | 否 | 建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。 |
...@@ -569,6 +605,8 @@ ws.off('error'); ...@@ -569,6 +605,8 @@ ws.off('error');
关闭WebSocket连接时，可选参数的类型和说明。 关闭WebSocket连接时，可选参数的类型和说明。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| code | number | 否 | 错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。 | | code | number | 否 | 错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。 |
...@@ -578,6 +616,8 @@ ws.off('error'); ...@@ -578,6 +616,8 @@ ws.off('error');
发送给服务端的错误码可以自行定义，下面的列表仅供参考。 发送给服务端的错误码可以自行定义，下面的列表仅供参考。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 值 | 说明 | | 值 | 说明 |
| :-------- | :----------------- | | :-------- | :----------------- |
| 1000 | 正常关闭 | | 1000 | 正常关闭 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或