js-apis-app-ability-missionManager.md

# @ohos.app.ability.missionManager (missionManager)

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

> **说明：**
> 
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

## 导入模块

```ts
import missionManager from '@ohos.app.ability.missionManager'
```

## 权限列表

ohos.permission.MANAGE_MISSIONS

## missionManager.on

on(type:"mission", listener: MissionListener): number;

注册系统任务状态监听器。

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | listener | [MissionListener](js-apis-inner-application-missionListener.md) | 是 | 系统任务监听器。 |

**返回值：**

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

**示例：**

```ts
import UIAbility from '@ohos.app.ability.UIAbility';

var listener = {
    onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
    onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
    onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
    onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
    onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")},
    onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")},
    onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")}
};

var listenerId = -1;

export default class MainAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log("[Demo] MainAbility onCreate")
        globalThis.abilityWant = want;
        globalThis.context = this.context;
    }

    onDestroy() {
        try {
            if (listenerId != -1) {
                missionManager.off("mission", listenerId).catch(function (err) {
                    console.log(err);
                });
            }
        } catch (paramError) {
            console.log("error: " + paramError.code + ", " + paramError.message);
        }
        console.log("[Demo] MainAbility onDestroy")
    }

    onWindowStageCreate(windowStage) {
        // Main window is created, set main page for this ability
        console.log("[Demo] MainAbility onWindowStageCreate")
        try {
            listenerId = missionManager.on("mission", listener);
        } catch (paramError) {
            console.log("error: " + paramError.code + ", " + paramError.message);
        }

        windowStage.loadContent("pages/index", (err, data) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
        });

        if (globalThis.flag) {
            return;
        }
    }
};
```


## missionManager.off

off(type: "mission", listenerId: number, callback: AsyncCallback<void>): void;

解注册任务状态监听器。

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

```ts
import UIAbility from '@ohos.app.ability.UIAbility';

var listener = {
    onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
    onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
    onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
    onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
    onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")},
    onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")},
    onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")}
};

var listenerId = -1;

export default class MainAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log("[Demo] MainAbility onCreate")
        globalThis.abilityWant = want;
        globalThis.context = this.context;
    }

    onDestroy() {
        try {
            if (listenerId != -1) {
                missionManager.off("mission", listenerId, (err) => {
                    console.log(err);
                });
            }
        } catch (paramError) {
            console.log("error: " + paramError.code + ", " + paramError.message);
        }
        console.log("[Demo] MainAbility onDestroy")
    }

    onWindowStageCreate(windowStage) {
        // Main window is created, set main page for this ability
        console.log("[Demo] MainAbility onWindowStageCreate")
        try {
            listenerId = missionManager.on("mission", listener);
        } catch (paramError) {
            console.log("error: " + paramError.code + ", " + paramError.message);
        }

        windowStage.loadContent("pages/index", (err, data) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
        });

        if (globalThis.flag) {
            return;
        }
    }
};
```


## missionManager.off

off(type: "mission", listenerId: number): Promise<void>;

解注册任务状态监听，以promise方式返回执行结果。

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise<void> | promise方式返回执行结果。 | 

**示例：**

```ts
import UIAbility from '@ohos.app.ability.UIAbility';

var listener = {
    onMissionCreated: function (mission) {console.log("--------onMissionCreated-------")},
    onMissionDestroyed: function (mission) {console.log("--------onMissionDestroyed-------")},
    onMissionSnapshotChanged: function (mission) {console.log("--------onMissionSnapshotChanged-------")},
    onMissionMovedToFront: function (mission) {console.log("--------onMissionMovedToFront-------")},
    onMissionIconUpdated: function (mission, icon) {console.log("--------onMissionIconUpdated-------")},
    onMissionClosed: function (mission) {console.log("--------onMissionClosed-------")},
    onMissionLabelUpdated: function (mission) {console.log("--------onMissionLabelUpdated-------")}
};

var listenerId = -1;

export default class MainAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log("[Demo] MainAbility onCreate")
        globalThis.abilityWant = want;
        globalThis.context = this.context;
    }

    onDestroy() {
        try {
            if (listenerId != -1) {
                missionManager.off("mission", listenerId).catch(function (err) {
                    console.log(err);
                });
            }
        } catch (paramError) {
            console.log("error: " + paramError.code + ", " + paramError.message);
        }
        console.log("[Demo] MainAbility onDestroy")
    }

    onWindowStageCreate(windowStage) {
        // Main window is created, set main page for this ability
        console.log("[Demo] MainAbility onWindowStageCreate")
        try {
            listenerId = missionManager.on("mission", listener);
        } catch (paramError) {
            console.log("error: " + paramError.code + ", " + paramError.message);
        }

        windowStage.loadContent("pages/index", (err, data) => {
            if (err.code) {
                console.error('Failed to load the content. Cause:' + JSON.stringify(err));
                return;
            }
            console.info('Succeeded in loading the content. Data: ' + JSON.stringify(data))
        });

        if (globalThis.flag) {
            return;
        }
    }
};
```


## missionManager.getMissionInfo

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

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    var allMissions=missionManager.getMissionInfos("",10).catch(function(err){console.log(err);});
      missionManager.getMissionInfo("", allMissions[0].missionId, (error, mission) => {
        if (error.code) {
          console.log("getMissionInfo failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
        }

        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);
      });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.getMissionInfo

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

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<[MissionInfo](./js-apis-inner-application-missionInfo.md)> | 任务信息。 |

**示例：**

  ```ts
  try {
    var mission = missionManager.getMissionInfo("", 10).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.getMissionInfos

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

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfo failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      console.log("size = " + missions.length);
      console.log("missions = " + JSON.stringify(missions));
    })
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.getMissionInfos

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

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<Array<[MissionInfo](./js-apis-inner-application-missionInfo.md)>> | 任务信息数组。 |

**示例：**

  ```ts
  try {
    var allMissions = missionManager.getMissionInfos("", 10).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.getMissionSnapShot

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

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      console.log("size = " + missions.length);
      console.log("missions = " + JSON.stringify(missions));
      var id = missions[0].missionId;

      missionManager.getMissionSnapShot("", id, (err, snapshot) => {
          if (err.code) {
              console.log("getMissionInfos failed, err.code:" + JSON.stringify(err.code) +
                "err.message:" + JSON.stringify(err.message));
              return;
          }
          console.log("bundleName = " + snapshot.ability.bundleName);
      })
    })
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.getMissionSnapShot

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

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise<[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)> | 任务快照信息。 |

**示例：**

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

      var snapshot = missionManager.getMissionSnapShot("", id).catch(function (err){
        console.log(err);
      });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```

## missionManager.getLowResolutionMissionSnapShot

getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback\<MissionSnapshot>): void;

获取任务低分辨率快照。

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      console.log("size = " + missions.length);
      console.log("missions = " + JSON.stringify(missions));
      var id = missions[0].missionId;

      missionManager.getLowResolutionMissionSnapShot("", id, (error, snapshot) => {
        if (error.code) {
          console.log("getLowResolutionMissionSnapShot failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
        }
  	    console.log("bundleName = " + snapshot.ability.bundleName);
      })
    })
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.getLowResolutionMissionSnapShot

getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise\<MissionSnapshot>;

获取任务低分辨率快照。

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 |
  | -------- | -------- |
  | Promise&lt;[MissionSnapshot](js-apis-inner-application-missionSnapshot.md)&gt; | 任务快照信息。 |

**示例：**

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

      var snapshot = missionManager.getLowResolutionMissionSnapShot("", id).catch(function (err){
        console.log(err);
      });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.lockMission

lockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }

      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 ");
      });
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.lockMission

lockMission(missionId: number): Promise&lt;void&gt;;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;void&gt; | promise方式返回执行结果。 | 

**示例：**

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

    missionManager.lockMission(id).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.unlockMission

unlockMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      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 ");
      });
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.unlockMission

unlockMission(missionId: number): Promise&lt;void&gt;;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;void&gt; | promise方式返回执行结果。 | 

**示例：**

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

    missionManager.lockMission(id).catch(function (err){
      console.log(err);
    });
    missionManager.unlockMission(id).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.clearMission

clearMission(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      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 ");
      });
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.clearMission

clearMission(missionId: number): Promise&lt;void&gt;;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**返回值：**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;void&gt; | promise方式返回执行结果。 | 

**示例：**

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

    missionManager.clearMission(id).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.clearAllMissions

clearAllMissions(callback: AsyncCallback&lt;void&gt;): void;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**示例：**

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


## missionManager.clearAllMissions

clearAllMissions(): Promise&lt;void&gt;;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**返回值：**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;void&gt; | promise方式返回执行结果。 | 

**示例：**

  ```ts
  missionManager.clearAllMissions().catch(function (err){
    console.log(err);
  });
  ```


## missionManager.moveMissionToFront

moveMissionToFront(missionId: number, callback: AsyncCallback&lt;void&gt;): void;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

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

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      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 ");
      });
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.moveMissionToFront

moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback&lt;void&gt;): void;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | options | [StartOptions](js-apis-app-ability-startOptions.md) | 是 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |
  | callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |

**示例：**

  ```ts
  try {
    missionManager.getMissionInfos("", 10, (error, missions) => {
      if (error.code) {
          console.log("getMissionInfos failed, error.code:" + JSON.stringify(error.code) +
            "error.message:" + JSON.stringify(error.message));
          return;
      }
      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 ");
      });
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```


## missionManager.moveMissionToFront

moveMissionToFront(missionId: number, options?: StartOptions): Promise&lt;void&gt;;

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

**需要权限**：ohos.permission.MANAGE_MISSIONS

**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission

**系统API**: 此接口为系统接口，三方应用不支持调用。

**参数：**

  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | missionId | number | 是 | 任务ID。 |
  | options | [StartOptions](js-apis-app-ability-startOptions.md) | 否 | 启动参数选项，用于指定任务切到前台时的窗口模式，设备ID等。 |

**返回值：**

  | 类型 | 说明 | 
  | -------- | -------- |
  | Promise&lt;void&gt; | promise方式返回执行结果。 | 

**示例：**

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

    missionManager.moveMissionToFront(id).catch(function (err){
      console.log(err);
    });
  } catch (paramError) {
    console.log("error: " + paramError.code + ", " + paramError.message);
  }
  ```