• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 为通知添加行为意图
2
3[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)提供了封装行为意图的能力，该行为意图是指拉起指定的应用组件及发布公共事件等能力。OpenHarmony支持以通知的形式，将[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)从发布方传递至接收方，从而在接收方触发[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)中指定的意图。例如在通知消息的发布者发布通知时，通常期望用户可以通过通知栏点击拉起目标应用组件。为了达成这一目标，开发者可以将[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)封装至通知消息中，当系统接收到[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)后，在用户点击通知栏时触发[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)的意图，从而拉起目标应用组件。
4
5为通知添加行为意图的实现方式如下图所示：发布通知的应用向应用组件管理服务AMS（Ability Manager Service）申请[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)，然后随其他通知信息一起发送给桌面，当用户在桌面通知栏上点击通知时，触发[WantAgent](../reference/apis/js-apis-app-ability-wantAgent.md)动作。
6
7**图1** 携带行为意图的通知运行机制
8![notification-with-wantagent](figures/notification-with-wantagent.png)
9
10
11## 接口说明
12
13具体接口描述，详见[WantAgent接口文档](../reference/apis/js-apis-app-ability-wantAgent.md)。
14
15| **接口名** | **描述** |
16| -------- | -------- |
17| getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>): void | 创建WantAgent。 |
18| trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>): void | 触发WantAgent意图。 |
19| cancel(agent: WantAgent, callback: AsyncCallback<void>): void | 取消WantAgent。 |
20| getWant(agent: WantAgent, callback: AsyncCallback<Want>): void | 获取WantAgent的want。 |
21| equal(agent: WantAgent, otherAgent: WantAgent, callback: AsyncCallback<boolean>): void | 判断两个WantAgent实例是否相等。 |
22
23
24## 开发步骤
25
261. [使能通知开关](notification-enable.md)，获得用户授权后，才能使用通知功能。
27
282. 导入模块。
29
30   ```typescript
31   import notificationManager from '@ohos.notificationManager';
32   import wantAgent from '@ohos.app.ability.wantAgent';
33   ```
34
353. 创建WantAgentInfo信息。
36
37   场景一：创建拉起UIAbility的WantAgent的[WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md)信息。
38
39   ```typescript
40   let wantAgentObj = null; // 用于保存创建成功的wantAgent对象，后续使用其完成触发的动作。
41
42   // 通过WantAgentInfo的operationType设置动作类型
43   let wantAgentInfo = {
44     wants: [
45       {
46         deviceId: '',
47         bundleName: 'com.example.myapplication',
48         abilityName: 'EntryAbility',
49         action: '',
50         entities: [],
51         uri: '',
52         parameters: {}
53       }
54     ],
55     operationType: wantAgent.OperationType.START_ABILITY,
56     requestCode: 0,
57     wantAgentFlags:[wantAgent.WantAgentFlags.CONSTANT_FLAG]
58   };
59   ```
60
61   场景二：创建发布[公共事件](../application-models/common-event-overview.md)的WantAgent的[WantAgentInfo](../reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md)信息。
62
63   ```typescript
64   let wantAgentObj = null; // 用于保存创建成功的WantAgent对象，后续使用其完成触发的动作。
65
66   // 通过WantAgentInfo的operationType设置动作类型
67   let wantAgentInfo = {
68     wants: [
69       {
70         action: 'event_name', // 设置事件名
71         parameters: {},
72       }
73     ],
74     operationType: wantAgent.OperationType.SEND_COMMON_EVENT,
75     requestCode: 0,
76     wantAgentFlags: [wantAgent.WantAgentFlags.CONSTANT_FLAG],
77   };
78   ```
79
804. 调用[getWantAgent()](../reference/apis/js-apis-app-ability-wantAgent.md#wantagentgetwantagent)方法进行创建WantAgent。
81
82   ```typescript
83   // 创建WantAgent
84   wantAgent.getWantAgent(wantAgentInfo, (err, data) => {
85     if (err) {
86       console.error(`Failed to get want agent. Code is ${err.code}, message is ${err.message}`);
87       return;
88     }
89     console.info('Succeeded in geting want agent.');
90     wantAgentObj = data;
91   });
92   ```
93
945. 构造NotificationRequest对象，并发布WantAgent通知。
95
96   ```typescript
97   // 构造NotificationRequest对象
98   let notificationRequest: notificationManager.NotificationRequest = {
99     content: {
100       contentType: notificationManager.ContentType.NOTIFICATION_CONTENT_BASIC_TEXT,
101       normal: {
102         title: 'Test_Title',
103         text: 'Test_Text',
104         additionalText: 'Test_AdditionalText',
105       },
106     },
107     id: 1,
108     label: 'TEST',
109     wantAgent: wantAgentObj,
110   }
111
112   notificationManager.publish(notificationRequest, (err) => {
113     if (err) {
114       console.error(`Failed to publish notification. Code is ${err.code}, message is ${err.message}`);
115       return;
116     }
117     console.info('Succeeded in publishing notification.');
118   });
119   ```
120
1216. 用户通过点击通知栏上的通知，系统会自动触发WantAgent的动作。
122