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