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 8f614569dea1038acd5932ba45a1a3d68aed2461..e5c8178f7440f35e6d6d2149a9b6173b4b53afe8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-request.md +++ b/zh-cn/application-dev/reference/apis/js-apis-request.md @@ -31,7 +31,7 @@ var config = { } ``` -在开发stage模型下的应用程序时,需要在module.json和app.json配置文件中对应用结构进行声明,不涉及属性标识 "cleartextTraffic"。 +在开发stage模型下的应用程序时,不涉及属性标识 "cleartextTraffic"。 @@ -71,6 +71,8 @@ upload(config: UploadConfig): Promise<UploadTask> 上传,异步方法,使用promise形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -90,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)); @@ -108,6 +114,8 @@ upload(config: UploadConfig, callback: AsyncCallback<UploadTask>): void 上传,异步方法,使用callback形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Upload @@ -122,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; @@ -134,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 @@ -385,6 +476,8 @@ download(config: DownloadConfig): Promise<DownloadTask> 下载,异步方法,使用promise形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -419,6 +512,8 @@ download(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): v 下载,异步方法,使用callback形式返回结果。 +此接口仅可在FA模型下使用 + **需要权限**:ohos.permission.INTERNET **系统能力**: SystemCapability.MiscServices.Download @@ -444,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 下载任务。