js-apis-missionManager.md

# missionManager


> **说明：**
> 本模块首批接口从API version 8开始支持。


missionManager模块提供系统任务管理能力，开发者可以对系统任务执行锁定、解锁、清理、切换到前台等操作。


## 导入模块


```
import missionManager from '@ohos.application.missionManager'
```


## registerMissionListener

function registerMissionListener(listener: MissionListener): number;

注册系统任务状态监听。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | listener | MissionListener | 是 | 系统任务监听方法。 |

- 返回值：
    | 类型 | 说明 |
  | -------- | -------- |
  | number | 监听方法的index值，由系统创建，在注册系统任务状态监听时分配，和监听方法一一对应 。 |

- 示例：

  ```
  var listener =  {
  	onMissionCreated: this.onMissionCreatedCallback,
  	onMissionDestroyed: this.onMissionDestroyedCallback,
  	onMissionSnapshotChanged: this.onMissionSnapshotChangedCallback,
  	onMissionMovedToFront: this.onMissionMovedToFrontCallback
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

  ```


## unregisterMissionListener

function unregisterMissionListener(listenerId: number, callback: AsyncCallback<void>): void;

取消任务状态监听。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |
  | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 |

- 示例：

  ```
  var listener =  {
    onMissionCreated: this.onMissionCreatedCallback,
    onMissionDestroyed: this.onMissionDestroyedCallback,
    onMissionSnapshotChanged: this.onMissionSnapshotChangedCallback,
    onMissionMovedToFront: this.onMissionMovedToFrontCallback
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

  missionManager.unregisterMissionListener(listenerid, (error) => {
    console.log("unregisterMissionListener");
  })
  ```


## unregisterMissionListener

function unregisterMissionListener(listenerId: number): Promise<void>;

取消任务状态监听，以promise方式返回执行结果。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |

- 示例：

  ```
  var listener =  {
      onMissionCreated: this.onMissionCreatedCallback,
      onMissionDestroyed: this.onMissionDestroyedCallback,
      onMissionSnapshotChanged: this.onMissionSnapshotChangedCallback,
      onMissionMovedToFront: this.onMissionMovedToFrontCallback
    };
    console.log("registerMissionListener")
    var listenerid = missionManager.registerMissionListener(listener);

    await missionManager.unregisterMissionListener(listenerid).catch(function (err){
      console.log(err);
    });
  ```


## getMissionInfo

function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<MissionInfo>): void;

获取任务信息，以异步回调的方式返回任务信息。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
  | missionId | number | 是 | 任务ID。 |
  | callback | AsyncCallback<MissionInfo> | 是 | 执行结果回调函数，返回任务信息。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfo("", allMissions[0].missionId, (error, mission) => {
  	console.log("getMissionInfo is called, error.code = " + error.code)
  	console.log("mission.missionId = " + mission.missionId);
  	console.log("mission.runningState = " + mission.runningState);
  	console.log("mission.lockedState = " + mission.lockedState);
  	console.log("mission.timestamp = " + mission.timestamp);
  	console.log("mission.label = " + mission.label);
  	console.log("mission.iconPath = " + mission.iconPath);
  }
  ```


## getMissionInfo

function getMissionInfo(deviceId: string, missionId: number): Promise<MissionInfo>;

获取任务信息，以promise方式返回任务信息。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
  | missionId | number | 是 | 任务ID。 |

- 返回值：
    | 类型 | 说明 |
  | -------- | -------- |
  | [MissionInfo](js-apis-application-MissionInfo.md) | 任务信息。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var mission = await missionManager.getMissionInfo("", id).catch(function (err){
      console.log(err);
  });
  ```


## getMissionInfos

function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback<Array<MissionInfo>>): void;

获取所有任务信息，以回调函数的方式返回任务信息数组。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
  | numMax | number | 是 | 任务信息数量上限。 |
  | callback | AsyncCallback<Array<[MissionInfo](js-apis-application-MissionInfo.md)>> | 是 | 执行结果回调函数，返回任务信息数组。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
      console.log("getMissionInfos is called, error.code = " + error.code);
      console.log("size = " + missions.length);
      console.log("missions = " + JSON.stringify(missions));
  })
  ```


## getMissionInfos

function getMissionInfos(deviceId: string, numMax: number): Promise<Array<MissionInfo>>;

获取所有任务信息，以promise的方式返回任务信息数组。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
  | numMax | number | 是 | 任务信息数量上限。 |

- 返回值：
    | 类型 | 说明 |
  | -------- | -------- |
  | Array<MissionInfo> | 任务信息数组。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
      console.log(err);
  });
  ```


## getMissionSnapShot

function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;

获取任务快照，以回调函数的方式返回快照内容。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
  | missionId | number | 是 | 任务ID。 |
  | callback | AsyncCallback<[MissionSnapshot](js-apis-application-MissionSnapshot.md)> | 是 | 执行结果回调函数，返回任务快照信息。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
    console.log("getMissionInfos is called, error.code = " + error.code);
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.getMissionSnapShot("", id, (error, snapshot) => {
  	console.log("getMissionSnapShot is called, error.code = " + error.code);
  	console.log("bundleName = " + snapshot.ability.bundleName);
  })
  })
  ```


## getMissionSnapShot

function getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;

获取任务快照，以promise的方式返回快照内容。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | deviceId | string | 是 | 设备ID，本机默认为空字符串。 |
  | missionId | number | 是 | 任务ID。 |

- 返回值：
    | 类型 | 说明 |
  | -------- | -------- |
  | MissionSnapshot | 任务快照信息。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
    console.log(err);
  });
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;
  var snapshot = await missionManager.getMissionSnapShot("", id).catch(function (err){
    console.log(err);
  });
  ```


## lockMission

function lockMission(missionId: number, callback: AsyncCallback<void>): void;

锁定指定任务id的任务，以回调函数的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
    console.log("getMissionInfos is called, error.code = " + error.code);
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.lockMission(id).then(() => {
  	console.log("lockMission is called ");
  });
  });
  ```


## lockMission

function lockMission(missionId: number): Promise<void>;

锁定指定任务id的任务，以promise方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
    console.log(err);
  });
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

  await missionManager.lockMission(id).catch(function (err){
      console.log(err);
  });
  ```


## unlockMission

function unlockMission(missionId: number, callback: AsyncCallback<void>): void;

解锁指定任务id的任务，以回调函数的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
    console.log("getMissionInfos is called, error.code = " + error.code);
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.unlockMission(id).then(() => {
  	console.log("unlockMission is called ");
  });
  });
  ```


## unlockMission

function unlockMission(missionId: number): Promise<void>;

解锁指定任务id的任务，以promise的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
    console.log(err);
  });
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

  await missionManager.lockMission(id).catch(function (err){
      console.log(err);
  });
  await missionManager.unlockMission(id).catch(function (err){
      console.log(err);
  });
  ```


## clearMission

function clearMission(missionId: number, callback: AsyncCallback<void>): void;

清理指定任务id的任务，无论该任务是否被锁定，以回调函数的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
    console.log("getMissionInfos is called, error.code = " + error.code);
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.clearMission(id).then(() => {
  	console.log("clearMission is called ");
  });
  });
  ```


## clearMission

function clearMission(missionId: number): Promise<void>;

清理指定任务id的任务，无论该任务是否被锁定，以promise的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
    console.log(err);
  });
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

  await missionManager.clearMission(id).catch(function (err){
    console.log(err);
  });
  ```


## clearAllMissions

function clearAllMissions(callback: AsyncCallback<void>): void;

清理所有未锁定的任务，以回调函数的方式返回。

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.clearAllMissions().then(() => {
    console.log("clearAllMissions is called ");
  });
  ```


## clearAllMissions

function clearAllMissions(): Promise<void>;

清理所有未锁定的任务，以promise的方式返回。

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'
  await missionManager.clearAllMissions().catch(function (err){
    console.log(err);
  });
  ```


## moveMissionToFront

function moveMissionToFront(missionId: number, callback: AsyncCallback<void>): void;

把指定任务id的任务切到前台，以回调函数的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
    console.log("getMissionInfos is called, error.code = " + error.code);
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.moveMissionToFront(id).then(() => {
  	console.log("moveMissionToFront is called ");
  });
  });
  ```


## moveMissionToFront

function moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback<void>): void;

把指定任务id的任务切到前台，同时指定任务切换到前台时的启动参数，例如窗口模式、设备ID等，以回调函数的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | options | StartOptions | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
  | callback | AsyncCallback<void> | 是 | 执行结果回调函数。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  missionManager.getMissionInfos("", 10, (error, missions) => {
    console.log("getMissionInfos is called, error.code = " + error.code);
    console.log("size = " + missions.length);
    console.log("missions = " + JSON.stringify(missions));
    var id = missions[0].missionId;

    missionManager.moveMissionToFront(id,{windowMode : 101}).then(() => {
  	console.log("moveMissionToFront is called ");
    });
  });
  ```


## moveMissionToFront

function moveMissionToFront(missionId: number, options?: StartOptions): Promise<void>;

把指定任务id的任务切到前台，以promise的方式返回。

- 参数：
    | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | options | StartOptions | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |

- 示例：

  ```
  import missionManager from '@ohos.application.missionManager'

  var allMissions = await missionManager.getMissionInfos("", 10).catch(function (err){
    console.log(err);
  });
  console.log("size = " + allMissions.length);
  console.log("missions = " + JSON.stringify(allMissions));
  var id = allMissions[0].missionId;

  await missionManager.moveMissionToFront(id).catch(function (err){
    console.log(err);
  });
  ```