HarmonyOS API：@ohos.request (上传下载)

joytrian

发布于 2023-4-7 15:56

浏览

0收藏

版本：v3.1 Beta

@ohos.request (上传下载)

File

需要权限：ohos.permission.INTERNET

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download。

名称	类型	必填	说明
filename	string	是	multipart提交时，请求头中的文件名。
name	string	是	multipart提交时，表单项目的名称，缺省为file。
uri	string	是	文件的本地存储路径。仅支持“internal”协议类型，“internal://cache/”为必填字段，示例：internal://cache/path/to/file.txt
type	string	是	文件的内容类型，默认根据文件名或路径的后缀获取。

RequestData

需要权限：ohos.permission.INTERNET

系统能力: 以下各项对应的系统能力均为SystemCapability.MiscServices.Download。

名称	类型	必填	说明
name	string	是	表示表单元素的名称。
value	string	是	表示表单元素的值。

request.downloadFile⁹⁺

downloadFile(context: BaseContext, config: DownloadConfig): Promise<DownloadTask>

下载，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
context	BaseContext	是	基于应用程序的上下文。
config	DownloadConfig	是	下载的配置信息。

返回值：

类型	说明
Promise<DownloadTask>	返回下载任务。

错误码：

以下错误码的详细介绍请参见上传下载错误码。

错误码ID	错误信息
13400001	File operation error.
13400002	Bad file path.
13400003	Task manager service error.

示例：

let downloadTask;
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; 
      } 
      downloadTask = data;
  }); 
} catch (err) { 
  console.error('err.code : ' + err.code + ', err.message : ' + err.message); 
}

request.downloadFile⁹⁺

downloadFile(context: BaseContext, config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void;

下载，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
context	BaseContext	是	基于应用程序的上下文。
config	DownloadConfig	是	下载的配置信息。
callback	AsyncCallback<DownloadTask>	是	下载接口的回调函数。

错误码：

以下错误码的详细介绍请参见上传下载错误码。

错误码ID	错误信息
13400001	File operation error.
13400002	Bad file path.
13400003	Task manager service error.

示例：

let downloadTask;
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;
    }
    downloadTask = data;
});

request.download^(deprecated)

download(config: DownloadConfig): Promise<DownloadTask>

下载，异步方法，使用promise形式返回结果。

模型约束：此接口仅可在FA模型下使用

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
config	DownloadConfig	是	下载的配置信息。

返回值：

类型	说明
Promise<DownloadTask>	返回下载任务。

示例：

let downloadTask;
request.download({ 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(config: DownloadConfig, callback: AsyncCallback<DownloadTask>): void

下载，异步方法，使用callback形式返回结果。

模型约束：此接口仅可在FA模型下使用

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
config	DownloadConfig	是	下载的配置信息。
callback	AsyncCallback<DownloadTask>	是	下载接口的回调函数。

示例：

let downloadTask;
request.download({ 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;
});

request.download^(deprecated)

download(context: BaseContext, config: DownloadConfig): Promise<DownloadTask>

下载，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
context	BaseContext	是	基于应用程序的上下文。
config	DownloadConfig	是	下载的配置信息。

返回值：

类型	说明
Promise<DownloadTask>	返回下载任务。

示例：

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形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
context	BaseContext	是	基于应用程序的上下文。
config	DownloadConfig	是	下载的配置信息。
callback	AsyncCallback<DownloadTask>	是	下载接口的回调函数。

示例：

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

下载任务。

on('progress')

on(type: 'progress', callback:(receivedSize: number, totalSize: number) => void): void

开启下载任务监听，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型，取值为'progress'（下载的进度信息）。
callback	function	是	下载的回调函数。

回调函数的参数：

参数名	类型	必填	说明
receivedSize	number	是	当前下载的进度，单位为bit。
totalSize	number	是	下载文件的总大小，单位为bit。

示例：

downloadTask.on('progress', function download_callback(receivedSize, totalSize) {
    console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}
);

off('progress')

off(type: 'progress', callback?: (receivedSize: number, totalSize: number) => void): void

关闭下载任务监听，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
type	string	是	取消订阅的事件类型，取值为'progress'（下载的进度信息）。
callback	function	否	下载任务的回调函数。

回调函数的参数：

参数名	类型	必填	说明
receivedSize	number	是	当前下载的进度。
totalSize	number	是	下载文件的总大小。

示例：

downloadTask .off('progress', function download_callback(receivedSize, totalSize) {
    console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}
);

on('complete'|'pause'|'remove')⁷⁺

on(type: 'complete'|'pause'|'remove', callback:() => void): void

开启下载任务相关的监听，异步方法，使用callback形式返回。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型。 - 取值为'complete'，表示下载任务完成； - 取值为'pause'，表示下载任务暂停； - 取值为'remove'，表示下载任务移除。
callback	function	是	回调函数。

示例：

downloadTask.on('complete', function callback() {
    console.info('Download task completed.');
}
);

off('complete'|'pause'|'remove')⁷⁺

off(type: 'complete'|'pause'|'remove', callback?:() => void): void

取消下载任务相关的监听，异步方法，使用callback形式返回。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
type	string	是	取消订阅的事件类型。 - 取值为'complete'，表示下载任务完成； - 取值为'pause'，表示下载任务暂停； - 取值为'remove'，表示下载任务移除。
callback	function	否	回调函数。

示例：

downloadTask.off('complete', function callback() {
    console.info('Download task completed.');
}
);

on('fail')⁷⁺

on(type: 'fail', callback: (err: number) => void): void

开启下载任务失败监听，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
type	string	是	订阅的事件类型，取值为'fail'（下载失败）。
callback	function	是	下载失败的回调函数。

回调函数的参数：

参数名	类型	必填	说明
err	number	是	下载失败的错误码，错误原因见ERROR.*。

示例：

downloadTask.on('fail', function callBack(err) {
    console.info('Download task failed. Cause:' + err);
}
);

off('fail')⁷⁺

off(type: 'fail', callback?: (err: number) => void): void

取消下载任务失败监听，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
type	string	是	取消订阅的事件类型，取值为'fail'（下载失败）。
callback	function	否	取消下载失败的回调函数。

回调函数的参数

参数名	类型	必填	说明
err	number	是	下载失败的错误码。错误原因见ERROR_*。

示例：

downloadTask.off('fail', function callBack(err) {
    console.info('Download task failed. Cause:' + err);
} 
);

delete⁹⁺

delete(): Promise<boolean>

移除下载的任务，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<boolean>	移除任务是否成功。

示例：

downloadTask.delete().then((result) => {
    if (result) {
        console.info('Download task removed.');
    } else {
        console.error('Failed to remove the download task.');
    }
}).catch ((err) => {
    console.error('Failed to remove the download task.');
});

delete⁹⁺

delete(callback: AsyncCallback<boolean>): void

移除下载的任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	移除任务是否成功。

示例：

downloadTask.delete((err, result)=>{
    if(err) {
        console.error('Failed to remove the download task.');
        return;
    } 
    if (result) {
        console.info('Download task removed.');
    } else {
        console.error('Failed to remove the download task.');
    } 
});

getTaskInfo⁹⁺

getTaskInfo(): Promise<DownloadInfo>

查询下载任务，异步方法，使用promise形式返回DownloadInfo里的信息。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<DownloadInfo>	查询下载任务信息。

示例：

downloadTask.getTaskInfo().then((downloadInfo) => {    
    console.info('Download task queried. Data:' + JSON.stringify(downloadInfo))
}) .catch((err) => {
    console.error('Failed to query the download task. Cause:' + err)
});

getTaskInfo⁹⁺

getTaskInfo(callback: AsyncCallback<DownloadInfo>): void

查询下载的任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<DownloadInfo>	是	查询下载任务的回调函数。

示例：

downloadTask.getTaskInfo((err, downloadInfo)=>{
    if(err) {
        console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err));
    } else {
        console.info('download query success. data:'+ JSON.stringify(downloadInfo));
    }
});

getTaskMimeType⁹⁺

getTaskMimeType(): Promise<string>

查询下载的任务的 MimeType，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<string>	查询下载任务的MimeType。

示例：

downloadTask.getTaskMimeType().then((data) => {    
    console.info('Download task queried. Data:' + JSON.stringify(data));
}).catch((err) => {
    console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err))
});

getTaskMimeType⁹⁺

getTaskMimeType(callback: AsyncCallback<string>): void;

查询下载的任务的 MimeType，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	查询下载任务的MimeType的回调函数。

示例：

downloadTask.getTaskMimeType((err, data)=>{
    if(err) {
        console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err));
    } else {
        console.info('Download task queried. data:' + JSON.stringify(data));
    }
});

suspend⁹⁺

suspend(): Promise<boolean>

暂停下载任务，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<boolean>	暂停下载任务是否成功。

示例：

downloadTask.suspend().then((result) => {    
    if (result) {
         console.info('Download task paused. ');
    } else {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(result));
    }
}).catch((err) => {
    console.error('Failed to pause the download task. Cause:' + JSON.stringify(err));
});

suspend⁹⁺

suspend(callback: AsyncCallback<boolean>): void

暂停下载任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	暂停下载任务的回调函数。

示例：

downloadTask.suspend((err, result)=>{
    if(err) {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(err));
        return;
    }
    if (result) {
         console.info('Download task paused. ');
    } else {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(result));
    }
});

restore⁹⁺

restore(): Promise<boolean>

重新启动暂停的下载任务，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<boolean>	重新启动暂停的下载任务是否成功。

示例：

downloadTask.restore().then((result) => {
    if (result) {
        console.info('Download task resumed.')
    } else {
        console.error('Failed to resume the download task. ');
    }
    console.info('Download task resumed.')
}).catch((err) => {
    console.error('Failed to resume the download task. Cause:' + err);
});

restore⁹⁺

restore(callback: AsyncCallback<boolean>): void

重新启动暂停的下载任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	重新启动暂停的下载任务的回调函数。

示例：

downloadTask.restore((err, result)=>{
    if (err) {
        console.error('Failed to resume the download task. Cause:' + err);
        return;
    } 
    if (result) {
        console.info('Download task resumed.');
    } else {
        console.error('Failed to resume the download task.');
    }
});

remove^(deprecated)

remove(): Promise<boolean>

移除下载的任务，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<boolean>	移除任务是否成功。

示例：

downloadTask.remove().then((result) => {
    if (result) {
        console.info('Download task removed.');
    } else {
        console.error('Failed to remove the download task.');
    }
}).catch ((err) => {
    console.error('Failed to remove the download task.');
});

remove^(deprecated)

remove(callback: AsyncCallback<boolean>): void

移除下载的任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<boolean>	是	移除任务是否成功。

示例：

downloadTask.remove((err, result)=>{
    if(err) {
        console.error('Failed to remove the download task.');
        return;
    } 
    if (result) {
        console.info('Download task removed.');
    } else {
        console.error('Failed to remove the download task.');
    } 
});

query^(deprecated)

query(): Promise<DownloadInfo>

查询下载任务，异步方法，使用promise形式返回DownloadInfo里的信息。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<DownloadInfo>	查询下载任务信息。

示例：

downloadTask.query().then((downloadInfo) => {    
    console.info('Download task queried. Data:' + JSON.stringify(downloadInfo))
}) .catch((err) => {
    console.error('Failed to query the download task. Cause:' + err)
});

query^(deprecated)

query(callback: AsyncCallback<DownloadInfo>): void

查询下载的任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<DownloadInfo>	是	查询下载任务的回调函数。

示例：

downloadTask.query((err, downloadInfo)=>{
    if(err) {
        console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err));
    } else {
        console.info('download query success. data:'+ JSON.stringify(downloadInfo));
    }
});

queryMimeType^(deprecated)

queryMimeType(): Promise<string>

查询下载的任务的 MimeType，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<string>	查询下载任务的MimeType。

示例：

downloadTask.queryMimeType().then((data) => {    
    console.info('Download task queried. Data:' + JSON.stringify(data));
}).catch((err) => {
    console.error('Failed to query the download MimeType. Cause:' + JSON.stringify(err))
});

queryMimeType^(deprecated)

queryMimeType(callback: AsyncCallback<string>): void;

查询下载的任务的 MimeType，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<string>	是	查询下载任务的MimeType的回调函数。

示例：

downloadTask.queryMimeType((err, data)=>{
    if(err) {
        console.error('Failed to query the download mimeType. Cause:' + JSON.stringify(err));
    } else {
        console.info('Download task queried. data:' + JSON.stringify(data));
    }
});

pause^(deprecated)

pause(): Promise<void>

暂停下载任务，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<void>	暂停下载任务是否成功。

示例：

downloadTask.pause().then((result) => {    
    if (result) {
         console.info('Download task paused. ');
    } else {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(result));
    }
}).catch((err) => {
    console.error('Failed to pause the download task. Cause:' + JSON.stringify(err));
});

pause^(deprecated)

pause(callback: AsyncCallback<void>): void

暂停下载任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	暂停下载任务的回调函数。

示例：

downloadTask.pause((err, result)=>{
    if(err) {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(err));
        return;
    }
    if (result) {
         console.info('Download task paused. ');
    } else {
        console.error('Failed to pause the download task. Cause:' + JSON.stringify(result));
    }
});

resume^(deprecated)

resume(): Promise<void>

重新启动暂停的下载任务，异步方法，使用promise形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

返回值：

类型	说明
Promise<void>	重新启动暂停的下载任务是否成功。

示例：

downloadTask.resume().then((result) => {
    if (result) {
        console.info('Download task resumed.')
    } else {
        console.error('Failed to resume the download task. ');
    }
    console.info('Download task resumed.')
}).catch((err) => {
    console.error('Failed to resume the download task. Cause:' + err);
});

resume^(deprecated)

resume(callback: AsyncCallback<void>): void

重新启动暂停的下载任务，异步方法，使用callback形式返回结果。

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

参数：

参数名	类型	必填	说明
callback	AsyncCallback<void>	是	重新启动暂停的下载任务的回调函数。

示例：

downloadTask.resume((err, result)=>{
    if (err) {
        console.error('Failed to resume the download task. Cause:' + err);
        return;
    } 
    if (result) {
        console.info('Download task resumed.');
    } else {
        console.error('Failed to resume the download task.');
    }
});

DownloadConfig

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

名称	类型	必填	说明
url	string	是	资源地址。
header	Object	否	添加要包含在下载请求中的HTTPS标志头。开发者可以通过header的X-TLS-Version参数指定需要使用的TLS版本(如果不指定，则默认使用CURL_SSLVERSION_TLSv1_2版本，指定则使用指定版本。) CURL_SSLVERSION_TLSv1_0 CURL_SSLVERSION_TLSv1_1 CURL_SSLVERSION_TLSv1_2 CURL_SSLVERSION_TLSv1_3 通过header的X-Cipher-List参数指定需要使用的密码套件(如果不指定，则默认使用安全密码套件，指定则使用指定密码套件。) -1.2允许使用的密码套件白名单： TLS_DHE_RSA_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_DHE_DSS_WITH_AES_128_GCM_SHA256,TLS_DSS_RSA_WITH_AES_256_GCM_SHA384, TLS_PSK_WITH_AES_256_GCM_SHA384,TLS_DHE_PSK_WITH_AES_128_GCM_SHA256, TLS_DHE_PSK_WITH_AES_256_GCM_SHA384,TLS_DHE_PSK_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_PSK_WITH_CHACHA20_POLY1305_SHA256, TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256,TLS_ECDHE_PSK_WITH_AES_256_GCM_SHA384, TLS_ECDHE_PSK_WITH_AES_128_GCM_SHA256,TLS_DHE_RSA_WITH_AES_128_CCM, TLS_DHE_RSA_WITH_AES_256_CCM,TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256, TLS_PSK_WITH_AES_256_CCM,TLS_DHE_PSK_WITH_AES_128_CCM, TLS_DHE_PSK_WITH_AES_256_CCM,TLS_ECDHE_ECDSA_WITH_AES_128_CCM, TLS_ECDHE_ECDSA_WITH_AES_256_CCM,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 -1.3允许使用的密码套件白名单： TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384,TLS_CHACHA20_POLY1305_SHA256,TLS_AES_128_CCM_SHA256 -1.3新增国密算法套： TLS_SM4_GCM_SM3,TLS_SM4_CCM_SM3
enableMetered	boolean	否	设置是否允许在按流量计费的连接下下载。 - true：是 - false：否
enableRoaming	boolean	否	设置是否允许在漫游网络中下载。 - true：是 - false：否
description	string	否	设置下载会话的描述。
filePath⁷⁺	string	否	设置下载路径。。 - filePath:'/data/storage/el2/base/haps/entry/files/test.txt'：将文件存储在绝对路径下。 - FA模型下使用context获取应用存储路径，比如：'${featureAbility.getContext().getFilesDir()}/test.txt'，并将文件存储在此路径下。- Stage模型下使用AbilityContext 类获取文件路径，比如：'${globalThis.abilityContext.tempDir}/test.txt'并将文件存储在此路径下。- FA模型下使用context获取应用存储路径，比如：'${featureAbility.getContext().getFilesDir()}/test.txt'，并将文件存储在此路径下。- Stage模型下使用AbilityContext 类获取文件路径，比如：'${globalThis.abilityContext.tempDir}/test.txt'并将文件存储在此路径下。
networkType	number	否	设置允许下载的网络类型。 - NETWORK_MOBILE：0x00000001 - NETWORK_WIFI：0x00010000
title	string	否	设置下载会话标题。
background⁹⁺	boolean	否	后台任务通知开关，开启后可在通知中显示下载状态。

DownloadInfo⁷⁺

需要权限：ohos.permission.INTERNET

系统能力: SystemCapability.MiscServices.Download

名称	类型	必填	说明
downloadId	number	是	下载的文件ID。
failedReason	number	否	下载失败原因，可以是任何ERROR_*常量。
fileName	string	是	下载的文件名。
filePath	string	是	存储文件的URI。
pausedReason	number	否	会话暂停的原因，可以是任何PAUSED_*常量。
status	number	是	下载状态代码，可以是任何SESSION_*常量。
targetURI	string	是	下载文件的URI。
downloadTitle	string	是	下载的文件的标题。
downloadTotalBytes	number	是	下载的文件的总大小（int bytes）。
description	string	是	待下载文件的描述信息。
downloadedBytes	number	是	实时下载大小（int bytes）。

文章转载自：https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-request-0000001428061972-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001428061972__resumedeprecated-1

分类

卡片开发

三方库

标签

HarmonyOS API

已于2023-4-7 15:56:08修改

51CTO

51CTO博客

51CTO学堂

HarmonyOS API：@ohos.request (上传下载)

@ohos.request (上传下载)

File

RequestData

request.downloadFile9+

request.downloadFile9+

request.download(deprecated)

request.download(deprecated)

request.download(deprecated)

request.download(deprecated)

DownloadTask

on('progress')

off('progress')

on('complete'|'pause'|'remove')7+

off('complete'|'pause'|'remove')7+

on('fail')7+

off('fail')7+

delete9+

delete9+

getTaskInfo9+

getTaskInfo9+

getTaskMimeType9+

getTaskMimeType9+

suspend9+

suspend9+

restore9+

restore9+

remove(deprecated)

remove(deprecated)

query(deprecated)

query(deprecated)

queryMimeType(deprecated)

queryMimeType(deprecated)

pause(deprecated)

pause(deprecated)

resume(deprecated)

resume(deprecated)

DownloadConfig

DownloadInfo7+

目录

订阅鸿蒙技术特刊，精选内容抢先看

request.downloadFile⁹⁺

request.downloadFile⁹⁺

request.download^(deprecated)

request.download^(deprecated)

request.download^(deprecated)

request.download^(deprecated)

on('complete'|'pause'|'remove')⁷⁺

off('complete'|'pause'|'remove')⁷⁺

on('fail')⁷⁺

off('fail')⁷⁺

delete⁹⁺

delete⁹⁺

getTaskInfo⁹⁺

getTaskInfo⁹⁺

getTaskMimeType⁹⁺

getTaskMimeType⁹⁺

suspend⁹⁺

suspend⁹⁺

restore⁹⁺

restore⁹⁺

remove^(deprecated)

remove^(deprecated)

query^(deprecated)

query^(deprecated)

queryMimeType^(deprecated)

queryMimeType^(deprecated)

pause^(deprecated)

pause^(deprecated)

resume^(deprecated)

resume^(deprecated)

DownloadInfo⁷⁺