@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
Name | Type | Mandatory | Description |
---|---|---|---|
listener | MissionListener | Yes | Mission status listener to register. |
Return value
Type | Description |
---|---|
number | Index of the mission status listener, which is created by the system and allocated when the listener is registered. |
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
Name | Type | Mandatory | Description |
---|---|---|---|
listenerId | number | Yes | Index of the mission status listener to deregister. It is returned by on(). |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
16300002 | Input error. The specified mission listener does not exist. |
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
Name | Type | Mandatory | Description |
---|---|---|---|
listenerId | number | Yes | Index of the mission status listener to deregister. It is returned by on(). |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
16300002 | Input error. The specified mission listener does not exist. |
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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<MissionInfo> | Yes | Callback used to return the mission information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 1;
missionManager.getMissionInfos('',10)
.then((allMissions) => {
try {
if (allMissions && allMissions.length > 0) {
testMissionId = allMissions[0].missionId;
}
missionManager.getMissionInfo('', testMissionId, (error, mission) => {
if (error) {
console.error('getMissionInfo failed, error.code: ${error.code}, error.message: ${error.message}');
} else {
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.error('error.code: ${paramError.code}, error.message: ${paramError.message}');
}
})
.catch(function(err){console.log(err);});
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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
missionId | number | Yes | Mission ID. |
Return value
Type | Description |
---|---|
Promise<MissionInfo> | Promise used to return the mission information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 1;
try {
missionManager.getMissionInfo('', testMissionId).then((data) => {
console.info('getMissionInfo successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('getMissionInfo failed. Cause: ${error.message}');
});
} catch (error) {
console.error('getMissionInfo failed. Cause: ${error.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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
numMax | number | Yes | Maximum number of missions whose information can be obtained. |
callback | AsyncCallback<Array<MissionInfo>> | Yes | Callback used to return the array of mission information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
try {
missionManager.getMissionInfos('', 10, (error, missions) => {
if (error) {
console.error('getMissionInfos failed, error.code: ${error.code}, error.message: ${error.message}');
} else {
console.log('size = ${missions.length}');
console.log('missions = ${JSON.stringify(missions)}');
}
});
} catch (paramError) {
console.error('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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
numMax | number | Yes | Maximum number of missions whose information can be obtained. |
Return value
Type | Description |
---|---|
Promise<Array<MissionInfo>> | Promise used to return the array of mission information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
try {
missionManager.getMissionInfos('', 10).then((data) => {
console.info('getMissionInfos successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('getMissionInfos failed. Cause: ${error.message}');
});
} catch (error) {
console.error('getMissionInfos failed. Cause: ${error.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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<MissionSnapshot> | Yes | Callback used to return the snapshot information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.getMissionSnapShot('', testMissionId, (err, data) => {
if (err) {
console.error('getMissionSnapShot failed: ${err.message}');
} else {
console.info('getMissionSnapShot successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('getMissionSnapShot failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
missionId | number | Yes | Mission ID. |
Return value
Type | Description |
---|---|
Promise<MissionSnapshot> | Promise used to return the snapshot information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.getMissionSnapShot('', testMissionId).then((data) => {
console.info('getMissionSnapShot successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('getMissionSnapShot failed. Cause: ${error.message}');
});
} catch (error) {
console.error('getMissionSnapShot failed. Cause: ${error.message}');
}
missionManager.getLowResolutionMissionSnapShot
getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;
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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<MissionSnapshot> | Yes | Callback used to return the snapshot information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.getLowResolutionMissionSnapShot('', testMissionId, (err, data) => {
if (err) {
console.error('getLowResolutionMissionSnapShot failed: ${err.message}');
} else {
console.info('getLowResolutionMissionSnapShot successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('getLowResolutionMissionSnapShot failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
deviceId | string | Yes | Device ID. It is a null string by default for the local device. |
missionId | number | Yes | Mission ID. |
Return value
Type | Description |
---|---|
Promise<MissionSnapshot> | Promise used to return the snapshot information obtained. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.getLowResolutionMissionSnapShot('', testMissionId).then((data) => {
console.info('getLowResolutionMissionSnapShot successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('getLowResolutionMissionSnapShot failed. Cause: ${error.message}');
});
} catch (error) {
console.error('getLowResolutionMissionSnapShot failed. Cause: ${error.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
16300001 | Mission not found. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.lockMission(testMissionId, (err, data) => {
if (err) {
console.error('lockMission failed: ${err.message}');
} else {
console.info('lockMission successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('lockMission failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
16300001 | Mission not found. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.lockMission(testMissionId).then((data) => {
console.info('lockMission successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('lockMission failed. Cause: ${error.message}');
});
} catch (error) {
console.error('lockMission failed. Cause: ${error.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
16300001 | Mission not found. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.unlockMission(testMissionId, (err, data) => {
if (err) {
console.error('unlockMission failed: ${err.message}');
} else {
console.info('unlockMission successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('unlockMission failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
16300001 | Mission not found. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.unlockMission(testMissionId).then((data) => {
console.info('unlockMission successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('unlockMission failed. Cause: ${error.message}');
});
} catch (error) {
console.error('unlockMission failed. Cause: ${error.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.clearMission(testMissionId, (err, data) => {
if (err) {
console.error('clearMission failed: ${err.message}');
} else {
console.info('clearMission successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('clearMission failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.clearMission(testMissionId).then((data) => {
console.info('clearMission successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('clearMission failed. Cause: ${error.message}');
});
} catch (error) {
console.error('clearMission failed. Cause: ${error.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';
try {
missionManager.clearAllMissions(err => {
if (err) {
console.error('clearAllMissions failed: ${err.message}');
} else {
console.info('clearAllMissions successfully.');
}
});
} catch (err) {
console.error('clearAllMissions failed: ${err.message}');
}
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
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Example
import missionManager from '@ohos.app.ability.missionManager';
try {
missionManager.clearAllMissions(bundleName).then((data) => {
console.info('clearAllMissions successfully. Data: ${JSON.stringify(data)}');
}).catch(err => {
console.error('clearAllMissions failed: ${err.message}');
});
} catch (err) {
console.error('clearAllMissions failed: ${err.message}');
}
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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
16000009 | An ability cannot be started or stopped in Wukong mode. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.moveMissionToFront(testMissionId, (err, data) => {
if (err) {
console.error('moveMissionToFront failed: ${err.message}');
} else {
console.info('moveMissionToFront successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('moveMissionToFront failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
options | StartOptions | Yes | Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground. |
callback | AsyncCallback<void> | Yes | Callback used to return the result. |
Error codes
ID | Error Message |
---|---|
16000009 | An ability cannot be started or stopped in Wukong mode. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.moveMissionToFront(testMissionId, {windowMode : 101}, (err, data) => {
if (err) {
console.error('moveMissionToFront failed: ${err.message}');
} else {
console.info('moveMissionToFront successfully: ${JSON.stringify(data)}');
}
});
} catch (err) {
console.error('moveMissionToFront failed: ${err.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
Name | Type | Mandatory | Description |
---|---|---|---|
missionId | number | Yes | Mission ID. |
options | StartOptions | No | Startup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground. |
Return value
Type | Description |
---|---|
Promise<void> | Promise used to return the result. |
Error codes
ID | Error Message |
---|---|
16000009 | An ability cannot be started or stopped in Wukong mode. |
For details about the error codes, see Ability Error Codes.
Example
import missionManager from '@ohos.app.ability.missionManager';
let testMissionId = 2;
try {
missionManager.moveMissionToFront(testMissionId).then((data) => {
console.info('moveMissionToFront successfully. Data: ${JSON.stringify(data)}');
}).catch(error => {
console.error('moveMissionToFront failed. Cause: ${error.message}');
});
} catch (error) {
console.error('moveMissionToFront failed. Cause: ${error.message}');
}