1# @ohos.request (上传下载)(系统接口) 2 3request部件主要给应用提供上传下载文件、后台传输代理的基础能力。 4 5> **说明：** 6> 7> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8> 9> 当前界面仅包含本模块的系统接口，其他公开接口参见[@ohos.request](js-apis-request.md)。 10 11 12## 导入模块 13 14 15```js 16import { request } from '@kit.BasicServicesKit'; 17``` 18 19 20## Filter<sup>10+</sup> 21 22过滤条件。 23 24**系统能力**：SystemCapability.Request.FileTransferAgent 25 26| 名称 | 类型 | 必填 | 说明 | 27| -------- | -------- | -------- | -------- | 28| bundle | string | 否 | 指定应用程序的包名，仅对系统应用开放。<br/>**系统接口**：此接口为系统接口。 | 29 30 31## TaskInfo<sup>10+</sup> 32 33查询结果的任务信息数据结构。提供普通查询和系统查询，两种字段的可见范围不同。 34 35**系统能力**：SystemCapability.Request.FileTransferAgent 36 37| 名称 | 类型 | 必填 | 说明 | 38| -------- | -------- | -------- | -------- | 39| uid | string | 否 | 应用程序的UID，仅用于系统查询。<br/>**系统接口**：此接口为系统接口。| 40| bundle | string | 否 | 应用程序的包名，仅用于系统查询。<br/>**系统接口**：此接口为系统接口。| 41 42 43 44## request.agent.query<sup>10+</sup> 45 46query(id: string, callback: AsyncCallback<TaskInfo>): void 47 48根据任务id查询任务的详细信息。使用callback异步回调。 49 50**需要权限**：ohos.permission.DOWNLOAD_SESSION_MANAGER 或 ohos.permission.UPLOAD_SESSION_MANAGER 51 52**系统能力**：SystemCapability.Request.FileTransferAgent 53 54**系统接口**：此接口为系统接口。 55 56**参数：** 57 58| 参数名 | 类型 | 必填 | 说明 | 59|----------------------------------------------| -------- | -------- | -------- | 60| id | string | 是 | 任务id。 | 61| callback | AsyncCallback<[TaskInfo](#taskinfo10)> | 是 | 回调函数，返回任务详细信息。 | 62 63**错误码：** 64 65以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)和[上传下载错误码](errorcode-request.md)。 66 67| 错误码ID | 错误信息 | 68| -------- | -------- | 69| 201 | permission denied. | 70| 202 | permission verification failed, application which is not a system application uses system API. | 71| 401 | parameter error. Possible causes: 1. Missing mandatory parameters. 2. Incorrect parameter type. | 72| 13400003 | task service ability error. | 73| 21900006 | task not found. | 74 75**示例：** 76 77 ```ts 78 import { BusinessError } from '@kit.BasicServicesKit'; 79 80 request.agent.query("123456", (err: BusinessError, taskInfo: request.agent.TaskInfo) => { 81 if (err) { 82 console.error(`Failed to query a upload task, Code: ${err.code}, message: ${err.message}`); 83 return; 84 } 85 console.info(`Succeeded in querying a upload task. result: ${taskInfo.uid}`); 86 }); 87 ``` 88 89 90## request.agent.query<sup>10+</sup> 91 92query(id: string): Promise<TaskInfo> 93 94根据任务id查询任务的详细信息。使用Promise异步回调。 95 96**需要权限**：ohos.permission.DOWNLOAD_SESSION_MANAGER 或 ohos.permission.UPLOAD_SESSION_MANAGER 97 98**系统能力**：SystemCapability.Request.FileTransferAgent 99 100**系统接口**：此接口为系统接口。 101 102**参数：** 103 104| 参数名 | 类型 | 必填 | 说明 | 105| -------- | -------- | -------- | -------- | 106| id | string | 是 | 任务id。 | 107 108**返回值：** 109 110| 类型 | 说明 | 111|----------------------------------------| ------------------------- | 112| Promise<[TaskInfo](#taskinfo10)> | Promise对象。返回任务详细信息的Promise对象。 | 113 114**错误码：** 115 116以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)和[上传下载错误码](errorcode-request.md)。 117 118| 错误码ID | 错误信息 | 119| -------- | -------- | 120| 201 | permission denied. | 121| 202 | permission verification failed, application which is not a system application uses system API. | 122| 401 | parameter error. Possible causes: 1. Missing mandatory parameters. 2. Incorrect parameter type. | 123| 13400003 | task service ability error. | 124| 21900006 | task not found. | 125 126**示例：** 127 128 ```ts 129 import { BusinessError } from '@kit.BasicServicesKit'; 130 131 request.agent.query("123456").then((taskInfo: request.agent.TaskInfo) => { 132 console.info(`Succeeded in querying a upload task. result: ${taskInfo.uid}`); 133 }).catch((err: BusinessError) => { 134 console.error(`Failed to query a upload task, Code: ${err.code}, message: ${err.message}`); 135 }); 136 ``` 137