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