From f7bb9ee56ab825b511da7b0e09f151a315d9eff1 Mon Sep 17 00:00:00 2001 From: anyueling Date: Tue, 23 Aug 2022 14:57:18 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E6=8E=A5=E5=8F=A3=E4=BF=AE?= =?UTF-8?q?=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: anyueling --- .../reference/apis/js-apis-request.md | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-request.md b/zh-cn/application-dev/reference/apis/js-apis-request.md index 2e8f3bed49..8cb1f59036 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -299,6 +299,48 @@ on(type: 'headerReceive', callback: (header: object) => void): void ``` +### on('complete' | 'fail') + + on(type:'complete' | 'fail', callback: Callback<Array<TaskState>>): void; + +开启上传任务监听,异步方法,使用callback形式返回结果。 + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: SystemCapability.MiscServices.Upload + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 订阅的事件类型,取值为'complete',表示上传任务完成;取值为'fail',表示上传任务失败。| + | callback | function | 是 | 上传任务完成或失败的回调函数。 | + + 回调函数的参数 + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| <Array<TaskState>> | array | 是 | 上传任务返回结果 | + +**示例:** + + ```js + uploadTask.on('complete', function callback(TaskStates) { + for (let i = 0; i < TaskState.length; i++ ) { + console.info("upOnComplete taskState:" + JSON.stringify(TaskStates[i])); + } + } + ); + + uploadTask.on('fail', function callback(TaskStates) { + for (let i = 0; i < TaskState.length; i++ ) { + console.info("upOnFail taskState:" + JSON.stringify(TaskStates[i])); + } + } + ); + ``` + + ### off('progress') off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) => void): void @@ -365,6 +407,30 @@ off(type: 'headerReceive', callback?: (header: object) => void): void ); ``` +### off('complete' | 'fail') + + off(type:'complete' | 'fail'): void; + +关闭上传任务监听。 + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: SystemCapability.MiscServices.Upload + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | type | string | 是 | 订阅的事件类型,取值为'complete',表示上传任务完成;取值为'fail',表示上传任务失败。| + +**示例:** + + ```js + uploadTask.off('complete'); + + uploadTask.off('fail'); + ``` + ### remove @@ -444,6 +510,17 @@ remove(callback: AsyncCallback<boolean>): void | files | Array<[File](#file)> | 是 | 要上传的文件列表。请使用 multipart/form-data提交。 | | data | Array<[RequestData](#requestdata)> | 是 | 请求的表单数据。 | +## TaskState + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。 + +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| path | string | 是 | 文件路径 | +| responseCode | number | 是 | 上传任务返回值 | +| message | string | 是 | 上传任务结果描述信息 | ## File -- GitLab