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 75d6b4faa5586f948c01259d0d39fb90f7523f2f..b8d0060ec1db845e8e757d40cc11cd3f14c31435 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -16,9 +16,9 @@ import request from '@ohos.request'; ## 限制与约束 -默认支持https,如果要支持http,需要在config.json里增加network标签,属性标识 "cleartextTraffic": true。即: +在开发FA模型下的应用程序时, 默认支持https,如果要支持http,需要在config.json里增加network标签,属性标识 "cleartextTraffic": true。即: -``` +```js var config = { "deviceConfig": { "default": { @@ -31,6 +31,9 @@ var config = { } ``` +在开发stage模型下的应用程序时,不涉及属性标识 "cleartextTraffic"。 + + ## 常量 @@ -68,6 +71,8 @@ upload(config: UploadConfig): Promise<UploadTask> 上传,异步方法,使用promise形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -87,11 +92,15 @@ upload(config: UploadConfig): Promise<UploadTask> **示例:** ```js - let file1 = { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }; - let data = { name: "name123", value: "123" }; - let header = { key1: "value1", key2: "value2" }; let uploadTask; - request.upload({ url: 'https://patch', header: header, method: "POST", files: [file1], data: [data] }).then((data) => { + 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(uploadConfig).then((data) => { uploadTask = data; }).catch((err) => { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); @@ -105,6 +114,8 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void 上传,异步方法,使用callback形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -119,11 +130,15 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void **示例:** ```js - let file1 = { filename: "test", name: "test", uri: "internal://cache/test.jpg", type: "jpg" }; - let data = { name: "name123", value: "123" }; - let header = { key1: "value1", key2: "value2" }; let uploadTask; - request.upload({ url: 'https://patch', header: header, method: "POST", files: [file1], data: [data] }, (err, data) => { + 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(uploadConfig, (err, data) => { if (err) { console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); return; @@ -131,7 +146,86 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void uploadTask = data; }); ``` +## request.upload9+ + +upload(context: BaseContext, config: UploadConfig): Promise<UploadTask> + +上传,异步方法,使用promise形式返回结果。 + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: SystemCapability.MiscServices.Upload + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [BaseContext](#baseContext) | 是 | 基于应用程序的上下文。 | + | 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.upload9+ + +upload(context: BaseContext, config: UploadConfig, callback: AsyncCallback<UploadTask>): void + +上传,异步方法,使用callback形式返回结果。 + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: SystemCapability.MiscServices.Upload + +**参数:** + + | 参数名 | 参数类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [BaseContext](#baseContext) | 是 | 基于应用程序的上下文。 | + | 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 @@ -338,6 +432,8 @@ remove(callback: AsyncCallback<boolean>): void ## UploadConfig +**需要权限**:ohos.permission.INTERNET + **系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。 | 名称 | 类型 | 必填 | 说明 | @@ -351,7 +447,9 @@ remove(callback: AsyncCallback<boolean>): void ## File -**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。 +**需要权限**:ohos.permission.INTERNET + +**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -363,8 +461,9 @@ remove(callback: AsyncCallback<boolean>): void ## RequestData -**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Upload。 +**需要权限**:ohos.permission.INTERNET +**系统能力**: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download | 名称 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | name | string | 是 | 表示表单元素的名称。 | @@ -377,6 +476,8 @@ download(config: DownloadConfig): Promise<DownloadTask> 下载,异步方法,使用promise形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -411,6 +512,8 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v 下载,异步方法,使用callback形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -436,7 +539,72 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v }); ``` +## request.download9+ + +download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask> + +下载,异步方法,使用promise形式返回结果。 + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: SystemCapability.MiscServices.Download + +**参数:** + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [BaseContext](#baseContext) | 是 | 基于应用程序的上下文。 | + | 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.download9+ + +download(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void; + +下载,异步方法,使用callback形式返回结果。 + +**需要权限**:ohos.permission.INTERNET + +**系统能力**: SystemCapability.MiscServices.Download + +**参数:** + + | 参数名 | 参数类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | config | [BaseContext](#baseContext) | 是 | 基于应用程序的上下文。 | + | 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 下载任务。 @@ -936,6 +1104,8 @@ resume(callback: AsyncCallback<void>): void ## DownloadConfig +**需要权限**:ohos.permission.INTERNET + **系统能力**: SystemCapability.MiscServices.Download | 名称 | 类型 | 必填 | 说明 | @@ -952,6 +1122,8 @@ resume(callback: AsyncCallback<void>): void ## DownloadInfo7+ +**需要权限**:ohos.permission.INTERNET + **系统能力**: SystemCapability.MiscServices.Download | 名称 | 类型 | 必填 | 说明 |