Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
82eebd52
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
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看板
提交
82eebd52
编写于
8月 23, 2023
作者:
Y
Yangys
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update netstack docs
Signed-off-by:
N
Yangys
<
yangyousheng@huawei.com
>
上级
02a6e484
变更
2
隐藏空白更改
内联
并排
Showing
2 changed file
with
17 addition
and
6 deletion
+17
-6
zh-cn/application-dev/reference/apis/js-apis-http.md
zh-cn/application-dev/reference/apis/js-apis-http.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
+15
-4
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @
82eebd52
...
...
@@ -874,7 +874,7 @@ httpRequest.off('dataReceiveProgress');
| 名称 | 类型 | 必填 | 说明 |
| -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ |
| method |
[
RequestMethod
](
#requestmethod
)
| 否 | 请求方式,默认为GET。 |
| extraData | string
<sup>
6+
</sup>
\|
Object
<sup>
6+
</sup>
\|
ArrayBuffer
<sup>
8+
</sup>
| 否 | 发送请求的额外数据,默认无此字段。
<br
/>
- 当HTTP请求为POST、PUT等方法时,此字段为HTTP请求的content,以UTF-8编码形式作为请求体。当'Content-Type'为'application/x-www-form-urlencoded'时,请求提交的信息主体数据应在key和value进行URL转码后按照键值对"key1=value1&key2=value2&key3=value3"的方式进行编码
。
- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时,此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数,Object类型的参数无需预编码,参数内容会拼接到URL中进行发送;ArrayBuffer类型的参数不会做拼接处理。|
| extraData | string
<sup>
6+
</sup>
\|
Object
<sup>
6+
</sup>
\|
ArrayBuffer
<sup>
8+
</sup>
| 否 | 发送请求的额外数据,默认无此字段。
<br
/>
- 当HTTP请求为POST、PUT等方法时,此字段为HTTP请求的content,以UTF-8编码形式作为请求体。当'Content-Type'为'application/x-www-form-urlencoded'时,请求提交的信息主体数据应在key和value进行URL转码后按照键值对"key1=value1&key2=value2&key3=value3"的方式进行编码
,以字符串形式传入。
<br
/>
- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时,此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数,Object类型的参数无需预编码,参数内容会拼接到URL中进行发送;ArrayBuffer类型的参数不会做拼接处理。|
| expectDataType
<sup>
9+
</sup>
|
[
HttpDataType
](
#httpdatatype9
)
| 否 | 指定返回数据的类型,默认无此字段。如果设置了此参数,系统将优先返回指定的类型。 |
| usingCache
<sup>
9+
</sup>
| boolean | 否 | 是否使用缓存,默认为true。 |
| priority
<sup>
9+
</sup>
| number | 否 | 优先级,范围[1,1000],默认是1。 |
...
...
@@ -883,7 +883,7 @@ httpRequest.off('dataReceiveProgress');
| connectTimeout | number | 否 | 连接超时时间。单位为毫秒(ms),默认为60000ms。 |
| usingProtocol
<sup>
9+
</sup>
|
[
HttpProtocol
](
#httpprotocol9
)
| 否 | 使用协议。默认值由系统自动指定。 |
| usingProxy
<sup>
10+
</sup>
| boolean
\|
Object | 否 | 是否使用HTTP代理,默认为false,不使用代理。
<br
/>
- 当usingProxy为布尔类型true时,使用默认网络代理。
<br
/>
- 当usingProxy为object类型时,使用指定网络代理。
| caPath
<sup>
10+
</sup>
| string | 否 | 如果设置了此参数,系统将使用用户指定路径的CA证书,否则将使用系统预设CA证书。 |
| caPath
<sup>
10+
</sup>
| string | 否 | 如果设置了此参数,系统将使用用户指定路径的CA证书,否则将使用系统预设CA证书
;证书路径为沙箱映射路径,系统预设CA证书位置:/etc/ssl/certs/cacert.pem,建议用户的CA证书存放在此路径下,目前仅支持后缀名为.pem的文本格式证书
。 |
## RequestMethod<sup>6+</sup>
...
...
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @
82eebd52
...
...
@@ -538,7 +538,7 @@ ws.off('message');
### on('close')<sup>6+</sup>
on(type: 'close', callback: AsyncCallback
\<
{
code: number, reason: string
}
\>
): void
on(type: 'close', callback: AsyncCallback
\<
{
CloseResult
}
\>
): void
订阅WebSocket的关闭事件,使用callback方式作为异步方法。
...
...
@@ -549,7 +549,7 @@ on(type: 'close', callback: AsyncCallback\<{ code: number, reason: string }\>):
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close':WebSocket的关闭事件。 |
| callback | AsyncCallback
\<
{
code: number, reason: string
}
\>
| 是 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
| callback | AsyncCallback
\<
{
CloseResult
}
\>
| 是 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
**示例:**
...
...
@@ -562,7 +562,7 @@ ws.on('close', (err, value) => {
### off('close')<sup>6+</sup>
off(type: 'close', callback?: AsyncCallback
\<
{
code: number, reason: string
}
\>
): void
off(type: 'close', callback?: AsyncCallback
\<
{
CloseResult
}
\>
): void
取消订阅WebSocket的关闭事件,使用callback方式作为异步方法。
...
...
@@ -576,7 +576,7 @@ off(type: 'close', callback?: AsyncCallback\<{ code: number, reason: string }\>)
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close':WebSocket的关闭事件。 |
| callback | AsyncCallback
\<
{
code: number, reason: string
}
\>
| 否 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
| callback | AsyncCallback
\<
{
CloseResult
}
\>
| 否 | 回调函数。
<br>
close:close错误码,reason:错误码说明 |
**示例:**
...
...
@@ -655,6 +655,17 @@ ws.off('error');
| code | number | 否 | 错误码,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为1000。 |
| reason | string | 否 | 原因值,关闭WebSocket连接时的可选参数,可根据实际情况来填。默认值为空字符串("")。 |
## CloseResult<sup>10+</sup>
关闭WebSocket连接时,监听close事件得到的关闭结果。
**系统能力**
:SystemCapability.Communication.NetStack
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| code | number | 是 | 错误码,监听close事件得到的关闭连接的错误码。 |
| reason | string | 是 | 原因值,监听close事件得到的关闭连接的错误原因。 |
## close错误码说明
发送给服务端的错误码可以自行定义,下面的列表仅供参考。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录