Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
2b817254
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看板
未验证
提交
2b817254
编写于
7月 05, 2022
作者:
O
openharmony_ci
提交者:
Gitee
7月 05, 2022
浏览文件
操作
浏览文件
下载
差异文件
!6298 增加http错误码
Merge pull request !6298 from zengyawen/master
上级
03921f5a
a3a00c93
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
30 addition
and
17 deletion
+30
-17
zh-cn/application-dev/reference/apis/js-apis-http.md
zh-cn/application-dev/reference/apis/js-apis-http.md
+30
-17
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @
2b817254
# 数据请求
# 数据请求
> **说明:**
本模块提供http数据请求能力。应用可以通过HTTP发起一个数据请求,支持常见的GET、POST、OPTIONS、HEAD、PUT、DELETE、TRACE、CONNECT方法。
>**说明:**
>
>
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
>
...
@@ -93,9 +95,9 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
...
@@ -93,9 +95,9 @@ request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void
**参数:**
**参数:**
| 参数名 | 类型
| 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------
---------
| ---- | ----------------------- |
| -------- | ---------------------------------------------- | ---- | ----------------------- |
| url | string
| 是 | 发起网络请求的URL地址。 |
| url | string | 是 | 发起网络请求的URL地址。 |
| callback | AsyncCallback
\<
[
HttpResponse
](
#httpresponse
)
\>
| 是 | 回调函数。 |
| callback | AsyncCallback
\<
[
HttpResponse
](
#httpresponse
)
\>
| 是 | 回调函数。 |
**示例:**
**示例:**
...
@@ -169,15 +171,15 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
...
@@ -169,15 +171,15 @@ request\(url: string, options? : HttpRequestOptions\): Promise<HttpResponse\>
**参数:**
**参数:**
| 参数名 | 类型 | 必填 | 说明
|
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------ | ---- | -----------------------------------------------
---
|
| ------- | ------------------ | ---- | ----------------------------------------------- |
| url | string | 是 | 发起网络请求的URL地址。
|
| url | string | 是 | 发起网络请求的URL地址。 |
| options | HttpRequestOptions | 是 | 参考
[
HttpRequestOptions
](
#httprequestoptions
)
。 |
| options | HttpRequestOptions | 是 | 参考
[
HttpRequestOptions
](
#httprequestoptions
)
。 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| 类型
| 说明 |
| :-------------------- | :-------------------------------- |
| :--------------------
-----------------
| :-------------------------------- |
| Promise
<
[
HttpResponse
](
#httpresponse
)
>
| 以Promise形式返回发起请求的结果。 |
| Promise
<
[
HttpResponse
](
#httpresponse
)
>
| 以Promise形式返回发起请求的结果。 |
...
@@ -225,7 +227,7 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void
...
@@ -225,7 +227,7 @@ on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void
订阅HTTP Response Header 事件。
订阅HTTP Response Header 事件。
> **说明:**
> **说明:**
>
此接口已废弃,建议使用[on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8)替代。
>此接口已废弃,建议使用[on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8)替代。
**系统能力**
:SystemCapability.Communication.NetStack
**系统能力**
:SystemCapability.Communication.NetStack
...
@@ -353,13 +355,13 @@ httpRequest.once('headersReceive', (header) => {
...
@@ -353,13 +355,13 @@ httpRequest.once('headersReceive', (header) => {
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Communication.NetStack。
**系统能力**
:以下各项对应的系统能力均为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>
|
| header | Object
| 否 | HTTP请求头字段。默认{'Content-Type': 'application/json'}。
|
| header | Object
| 否 | HTTP请求头字段。默认{'Content-Type': 'application/json'}。
|
| readTimeout | number
| 否 | 读取超时时间。单位为毫秒(ms),默认为60000ms。
|
| readTimeout | number
| 否 | 读取超时时间。单位为毫秒(ms),默认为60000ms。
|
| connectTimeout | number
| 否 | 连接超时时间。单位为毫秒(ms),默认为60000ms。
|
| connectTimeout | number
| 否 | 连接超时时间。单位为毫秒(ms),默认为60000ms。
|
## RequestMethod
## RequestMethod
...
@@ -431,7 +433,18 @@ request方法回调函数的返回值类型。
...
@@ -431,7 +433,18 @@ request方法回调函数的返回值类型。
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ |
| 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 |
| responseCode |
[
ResponseCode
](
#responsecode
)
\|
number | 是 | 回调函数执行成功时,此字段为
[
ResponseCode
](
#responsecode
)
。若执行失败,错误码将会从AsyncCallback中的err字段返回。错误码
如下:
<br
/>
- 200:通用错误
<br
/>
- 202:参数错误
<br
/>
- 300:I/O错误
|
| responseCode |
[
ResponseCode
](
#responsecode
)
\|
number | 是 | 回调函数执行成功时,此字段为
[
ResponseCode
](
#responsecode
)
。若执行失败,错误码将会从AsyncCallback中的err字段返回。错误码
参考
[
Response错误码
](
#response常用错误码
)
。
|
| header | Object | 是 | 发起http请求返回来的响应头。当前返回的是JSON格式字符串,如需具体字段内容,需开发者自行解析。常见字段及解析方式如下:
<br/>
- Content-Type:header['Content-Type'];
<br
/>
- Status-Line:header['Status-Line'];
<br
/>
- Date:header.Date/header['Date'];
<br
/>
- Server:header.Server/header['Server']; |
| header | Object | 是 | 发起http请求返回来的响应头。当前返回的是JSON格式字符串,如需具体字段内容,需开发者自行解析。常见字段及解析方式如下:
<br/>
- Content-Type:header['Content-Type'];
<br
/>
- Status-Line:header['Status-Line'];
<br
/>
- Date:header.Date/header['Date'];
<br
/>
- Server:header.Server/header['Server']; |
| cookies
<sup>
8+
</sup>
| Array
\<
string
\>
| 是 | 服务器返回的 cookies。 |
| cookies
<sup>
8+
</sup>
| Array
\<
string
\>
| 是 | 服务器返回的 cookies。 |
## Response常用错误码
| 错误码 | 说明 |
| ------ | ------------------------------------------------------------ |
| -1 | 参数错误。 |
| 3 | URL格式错误。 |
| 4 | 构建时无法找到内置的请求功能、协议或选项。 |
| 5 | 无法解析代理。 |
| 6 | 无法解析主机。 |
| 7 | 无法连接代理或主机。 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录