From aaf33c2a60c0d51e9d77f2e90dce05e4417bb27f Mon Sep 17 00:00:00 2001 From: Jeam_wang Date: Tue, 31 Jan 2023 10:58:52 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=A0=E9=99=A4API9-beta=E6=8E=A5=E5=8F=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jeam_wang # Conflicts: # zh-cn/application-dev/reference/apis/js-apis-request.md --- .../reference/apis/js-apis-request.md | 157 ------------------ .../changelogs-request.md | 42 +++++ 2 files changed, 42 insertions(+), 157 deletions(-) create mode 100644 zh-cn/release-notes/changelogs/OpenHarmony_3.2.10.6/changelogs-request.md 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 31d80be61e..2a0ff7f77f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -280,91 +280,6 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void }); ``` -## request.upload(deprecated) - -upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> - -上传，异步方法，使用promise形式返回结果。 - -> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.uploadFile9+](#requestuploadfile9)替代。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Upload - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 基于应用程序的上下文。 | - | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | - - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<[UploadTask](#uploadtask)> | 返回上传任务。 | - -**示例：** - - ```js - let uploadTask; - let uploadConfig = { - url: 'https://patch', - header: { key1: "value1", key2: "value2" }, - method: "POST", - files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], - data: [{ name: "name123", value: "123" }], - }; - request.upload(globalThis.abilityContext, uploadConfig).then((data) => { - uploadTask = data; - }).catch((err) => { - console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); - }); - ``` - - -## request.upload(deprecated) - -upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void - -上传，异步方法，使用callback形式返回结果。 - -> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.uploadFile9+](#requestuploadfile9-1)替代。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Upload - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 基于应用程序的上下文。 | - | config | [UploadConfig](#uploadconfig) | 是 | 上传的配置信息。 | - | callback | AsyncCallback<[UploadTask](#uploadtask)> | 是 | 回调函数，异步返回UploadTask对象。 | - -**示例：** - - ```js - let uploadTask; - let uploadConfig = { - url: 'https://patch', - header: { key1: "value1", key2: "value2" }, - method: "POST", - files: [{ filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }], - data: [{ name: "name123", value: "123" }], - }; - request.upload(globalThis.abilityContext, uploadConfig, (err, data) => { - if (err) { - console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); - return; - } - uploadTask = data; - }); - ``` - ## UploadTask 上传任务，使用下列方法前，需要先获取UploadTask对象。 @@ -933,78 +848,6 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v }); ``` -## request.download(deprecated) - -download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask> - -下载，异步方法，使用promise形式返回结果。 - -> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.downloadFile9+](#requestdownloadfile9)替代。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Download - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 基于应用程序的上下文。 | - | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | - -**返回值：** - - | 类型 | 说明 | - | -------- | -------- | - | Promise<[DownloadTask](#downloadtask)> | 返回下载任务。 | - -**示例：** - - ```js - let downloadTask; - request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => { - downloadTask = data; - }).catch((err) => { - console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); - }) - ``` - - -## request.download(deprecated) - -download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void; - -下载，异步方法，使用callback形式返回结果。 - -> **说明：** 从API Version 9开始支持，从API Version 9开始不再维护，建议使用[request.downloadFile9+](#requestdownloadfile9-1)替代。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**: SystemCapability.MiscServices.Download - -**参数：** - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | context | [BaseContext](js-apis-inner-application-baseContext.md) | 是 | 基于应用程序的上下文。 | - | config | [DownloadConfig](#downloadconfig) | 是 | 下载的配置信息。 | - | callback | AsyncCallback<[DownloadTask](#downloadtask)> | 是 | 下载接口的回调函数。 | - -**示例：** - - ```js - let downloadTask; - request.download(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', - filePath: 'xxx/xxxxx.hap'}, (err, data) => { - if (err) { - console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); - return; - } - downloadTask = data; - }); - ``` - - ## DownloadTask 下载任务。 diff --git a/zh-cn/release-notes/changelogs/OpenHarmony_3.2.10.6/changelogs-request.md b/zh-cn/release-notes/changelogs/OpenHarmony_3.2.10.6/changelogs-request.md new file mode 100644 index 0000000000..6d7bc0e05c --- /dev/null +++ b/zh-cn/release-notes/changelogs/OpenHarmony_3.2.10.6/changelogs-request.md @@ -0,0 +1,42 @@ +# 上传下载子系统ChangeLog + + +## cl.request.2 request上传下载接口变更 + +- 删除API9-beta接口： +1. function download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback): void; +2. function download(context: BaseContext, config: DownloadConfig): Promise; +3. function upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback): void; +4. function upload(context: BaseContext, config: UploadConfig): Promise; + +**变更影响** + +基于此前版本使用Stage模式开发的应用，需适配变更后的接口，否则会影响原有业务逻辑。 + +**关键的接口/组件变更** + +| 模块名 | 类名 | 方法/属性/枚举/常量 | 变更类型 | +|--------------|--------------|-------------------------------------------------------------------------------------------------------------------|------| +| ohos.request | request | function download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback): void; | 删除 | +| ohos.request | request | function download(context: BaseContext, config: DownloadConfig): Promise; | 删除 | +| ohos.request | request | function upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback): void; | 删除 | +| ohos.request | request | function upload(context: BaseContext, config: UploadConfig): Promise; | 删除 | + + +**适配指导** + +以download为例，在新版本上需要使用downloadFile, 如下方式进行调用： + +```ts +try { + request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', + filePath: 'xxx/xxxxx.hap'}, (err, data) => { + if (err) { + console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); + return; + } + }); +} catch (err) { + console.log("downloadFile callback fail." + "errCode:" + err.code + ",errMessage:" + err.message); +} +``` \ No newline at end of file -- GitLab