Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 b343fb50 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!19599 【request】示例修改 

Merge pull request !19599 from wangdongqi/master
上级 61002ec2 bdf87f7d
隐藏空白更改
内联 并排
Showing with 322 addition and 273 deletion
zh-cn/application-dev/reference/apis/js-apis-inputmethod.md
浏览文件 @ b343fb50
...@@ -705,7 +705,7 @@ try { ...@@ -705,7 +705,7 @@ try {
attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void> attach(showKeyboard: boolean, textConfig: TextConfig): Promise<void>
用于自绘控件绑定输入法应用。使用callback异步回调。 用于自绘控件绑定输入法应用。使用promise异步回调。
必须先调用此接口完成自绘控件与输入法应用的绑定，才可以使用输入法框架的以下功能：显示、隐藏键盘；更新光标信息；更改编辑框选中范围；保存配置信息；监听处理由输入法应用发送的信息或命令等。 必须先调用此接口完成自绘控件与输入法应用的绑定，才可以使用输入法框架的以下功能：显示、隐藏键盘；更新光标信息；更改编辑框选中范围；保存配置信息；监听处理由输入法应用发送的信息或命令等。
......
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @ b343fb50
...@@ -105,6 +105,7 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask&gt ...@@ -105,6 +105,7 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask&gt
```js ```js
let uploadTask; let uploadTask;
let context;
let uploadConfig = { let uploadConfig = {
url: 'http://patch', url: 'http://patch',
header: { key1: "value1", key2: "value2" }, header: { key1: "value1", key2: "value2" },
...@@ -113,16 +114,20 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask&gt ...@@ -113,16 +114,20 @@ uploadFile(context: BaseContext, config: UploadConfig): Promise<UploadTask&gt
data: [{ name: "name123", value: "123" }], data: [{ name: "name123", value: "123" }],
}; };
try { try {
request.uploadFile(globalThis.abilityContext, uploadConfig).then((data) => { request.uploadFile(context, uploadConfig).then((data) => {
uploadTask = data; uploadTask = data;
}).catch((err) => { }).catch((err) => {
console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the upload. Code: ${err.code}, message: ${err.message}`);
}); });
} catch (err) { } catch (err) {
console.error('err.code : ' + err.code + ', err.message : ' + err.message); console.error(`Failed to request the upload. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
## request.uploadFile<sup>9+</sup> ## request.uploadFile<sup>9+</sup>
...@@ -154,6 +159,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l ...@@ -154,6 +159,7 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l
```js ```js
let uploadTask; let uploadTask;
let context;
let uploadConfig = { let uploadConfig = {
url: 'http://patch', url: 'http://patch',
header: { key1: "value1", key2: "value2" }, header: { key1: "value1", key2: "value2" },
...@@ -162,18 +168,22 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l ...@@ -162,18 +168,22 @@ uploadFile(context: BaseContext, config: UploadConfig, callback: AsyncCallback&l
data: [{ name: "name123", value: "123" }], data: [{ name: "name123", value: "123" }],
}; };
try { try {
request.uploadFile(globalThis.abilityContext, uploadConfig, (err, data) => { request.uploadFile(context, uploadConfig, (err, data) => {
if (err) { if (err) {
console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the upload. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
uploadTask = data; uploadTask = data;
}); });
} catch (err) { } catch (err) {
console.error('err.code : ' + err.code + ', err.message : ' + err.message); console.error(`Failed to request the upload. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
## request.upload<sup>(deprecated)</sup> ## request.upload<sup>(deprecated)</sup>
upload(config: UploadConfig): Promise&lt;UploadTask&gt; upload(config: UploadConfig): Promise&lt;UploadTask&gt;
...@@ -212,9 +222,9 @@ upload(config: UploadConfig): Promise&lt;UploadTask&gt; ...@@ -212,9 +222,9 @@ upload(config: UploadConfig): Promise&lt;UploadTask&gt;
data: [{ name: "name123", value: "123" }], data: [{ name: "name123", value: "123" }],
}; };
request.upload(uploadConfig).then((data) => { request.upload(uploadConfig).then((data) => {
uploadTask = data; uploadTask = data;
}).catch((err) => { }).catch((err) => {
console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the upload. Code: ${err.code}, message: ${err.message}`);
}) })
``` ```
...@@ -252,11 +262,11 @@ upload(config: UploadConfig, callback: AsyncCallback&lt;UploadTask&gt;): void ...@@ -252,11 +262,11 @@ upload(config: UploadConfig, callback: AsyncCallback&lt;UploadTask&gt;): void
data: [{ name: "name123", value: "123" }], data: [{ name: "name123", value: "123" }],
}; };
request.upload(uploadConfig, (err, data) => { request.upload(uploadConfig, (err, data) => {
if (err) { if (err) {
console.error('Failed to request the upload. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the upload. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
uploadTask = data; uploadTask = data;
}); });
``` ```
...@@ -294,7 +304,7 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) =&gt; vo ...@@ -294,7 +304,7 @@ on(type: 'progress', callback:(uploadedSize: number, totalSize: number) =&gt; vo
```js ```js
let upProgressCallback = (uploadedSize, totalSize) => { let upProgressCallback = (uploadedSize, totalSize) => {
console.info("upload totalSize:" + totalSize + " uploadedSize:" + uploadedSize); console.info("upload totalSize:" + totalSize + " uploadedSize:" + uploadedSize);
}; };
uploadTask.on('progress', upProgressCallback); uploadTask.on('progress', upProgressCallback);
``` ```
...@@ -327,7 +337,7 @@ on(type: 'headerReceive', callback: (header: object) =&gt; void): void ...@@ -327,7 +337,7 @@ on(type: 'headerReceive', callback: (header: object) =&gt; void): void
```js ```js
let headerCallback = (headers) => { let headerCallback = (headers) => {
console.info("upOnHeader headers:" + JSON.stringify(headers)); console.info("upOnHeader headers:" + JSON.stringify(headers));
}; };
uploadTask.on('headerReceive', headerCallback); uploadTask.on('headerReceive', headerCallback);
``` ```
...@@ -361,7 +371,7 @@ on(type: 'headerReceive', callback: (header: object) =&gt; void): void ...@@ -361,7 +371,7 @@ on(type: 'headerReceive', callback: (header: object) =&gt; void): void
```js ```js
let upCompleteCallback = (taskStates) => { let upCompleteCallback = (taskStates) => {
for (let i = 0; i < taskStates.length; i++ ) { for (let i = 0; i < taskStates.length; i++ ) {
console.info("upOnComplete taskState:" + JSON.stringify(taskStates[i])); console.info("upOnComplete taskState:" + JSON.stringify(taskStates[i]));
} }
}; };
uploadTask.on('complete', upCompleteCallback); uploadTask.on('complete', upCompleteCallback);
...@@ -396,7 +406,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g ...@@ -396,7 +406,7 @@ off(type: 'progress', callback?: (uploadedSize: number, totalSize: number) =&g
```js ```js
let upProgressCallback = (uploadedSize, totalSize) => { let upProgressCallback = (uploadedSize, totalSize) => {
console.info('Upload delete progress notification.' + 'totalSize:' + totalSize + 'uploadedSize:' + uploadedSize); console.info('Upload delete progress notification.' + 'totalSize:' + totalSize + 'uploadedSize:' + uploadedSize);
}; };
uploadTask.off('progress', upProgressCallback); uploadTask.off('progress', upProgressCallback);
``` ```
...@@ -423,7 +433,7 @@ off(type: 'headerReceive', callback?: (header: object) =&gt; void): void ...@@ -423,7 +433,7 @@ off(type: 'headerReceive', callback?: (header: object) =&gt; void): void
```js ```js
let headerCallback = (header) => { let headerCallback = (header) => {
console.info(`Upload delete headerReceive notification. header: ${JSON.stringify(header)}`); console.info(`Upload delete headerReceive notification. header: ${JSON.stringify(header)}`);
}; };
uploadTask.off('headerReceive', headerCallback); uploadTask.off('headerReceive', headerCallback);
``` ```
...@@ -451,7 +461,7 @@ off(type: 'headerReceive', callback?: (header: object) =&gt; void): void ...@@ -451,7 +461,7 @@ off(type: 'headerReceive', callback?: (header: object) =&gt; void): void
let upCompleteCallback = (taskStates) => { let upCompleteCallback = (taskStates) => {
console.info('Upload delete complete notification.'); console.info('Upload delete complete notification.');
for (let i = 0; i < taskStates.length; i++ ) { for (let i = 0; i < taskStates.length; i++ ) {
console.info('taskState:' + JSON.stringify(taskStates[i])); console.info('taskState:' + JSON.stringify(taskStates[i]));
} }
}; };
uploadTask.off('complete', upCompleteCallback); uploadTask.off('complete', upCompleteCallback);
...@@ -484,13 +494,13 @@ delete(): Promise&lt;boolean&gt; ...@@ -484,13 +494,13 @@ delete(): Promise&lt;boolean&gt;
```js ```js
uploadTask.delete().then((result) => { uploadTask.delete().then((result) => {
if (result) { if (result) {
console.info('Upload task removed successfully. '); console.info('Succeeded in deleting the upload task.');
} else { } else {
console.error('Failed to remove the upload task. '); console.error(`Failed to delete the upload task. Code: ${err.code}, message: ${err.message}`);
} }
}).catch((err) => { }).catch((err) => {
console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err)); console.error(`Failed to delete the upload task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -515,15 +525,15 @@ delete(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -515,15 +525,15 @@ delete(callback: AsyncCallback&lt;boolean&gt;): void
```js ```js
uploadTask.delete((err, result) => { uploadTask.delete((err, result) => {
if (err) { if (err) {
console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err)); console.error(`Failed to delete the upload task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Upload task removed successfully.'); console.info('Succeeded in deleting the upload task.');
} else { } else {
console.error('Failed to remove the upload task.'); console.error(`Failed to delete the upload task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -550,13 +560,13 @@ remove(): Promise&lt;boolean&gt; ...@@ -550,13 +560,13 @@ remove(): Promise&lt;boolean&gt;
```js ```js
uploadTask.remove().then((result) => { uploadTask.remove().then((result) => {
if (result) { if (result) {
console.info('Upload task removed successfully. '); console.info('Succeeded in removing the upload task.');
} else { } else {
console.error('Failed to remove the upload task. '); console.error(`Failed to remove the upload task. Code: ${err.code}, message: ${err.message}`);
} }
}).catch((err) => { }).catch((err) => {
console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err)); console.error(`Failed to remove the upload task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -583,15 +593,15 @@ remove(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -583,15 +593,15 @@ remove(callback: AsyncCallback&lt;boolean&gt;): void
```js ```js
uploadTask.remove((err, result) => { uploadTask.remove((err, result) => {
if (err) { if (err) {
console.error('Failed to remove the upload task. Cause: ' + JSON.stringify(err)); console.error(`Failed to remove the upload task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Upload task removed successfully.'); console.info('Succeeded in removing the upload task.');
} else { } else {
console.error('Failed to remove the upload task.'); console.error(`Failed to remove the upload task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -688,17 +698,22 @@ downloadFile(context: BaseContext, config: DownloadConfig): Promise&lt;DownloadT ...@@ -688,17 +698,22 @@ downloadFile(context: BaseContext, config: DownloadConfig): Promise&lt;DownloadT
```js ```js
let downloadTask; let downloadTask;
let context;
try { try {
request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxx.hap' }).then((data) => { request.downloadFile(context, { url: 'https://xxxx/xxxx.hap' }).then((data) => {
downloadTask = data; downloadTask = data;
}).catch((err) => { }).catch((err) => {
console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the download. Code: ${err.code}, message: ${err.message}`);
}) })
} catch (err) { } catch (err) {
console.error('err.code : ' + err.code + ', err.message : ' + err.message); console.error(`Failed to request the download. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
## request.downloadFile<sup>9+</sup> ## request.downloadFile<sup>9+</sup>
...@@ -733,20 +748,25 @@ downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallba ...@@ -733,20 +748,25 @@ downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallba
```js ```js
let downloadTask; let downloadTask;
let context;
try { try {
request.downloadFile(globalThis.abilityContext, { url: 'https://xxxx/xxxxx.hap', request.downloadFile(context, { url: 'https://xxxx/xxxxx.hap',
filePath: 'xxx/xxxxx.hap'}, (err, data) => { filePath: 'xxx/xxxxx.hap'}, (err, data) => {
if (err) { if (err) {
console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the download. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
downloadTask = data; downloadTask = data;
}); });
} catch (err) { } catch (err) {
console.error('err.code : ' + err.code + ', err.message : ' + err.message); console.error(`Failed to request the download. Code: ${err.code}, message: ${err.message}`);
} }
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
## request.download<sup>(deprecated)</sup> ## request.download<sup>(deprecated)</sup>
download(config: DownloadConfig): Promise&lt;DownloadTask&gt; download(config: DownloadConfig): Promise&lt;DownloadTask&gt;
...@@ -778,9 +798,9 @@ download(config: DownloadConfig): Promise&lt;DownloadTask&gt; ...@@ -778,9 +798,9 @@ download(config: DownloadConfig): Promise&lt;DownloadTask&gt;
```js ```js
let downloadTask; let downloadTask;
request.download({ url: 'https://xxxx/xxxx.hap' }).then((data) => { request.download({ url: 'https://xxxx/xxxx.hap' }).then((data) => {
downloadTask = data; downloadTask = data;
}).catch((err) => { }).catch((err) => {
console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the download. Code: ${err.code}, message: ${err.message}`);
}) })
``` ```
...@@ -812,11 +832,11 @@ download(config: DownloadConfig, callback: AsyncCallback&lt;DownloadTask&gt;): v ...@@ -812,11 +832,11 @@ download(config: DownloadConfig, callback: AsyncCallback&lt;DownloadTask&gt;): v
let downloadTask; let downloadTask;
request.download({ url: 'https://xxxx/xxxxx.hap', request.download({ url: 'https://xxxx/xxxxx.hap',
filePath: 'xxx/xxxxx.hap'}, (err, data) => { filePath: 'xxx/xxxxx.hap'}, (err, data) => {
if (err) { if (err) {
console.error('Failed to request the download. Cause: ' + JSON.stringify(err)); console.error(`Failed to request the download. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
downloadTask = data; downloadTask = data;
}); });
``` ```
...@@ -853,7 +873,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) =&gt; vo ...@@ -853,7 +873,7 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) =&gt; vo
```js ```js
let progresCallback = (receivedSize, totalSize) => { let progresCallback = (receivedSize, totalSize) => {
console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize); console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}; };
downloadTask.on('progress', progresCallback); downloadTask.on('progress', progresCallback);
``` ```
...@@ -880,7 +900,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =&gt; ...@@ -880,7 +900,7 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =&gt;
```js ```js
let progresCallback = (receivedSize, totalSize) => { let progresCallback = (receivedSize, totalSize) => {
console.info('Download delete progress notification.' + 'receivedSize:' + receivedSize + 'totalSize:' + totalSize); console.info('Download delete progress notification.' + 'receivedSize:' + receivedSize + 'totalSize:' + totalSize);
}; };
downloadTask.off('progress', progresCallback); downloadTask.off('progress', progresCallback);
``` ```
...@@ -907,17 +927,17 @@ on(type: 'complete'|'pause'|'remove', callback:() =&gt; void): void ...@@ -907,17 +927,17 @@ on(type: 'complete'|'pause'|'remove', callback:() =&gt; void): void
```js ```js
let completeCallback = () => { let completeCallback = () => {
console.info('Download task completed.'); console.info('Download task completed.');
}; };
downloadTask.on('complete', completeCallback); downloadTask.on('complete', completeCallback);
let pauseCallback = () => { let pauseCallback = () => {
console.info('Download task pause.'); console.info('Download task pause.');
}; };
downloadTask.on('pause', pauseCallback); downloadTask.on('pause', pauseCallback);
let removeCallback = () => { let removeCallback = () => {
console.info('Download task remove.'); console.info('Download task remove.');
}; };
downloadTask.on('remove', removeCallback); downloadTask.on('remove', removeCallback);
``` ```
...@@ -944,17 +964,17 @@ off(type: 'complete'|'pause'|'remove', callback?:() =&gt; void): void ...@@ -944,17 +964,17 @@ off(type: 'complete'|'pause'|'remove', callback?:() =&gt; void): void
```js ```js
let completeCallback = () => { let completeCallback = () => {
console.info('Download delete complete notification.'); console.info('Download delete complete notification.');
}; };
downloadTask.off('complete', completeCallback); downloadTask.off('complete', completeCallback);
let pauseCallback = () => { let pauseCallback = () => {
console.info('Download delete pause notification.'); console.info('Download delete pause notification.');
}; };
downloadTask.off('pause', pauseCallback); downloadTask.off('pause', pauseCallback);
let removeCallback = () => { let removeCallback = () => {
console.info('Download delete remove notification.'); console.info('Download delete remove notification.');
}; };
downloadTask.off('remove', removeCallback); downloadTask.off('remove', removeCallback);
``` ```
...@@ -987,7 +1007,7 @@ on(type: 'fail', callback: (err: number) =&gt; void): void ...@@ -987,7 +1007,7 @@ on(type: 'fail', callback: (err: number) =&gt; void): void
```js ```js
let failCallback = (err) => { let failCallback = (err) => {
console.info('Download task failed. Cause:' + err); console.error(`Failed to download the task. Code: ${err.code}, message: ${err.message}`);
}; };
downloadTask.on('fail', failCallback); downloadTask.on('fail', failCallback);
``` ```
...@@ -1014,7 +1034,7 @@ off(type: 'fail', callback?: (err: number) =&gt; void): void ...@@ -1014,7 +1034,7 @@ off(type: 'fail', callback?: (err: number) =&gt; void): void
```js ```js
let failCallback = (err) => { let failCallback = (err) => {
console.info(`Download delete fail notification. err: ${err.message}`); console.error(`Failed to download the task. Code: ${err.code}, message: ${err.message}`);
}; };
downloadTask.off('fail', failCallback); downloadTask.off('fail', failCallback);
``` ```
...@@ -1039,13 +1059,13 @@ delete(): Promise&lt;boolean&gt; ...@@ -1039,13 +1059,13 @@ delete(): Promise&lt;boolean&gt;
```js ```js
downloadTask.delete().then((result) => { downloadTask.delete().then((result) => {
if (result) { if (result) {
console.info('Download task removed.'); console.info('Succeeded in removing the download task.');
} else { } else {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
} }
}).catch ((err) => { }).catch ((err) => {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -1070,15 +1090,15 @@ delete(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1070,15 +1090,15 @@ delete(callback: AsyncCallback&lt;boolean&gt;): void
```js ```js
downloadTask.delete((err, result)=>{ downloadTask.delete((err, result)=>{
if(err) { if(err) {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Download task removed.'); console.info('Succeeded in removing the download task.');
} else { } else {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -1103,9 +1123,9 @@ getTaskInfo(): Promise&lt;DownloadInfo&gt; ...@@ -1103,9 +1123,9 @@ getTaskInfo(): Promise&lt;DownloadInfo&gt;
```js ```js
downloadTask.getTaskInfo().then((downloadInfo) => { downloadTask.getTaskInfo().then((downloadInfo) => {
console.info('Download task queried. Data:' + JSON.stringify(downloadInfo)) console.info('Succeeded in querying the download task')
}) .catch((err) => { }) .catch((err) => {
console.error('Failed to query the download task. Cause:' + err) console.error(`Failed to query the download task. Code: ${err.code}, message: ${err.message}`)
}); });
``` ```
...@@ -1130,11 +1150,11 @@ getTaskInfo(callback: AsyncCallback&lt;DownloadInfo&gt;): void ...@@ -1130,11 +1150,11 @@ getTaskInfo(callback: AsyncCallback&lt;DownloadInfo&gt;): void
```js ```js
downloadTask.getTaskInfo((err, downloadInfo)=>{ downloadTask.getTaskInfo((err, downloadInfo)=>{
if(err) { if(err) {
console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); console.error(`Failed to query the download mimeType. Code: ${err.code}, message: ${err.message}`);
} else { } else {
console.info('download query success. data:'+ JSON.stringify(downloadInfo)); console.info('Succeeded in querying the download mimeType');
} }
}); });
``` ```
...@@ -1159,9 +1179,9 @@ getTaskMimeType(): Promise&lt;string&gt; ...@@ -1159,9 +1179,9 @@ getTaskMimeType(): Promise&lt;string&gt;
```js ```js
downloadTask.getTaskMimeType().then((data) => { downloadTask.getTaskMimeType().then((data) => {
console.info('Download task queried. Data:' + JSON.stringify(data)); console.info('Succeeded in querying the download MimeType');
}).catch((err) => { }).catch((err) => {
console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err)) console.error(`Failed to query the download MimeType. Code: ${err.code}, message: ${err.message}`)
}); });
``` ```
...@@ -1186,11 +1206,11 @@ getTaskMimeType(callback: AsyncCallback&lt;string&gt;): void; ...@@ -1186,11 +1206,11 @@ getTaskMimeType(callback: AsyncCallback&lt;string&gt;): void;
```js ```js
downloadTask.getTaskMimeType((err, data)=>{ downloadTask.getTaskMimeType((err, data)=>{
if(err) { if(err) {
console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); console.error(`Failed to query the download mimeType. Code: ${err.code}, message: ${err.message}`);
} else { } else {
console.info('Download task queried. data:' + JSON.stringify(data)); console.info('Succeeded in querying the download mimeType');
} }
}); });
``` ```
...@@ -1215,13 +1235,13 @@ suspend(): Promise&lt;boolean&gt; ...@@ -1215,13 +1235,13 @@ suspend(): Promise&lt;boolean&gt;
```js ```js
downloadTask.suspend().then((result) => { downloadTask.suspend().then((result) => {
if (result) { if (result) {
console.info('Download task paused. '); console.info('Succeeded in pausing the download task.');
} else { } else {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(result)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
} }
}).catch((err) => { }).catch((err) => {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(err)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -1246,15 +1266,15 @@ suspend(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1246,15 +1266,15 @@ suspend(callback: AsyncCallback&lt;boolean&gt;): void
```js ```js
downloadTask.suspend((err, result)=>{ downloadTask.suspend((err, result)=>{
if(err) { if(err) {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(err)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Download task paused. '); console.info('Succeeded in pausing the download task.');
} else { } else {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(result)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -1279,14 +1299,14 @@ restore(): Promise&lt;boolean&gt; ...@@ -1279,14 +1299,14 @@ restore(): Promise&lt;boolean&gt;
```js ```js
downloadTask.restore().then((result) => { downloadTask.restore().then((result) => {
if (result) { if (result) {
console.info('Download task resumed.') console.info('Succeeded in resuming the download task.')
} else { } else {
console.error('Failed to resume the download task. '); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
} }
console.info('Download task resumed.') console.info('Succeeded in resuming the download task.')
}).catch((err) => { }).catch((err) => {
console.error('Failed to resume the download task. Cause:' + err); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -1311,20 +1331,19 @@ restore(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1311,20 +1331,19 @@ restore(callback: AsyncCallback&lt;boolean&gt;): void
```js ```js
downloadTask.restore((err, result)=>{ downloadTask.restore((err, result)=>{
if (err) { if (err) {
console.error('Failed to resume the download task. Cause:' + err); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Download task resumed.'); console.info('Succeeded in resuming the download task.');
} else { } else {
console.error('Failed to resume the download task.'); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
### remove<sup>(deprecated)</sup> ### remove<sup>(deprecated)</sup>
remove(): Promise&lt;boolean&gt; remove(): Promise&lt;boolean&gt;
...@@ -1347,13 +1366,13 @@ remove(): Promise&lt;boolean&gt; ...@@ -1347,13 +1366,13 @@ remove(): Promise&lt;boolean&gt;
```js ```js
downloadTask.remove().then((result) => { downloadTask.remove().then((result) => {
if (result) { if (result) {
console.info('Download task removed.'); console.info('Succeeded in removing the download task.');
} else { } else {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
} }
}).catch ((err) => { }).catch ((err) => {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -1380,15 +1399,15 @@ remove(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1380,15 +1399,15 @@ remove(callback: AsyncCallback&lt;boolean&gt;): void
```js ```js
downloadTask.remove((err, result)=>{ downloadTask.remove((err, result)=>{
if(err) { if(err) {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Download task removed.'); console.info('Succeeded in removing the download task.');
} else { } else {
console.error('Failed to remove the download task.'); console.error(`Failed to remove the download task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -1415,9 +1434,9 @@ query(): Promise&lt;DownloadInfo&gt; ...@@ -1415,9 +1434,9 @@ query(): Promise&lt;DownloadInfo&gt;
```js ```js
downloadTask.query().then((downloadInfo) => { downloadTask.query().then((downloadInfo) => {
console.info('Download task queried. Data:' + JSON.stringify(downloadInfo)) console.info('Succeeded in querying the download task.')
}) .catch((err) => { }) .catch((err) => {
console.error('Failed to query the download task. Cause:' + err) console.error(`Failed to query the download task. Code: ${err.code}, message: ${err.message}`)
}); });
``` ```
...@@ -1444,11 +1463,11 @@ query(callback: AsyncCallback&lt;DownloadInfo&gt;): void ...@@ -1444,11 +1463,11 @@ query(callback: AsyncCallback&lt;DownloadInfo&gt;): void
```js ```js
downloadTask.query((err, downloadInfo)=>{ downloadTask.query((err, downloadInfo)=>{
if(err) { if(err) {
console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); console.error(`Failed to query the download mimeType. Code: ${err.code}, message: ${err.message}`);
} else { } else {
console.info('download query success. data:'+ JSON.stringify(downloadInfo)); console.info('Succeeded in querying the download task.');
} }
}); });
``` ```
...@@ -1475,9 +1494,9 @@ queryMimeType(): Promise&lt;string&gt; ...@@ -1475,9 +1494,9 @@ queryMimeType(): Promise&lt;string&gt;
```js ```js
downloadTask.queryMimeType().then((data) => { downloadTask.queryMimeType().then((data) => {
console.info('Download task queried. Data:' + JSON.stringify(data)); console.info('Succeededto in querying the download MimeType.');
}).catch((err) => { }).catch((err) => {
console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err)) console.error(`Failed to query the download MimeType. Code: ${err.code}, message: ${err.message}`)
}); });
``` ```
...@@ -1504,11 +1523,11 @@ queryMimeType(callback: AsyncCallback&lt;string&gt;): void; ...@@ -1504,11 +1523,11 @@ queryMimeType(callback: AsyncCallback&lt;string&gt;): void;
```js ```js
downloadTask.queryMimeType((err, data)=>{ downloadTask.queryMimeType((err, data)=>{
if(err) { if(err) {
console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err)); console.error(`Failed to query the download mimeType. Code: ${err.code}, message: ${err.message}`);
} else { } else {
console.info('Download task queried. data:' + JSON.stringify(data)); console.info('Succeeded in querying the download mimeType.');
} }
}); });
``` ```
...@@ -1535,13 +1554,13 @@ pause(): Promise&lt;void&gt; ...@@ -1535,13 +1554,13 @@ pause(): Promise&lt;void&gt;
```js ```js
downloadTask.pause().then((result) => { downloadTask.pause().then((result) => {
if (result) { if (result) {
console.info('Download task paused. '); console.info('Succeeded in pausing the download task.');
} else { } else {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(result)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
} }
}).catch((err) => { }).catch((err) => {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(err)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -1568,15 +1587,15 @@ pause(callback: AsyncCallback&lt;void&gt;): void ...@@ -1568,15 +1587,15 @@ pause(callback: AsyncCallback&lt;void&gt;): void
```js ```js
downloadTask.pause((err, result)=>{ downloadTask.pause((err, result)=>{
if(err) { if(err) {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(err)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Download task paused. '); console.info('Succeeded in pausing the download task.');
} else { } else {
console.error('Failed to pause the download task. Cause:' + JSON.stringify(result)); console.error(`Failed to pause the download task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -1603,14 +1622,14 @@ resume(): Promise&lt;void&gt; ...@@ -1603,14 +1622,14 @@ resume(): Promise&lt;void&gt;
```js ```js
downloadTask.resume().then((result) => { downloadTask.resume().then((result) => {
if (result) { if (result) {
console.info('Download task resumed.') console.info('Succeeded in resuming the download task.')
} else { } else {
console.error('Failed to resume the download task. '); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
} }
console.info('Download task resumed.') console.info('Succeeded in resuming the download task.')
}).catch((err) => { }).catch((err) => {
console.error('Failed to resume the download task. Cause:' + err); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -1637,15 +1656,15 @@ resume(callback: AsyncCallback&lt;void&gt;): void ...@@ -1637,15 +1656,15 @@ resume(callback: AsyncCallback&lt;void&gt;): void
```js ```js
downloadTask.resume((err, result)=>{ downloadTask.resume((err, result)=>{
if (err) { if (err) {
console.error('Failed to resume the download task. Cause:' + err); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
return; return;
} }
if (result) { if (result) {
console.info('Download task resumed.'); console.info('Succeeded in resuming the download task.');
} else { } else {
console.error('Failed to resume the download task.'); console.error(`Failed to resume the download task. Code: ${err.code}, message: ${err.message}`);
} }
}); });
``` ```
...@@ -1895,6 +1914,7 @@ on(event: "progress" | "completed" | "failed", callback: (progress: Progress) =& ...@@ -1895,6 +1914,7 @@ on(event: "progress" | "completed" | "failed", callback: (progress: Progress) =&
**示例：** **示例：**
```js ```js
let context;
let attachments = [{ let attachments = [{
name: "taskOnTest", name: "taskOnTest",
value: { value: {
...@@ -1928,16 +1948,19 @@ on(event: "progress" | "completed" | "failed", callback: (progress: Progress) =& ...@@ -1928,16 +1948,19 @@ on(event: "progress" | "completed" | "failed", callback: (progress: Progress) =&
let createOnCallback = (progress) => { let createOnCallback = (progress) => {
console.info('upload task completed.'); console.info('upload task completed.');
}; };
request.agent.create(globalThis.abilityContext, conf).then((task)=> { request.agent.create(context, conf).then((task)=> {
task.on('progress', createOnCallback); task.on('progress', createOnCallback);
task.on('completed', createOnCallback); task.on('completed', createOnCallback);
task.on('failed', createOnCallback); task.on('failed', createOnCallback);
console.info(`create a upload task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a upload task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a upload task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a upload task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
### off('progress'|'completed'|'failed')<sup>10+</sup> ### off('progress'|'completed'|'failed')<sup>10+</sup>
...@@ -1951,7 +1974,7 @@ off(event: "progress" | "completed" | "failed", callback?: (progress: Progress) ...@@ -1951,7 +1974,7 @@ off(event: "progress" | "completed" | "failed", callback?: (progress: Progress)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| evt | string | 是 | 订阅的事件类型。<br>- 取值为'progress'，表示任务进度；<br/>- 取值为'completed'，表示任务已完成；<br/>- 取值为'failed'，表示任务失败。 | | event | string | 是 | 订阅的事件类型。<br>- 取值为'progress'，表示任务进度；<br/>- 取值为'completed'，表示任务已完成；<br/>- 取值为'failed'，表示任务失败。 |
| callback | function | 否 | 发生相关的事件时触发该回调方法，返回任务进度的数据结构| | callback | function | 否 | 发生相关的事件时触发该回调方法，返回任务进度的数据结构|
**错误码：** **错误码：**
...@@ -1965,6 +1988,7 @@ off(event: "progress" | "completed" | "failed", callback?: (progress: Progress) ...@@ -1965,6 +1988,7 @@ off(event: "progress" | "completed" | "failed", callback?: (progress: Progress)
**示例：** **示例：**
```js ```js
let context;
let attachments = [{ let attachments = [{
name: "taskOffTest", name: "taskOffTest",
value: { value: {
...@@ -1998,19 +2022,22 @@ off(event: "progress" | "completed" | "failed", callback?: (progress: Progress) ...@@ -1998,19 +2022,22 @@ off(event: "progress" | "completed" | "failed", callback?: (progress: Progress)
let createOffCallback = (progress) => { let createOffCallback = (progress) => {
console.info('upload task completed.'); console.info('upload task completed.');
}; };
request.agent.create(globalThis.abilityContext, conf).then((task)=> { request.agent.create(context, conf).then((task)=> {
task.on('progress', createOffCallback); task.on('progress', createOffCallback);
task.on('completed', createOffCallback); task.on('completed', createOffCallback);
task.on('failed', createOffCallback); task.on('failed', createOffCallback);
task.off('progress', createOffCallback); task.off('progress', createOffCallback);
task.off('completed', createOffCallback); task.off('completed', createOffCallback);
task.off('failed', createOffCallback); task.off('failed', createOffCallback);
console.info(`create a upload task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a upload task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a upload task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a upload task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
### start<sup>10+</sup> ### start<sup>10+</sup>
...@@ -2040,6 +2067,7 @@ start(callback: AsyncCallback&lt;void&gt;): void ...@@ -2040,6 +2067,7 @@ start(callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2062,20 +2090,23 @@ start(callback: AsyncCallback&lt;void&gt;): void ...@@ -2062,20 +2090,23 @@ start(callback: AsyncCallback&lt;void&gt;): void
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.start((err) => { task.start((err) => {
if (err) { if (err) {
console.error(`Failed to start the download task, because: ${JSON.stringify(err)}`); console.error(`Failed to start the download task, Code: ${err.code}, message: ${err.message}`);
return; return;
} }
console.info(`start a download task successfully. `); console.info(`Succeeded in starting a download task.`);
}) });
console.info(`create a download task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
### start<sup>10+</sup> ### start<sup>10+</sup>
...@@ -2105,6 +2136,7 @@ start(): Promise&lt;void&gt; ...@@ -2105,6 +2136,7 @@ start(): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2127,18 +2159,21 @@ start(): Promise&lt;void&gt; ...@@ -2127,18 +2159,21 @@ start(): Promise&lt;void&gt;
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.start().then(() => { task.start().then(() => {
console.info(`start a download task successfully. `); console.info(`Succeeded in starting a download task.`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to start the download task, because: ${JSON.stringify(err)}`); console.error(`Failed to start the download task, Code: ${err.code}, message: ${err.message}`);
}); });
console.info(`create a download task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
### pause<sup>10+</sup> ### pause<sup>10+</sup>
...@@ -2167,6 +2202,7 @@ pause(callback: AsyncCallback&lt;void&gt;): void ...@@ -2167,6 +2202,7 @@ pause(callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2189,17 +2225,17 @@ pause(callback: AsyncCallback&lt;void&gt;): void ...@@ -2189,17 +2225,17 @@ pause(callback: AsyncCallback&lt;void&gt;): void
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.pause((err) => { task.pause((err) => {
if (err) { if (err) {
console.error(`Failed to pause the download task, because: ${JSON.stringify(err)}`); console.error(`Failed to pause the download task, Code: ${err.code}, message: ${err.message}`);
return; return;
} }
console.info(`pause a download task successfully. `); console.info(`Succeeded in pausing a download task. `);
}) });
console.info(`create a download task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -2231,6 +2267,7 @@ pause(): Promise&lt;void&gt; ...@@ -2231,6 +2267,7 @@ pause(): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2253,15 +2290,15 @@ pause(): Promise&lt;void&gt; ...@@ -2253,15 +2290,15 @@ pause(): Promise&lt;void&gt;
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.pause().then(() => { task.pause().then(() => {
console.info(`pause a upload task successfully. `); console.info(`Succeeded in pausing a download task. `);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to pause the upload task, because: ${JSON.stringify(err)}`); console.error(`Failed to pause the upload task, Code: ${err.code}, message: ${err.message}`);
}); });
console.info(`create a upload task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a upload task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a upload task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -2295,6 +2332,7 @@ resume(callback: AsyncCallback&lt;void&gt;): void ...@@ -2295,6 +2332,7 @@ resume(callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2317,15 +2355,17 @@ resume(callback: AsyncCallback&lt;void&gt;): void ...@@ -2317,15 +2355,17 @@ resume(callback: AsyncCallback&lt;void&gt;): void
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.resume().then(() => { task.resume((err) => {
console.info(`resume a download task successfully. `); if (err) {
}).catch((err) => { console.error(`Failed to resume the download task, Code: ${err.code}, message: ${err.message}`);
console.error(`Failed to resume the download task, because: ${JSON.stringify(err)}`); return;
}
console.info(`Succeeded in resuming a download task. `);
}); });
console.info(`create a download task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -2359,6 +2399,7 @@ resume(): Promise&lt;void&gt; ...@@ -2359,6 +2399,7 @@ resume(): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2381,17 +2422,15 @@ resume(): Promise&lt;void&gt; ...@@ -2381,17 +2422,15 @@ resume(): Promise&lt;void&gt;
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.resume((err) => { task.resume().then(() => {
if (err) { console.info(`Succeeded in resuming a download task. `);
console.error(`Failed to resume the download task, because: ${JSON.stringify(err)}`); }).catch((err) => {
return; console.error(`Failed to resume the download task, Code: ${err.code}, message: ${err.message}`);
} });
console.info(`resume a download task successfully. `); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
})
console.info(`create a download task successfully. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -2422,6 +2461,7 @@ stop(callback: AsyncCallback&lt;void&gt;): void ...@@ -2422,6 +2461,7 @@ stop(callback: AsyncCallback&lt;void&gt;): void
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2444,15 +2484,17 @@ stop(callback: AsyncCallback&lt;void&gt;): void ...@@ -2444,15 +2484,17 @@ stop(callback: AsyncCallback&lt;void&gt;): void
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.stop().then(() => { task.stop((err) => {
console.info(`stop a download task successfully. `); if (err) {
}).catch((err) => { console.error(`Failed to stop the download task, Code: ${err.code}, message: ${err.message}`);
console.error(`Failed to stop the download task, because: ${JSON.stringify(err)}`); return;
}
console.info(`Succeeded in stopping a download task. `);
}); });
console.info(`create a download task successfully. result: ${task.tid}`); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -2483,6 +2525,7 @@ stop(): Promise&lt;void&gt; ...@@ -2483,6 +2525,7 @@ stop(): Promise&lt;void&gt;
**示例：** **示例：**
```js ```js
let context;
let conf = { let conf = {
action: request.agent.Action.DOWNLOAD, action: request.agent.Action.DOWNLOAD,
url: 'http://127.0.0.1', url: 'http://127.0.0.1',
...@@ -2505,17 +2548,15 @@ stop(): Promise&lt;void&gt; ...@@ -2505,17 +2548,15 @@ stop(): Promise&lt;void&gt;
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task) => { request.agent.create(context, conf).then((task) => {
task.stop((err) => { task.stop().then(() => {
if (err) { console.info(`Succeeded in stopping a download task. `);
console.error(`Failed to stop the download task, because: ${JSON.stringify(err)}`); }).catch((err) => {
return; console.error(`Failed to stop the download task, Code: ${err.code}, message: ${err.message}`);
} });
console.info(`stop a download task successfully. `); console.info(`Succeeded in creating a download task. result: ${task.tid}`);
})
console.info(`create a download task successfully. result: ${task.tid}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a download task, because: ${JSON.stringify(err)}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
...@@ -2552,6 +2593,7 @@ create(context: BaseContext, conf: Conf, callback: AsyncCallback&lt;Task&gt;): v ...@@ -2552,6 +2593,7 @@ create(context: BaseContext, conf: Conf, callback: AsyncCallback&lt;Task&gt;): v
**示例：** **示例：**
```js ```js
let context;
let attachments = [{ let attachments = [{
name: "reeateTest", name: "reeateTest",
value: { value: {
...@@ -2582,15 +2624,18 @@ create(context: BaseContext, conf: Conf, callback: AsyncCallback&lt;Task&gt;): v ...@@ -2582,15 +2624,18 @@ create(context: BaseContext, conf: Conf, callback: AsyncCallback&lt;Task&gt;): v
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf, (err, task) => { request.agent.create(context, conf, (err, task) => {
if (err) { if (err) {
console.error(`Failed to create a upload task, because: ${err.message}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
return; return;
} }
console.info(`create a upload task successfully. result: ${task.conf}`); console.info(`Succeeded in creating a download task. result: ${task.conf}`);
}); });
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
## request.agent.create<sup>10+</sup> ## request.agent.create<sup>10+</sup>
...@@ -2630,6 +2675,7 @@ create(context: BaseContext, conf: Conf): Promise&lt;Task&gt; ...@@ -2630,6 +2675,7 @@ create(context: BaseContext, conf: Conf): Promise&lt;Task&gt;
**示例：** **示例：**
```js ```js
let context;
let attachments = [{ let attachments = [{
name: "reeateTest", name: "reeateTest",
value: { value: {
...@@ -2660,13 +2706,16 @@ create(context: BaseContext, conf: Conf): Promise&lt;Task&gt; ...@@ -2660,13 +2706,16 @@ create(context: BaseContext, conf: Conf): Promise&lt;Task&gt;
precise: false, precise: false,
token: "it is a secret" token: "it is a secret"
}; };
request.agent.create(globalThis.abilityContext, conf).then((task)=> { request.agent.create(context, conf).then((task)=> {
console.info(`create a upload task successfully. result: ${task.conf}`); console.info(`Succeeded in creating a download task. result: ${task.conf}`);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to create a upload task, because: ${err.message}`); console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
> **说明：**
>
> 示例中context的获取方式请参见[获取UIAbility的上下文信息](../../application-models/uiability-usage.md#获取uiability的上下文信息)。
## request.agent.remove<sup>10+</sup> ## request.agent.remove<sup>10+</sup>
...@@ -2697,10 +2746,10 @@ remove(id: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -2697,10 +2746,10 @@ remove(id: string, callback: AsyncCallback&lt;void&gt;): void
```js ```js
request.agent.remove("id", (err) => { request.agent.remove("id", (err) => {
if (err) { if (err) {
console.error(`Failed to remove a upload task, because: ${JSON.stringify(err)}`); console.error(`Failed to removing a download task, Code: ${err.code}, message: ${err.message}`);
return; return;
} }
console.info(`remove a upload task successfully.`); console.info(`Succeeded in creating a download task.`);
}); });
``` ```
...@@ -2738,9 +2787,9 @@ remove(id: string): Promise&lt;void&gt; ...@@ -2738,9 +2787,9 @@ remove(id: string): Promise&lt;void&gt;
```js ```js
request.agent.remove("id").then(() => { request.agent.remove("id").then(() => {
console.info(`remove a upload task successfully. `); console.info(`Succeeded in removing a download task. `);
}).catch((err) => { }).catch((err) => {
console.error(`Failed to remove a upload task, because: ${JSON.stringify(err)}`); console.error(`Failed to remove a download task, Code: ${err.code}, message: ${err.message}`);
}); });
``` ```
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或