@ohos.request (上传下载)(系统接口)

request部件主要给应用提供上传下载文件、后台传输代理的基础能力。

说明:

本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 当前界面仅包含本模块的系统接口,其他公开接口参见@ohos.request

导入模块

import request from '@ohos.request';

Filter10+

过滤条件。

需要权限:ohos.permission.INTERNET

系统能力: SystemCapability.Request.FileTransferAgent

名称 类型 必填 说明
bundle string 指定应用程序的包名,仅对系统应用开放。
系统接口:此接口为系统接口。

TaskInfo10+

查询结果的任务信息数据结构,提供普通查询和系统查询,两种字段的可见范围不同。

需要权限:ohos.permission.INTERNET

系统能力: SystemCapability.Request.FileTransferAgent

名称 类型 必填 说明
uid string 应用程序的UID,仅用于系统查询。
系统接口:此接口为系统接口。
bundle string 应用程序的包名,仅用于系统查询。
系统接口:此接口为系统接口。

request.agent.query10+

query(id: string, callback: AsyncCallback<TaskInfo>): void

根据任务id查询任务的详细信息。使用callback异步回调。

需要权限:ohos.permission.DOWNLOAD_SESSION_MANAGER 或 ohos.permission.UPLOAD_SESSION_MANAGER

系统能力: SystemCapability.Request.FileTransferAgent

系统接口:此接口为系统接口。

参数:

参数名 类型 必填 说明
id string 任务id。
callback AsyncCallback<TaskInfo> 回调函数,返回任务详细信息。

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

错误码ID 错误信息
13400003 task service ability error.
21900006 task not found error.

示例:

request.agent.query("123456", (err: BusinessError, taskInfo: request.agent.TaskInfo) => {
  if (err) {
    console.error(`Failed to query a upload task, Code: ${err.code}, message: ${err.message}`);
    return;
  }
  console.info(`Succeeded in querying a upload task. result: ${taskInfo.uid}`);
});

request.agent.query10+

query(id: string): Promise<TaskInfo>

根据任务id查询任务的详细信息。使用Promise异步回调。

需要权限:ohos.permission.DOWNLOAD_SESSION_MANAGER 或 ohos.permission.UPLOAD_SESSION_MANAGER

系统能力: SystemCapability.Request.FileTransferAgent

系统接口:此接口为系统接口。

参数:

参数名 类型 必填 说明
id string 任务id。

返回值:

类型 说明
Promise<TaskInfo> Promise对象。返回任务详细信息的Promise对象。

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

错误码ID 错误信息
13400003 task service ability error.
21900006 task not found error.

示例:

request.agent.query("123456").then((taskInfo: request.agent.TaskInfo) => {
  console.info(`Succeeded in querying a upload task. result: ${taskInfo.uid}`);
}).catch((err: BusinessError) => {
  console.error(`Failed to query a upload task, Code: ${err.code}, message: ${err.message}`);
});