• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.ability.wantAgent (WantAgent模块)(系统接口)
2
3app.ability.WantAgent模块提供了创建WantAgent实例、获取实例的用户ID、获取want信息、比较WantAgent实例和获取bundle名称等能力。该模块将会取代[@ohos.wantAgent](js-apis-wantAgent.md)模块，建议优先使用本模块。
4
5> **说明：**
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8>
9> 当前页面仅包含本模块的系统接口，其他公开接口参见[@ohos.app.ability.wantAgent (WantAgent模块)](js-apis-app-ability-wantAgent.md)。
10
11## 导入模块
12
13```ts
14import { WantAgent } from '@kit.AbilityKit';
15```
16
17## WantAgent.getWant
18
19getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
20
21获取WantAgent对象的want（callback形式）。
22
23**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
24
25**系统接口**：此接口为系统接口。
26
27**参数：**
28
29| 参数名     | 类型                  | 必填 | 说明                            |
30| -------- | --------------------- | ---- | ------------------------------- |
31| agent    | WantAgent             | 是   | WantAgent对象。                   |
32| callback | AsyncCallback\<[Want](js-apis-app-ability-want.md)\> | 是   | 获取WantAgent对象want的回调方法。 |
33
34**错误码：**
35
36以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](errorcode-ability.md)。
37
38| 错误码ID    | 错误信息            |
39|-----------|--------------------|
40| 401        | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
41| 16000007   | Service busy. There are concurrent tasks. Try again later. |
42| 16000015   | Service timeout.|
43| 16000151   | Invalid wantagent object.|
44
45**示例：**
46
47```ts
48import { wantAgent, WantAgent as _WantAgent, Want } from '@kit.AbilityKit';
49import { BusinessError } from '@kit.BasicServicesKit';
50
51//wantAgent对象
52let wantAgentData: _WantAgent;
53//WantAgentInfo对象
54let wantAgentInfo: wantAgent.WantAgentInfo = {
55  wants: [
56    {
57      deviceId: 'deviceId',
58      bundleName: 'com.example.myapplication',
59      abilityName: 'EntryAbility',
60      action: 'action1',
61      entities: ['entity1'],
62      type: 'MIMETYPE',
63      uri: 'key={true,true,false}',
64      parameters:
65      {
66        mykey0: 2222,
67        mykey1: [1, 2, 3],
68        mykey2: '[1, 2, 3]',
69        mykey3: 'ssssssssssssssssssssssssss',
70        mykey4: [false, true, false],
71        mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
72        mykey6: true,
73      }
74    } as Want
75  ],
76  actionType: wantAgent.OperationType.START_ABILITIES,
77  requestCode: 0,
78  wantAgentFlags:[wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
79};
80
81//getWantAgent回调
82function getWantAgentCallback(err: BusinessError, data: _WantAgent) {
83  if (err) {
84    console.info(`getWantAgent failed, code: ${err.code}, message: ${err.message}`);
85  } else {
86    wantAgentData = data;
87  }
88  //getWant回调
89  let getWantCallback = (err: BusinessError, data: Want) => {
90    if(err) {
91      console.error(`getWant failed, code: ${err.code}, messgae: ${err.message}.`);
92    } else {
93      console.info(`getWant success, data: ${JSON.stringify(data)}.`);
94    }
95  }
96  try {
97    wantAgent.getWant(wantAgentData, getWantCallback);
98  } catch(err) {
99    let code = (err as BusinessError).code;
100    let msg = (err as BusinessError).message;
101    console.error(`getWant failed, code: ${code}, message: ${msg}.`);
102  }
103}
104
105try {
106  wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
107} catch(err) {
108  let code = (err as BusinessError).code;
109  let msg = (err as BusinessError).message;
110  console.error(`getWantAgent failed, code: ${code}, message: ${msg}.`);
111}
112```
113
114
115
116## WantAgent.getWant
117
118getWant(agent: WantAgent): Promise\<Want\>
119
120获取WantAgent对象的want（Promise形式）。
121
122**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
123
124**系统接口**：此接口为系统接口。
125
126**参数：**
127
128| 参数名  | 类型      | 必填 | 说明          |
129| ----- | --------- | ---- | ------------- |
130| agent | WantAgent | 是   | WantAgent对象。 |
131
132**返回值：**
133
134| 类型                                                        | 说明                                                         |
135| ----------------------------------------------------------- | ------------------------------------------------------------ |
136| Promise\<[Want](js-apis-app-ability-want.md)\> | 以Promise形式返回获取WantAgent对象的want。 |
137
138**错误码：**
139
140以下错误码详细介绍请参考[通用错误码](../errorcode-universal.md)和[元能力子系统错误码](errorcode-ability.md)。
141
142| 错误码ID    | 错误信息            |
143|-----------|--------------------|
144| 401        | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
145| 16000007   | Service busy. There are concurrent tasks. Try again later. |
146| 16000015   | Service timeout.|
147| 16000151   | Invalid wantagent object.|
148
149错误码详细介绍请参考[元能力子系统错误码](errorcode-ability.md)
150
151**示例：**
152
153```ts
154import { wantAgent, WantAgent as _WantAgent, Want } from '@kit.AbilityKit';
155import { BusinessError } from '@kit.BasicServicesKit';
156
157//wantAgent对象
158let wantAgentData: _WantAgent;
159//WantAgentInfo对象
160let wantAgentInfo: wantAgent.WantAgentInfo = {
161  wants: [
162    {
163      deviceId: 'deviceId',
164      bundleName: 'com.example.myapplication',
165      abilityName: 'EntryAbility',
166      action: 'action1',
167      entities: ['entity1'],
168      type: 'MIMETYPE',
169      uri: 'key={true,true,false}',
170      parameters:
171      {
172        mykey0: 2222,
173        mykey1: [1, 2, 3],
174        mykey2: '[1, 2, 3]',
175        mykey3: 'ssssssssssssssssssssssssss',
176        mykey4: [false, true, false],
177        mykey5: ['qqqqq', 'wwwwww', 'aaaaaaaaaaaaaaaaa'],
178        mykey6: true,
179      }
180    } as Want
181  ],
182  actionType: wantAgent.OperationType.START_ABILITIES,
183  requestCode: 0,
184  wantAgentFlags:[wantAgent.WantAgentFlags.UPDATE_PRESENT_FLAG]
185};
186
187//getWantAgent回调
188function getWantAgentCallback(err: BusinessError, data: _WantAgent) {
189  if (err) {
190    console.info(`getWantAgent failed, code: ${err.code}, message: ${err.message}`);
191  } else {
192    wantAgentData = data;
193  }
194  try {
195    wantAgent.getWant(wantAgentData).then((data)=>{
196      console.info(`getWant success, data: ${JSON.stringify(data)}`);
197    }).catch((err: BusinessError)=>{
198      console.error(`getWant failed, code: ${err.code}, messgae: ${err.message}.`);
199    });
200  } catch(err){
201    let code = (err as BusinessError).code;
202    let msg = (err as BusinessError).message;
203    console.error(`getWant failed, code: ${code}, messgae: ${msg}.`);
204  }
205}
206
207try {
208  wantAgent.getWantAgent(wantAgentInfo, getWantAgentCallback);
209} catch(err) {
210  let code = (err as BusinessError).code;
211  let msg = (err as BusinessError).message;
212  console.error(`getWantAgent failed, code: ${code}, messgae: ${msg}.`);
213}
214```
215## OperationType
216
217表示操作WantAgent类型的枚举。
218
219**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
220
221| 名称                      | 值 | 说明                                            |
222|-------------------------|---|-----------------------------------------------|
223| START_SERVICE_EXTENSION<sup>12+</sup> | 6 | 开启一个ServiceExtension。<br/>**系统接口**：该接口为系统接口。 |