提交 54b8cf8f 编写于 作者: L liyufan

api match docs

Signed-off-by: Nliyufan <liyufan5@huawei.com>
上级 a9b99a35
......@@ -176,7 +176,7 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------ | ---- | ----------------------------------------------- |
| url | string | 是 | 发起网络请求的URL地址。 |
| options | HttpRequestOptions | | 参考[HttpRequestOptions](#httprequestoptions)。 |
| options | HttpRequestOptions | | 参考[HttpRequestOptions](#httprequestoptions)。 |
**返回值:**
......@@ -355,7 +355,7 @@ httpRequest.once('headersReceive', (header) => {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| method | [RequestMethod](#requestmethod) | 否 | 请求方式。 |
| extraData | string \| Object \| ArrayBuffer<sup>6+</sup> | 否 | 发送请求的额外数据。<br />- 当HTTP请求为POST、PUT等方法时,此字段为HTTP请求的content。<br />- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时,此字段为HTTP请求的参数补充,参数内容会拼接到URL中进行发送。<sup>6+</sup><br />- 开发者传入string对象,开发者需要自行编码,将编码后的string传入。<sup>6+</sup> |
......@@ -375,14 +375,14 @@ HTTP 请求方法。
| 名称 | 值 | 说明 |
| :------ | ------- | :------------------ |
| 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。 |
| 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
......@@ -434,7 +434,7 @@ request方法回调函数的返回值类型。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| result | string \| Object \| ArrayBuffer<sup>6+</sup> | 是 | HTTP请求根据响应头中Content-type类型返回对应的响应格式内容:<br />- application/json:返回JSON格式的字符串,如需HTTP响应具体内容,需开发者自行解析<br />- application/octet-stream:ArrayBuffer<br />- 其他:string |
| resultType<sup>9+</sup> | [HttpDataType](#httpdatatype9) | 是 | 返回值类型。 |
......@@ -509,7 +509,7 @@ flush(): Promise\<void>
**系统能力**:SystemCapability.Communication.NetStack
**参数:**
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
......@@ -562,7 +562,7 @@ delete(): Promise\<void>
**系统能力**:SystemCapability.Communication.NetStack
**参数:**
**返回值:**
| 类型 | 说明 |
| --------------------------------- | ------------------------------------- |
......@@ -595,17 +595,17 @@ httpResponseCache.delete().then() => {
http的数据类型。
| **HttpDataType 的合法值** | 说明 |
| :------------------ | :----------- |
| STRING | 字符串类型。 |
| OBJECT | 对象类型。 |
| ARRAY_BUFFER | 二进制数组类型。|
| 名称 | 值 | 说明 |
| ------------------ | -- | ----------- |
| STRING | 0 | 字符串类型。 |
| OBJECT | 1 | 对象类型。 |
| ARRAY_BUFFER | 2 | 二进制数组类型。|
## HttpProtocol<sup>9+</sup>
http协议版本。
| **HttpProtocol 的合法值** | 说明 |
| :----------------- | :----------- |
| HTTP1_1 | 协议http1.1 |
| HTTP2 | 协议http2 |
| 名称 | 说明 |
| :-------- | :----------- |
| HTTP1_1 | 协议http1.1 |
| HTTP2 | 协议http2 |
......@@ -61,7 +61,7 @@ connection.getDefaultNet().then(function (netHandle) {
})
```
## connection.getDefaultNetSync
## connection.getDefaultNetSync<sup>9+</sup>
getDefaultNetSync(): NetHandle;
......@@ -302,6 +302,55 @@ connection.getDefaultNet().then(function (netHandle) {
})
```
## connection.isDefaultNetMetered<sup>9+</sup>
isDefaultNetMetered(callback: AsyncCallback\<boolean>): void
检查当前网络上的数据流量使用是否被计量,使用callback方式作为异步方法。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------- |
| callback | AsyncCallback\<boolean> | 是 | 回调函数,当前网络上的数据流量使用被计量返回true。 |
**示例:**
```js
connection.isDefaultNetMetered(function (error, has) {
console.log(JSON.stringify(error))
console.log('has: ' + has)
})
```
## connection.isDefaultNetMetered<sup>9+</sup>
isDefaultNetMetered(): Promise\<boolean>
检查当前网络上的数据流量使用是否被计量,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**返回值:**
| 类型 | 说明 |
| ----------------- | ----------------------------------------------- |
| Promise\<boolean> | 以Promise形式返回,当前网络上的数据流量使用被计量true。 |
**示例:**
```js
connection.isDefaultNetMetered().then(function (has) {
console.log('has: ' + has)
})
```
## connection.reportNetConnected
reportNetConnected(netHandle: NetHandle, callback: AsyncCallback&lt;void&gt;): void
......@@ -490,7 +539,7 @@ enableAirplaneMode(callback: AsyncCallback\<void>): void
开启飞行模式,使用callback方式作为异步方法。
接口为系统接口。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
......@@ -514,7 +563,7 @@ enableAirplaneMode(): Promise\<void>
开启飞行模式,使用Promise方式作为异步方法。
接口为系统接口。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
......@@ -539,7 +588,7 @@ disableAirplaneMode(callback: AsyncCallback\<void>): void
关闭飞行模式,使用callback方式作为异步方法。
接口为系统接口。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
......@@ -563,7 +612,7 @@ disableAirplaneMode(): Promise\<void>
关闭飞行模式,使用Promise方式作为异步方法。
接口为系统接口。
**系统接口**:此接口为系统接口。
**系统能力**:SystemCapability.Communication.NetManager.Core
......@@ -816,19 +865,16 @@ netConnection.unregister(function (error) {
### 属性
| 参数名 | 类型 | 说明 |
| ------ | ------ | ------------------------- |
| netId | number | 网络ID,取值为0代表没有默认网络,其余取值必须大于等于100。 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | --- |------------------------- |
| netId | number | 是 | 网络ID,取值为0代表没有默认网络,其余取值必须大于等于100。 |
### bindSocket
### bindSocket<sup>9+</sup>
bindSocket(socketParam: TCPSocket \| UDPSocket, callback: AsyncCallback\<void>): void;
将TCPSocket或UDPSocket绑定到当前网络,使用callback方式作为异步方法。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
......@@ -870,14 +916,12 @@ connection.getDefaultNet().then(function (netHandle) {
}
```
### bindSocket
### bindSocket<sup>9+</sup>
bindSocket(socketParam: TCPSocket \| UDPSocket): Promise\<void>;
将TCPSocket或UDPSockett绑定到当前网络,使用Promise方式作为异步方法。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**参数:**
......@@ -1052,10 +1096,10 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ----------------------- | ----------------------------------- | ------------------------------------------------------------ |
| netCapabilities | [NetCapabilities](#netcapabilities) | 存储数据网络的传输能力和承载类型。 |
| bearerPrivateIdentifier | string | 网络标识符,Wi-Fi网络的标识符是"wifi",蜂窝网络的标识符是"slot0"(对应SIM卡1)。 |
| 名称 | 类型 | 必填 | 说明 |
| ----------------------- | ----------------------------------- | ---- | ------------------------------------------------------------ |
| netCapabilities | [NetCapabilities](#netcapabilities) | 是 | 存储数据网络的传输能力和承载类型。 |
| bearerPrivateIdentifier | string | 否 | 网络标识符,Wi-Fi网络的标识符是"wifi",蜂窝网络的标识符是"slot0"(对应SIM卡1)。 |
## NetCapabilities
......@@ -1063,12 +1107,12 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| --------------------- | ---------------------------------- | ------------------------ |
| linkUpBandwidthKbps | number | 上行(设备到网络)带宽。 |
| linkDownBandwidthKbps | number | 下行(网络到设备)带宽。 |
| networkCap | Array<[NetCap](#netcap)> | 网络具体能力。 |
| bearerTypes | Array<[NetBearType](#netbeartype)> | 网络类型。 |
| 名称 | 类型 | 必填 | 说明 |
| --------------------- | ---------------------------------- | --- | ------------------------ |
| linkUpBandwidthKbps | number | 否 | 上行(设备到网络)带宽。 |
| linkDownBandwidthKbps | number | 否 | 下行(网络到设备)带宽。 |
| networkCap | Array\<[NetCap](#netcap)> | 否 | 网络具体能力。 |
| bearerTypes | Array\<[NetBearType](#netbeartype)> | 是 | 网络类型。 |
## NetCap
......@@ -1076,7 +1120,7 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| NET_CAPABILITY_MMS | 0 | 表示网络可以访问运营商的MMSC(Multimedia&nbsp;Message&nbsp;Service,多媒体短信服务)发送和接收彩信。 |
| NET_CAPABILITY_NOT_METERED | 11 | 表示网络流量未被计费。 |
......@@ -1102,14 +1146,14 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------------- | ---------------------------------- | ---------------- |
| interfaceName | string | 网卡名称。 |
| domains | string | 所属域,默认""。 |
| linkAddresses | Array<[LinkAddress](#linkaddress)> | 链路信息。 |
| routes | Array<[RouteInfo](#routeinfo)> | 路由信息。 |
| dnses | Array&lt;[NetAddress](#netaddress)&gt; | 网络地址,参考[NetAddress](#netaddress)。 |
| mtu | number | 最大传输单元。 |
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ---------------------------------- | ----|---------------- |
| interfaceName | string | 是 |网卡名称。 |
| domains | string | 是 |所属域,默认""。 |
| linkAddresses | Array\<[LinkAddress](#linkaddress)> | 是 |链路信息。 |
| routes | Array\<[RouteInfo](#routeinfo)> | 是 |路由信息。 |
| dnses | Array\<[NetAddress](#netaddress)>; | 是 |网络地址,参考[NetAddress](#netaddress)。 |
| mtu | number | 是 |最大传输单元。 |
## LinkAddress
......@@ -1117,10 +1161,10 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------------ | ------------------------- | -------------------- |
| address | [NetAddress](#netaddress) | 链路地址。 |
| prefixLength | number | 链路地址前缀的长度。 |
| 名称 | 类型 | 必填 |说明 |
| ------------ | ----------------------- |---- |-------------------- |
| address | [NetAddress](#netaddress) | 是 | 链路地址。 |
| prefixLength | number | 是 |链路地址前缀的长度。 |
## RouteInfo
......@@ -1128,13 +1172,13 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| -------------- | --------------------------- | ---------------- |
| interface | string | 网卡名称。 |
| destination | [LinkAddress](#linkaddress) | 目的地址。 |
| gateway | [NetAddress](#netaddress) | 网关地址。 |
| hasGateway | boolean | 是否有网关。 |
| isDefaultRoute | boolean | 是否为默认路由。 |
| 名称 | 类型 | 必填 |说明 |
| -------------- | --------------------------- | --- |---------------- |
| interface | string | 是 |网卡名称。 |
| destination | [LinkAddress](#linkaddress) | 是 |目的地址。 |
| gateway | [NetAddress](#netaddress) | 是 |网关地址。 |
| hasGateway | boolean | 是 |是否有网关。 |
| isDefaultRoute | boolean | 是 |是否为默认路由。 |
## NetAddress
......@@ -1142,8 +1186,8 @@ connection.getDefaultNet().then(function (netHandle) {
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
| 参数名 | 类型 | 说明 |
| ------- | ------ | ------------------------------ |
| address | string | 地址。 |
| family | number | IPv4 = 1,IPv6 = 2,默认IPv4。 |
| port | number | 端口,取值范围\[0, 65535]。 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | -- |------------------------------ |
| address | string | 是 |地址。 |
| family | number | 否 |IPv4 = 1,IPv6 = 2,默认IPv4。 |
| port | number | 否 |端口,取值范围\[0, 65535]。 |
......@@ -18,9 +18,11 @@ setIfaceConfig(iface: string, ic: InterfaceConfiguration, callback: AsyncCallbac
设置网络接口配置信息,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -50,9 +52,11 @@ setIfaceConfig(iface: string, ic: InterfaceConfiguration): Promise\<void>;
设置网络接口配置信息,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.CONNECTIVITY_INTERNAL
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -84,9 +88,11 @@ getIfaceConfig(iface: string, callback: AsyncCallback\<InterfaceConfiguration>):
获取指定网络接口信息,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -119,9 +125,11 @@ getIfaceConfig(iface: string): Promise\<InterfaceConfiguration>;
获取指定网络接口信息,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -157,9 +165,11 @@ isIfaceActive(iface?: string, callback: AsyncCallback\<number>): void;
判断接口是否已激活,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -186,9 +196,11 @@ isIfaceActive(iface?: string): Promise\<number>;
判断接口是否已激活,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -218,9 +230,11 @@ getAllActiveIfaces(callback: AsyncCallback\<Array\<string>>): void;
获取活动的网络接口,使用callback方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -249,9 +263,11 @@ getAllActiveIfaces(): Promise\<Array\<string>>;
获取活动的网络接口,使用Promise方式作为异步方法。
**系统接口**:此接口为系统接口。
**需要权限**:ohos.permission.GET_NETWORK_INFO
**系统能力**:SystemCapability.Communication.NetManager.Core
**系统能力**:SystemCapability.Communication.NetManager.Ethernet
**参数:**
......@@ -278,7 +294,9 @@ ethernet.getAllActiveIfaces().then((data) => {
以太网连接配置网络信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
**系统接口**:此接口为系统接口。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Ethernet。
| 参数名 | 类型 | 说明 |
| ----------------------- | ----------------------------------- | ------------------------------------------------------------ |
......@@ -293,9 +311,11 @@ ethernet.getAllActiveIfaces().then((data) => {
以太网连接模式。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Core。
**系统接口**:此接口为系统接口。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetManager.Ethernet。
| 参数名 | 值 | 说明 |
| 名称 | 值 | 说明 |
| ------------------------ | ---- | ---------------------- |
| STATIC | 0 | 以太网连接静态配置网络信息。 |
| DHCP | 1 | 以太网连接动态配置网络信息。 |
......@@ -612,7 +612,7 @@ udp.off('error');
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 |
| port | number | 否 | 端口号 ,范围0~65535。如果不指定系统随机分配端口。 |
......@@ -624,7 +624,7 @@ UDPSocket发送参数。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------- |
| data | string \| ArrayBuffer<sup>7+</sup> | 是 | 发送的数据。 |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息。 |
......@@ -635,7 +635,7 @@ UDPSocket连接的其他属性。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | -------------------------------- |
| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
| receiveBufferSize | number | 否 | 接收缓冲区大小(单位:Byte)。 |
......@@ -649,7 +649,7 @@ Socket的状态信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | ---------- |
| isBound | boolean | 是 | 是否绑定。 |
| isClose | boolean | 是 | 是否关闭。 |
......@@ -661,7 +661,7 @@ Socket的连接信息。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 |
| family | string | 是 | 网络协议类型,可选类型:<br />- IPv4<br />- IPv6<br />默认为IPv4。 |
......@@ -1421,7 +1421,7 @@ TCPSocket连接的参数。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------------------- |
| address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 |
| timeout | number | 否 | 超时时间,单位毫秒(ms)。 |
......@@ -1432,7 +1432,7 @@ TCPSocket发送请求的参数。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| data | string\| ArrayBuffer<sup>7+</sup> | 是 | 发送的数据。 |
| encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |
......@@ -1443,7 +1443,7 @@ TCPSocket连接的其他属性。
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | ------------------------------------------------------------ |
| keepAlive | boolean | 否 | 是否保持连接。默认为false。 |
| OOBInline | boolean | 否 | 是否为OOB内联。默认为false。 |
......@@ -1460,8 +1460,6 @@ constructTLSSocketInstance(): TLSSocket
创建并返回一个TLSSocket对象。
**需要权限**:ohos.permission.INTERNET
**系统能力**:SystemCapability.Communication.NetStack
**返回值:**
......@@ -1500,6 +1498,7 @@ bind\(address: NetAddress, callback: AsyncCallback<void\>\): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2303198 | Address already in use. |
......@@ -1532,7 +1531,7 @@ bind\(address: NetAddress\): Promise<void\>
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | ------------------------------------------------------ |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
| address | [NetAddress](#netaddress) | 是 | 目标地址信息,参考[NetAddress](#netaddress)。 |
**返回值:**
......@@ -1543,6 +1542,7 @@ bind\(address: NetAddress\): Promise<void\>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------- |
| 401 | Parameter error. |
| 201 | Permission denied. |
| 2303198 | Address already in use. |
......@@ -1577,6 +1577,7 @@ getState\(callback: AsyncCallback<SocketStateBase\>\): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error. |
......@@ -1617,6 +1618,7 @@ getState\(\): Promise<SocketStateBase\>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error. |
......@@ -1657,6 +1659,7 @@ setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): voi
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error. |
......@@ -1714,6 +1717,7 @@ setExtraOptions\(options: TCPExtraOptions\): Promise<void\>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 401 | Parameter error. |
| 2303188 | Socket operation on non-socket.|
| 2300002 | System internal error. |
......@@ -1764,6 +1768,7 @@ connect(options: TLSConnectOptions, callback: AsyncCallback\<void>): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 401 | Parameter error. |
| 2303104 | Interrupted system call. |
| 2303109 | Bad file number. |
......@@ -1864,6 +1869,7 @@ connect(options: TLSConnectOptions): Promise\<void>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 401 | Parameter error. |
| 2303104 | Interrupted system call. |
| 2303109 | Bad file number. |
......@@ -2087,6 +2093,7 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
......@@ -2119,6 +2126,7 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
......@@ -2149,6 +2157,7 @@ getProtocol(callback: AsyncCallback\<string>): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ----------------------------- |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
......@@ -2182,6 +2191,7 @@ getProtocol():Promise\<string>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2300002 | System internal error. |
......@@ -2213,6 +2223,7 @@ getCipherSuite(callback: AsyncCallback\<Array\<string>>): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. |
......@@ -2247,6 +2258,7 @@ getCipherSuite(): Promise\<Array\<string>>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2303502 | Error in tls reading. |
| 2303505 | Error occurred in the tls system call. |
......@@ -2279,6 +2291,7 @@ getSignatureAlgorithms(callback: AsyncCallback\<Array\<string>>): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
......@@ -2311,6 +2324,7 @@ getSignatureAlgorithms(): Promise\<Array\<string>>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | ------------------------------ |
| 2303501 | SSL is null. |
| 2300002 | System internal error. |
......@@ -2342,6 +2356,7 @@ send(data: string, callback: AsyncCallback\<void>): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303503 | Error in tls writing |
......@@ -2378,6 +2393,7 @@ send(data: string): Promise\<void>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 401 | Parameter error. |
| 2303501 | SSL is null. |
| 2303503 | Error in tls writing |
......@@ -2418,6 +2434,7 @@ close(callback: AsyncCallback\<void>): void
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2303506 | Error clearing tls connection. |
......@@ -2452,6 +2469,7 @@ close(): Promise\<void>
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------------------- |
| 2303501 | SSL is null. |
| 2303505 | Error occurred in the tls system call. |
| 2303506 | Error clearing tls connection. |
......@@ -2473,11 +2491,11 @@ TLS连接的操作。
**系统能力**:SystemCapability.Communication.NetStack
| 参数名 | 类型 | 说明 |
| -------------- | ------------------------------------- | -------------- |
| address | [NetAddress](#netaddress) | 网关地址。 |
| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | TLS安全相关操作。|
| ALPNProtocols | Array\<string> | ALPN协议。 |
| 名称 | 类型 | 必填 | 说明 |
| -------------- | ------------------------------------- | --- |-------------- |
| address | [NetAddress](#netaddress) | 是 | 网关地址。 |
| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。|
| ALPNProtocols | Array\<string> | 是 | ALPN协议。 |
## TLSSecureOptions<sup>9+</sup>
......@@ -2485,16 +2503,16 @@ TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参
**系统能力**:SystemCapability.Communication.NetStack
| 参数名 | 类型 | 说明 |
| --------------------- | ---------------------- | ----------------------------------- |
| ca | string \| Array\<string> | 服务端的ca证书,用于认证校验服务端的数字证书。|
| cert | string | 本地客户端的数字证书。 |
| key | string | 本地数字证书的私钥。 |
| passwd | string | 读取私钥的密码。 |
| protocols | [Protocol](#protocol9) \| Array\<[Protocol](#protocol9)> | TLS的协议版本。 |
| useRemoteCipherPrefer | boolean | 优先使用对等方的密码套件。 |
| signatureAlgorithms | string | 通信过程中的签名算法。 |
| cipherSuite | string | 通信过程中的加密套件。 |
| 名称 | 类型 | 必填 | 说明 |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- |
| ca | string \| Array\<string> | 是 | 服务端的ca证书,用于认证校验服务端的数字证书。|
| cert | string | 否 | 本地客户端的数字证书。 |
| key | string | 否 | 本地数字证书的私钥。 |
| passwd | string | 否 | 读取私钥的密码。 |
| protocols | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)> | 否 | TLS的协议版本。 |
| useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 |
| signatureAlgorithms | string | 否 | 通信过程中的签名算法。 |
| cipherSuite | string | 否 | 通信过程中的加密套件。 |
## Protocol<sup>9+</sup>
......@@ -2502,10 +2520,10 @@ TLS通信的协议版本。
**系统能力**:SystemCapability.Communication.NetStack
| **protocol 的合法值** | 说明 |
| :------------------ | :------------------ |
| TLSv12 | 使用TLSv1.2协议通信。 |
| TLSv13 | 使用TLSv1.3协议通信。 |
| 名称 | 值 | 说明 |
| --------- | --------- |------------------ |
| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 |
| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 |
## X509CertRawData<sup>9+</sup>
......@@ -2513,7 +2531,6 @@ TLS通信的协议版本。
**系统能力**:SystemCapability.Communication.NetStack
| 参数名 | 类型 | 说明 |
| -------------- | ----------------------------- | -------------- |
| data | Uint8Array | 证书内容。 |
| encodingFormat | number | 编码格式der。 |
\ No newline at end of file
| 类型 | 说明 |
| --------------------------------------------------------------------- | --------------------- |
|[cryptoFramework.EncodingBlob](js-apis-cryptoFramework.md#EncodingBlob) | 存储证书的数据和编码格式 |
\ No newline at end of file
......@@ -595,7 +595,7 @@ ws.off('error');
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| header | Object | 否 | 建立WebSocket连接可选参数,代表建立连接时携带的HTTP头信息。参数内容自定义,也可以不指定。 |
......@@ -606,7 +606,7 @@ ws.off('error');
**系统能力**:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| code | number | 否 | 错误码,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为1000。 |
| reason | string | 否 | 原因值,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为空字符串("")。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册