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 1920e560f7a193f6af09a43a7fcde437adb5fd74..4b04529a5896fc74b7883d126863734c2870e066 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-http.md +++ b/zh-cn/application-dev/reference/apis/js-apis-http.md @@ -97,7 +97,7 @@ request(url: string, callback: AsyncCallback\):void 根据URL地址,发起HTTP网络请求,使用callback方式作为异步方法。 > **说明:** -> 此接口仅支持数据大小为5M以内的数据传输。 +> 此接口仅支持数据大小为5M以内的数据接收。 **需要权限**:ohos.permission.INTERNET @@ -148,7 +148,7 @@ request(url: string, options: HttpRequestOptions, callback: AsyncCallback\ **说明:** -> 此接口仅支持数据大小为5M以内的数据传输。 +> 此接口仅支持数据大小为5M以内的数据接收。 **需要权限**:ohos.permission.INTERNET @@ -234,7 +234,7 @@ request(url: string, options? : HttpRequestOptions): Promise\ 根据URL地址,发起HTTP网络请求,使用Promise方式作为异步方法。 > **说明:** -> 此接口仅支持数据大小为5M以内的数据传输。 +> 此接口仅支持数据大小为5M以内的数据接收。 **需要权限**:ohos.permission.INTERNET 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 0f591f2a6aa20c1ed232ebb69b9e99bbd2d80b5c..070f35e454dbd25adb0ea2250040cd46a0a9c374 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-socket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-socket.md @@ -1853,6 +1853,191 @@ promise.then(() => { }); ``` +### on('message') + +on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}>): void; + +订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Communication.NetStack + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | +| callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。 | + +**示例:** + +```js +let tls = socket.constructTLSSocketInstance(); +tls.on('message', value => { + for (var i = 0; i < value.message.length; i++) { + let messages = value.message[i] + let message = String.fromCharCode(messages); + let messageView = ''; + messageView += item; + } + console.log('on message message: ' + JSON.stringify(messageView)); + console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo)); +}); +``` + +### off('message') + +off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void + +取消订阅TLSSocket连接的接收消息事件。使用callback方式作为异步方法。 + +> **说明:** +> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 + +**系统能力**:SystemCapability.Communication.NetStack + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | +| type | string | 是 | 订阅的事件类型。'message':接收消息事件。 | +| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 否 | 回调函数。message:接收到的消息;remoteInfo:socket连接信息。| + +**示例:** + +```js +let tls = socket.constructTLSSocketInstance(); +let callback = value => { + for (var i = 0; i < value.message.length; i++) { + let messages = value.message[i] + let message = String.fromCharCode(messages); + let messageView = ''; + messageView += item; + } + console.log('on message message: ' + JSON.stringify(messageView)); + console.log('remoteInfo: ' + JSON.stringify(value.remoteInfo)); +} +tls.on('message', callback); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 +tls.off('message', callback); +``` +### on('connect' | 'close') + +on(type: 'connect' | 'close', callback: Callback\): void + +订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Communication.NetStack + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅的事件类型。
- 'connect':连接事件。
- 'close':关闭事件。 | +| callback | Callback\ | 是 | 回调函数。 | + +**示例:** + +```js +let tls = socket.constructTLSSocketInstance(); +tls.on('connect', () => { + console.log("on connect success") +}); +tls.on('close', () => { + console.log("on close success") +}); +``` + +### off('connect' | 'close') + +off(type: 'connect' | 'close', callback?: Callback\): void + +取消订阅TLSSocket的连接事件或关闭事件。使用callback方式作为异步方法。 + +> **说明:** +> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 + +**系统能力**:SystemCapability.Communication.NetStack + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------------------------------------------------ | +| type | string | 是 | 订阅的事件类型。
- 'connect':连接事件。
- 'close':关闭事件。 | +| callback | Callback\ | 否 | 回调函数。 | + +**示例:** + +```js +let tls = socket.constructTLSSocketInstance(); +let callback1 = () => { + console.log("on connect success"); +} +tls.on('connect', callback1); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 +tls.off('connect', callback1); +tls.off('connect'); +let callback2 = () => { + console.log("on close success"); +} +tls.on('close', callback2); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 +tls.off('close', callback2); +``` + +### on('error') + +on(type: 'error', callback: ErrorCallback): void + +订阅TLSSocket连接的error事件。使用callback方式作为异步方法。 + +**系统能力**:SystemCapability.Communication.NetStack + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------ | +| type | string | 是 | 订阅的事件类型。'error':error事件。 | +| callback | ErrorCallback | 是 | 回调函数。 | + +**示例:** + +```js +let tls = socket.constructTLSSocketInstance(); +tls.on('error', err => { + console.log("on error, err:" + JSON.stringify(err)) +}); +``` + +### off('error') + +off(type: 'error', callback?: ErrorCallback): void + +取消订阅TLSSocket连接的error事件。使用callback方式作为异步方法。 + +> **说明:** +> 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 + +**系统能力**:SystemCapability.Communication.NetStack + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------- | ---- | ------------------------------------ | +| type | string | 是 | 订阅的事件类型。'error':error事件。 | +| callback | ErrorCallback | 否 | 回调函数。 | + +**示例:** + +```js +let tls = socket.constructTLSSocketInstance(); +let callback = err => { + console.log("on error, err:" + JSON.stringify(err)); +} +tls.on('error', callback); +// 可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。 +tls.off('error', callback); +``` + ### connect9+ connect(options: TLSConnectOptions, callback: AsyncCallback\): void