@ohos.app.ability.missionManager (missionManager)

The missionManager module provides APIs to lock, unlock, and clear missions, and switch a mission to the foreground.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import missionManager from '@ohos.app.ability.missionManager';

Required Permissions

ohos.permission.MANAGE_MISSIONS

missionManager.on

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

Registers a listener to observe the mission status.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility';

let 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-------');}
};

let listenerId = -1;

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log('[Demo] EntryAbility 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.error('error: ${paramError.code}, ${paramError.message}');
        }
        console.log('[Demo] EntryAbility onDestroy');
    }

    onWindowStageCreate(windowStage) {
        // The main window is created. Set a main page for this ability.
        console.log('[Demo] EntryAbility onWindowStageCreate');
        try {
            listenerId = missionManager.on('mission', listener);
        } catch (paramError) {
            console.error('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;

Deregisters a mission status listener. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility';

let 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-------');}
};

let listenerId = -1;

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

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

    onWindowStageCreate(windowStage) {
        // The main window is created. Set a main page for this ability.
        console.log('[Demo] EntryAbility onWindowStageCreate');
        try {
            listenerId = missionManager.on('mission', listener);
        } catch (paramError) {
            console.error('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>;

Deregisters a mission status listener. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';
import UIAbility from '@ohos.app.ability.UIAbility';

let 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-------');}
};

let listenerId = -1;

export default class EntryAbility extends UIAbility {
    onCreate(want, launchParam) {
        console.log('[Demo] EntryAbility 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.error('error: ${paramError.code}, ${paramError.message}');
        }
        console.log('[Demo] EntryAbility onDestroy');
    }

    onWindowStageCreate(windowStage) {
        // The main window is created. Set a main page for this ability.
        console.log('[Demo] EntryAbility onWindowStageCreate');
        try {
            listenerId = missionManager.on('mission', listener);
        } catch (paramError) {
            console.error('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;

Obtains the information about a given mission. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let allMissions=missionManager.getMissionInfos('',10).catch(function(err){console.log(err);});
    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);
    });
} catch (paramError) {
  console.log('error: ' + paramError.code + ', ' + paramError.message);
}

missionManager.getMissionInfo

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

Obtains the information about a given mission. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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;

Obtains information about all missions. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

import missionManager from '@ohos.app.ability.missionManager';

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

missionManager.getMissionInfos

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

Obtains information about all missions. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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;

Obtains the snapshot of a given mission. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let id = missions[0].missionId;

    missionManager.getMissionSnapShot('', id, (error, snapshot) => {
	    console.log('getMissionSnapShot is called, error.code = ' + error.code);
	    console.log('bundleName = ' + snapshot.ability.bundleName);
    });
  });
} catch (paramError) {
  console.log('error: ' + paramError.code + ', ' + paramError.message);
}

missionManager.getMissionSnapShot

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

Obtains the snapshot of a given mission. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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));
    let id = allMissions[0].missionId;

    let 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;

Obtains the low-resolution snapshot of a given mission. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let id = missions[0].missionId;

    missionManager.getLowResolutionMissionSnapShot('', id, (error, snapshot) => {
	    console.log('getLowResolutionMissionSnapShot is called, error.code = ' + error.code);
	    console.log('bundleName = ' + snapshot.ability.bundleName);
    });
  });
} catch (paramError) {
  console.log('error: ' + paramError.code + ', ' + paramError.message);
}

missionManager.getLowResolutionMissionSnapShot

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

Obtains the low-resolution snapshot of a given mission. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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));
    let id = allMissions[0].missionId;

    let 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<void>): void;

Locks a given mission. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let 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<void>;

Locks a given mission. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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));
  let 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<void>): void;

Unlocks a given mission. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let 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<void>;

Unlocks a given mission. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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));
  let 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<void>): void;

Clears a given mission, regardless of whether it is locked. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let 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<void>;

Clears a given mission, regardless of whether it is locked. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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));
  let 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<void>): void;

Clears all unlocked missions. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Example

import missionManager from '@ohos.app.ability.missionManager';

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

missionManager.clearAllMissions

clearAllMissions(): Promise<void>;

Clears all unlocked missions. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Return value

Example

import missionManager from '@ohos.app.ability.missionManager';
missionManager.clearAllMissions().catch(function (err){
  console.log(err);
});

missionManager.moveMissionToFront

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

Switches a given mission to the foreground. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let 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<void>): void;

Switches a given mission to the foreground, with the startup parameters for the switching specified. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  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));
    let 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<void>;

Switches a given mission to the foreground, with the startup parameters for the switching specified. This API uses a promise to return the result.

Required permissions: ohos.permission.MANAGE_MISSIONS

System capability: SystemCapability.Ability.AbilityRuntime.Mission

System API: This is a system API and cannot be called by third-party applications.

Parameters

Return value

Error codes

For details about the error codes, see Ability Error Codes.

Example

import missionManager from '@ohos.app.ability.missionManager';

try {
  let 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));
  let id = allMissions[0].missionId;

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