diff --git a/zh-cn/application-dev/reference/apis/js-apis-http.md b/zh-cn/application-dev/reference/apis/js-apis-http.md index 3eada2b92b5d61165b5010f2f6c60f3d7be88974..09cd30943a12e14269d0152846bdf6acc406eda0 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-http.md +++ b/zh-cn/application-dev/reference/apis/js-apis-http.md @@ -801,7 +801,7 @@ httpRequest.off('dataProgress'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | | method | [RequestMethod](#requestmethod) | 否 | 请求方式。 | | extraData | string \| Object \| ArrayBuffer6+ | 否 | 发送请求的额外数据。
- 当HTTP请求为POST、PUT等方法时，此字段为HTTP请求的content。
- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时，此字段为HTTP请求的参数补充，参数内容会拼接到URL中进行发送。6+
- 开发者传入string对象，开发者需要自行编码，将编码后的string传入。6+ | @@ -820,7 +820,7 @@ HTTP 请求方法。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 值 | 说明 | +| 参数名 | 值 | 说明 | | :------ | ------- | :------------------ | | OPTIONS | "OPTIONS" | HTTP 请求 OPTIONS。 | | GET | "GET" | HTTP 请求 GET。 | @@ -837,7 +837,7 @@ HTTP 请求方法。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 值 | 说明 | +| 参数名 | 值 | 说明 | | ----------------- | ---- | ------------------------------------------------------------ | | OK | 200 | 请求成功。一般用于GET与POST请求。 | | CREATED | 201 | 已创建。成功请求并创建了新的资源。 | @@ -881,7 +881,7 @@ request方法回调函数的返回值类型。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | | result | string \| Object \| ArrayBuffer6+ | 是 | HTTP请求根据响应头中Content-type类型返回对应的响应格式内容：
- application/json：返回JSON格式的字符串，如需HTTP响应具体内容，需开发者自行解析
- application/octet-stream：ArrayBuffer
- 其他：string | | resultType9+ | [HttpDataType](#httpdatatype9) | 是 | 返回值类型。 | @@ -1025,7 +1025,7 @@ http的数据类型。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 值 | 说明 | +| 参数名 | 值 | 说明 | | ------------------ | -- | ----------- | | STRING | 0 | 字符串类型。 | | OBJECT | 1 | 对象类型。 | @@ -1037,7 +1037,7 @@ http协议版本。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 说明 | +| 参数名 | 说明 | | :-------- | :----------- | | HTTP1_1 | 协议http1.1 | | HTTP2 | 协议http2 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-socket.md b/zh-cn/application-dev/reference/apis/js-apis-socket.md index 532cde6b6ef44a6097fed6c0cad2feccce0635d9..bfce2924ff219fd4d21898a19b85eac8bf1d588b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-socket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-socket.md @@ -658,7 +658,7 @@ udp.off('error'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------------------------------------------------------------ | | address | string | 是 | 本地绑定的ip地址。 | | port | number | 否 | 端口号 ，范围0~65535。如果不指定系统随机分配端口。 | @@ -670,7 +670,7 @@ UDPSocket发送参数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ---------------------------------- | ---- | -------------- | | data | string \| ArrayBuffer7+ | 是 | 发送的数据。 | | address | [NetAddress](#netaddress) | 是 | 目标地址信息。 | @@ -681,7 +681,7 @@ UDPSocket连接的其他属性。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------------- | ------- | ---- | -------------------------------- | | broadcast | boolean | 否 | 是否可以发送广播。默认为false。 | | receiveBufferSize | number | 否 | 接收缓冲区大小（单位：Byte）。 | @@ -695,7 +695,7 @@ Socket的状态信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------- | ------- | ---- | ---------- | | isBound | boolean | 是 | 是否绑定。 | | isClose | boolean | 是 | 是否关闭。 | @@ -707,7 +707,7 @@ Socket的连接信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ------ | ---- | ------------------------------------------------------------ | | address | string | 是 | 本地绑定的ip地址。 | | family | string | 是 | 网络协议类型，可选类型：
- IPv4
- IPv6
默认为IPv4。 | @@ -1562,7 +1562,7 @@ TCPSocket连接的参数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ---------------------------------- | ---- | -------------------------- | | address | [NetAddress](#netaddress) | 是 | 绑定的地址以及端口。 | | timeout | number | 否 | 超时时间，单位毫秒（ms）。 | @@ -1573,7 +1573,7 @@ TCPSocket发送请求的参数。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------ | ---- | ------------------------------------------------------------ | | data | string\| ArrayBuffer7+ | 是 | 发送的数据。 | | encoding | string | 否 | 字符编码(UTF-8，UTF-16BE，UTF-16LE，UTF-16，US-AECII，ISO-8859-1)，默认为UTF-8。 | @@ -1584,7 +1584,7 @@ TCPSocket连接的其他属性。 **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ----------------- | ------- | ---- | ------------------------------------------------------------ | | keepAlive | boolean | 否 | 是否保持连接。默认为false。 | | OOBInline | boolean | 否 | 是否为OOB内联。默认为false。 | @@ -2632,7 +2632,7 @@ TLS连接的操作。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------------- | ------------------------------------- | --- |-------------- | | address | [NetAddress](#netaddress) | 是 | 网关地址。 | | secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。| @@ -2644,7 +2644,7 @@ TLS安全相关操作，其中ca证书为必选参数，其他参数为可选参 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | --------------------- | ------------------------------------------------------ | --- |----------------------------------- | | ca | string \| Array\ | 是 | 服务端的ca证书，用于认证校验服务端的数字证书。| | cert | string | 否 | 本地客户端的数字证书。 | @@ -2661,7 +2661,7 @@ TLS通信的协议版本。 **系统能力**：SystemCapability.Communication.NetStack -| 名称 | 值 | 说明 | +| 参数名 | 值 | 说明 | | --------- | --------- |------------------ | | TLSv12 | "TLSv1.2" | 使用TLSv1.2协议通信。 | | TLSv13 | "TLSv1.3" | 使用TLSv1.3协议通信。 | 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 a3c71e776adc301450ed12afe4427a528a0fc86b..ba9d3c1630340a0cf5b6a4ae95762c848e440ca1 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 @@ -23,7 +23,7 @@ fetch(Object): void **系统能力：** SystemCapability.Communication.NetStack **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | url | string | 是 | 资源地址。 | | data | string \| Object | 否 | 请求的参数，可选类型是字符串或者json对象。详见表 data与Content-Type关系。 | @@ -45,7 +45,7 @@ fetch(Object): void ## FetchResponse -| 名称 | 类型 | 可读 | 可写 | 说明 | +| 参数名 | 类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | code | number | 是 | 否 | 表示服务器的状态code。 | | data | string \| Object | 是 | 否 | 返回数据类型由responseType确定，详见表 responseType与success中data关系。 | 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 2008c020907e73b5c05423145edf06e4fb6aea4d..85e7aa74af1e2d315ba9d602d61528d2a1a4caa6 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 @@ -31,7 +31,7 @@ getType(Object): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | success | Function | 否 | 接口调用成功的回调函数，返回值为[NetworkResponse](#networkresponse) | | fail | Function | 否 | 接口调用失败的回调函数。 | @@ -71,7 +71,7 @@ subscribe(Object): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | success | Function | 否 | 网络发生变化的回调函数，返回值为[NetworkResponse](#networkresponse) | | fail | Function | 否 | 接口调用失败的回调函数。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md index 44f660731b199285cc744066b702934a6513c17f..7680bb1081d7f5ba57ae9c7d2c69adfef955f958 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md @@ -99,7 +99,7 @@ connect(url: string, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | ---------------------------- | | url | string | 是 | 建立WebSocket连接的URL地址。 | | callback | AsyncCallback\ | 是 | 回调函数。 | @@ -138,7 +138,7 @@ connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback\< **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | ------------------------------------------------------- | | url | string | 是 | 建立WebSocket连接的URL地址。 | | options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#websocketrequestoptions)。 | @@ -183,7 +183,7 @@ connect(url: string, options?: WebSocketRequestOptions): Promise\ **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | ----------------------- | ---- | ------------------------------------------------------- | | url | string | 是 | 建立WebSocket连接的URL地址。 | | options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#websocketrequestoptions)。 | @@ -227,7 +227,7 @@ send(data: string | ArrayBuffer, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | ------------ | | data | string \| ArrayBuffer | 是 | 发送的数据。
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 | | callback | AsyncCallback\ | 是 | 回调函数。 | @@ -268,7 +268,7 @@ send(data: string | ArrayBuffer): Promise\ **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------ | | data | string \| ArrayBuffer | 是 | 发送的数据。
API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 | @@ -313,7 +313,7 @@ close(callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | ---------- | | callback | AsyncCallback\ | 是 | 回调函数。 | @@ -351,7 +351,7 @@ close(options: WebSocketCloseOptions, callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------ | ---- | ----------------------------------------------------- | | options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#websocketcloseoptions)。 | | callback | AsyncCallback\ | 是 | 回调函数。 | @@ -393,7 +393,7 @@ close(options?: WebSocketCloseOptions): Promise\ **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------- | --------------------- | ---- | ----------------------------------------------------- | | options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#websocketcloseoptions)。 | @@ -437,7 +437,7 @@ on(type: 'open', callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ----------------------------- | | type | string | 是 | 'open'：WebSocket的打开事件。 | | callback | AsyncCallback\ | 是 | 回调函数。 | @@ -466,7 +466,7 @@ off(type: 'open', callback?: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | ----------------------------- | | type | string | 是 | 'open'：WebSocket的打开事件。 | | callback | AsyncCallback\ | 否 | 回调函数。 | @@ -497,7 +497,7 @@ on(type: 'message', callback: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------- | ---- | -------------------------------------------- | | type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 | | callback | AsyncCallback\8+\> | 是 | 回调函数。 | @@ -526,7 +526,7 @@ off(type: 'message', callback?: AsyncCallback\): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------- | ---- | -------------------------------------------- | | type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 | | callback | AsyncCallback\8+\> | 否 | 回调函数。 | @@ -549,7 +549,7 @@ on(type: 'close', callback: AsyncCallback\<{ code: number, reason: string }\>): **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 'close'：WebSocket的关闭事件。 | | callback | AsyncCallback\<{ code: number, reason: string }\> | 是 | 回调函数。
close：close错误码，reason：错误码说明 | @@ -577,7 +577,7 @@ off(type: 'close', callback?: AsyncCallback\<{ code: number, reason: string }\>) **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------- | ---- | ------------------------------ | | type | string | 是 | 'close'：WebSocket的关闭事件。 | | callback | AsyncCallback\<{ code: number, reason: string }\> | 否 | 回调函数。
close：close错误码，reason：错误码说明 | @@ -600,7 +600,7 @@ on(type: 'error', callback: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------- | ---- | ------------------------------- | | type | string | 是 | 'error'：WebSocket的Error事件。 | | callback | ErrorCallback | 是 | 回调函数。 | @@ -628,7 +628,7 @@ off(type: 'error', callback?: ErrorCallback): void **参数：** -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | -------- | ------------- | ---- | ------------------------------- | | type | string | 是 | 'error'：WebSocket的Error事件。 | | callback | ErrorCallback | 否 | 回调函数。 | @@ -647,7 +647,7 @@ ws.off('error'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | | header | Object | 否 | 建立WebSocket连接可选参数，代表建立连接时携带的HTTP头信息。参数内容自定义，也可以不指定。 | @@ -658,7 +658,7 @@ ws.off('error'); **系统能力**：以下各项对应的系统能力均为SystemCapability.Communication.NetStack。 -| 名称 | 类型 | 必填 | 说明 | +| 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ------------------------------------------------------------ | | code | number | 否 | 错误码，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为1000。 | | reason | string | 否 | 原因值，关闭WebSocket连接时的可选参数，可根据实际情况来填。默认值为空字符串（""）。 |