Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
f84e4ad2
D
Docs
项目概览
OpenHarmony
/
Docs
大约 2 年 前同步成功
通知
161
Star
293
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
f84e4ad2
编写于
3月 16, 2023
作者:
Y
Yangys
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Modify Table
Signed-off-by:
N
Yangys
<
yangyousheng@huawei.com
>
上级
e9846da2
变更
5
显示空白变更内容
内联
并排
Showing
5 changed file
with
39 addition
and
39 deletion
+39
-39
zh-cn/application-dev/reference/apis/js-apis-http.md
zh-cn/application-dev/reference/apis/js-apis-http.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-socket.md
zh-cn/application-dev/reference/apis/js-apis-socket.md
+11
-11
zh-cn/application-dev/reference/apis/js-apis-system-fetch.md
zh-cn/application-dev/reference/apis/js-apis-system-fetch.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-system-network.md
.../application-dev/reference/apis/js-apis-system-network.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
+18
-18
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @
f84e4ad2
...
@@ -801,7 +801,7 @@ httpRequest.off('dataProgress');
...
@@ -801,7 +801,7 @@ httpRequest.off('dataProgress');
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| method |
[
RequestMethod
](
#requestmethod
)
| 否 | 请求方式。 |
| 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>
|
| 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>
|
...
@@ -820,7 +820,7 @@ HTTP 请求方法。
...
@@ -820,7 +820,7 @@ HTTP 请求方法。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 值 | 说明 |
|
参数名
| 值 | 说明 |
| :------ | ------- | :------------------ |
| :------ | ------- | :------------------ |
| OPTIONS | "OPTIONS" | HTTP 请求 OPTIONS。 |
| OPTIONS | "OPTIONS" | HTTP 请求 OPTIONS。 |
| GET | "GET" | HTTP 请求 GET。 |
| GET | "GET" | HTTP 请求 GET。 |
...
@@ -837,7 +837,7 @@ HTTP 请求方法。
...
@@ -837,7 +837,7 @@ HTTP 请求方法。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 值 | 说明 |
|
参数名
| 值 | 说明 |
| ----------------- | ---- | ------------------------------------------------------------ |
| ----------------- | ---- | ------------------------------------------------------------ |
| OK | 200 | 请求成功。一般用于GET与POST请求。 |
| OK | 200 | 请求成功。一般用于GET与POST请求。 |
| CREATED | 201 | 已创建。成功请求并创建了新的资源。 |
| CREATED | 201 | 已创建。成功请求并创建了新的资源。 |
...
@@ -881,7 +881,7 @@ request方法回调函数的返回值类型。
...
@@ -881,7 +881,7 @@ request方法回调函数的返回值类型。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为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 |
| 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
)
| 是 | 返回值类型。 |
| resultType
<sup>
9+
</sup>
|
[
HttpDataType
](
#httpdatatype9
)
| 是 | 返回值类型。 |
...
@@ -1025,7 +1025,7 @@ http的数据类型。
...
@@ -1025,7 +1025,7 @@ http的数据类型。
**系统能力**
:SystemCapability.Communication.NetStack
**系统能力**
:SystemCapability.Communication.NetStack
|
名称
| 值 | 说明 |
|
参数名
| 值 | 说明 |
| ------------------ | -- | ----------- |
| ------------------ | -- | ----------- |
| STRING | 0 | 字符串类型。 |
| STRING | 0 | 字符串类型。 |
| OBJECT | 1 | 对象类型。 |
| OBJECT | 1 | 对象类型。 |
...
@@ -1037,7 +1037,7 @@ http协议版本。
...
@@ -1037,7 +1037,7 @@ http协议版本。
**系统能力**
:SystemCapability.Communication.NetStack
**系统能力**
:SystemCapability.Communication.NetStack
|
名称
| 说明 |
|
参数名
| 说明 |
| :-------- | :----------- |
| :-------- | :----------- |
| HTTP1_1 | 协议http1.1 |
| HTTP1_1 | 协议http1.1 |
| HTTP2 | 协议http2 |
| HTTP2 | 协议http2 |
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @
f84e4ad2
...
@@ -658,7 +658,7 @@ udp.off('error');
...
@@ -658,7 +658,7 @@ udp.off('error');
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 |
| address | string | 是 | 本地绑定的ip地址。 |
| port | number | 否 | 端口号 ,范围0~65535。如果不指定系统随机分配端口。 |
| port | number | 否 | 端口号 ,范围0~65535。如果不指定系统随机分配端口。 |
...
@@ -670,7 +670,7 @@ UDPSocket发送参数。
...
@@ -670,7 +670,7 @@ UDPSocket发送参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------- |
| ------- | ---------------------------------- | ---- | -------------- |
| data | string
\|
ArrayBuffer
<sup>
7+
</sup>
| 是 | 发送的数据。 |
| data | string
\|
ArrayBuffer
<sup>
7+
</sup>
| 是 | 发送的数据。 |
| address |
[
NetAddress
](
#netaddress
)
| 是 | 目标地址信息。 |
| address |
[
NetAddress
](
#netaddress
)
| 是 | 目标地址信息。 |
...
@@ -681,7 +681,7 @@ UDPSocket连接的其他属性。
...
@@ -681,7 +681,7 @@ UDPSocket连接的其他属性。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | -------------------------------- |
| ----------------- | ------- | ---- | -------------------------------- |
| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
| broadcast | boolean | 否 | 是否可以发送广播。默认为false。 |
| receiveBufferSize | number | 否 | 接收缓冲区大小(单位:Byte)。 |
| receiveBufferSize | number | 否 | 接收缓冲区大小(单位:Byte)。 |
...
@@ -695,7 +695,7 @@ Socket的状态信息。
...
@@ -695,7 +695,7 @@ Socket的状态信息。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ----------- | ------- | ---- | ---------- |
| ----------- | ------- | ---- | ---------- |
| isBound | boolean | 是 | 是否绑定。 |
| isBound | boolean | 是 | 是否绑定。 |
| isClose | boolean | 是 | 是否关闭。 |
| isClose | boolean | 是 | 是否关闭。 |
...
@@ -707,7 +707,7 @@ Socket的连接信息。
...
@@ -707,7 +707,7 @@ Socket的连接信息。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| ------- | ------ | ---- | ------------------------------------------------------------ |
| address | string | 是 | 本地绑定的ip地址。 |
| address | string | 是 | 本地绑定的ip地址。 |
| family | string | 是 | 网络协议类型,可选类型:
<br
/>
- IPv4
<br
/>
- IPv6
<br
/>
默认为IPv4。 |
| family | string | 是 | 网络协议类型,可选类型:
<br
/>
- IPv4
<br
/>
- IPv6
<br
/>
默认为IPv4。 |
...
@@ -1562,7 +1562,7 @@ TCPSocket连接的参数。
...
@@ -1562,7 +1562,7 @@ TCPSocket连接的参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | ---------------------------------- | ---- | -------------------------- |
| ------- | ---------------------------------- | ---- | -------------------------- |
| address |
[
NetAddress
](
#netaddress
)
| 是 | 绑定的地址以及端口。 |
| address |
[
NetAddress
](
#netaddress
)
| 是 | 绑定的地址以及端口。 |
| timeout | number | 否 | 超时时间,单位毫秒(ms)。 |
| timeout | number | 否 | 超时时间,单位毫秒(ms)。 |
...
@@ -1573,7 +1573,7 @@ TCPSocket发送请求的参数。
...
@@ -1573,7 +1573,7 @@ TCPSocket发送请求的参数。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| data | string
\|
ArrayBuffer
<sup>
7+
</sup>
| 是 | 发送的数据。 |
| data | string
\|
ArrayBuffer
<sup>
7+
</sup>
| 是 | 发送的数据。 |
| encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |
| encoding | string | 否 | 字符编码(UTF-8,UTF-16BE,UTF-16LE,UTF-16,US-AECII,ISO-8859-1),默认为UTF-8。 |
...
@@ -1584,7 +1584,7 @@ TCPSocket连接的其他属性。
...
@@ -1584,7 +1584,7 @@ TCPSocket连接的其他属性。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ----------------- | ------- | ---- | ------------------------------------------------------------ |
| ----------------- | ------- | ---- | ------------------------------------------------------------ |
| keepAlive | boolean | 否 | 是否保持连接。默认为false。 |
| keepAlive | boolean | 否 | 是否保持连接。默认为false。 |
| OOBInline | boolean | 否 | 是否为OOB内联。默认为false。 |
| OOBInline | boolean | 否 | 是否为OOB内联。默认为false。 |
...
@@ -2632,7 +2632,7 @@ TLS连接的操作。
...
@@ -2632,7 +2632,7 @@ TLS连接的操作。
**系统能力**
:SystemCapability.Communication.NetStack
**系统能力**
:SystemCapability.Communication.NetStack
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------------- | ------------------------------------- | --- |-------------- |
| -------------- | ------------------------------------- | --- |-------------- |
| address |
[
NetAddress
](
#netaddress
)
| 是 | 网关地址。 |
| address |
[
NetAddress
](
#netaddress
)
| 是 | 网关地址。 |
| secureOptions |
[
TLSSecureOptions
](
#tlssecureoptions9
)
| 是 | TLS安全相关操作。|
| secureOptions |
[
TLSSecureOptions
](
#tlssecureoptions9
)
| 是 | TLS安全相关操作。|
...
@@ -2644,7 +2644,7 @@ TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参
...
@@ -2644,7 +2644,7 @@ TLS安全相关操作,其中ca证书为必选参数,其他参数为可选参
**系统能力**
:SystemCapability.Communication.NetStack
**系统能力**
:SystemCapability.Communication.NetStack
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- |
| ca | string
\|
Array
\<
string
\>
| 是 | 服务端的ca证书,用于认证校验服务端的数字证书。|
| ca | string
\|
Array
\<
string
\>
| 是 | 服务端的ca证书,用于认证校验服务端的数字证书。|
| cert | string | 否 | 本地客户端的数字证书。 |
| cert | string | 否 | 本地客户端的数字证书。 |
...
@@ -2661,7 +2661,7 @@ TLS通信的协议版本。
...
@@ -2661,7 +2661,7 @@ TLS通信的协议版本。
**系统能力**
:SystemCapability.Communication.NetStack
**系统能力**
:SystemCapability.Communication.NetStack
|
名称
| 值 | 说明 |
|
参数名
| 值 | 说明 |
| --------- | --------- |------------------ |
| --------- | --------- |------------------ |
| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 |
| TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 |
| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 |
| TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-system-fetch.md
浏览文件 @
f84e4ad2
...
@@ -23,7 +23,7 @@ fetch(Object): void
...
@@ -23,7 +23,7 @@ fetch(Object): void
**系统能力:**
SystemCapability.Communication.NetStack
**系统能力:**
SystemCapability.Communication.NetStack
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| url | string | 是 | 资源地址。 |
| url | string | 是 | 资源地址。 |
| data | string
\|
Object | 否 | 请求的参数,可选类型是字符串或者json对象。详见表 data与Content-Type关系。 |
| data | string
\|
Object | 否 | 请求的参数,可选类型是字符串或者json对象。详见表 data与Content-Type关系。 |
...
@@ -45,7 +45,7 @@ fetch(Object): void
...
@@ -45,7 +45,7 @@ fetch(Object): void
## FetchResponse
## FetchResponse
|
名称
| 类型 | 可读 | 可写 | 说明 |
|
参数名
| 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- | -------- |
| code | number | 是 | 否 | 表示服务器的状态code。 |
| code | number | 是 | 否 | 表示服务器的状态code。 |
| data | string
\|
Object | 是 | 否 | 返回数据类型由responseType确定,详见表 responseType与success中data关系。 |
| data | string
\|
Object | 是 | 否 | 返回数据类型由responseType确定,详见表 responseType与success中data关系。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-system-network.md
浏览文件 @
f84e4ad2
...
@@ -31,7 +31,7 @@ getType(Object): void
...
@@ -31,7 +31,7 @@ getType(Object): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| success | Function | 否 | 接口调用成功的回调函数,返回值为
[
NetworkResponse
](
#networkresponse
)
|
| success | Function | 否 | 接口调用成功的回调函数,返回值为
[
NetworkResponse
](
#networkresponse
)
|
| fail | Function | 否 | 接口调用失败的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
...
@@ -71,7 +71,7 @@ subscribe(Object): void
...
@@ -71,7 +71,7 @@ subscribe(Object): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| success | Function | 否 | 网络发生变化的回调函数,返回值为
[
NetworkResponse
](
#networkresponse
)
|
| success | Function | 否 | 网络发生变化的回调函数,返回值为
[
NetworkResponse
](
#networkresponse
)
|
| fail | Function | 否 | 接口调用失败的回调函数。 |
| fail | Function | 否 | 接口调用失败的回调函数。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @
f84e4ad2
...
@@ -99,7 +99,7 @@ connect(url: string, callback: AsyncCallback\<boolean\>): void
...
@@ -99,7 +99,7 @@ connect(url: string, callback: AsyncCallback\<boolean\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------------------------- |
| -------- | ------------------------ | ---- | ---------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
...
@@ -138,7 +138,7 @@ connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback\<
...
@@ -138,7 +138,7 @@ connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback\<
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------------------------------------- |
| -------- | ------------------------ | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 是 | 参考
[
WebSocketRequestOptions
](
#websocketrequestoptions
)
。 |
| options | WebSocketRequestOptions | 是 | 参考
[
WebSocketRequestOptions
](
#websocketrequestoptions
)
。 |
...
@@ -183,7 +183,7 @@ connect(url: string, options?: WebSocketRequestOptions): Promise\<boolean\>
...
@@ -183,7 +183,7 @@ connect(url: string, options?: WebSocketRequestOptions): Promise\<boolean\>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | ----------------------- | ---- | ------------------------------------------------------- |
| ------- | ----------------------- | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 否 | 参考
[
WebSocketRequestOptions
](
#websocketrequestoptions
)
。 |
| options | WebSocketRequestOptions | 否 | 参考
[
WebSocketRequestOptions
](
#websocketrequestoptions
)
。 |
...
@@ -227,7 +227,7 @@ send(data: string | ArrayBuffer, callback: AsyncCallback\<boolean\>): void
...
@@ -227,7 +227,7 @@ send(data: string | ArrayBuffer, callback: AsyncCallback\<boolean\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------ |
| -------- | ------------------------ | ---- | ------------ |
| data | string
\|
ArrayBuffer | 是 | 发送的数据。
<br>
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
| data | string
\|
ArrayBuffer | 是 | 发送的数据。
<br>
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
...
@@ -268,7 +268,7 @@ send(data: string | ArrayBuffer): Promise\<boolean\>
...
@@ -268,7 +268,7 @@ send(data: string | ArrayBuffer): Promise\<boolean\>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ |
| ------ | ------ | ---- | ------------ |
| data | string
\|
ArrayBuffer | 是 | 发送的数据。
<br>
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
| data | string
\|
ArrayBuffer | 是 | 发送的数据。
<br>
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
...
@@ -313,7 +313,7 @@ close(callback: AsyncCallback\<boolean\>): void
...
@@ -313,7 +313,7 @@ close(callback: AsyncCallback\<boolean\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------- |
| -------- | ------------------------ | ---- | ---------- |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
...
@@ -351,7 +351,7 @@ close(options: WebSocketCloseOptions, callback: AsyncCallback\<boolean\>): void
...
@@ -351,7 +351,7 @@ close(options: WebSocketCloseOptions, callback: AsyncCallback\<boolean\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ----------------------------------------------------- |
| -------- | ------------------------ | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 是 | 参考
[
WebSocketCloseOptions
](
#websocketcloseoptions
)
。 |
| options | WebSocketCloseOptions | 是 | 参考
[
WebSocketCloseOptions
](
#websocketcloseoptions
)
。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
boolean
\>
| 是 | 回调函数。 |
...
@@ -393,7 +393,7 @@ close(options?: WebSocketCloseOptions): Promise\<boolean\>
...
@@ -393,7 +393,7 @@ close(options?: WebSocketCloseOptions): Promise\<boolean\>
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------- | --------------------- | ---- | ----------------------------------------------------- |
| ------- | --------------------- | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 否 | 参考
[
WebSocketCloseOptions
](
#websocketcloseoptions
)
。 |
| options | WebSocketCloseOptions | 否 | 参考
[
WebSocketCloseOptions
](
#websocketcloseoptions
)
。 |
...
@@ -437,7 +437,7 @@ on(type: 'open', callback: AsyncCallback\<Object\>): void
...
@@ -437,7 +437,7 @@ on(type: 'open', callback: AsyncCallback\<Object\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- |
| -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open':WebSocket的打开事件。 |
| type | string | 是 | 'open':WebSocket的打开事件。 |
| callback | AsyncCallback
\<
Object
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
Object
\>
| 是 | 回调函数。 |
...
@@ -466,7 +466,7 @@ off(type: 'open', callback?: AsyncCallback\<Object\>): void
...
@@ -466,7 +466,7 @@ off(type: 'open', callback?: AsyncCallback\<Object\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- |
| -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open':WebSocket的打开事件。 |
| type | string | 是 | 'open':WebSocket的打开事件。 |
| callback | AsyncCallback
\<
Object
\>
| 否 | 回调函数。 |
| callback | AsyncCallback
\<
Object
\>
| 否 | 回调函数。 |
...
@@ -497,7 +497,7 @@ on(type: 'message', callback: AsyncCallback\<string | ArrayBuffer\>): void
...
@@ -497,7 +497,7 @@ on(type: 'message', callback: AsyncCallback\<string | ArrayBuffer\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------------- |
| -------- | ----------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 |
| type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback
\<
string
\|
ArrayBuffer
<sup>
8+
</sup>
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
string
\|
ArrayBuffer
<sup>
8+
</sup>
\>
| 是 | 回调函数。 |
...
@@ -526,7 +526,7 @@ off(type: 'message', callback?: AsyncCallback\<string | ArrayBuffer\>): void
...
@@ -526,7 +526,7 @@ off(type: 'message', callback?: AsyncCallback\<string | ArrayBuffer\>): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | -------------------------------------------- |
| -------- | --------------------------------------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 |
| type | string | 是 | 'message':WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback
\<
string
\|
ArrayBuffer
<sup>
8+
</sup>
\>
| 否 | 回调函数。 |
| callback | AsyncCallback
\<
string
\|
ArrayBuffer
<sup>
8+
</sup>
\>
| 否 | 回调函数。 |
...
@@ -549,7 +549,7 @@ on(type: 'close', callback: AsyncCallback\<{ code: number, reason: string }\>):
...
@@ -549,7 +549,7 @@ on(type: 'close', callback: AsyncCallback\<{ code: number, reason: string }\>):
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close':WebSocket的关闭事件。 |
| type | string | 是 | 'close':WebSocket的关闭事件。 |
| callback | AsyncCallback
\<
{ code: number, reason: string }
\>
| 是 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
| callback | AsyncCallback
\<
{ code: number, reason: string }
\>
| 是 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
...
@@ -577,7 +577,7 @@ off(type: 'close', callback?: AsyncCallback\<{ code: number, reason: string }\>)
...
@@ -577,7 +577,7 @@ off(type: 'close', callback?: AsyncCallback\<{ code: number, reason: string }\>)
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close':WebSocket的关闭事件。 |
| type | string | 是 | 'close':WebSocket的关闭事件。 |
| callback | AsyncCallback
\<
{ code: number, reason: string }
\>
| 否 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
| callback | AsyncCallback
\<
{ code: number, reason: string }
\>
| 否 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
...
@@ -600,7 +600,7 @@ on(type: 'error', callback: ErrorCallback): void
...
@@ -600,7 +600,7 @@ on(type: 'error', callback: ErrorCallback): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- |
| -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error':WebSocket的Error事件。 |
| type | string | 是 | 'error':WebSocket的Error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 |
| callback | ErrorCallback | 是 | 回调函数。 |
...
@@ -628,7 +628,7 @@ off(type: 'error', callback?: ErrorCallback): void
...
@@ -628,7 +628,7 @@ off(type: 'error', callback?: ErrorCallback): void
**参数:**
**参数:**
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- |
| -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error':WebSocket的Error事件。 |
| type | string | 是 | 'error':WebSocket的Error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 |
| callback | ErrorCallback | 否 | 回调函数。 |
...
@@ -647,7 +647,7 @@ ws.off('error');
...
@@ -647,7 +647,7 @@ ws.off('error');
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| header | Object | 否 | 建立WebSocket连接可选参数,代表建立连接时携带的HTTP头信息。参数内容自定义,也可以不指定。 |
| header | Object | 否 | 建立WebSocket连接可选参数,代表建立连接时携带的HTTP头信息。参数内容自定义,也可以不指定。 |
...
@@ -658,7 +658,7 @@ ws.off('error');
...
@@ -658,7 +658,7 @@ ws.off('error');
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
|
名称
| 类型 | 必填 | 说明 |
|
参数名
| 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| code | number | 否 | 错误码,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为1000。 |
| code | number | 否 | 错误码,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为1000。 |
| reason | string | 否 | 原因值,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为空字符串("")。 |
| reason | string | 否 | 原因值,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为空字符串("")。 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录