From 3c3529c440f9d3bb4041888aead0057776011953 Mon Sep 17 00:00:00 2001 From: xujie Date: Fri, 12 May 2023 15:05:22 +0800 Subject: [PATCH] =?UTF-8?q?fetchnetwork=E6=96=87=E4=BB=B6=E6=94=B9?= =?UTF-8?q?=E5=9B=9E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xujie --- .../reference/apis/js-apis-system-fetch.md | 43 ++++++++----------- .../reference/apis/js-apis-system-network.md | 30 +++---------- 2 files changed, 24 insertions(+), 49 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-fetch.md b/zh-cn/application-dev/reference/apis/js-apis-system-fetch.md index 2c6db0f993..f8a64fc102 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-fetch.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-fetch.md @@ -16,7 +16,7 @@ import fetch from '@system.fetch'; ## fetch.fetch3+ -fetch(options:FetchOptions): void +fetch(Object): void 通过网络获取数据。 @@ -25,8 +25,23 @@ fetch(options:FetchOptions): void **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| options | FetchOptions | 是 | 调用参数。 | +| url | string | 是 | 资源地址。 | +| data | string \| Object | 否 | 请求的参数，可选类型是字符串或者json对象。详见表 data与Content-Type关系。 | +| header | Object | 否 | 设置请求的header。 | +| method | string | 否 | 请求方法默认为GET，可选值为：OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE。 | +| responseType | string | 否 | 默认会根据服务器返回header中的Content-Type确定返回类型，支持文本和json格式。详见success返回值。 | +| success | Function | 否 | 接口调用成功的回调函数，返回值为[FetchResponse](#fetchresponse) | +| fail | Function | 否 | 接口调用失败的回调函数。 | +| complete | Function | 否 | 接口调用结束的回调函数。 | + +**表1** data与Content-Type关系 +| data | Content-Type | 说明 | +| -------- | -------- | -------- | +| string | 不设置 | Content-Type默认为 text/plain，data值作为请求的body。 | +| string | 任意 Type | data值作为请求的body。 | +| Object | 不设置 | Content-Type默认为application/x-www-form-urlencoded，data按照资源地址规则进行encode拼接作为请求的body。 | +| Object | application/x-www-form-urlencoded | data按照资源地址规则进行encode拼接作为请求的body。 | ## FetchResponse3+ @@ -70,30 +85,6 @@ export default { } ``` -## FetchOptions3+ - -**系统能力：** SystemCapability.Communication.NetStack - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| url | string | 是 | 资源地址。 | -| data | string \| Object | 否 | 请求的参数，可选类型是字符串或者json对象。详见表 data与Content-Type关系。 | -| header | Object | 否 | 设置请求的header。 | -| method | string | 否 | 请求方法默认为GET，可选值为：OPTIONS、GET、HEAD、POST、PUT、DELETE、TRACE。 | -| responseType | string | 否 | 默认会根据服务器返回header中的Content-Type确定返回类型，支持文本和json格式。详见success返回值。 | -| success | Function | 否 | 接口调用成功的回调函数，返回值为[FetchResponse](#fetchresponse) | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | - -**表3** data与Content-Type关系 - -| data | Content-Type | 说明 | -| -------- | -------- | -------- | -| string | 不设置 | Content-Type默认为 text/plain，data值作为请求的body。 | -| string | 任意 Type | data值作为请求的body。 | -| Object | 不设置 | Content-Type默认为application/x-www-form-urlencoded，data按照资源地址规则进行encode拼接作为请求的body。 | -| Object | application/x-www-form-urlencoded | data按照资源地址规则进行encode拼接作为请求的body。 | - > **说明：** > 默认支持https，如果要支持http，需要在config.json里增加network标签，属性标识 "cleartextTraffic": true。即： diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-network.md b/zh-cn/application-dev/reference/apis/js-apis-system-network.md index c425181d18..259378cd44 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-system-network.md +++ b/zh-cn/application-dev/reference/apis/js-apis-system-network.md @@ -23,7 +23,7 @@ ohos.permission.GET_NETWORK_INFO ## network.getType3+ -getType(options?:GetTypeOptions): void +getType(Object): void 获取当前设备的网络类型。 @@ -33,7 +33,9 @@ getType(options?:GetTypeOptions): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| options | GetTypeOptions | 否 | 可选参数。 | +| success | Function | 否 | 接口调用成功的回调函数，返回值为[NetworkResponse](#networkresponse) | +| fail | Function | 否 | 接口调用失败的回调函数。 | +| complete | Function | 否 | 接口调用结束的回调函数。 | fail返回值： @@ -61,7 +63,7 @@ export default { ## network.subscribe3+ -subscribe(options?:SubscribeOptions): void +subscribe(Object): void 订阅当前设备的网络连接状态。如果多次调用，会覆盖前一次调用。 @@ -71,7 +73,8 @@ subscribe(options?:SubscribeOptions): void | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| options | SubscribeOptions | 否 | 可选参数。 | +| success | Function | 否 | 网络发生变化的回调函数，返回值为[NetworkResponse](#networkresponse) | +| fail | Function | 否 | 接口调用失败的回调函数。 | fail返回值： @@ -125,22 +128,3 @@ export default { | -------- | -------- | -------- | -------- | | metered | boolean | 否 |是否按照流量计费。 | | type | string | 是|网络类型，可能的值有2g，3g，4g，5g，wifi，none等。 | - -## GetTypeOptions3+ - -**系统能力：** SystemCapability.Communication.NetManager.Core - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 否 | 接口调用成功的回调函数，返回值为[NetworkResponse](#networkresponse) | -| fail | Function | 否 | 接口调用失败的回调函数。 | -| complete | Function | 否 | 接口调用结束的回调函数。 | - -## SubscribeOptions3+ - -**系统能力：** SystemCapability.Communication.NetManager.Core - -| 名称 | 类型 | 必填 | 说明 | -| -------- | -------- | -------- | -------- | -| success | Function | 否 | 网络发生变化的回调函数，返回值为[NetworkResponse](#networkresponse) | -| fail | Function | 否 | 接口调用失败的回调函数。 | \ No newline at end of file -- GitLab