• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# MissionListener (系统接口)
2
3定义系统任务状态监听，可以通过[on](js-apis-app-ability-missionManager-sys.md#missionmanageron)注册。
4
5> **说明：**
6>
7> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> 本模块接口为系统接口。
9
10## 导入模块
11
12```ts
13import missionManager from '@ohos.app.ability.missionManager';
14```
15
16## 属性
17
18**系统接口**: 此接口为系统接口，三方应用不支持调用。
19
20**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
21
22| 名称        | 类型                 | 必填 | 说明                                                         |
23| ----------- | -------- | ---- | ------------------------------------------------------------ |
24| onMissionCreated    | function               | 否   | 表示当系统创建任务时回调执行。                                |
25| onMissionDestroyed   | function               | 否   | 表示当系统销毁任务时回调执行。 |
26| onMissionSnapshotChanged   | function               | 否   | 表示当系统更新任务缩略图时回调执行。 |
27| onMissionMovedToFront   | function               | 否   | 表示当系统将任务移动到前台时回调执行。 |
28| onMissionLabelUpdated<sup>9+</sup>   | function               | 否   | 表示当系统更新任务标签时回调执行。 |
29| onMissionIconUpdated<sup>9+</sup>   | function               | 否   | 表示当系统更新任务图标时回调执行。 |
30| onMissionClosed<sup>9+</sup>   | function               | 否   | 表示当系统关闭任务时回调执行。 |
31
32**示例：**
33```ts
34import missionManager from '@ohos.app.ability.missionManager';
35
36let listener: missionManager.MissionListener = {
37  onMissionCreated: (mission) => {
38    console.log(`onMissionCreated mission: ${JSON.stringify(mission)}`);
39  },
40  onMissionDestroyed: (mission) => {
41    console.log(`onMissionDestroyed mission: ${JSON.stringify(mission)}`);
42  },
43  onMissionSnapshotChanged: (mission) => {
44    console.log(`onMissionSnapshotChanged mission: ${JSON.stringify(mission)}`);
45  },
46  onMissionMovedToFront: (mission) => {
47    console.log(`onMissionMovedToFront mission: ${JSON.stringify(mission)}`);
48  },
49  onMissionLabelUpdated: (mission) => {
50    console.log(`onMissionLabelUpdated mission: ${JSON.stringify(mission)}`);
51  },
52  onMissionIconUpdated: (mission, icon) => {
53    console.log(`onMissionIconUpdated mission: ${JSON.stringify(mission)}`);
54    console.log(`onMissionIconUpdated icon: ${JSON.stringify(mission)}`);
55  },
56  onMissionClosed: (mission) => {
57    console.log(`onMissionClosed mission: ${JSON.stringify(mission)}`);
58    }
59};
60
61try {
62  let listenerId = missionManager.on('mission', listener);
63} catch (paramError) {
64  console.error(`error: ${paramError.code}, ${paramError.message}`);
65}
66```