harmony(鸿蒙)missionManager

2022-08-09 浏览 (628)

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 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import missionManager from '@ohos.application.missionManager'

Required Permissions

ohos.permission.MANAGE_MISSIONS

missionManager.registerMissionListener

registerMissionListener(listener: MissionListener): number;

Registers a listener to observe the mission status.

Required permission: 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

NameTypeMandatoryDescription
listenerMissionListenerYesListener to register.

Return value

TypeDescription
numberReturns the unique index of the mission status listener, which is created by the system and allocated when the listener is registered.

Example

  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-------")}
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

missionManager.unregisterMissionListener

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

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

Required permission: 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

NameTypeMandatoryDescription
listenerIdnumberYesUnique index of the mission status listener to unregister. It is returned by registerMissionListener.
callbackAsyncCallback<void>YesCallback used to return the result.

Example

  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-------")}
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

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

missionManager.unregisterMissionListener

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

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

Required permission: 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

NameTypeMandatoryDescription
listenerIdnumberYesUnique index of the mission status listener to unregister. It is returned by registerMissionListener.

Return value

TypeDescription
Promise<void>Promise used to return the result.

Example

  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-------")}
  };
  console.log("registerMissionListener")
  var listenerid = missionManager.registerMissionListener(listener);

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

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
missionIdnumberYesMission ID.
callbackAsyncCallback<MissionInfo>YesCallback used to return the mission information obtained.

Example

import missionManager from '@ohos.application.missionManager'

var 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);
    });

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
missionIdnumberYesMission ID.

Return value

TypeDescription
Promise<MissionInfo>Promise used to return the mission information obtained.

Example

import missionManager from '@ohos.application.missionManager'

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

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
numMaxnumberYesMaximum number of missions whose information can be obtained.
callbackAsyncCallback<Array<MissionInfo>>YesCallback used to return the array of mission information obtained.

Example

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

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
numMaxnumberYesMaximum number of missions whose information can be obtained.

Return value

TypeDescription
Promise<Array<MissionInfo>>Promise used to return the array of mission information obtained.

Example

import missionManager from '@ohos.application.missionManager'

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

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
missionIdnumberYesMission ID.
callbackAsyncCallback<MissionSnapshot>YesCallback used to return the snapshot information obtained.

Example

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

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
missionIdnumberYesMission ID.

Return value

TypeDescription
Promise<MissionSnapshot>Promise used to return the snapshot information obtained.

Example

import missionManager from '@ohos.application.missionManager'

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

missionManager.getLowResolutionMissionSnapShot9+

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
missionIdnumberYesMission ID.
callbackAsyncCallback<MissionSnapshot>YesCallback used to return the snapshot information obtained.

Example

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.getLowResolutionMissionSnapShot("", id, (error, snapshot) => {
	console.log("getLowResolutionMissionSnapShot is called, error.code = " + error.code);
	console.log("bundleName = " + snapshot.ability.bundleName);
})
})

missionManager.getLowResolutionMissionSnapShot9+

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 permission: 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

NameTypeMandatoryDescription
deviceIdstringYesDevice ID. It is a null string by default for the local device.
missionIdnumberYesMission ID.

Return value

TypeDescription
Promise<MissionSnapshot>Promise used to return the snapshot information obtained.

Example

import missionManager from '@ohos.application.missionManager'

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

missionManager.lockMission

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

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

Required permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.
callbackAsyncCallback<void>YesCallback used to return the result.

Example

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 ");
});
});

missionManager.lockMission

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

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

Required permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.

Return value

TypeDescription
Promise<void>Promise used to return the result.

Example

import missionManager from '@ohos.application.missionManager'
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

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

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

Required permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.
callbackAsyncCallback<void>YesCallback used to return the result.

Example

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 ");
});
});

missionManager.unlockMission

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

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

Required permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.

Return value

TypeDescription
Promise<void>Promise used to return the result.

Example

import missionManager from '@ohos.application.missionManager'

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

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 permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.
callbackAsyncCallback<void>YesCallback used to return the result.

Example

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 ");
});
});

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 permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.

Return value

TypeDescription
Promise<void>Promise used to return the result.

Example

import missionManager from '@ohos.application.missionManager'

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

missionManager.clearAllMissions

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

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

Required permission: 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.application.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 permission: 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

TypeDescription
Promise<void>Promise used to return the result.

Example

import missionManager from '@ohos.application.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 permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.
callbackAsyncCallback<void>YesCallback used to return the result.

Example

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 ");
});
});

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 permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.
optionsStartOptionsYesStartup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.
callbackAsyncCallback<void>YesCallback used to return the result.

Example

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 ");
  });
});

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 permission: 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

NameTypeMandatoryDescription
missionIdnumberYesMission ID.
optionsStartOptionsNoStartup parameters, which are used to specify the window mode and device ID for switching the mission to the foreground.

Return value

TypeDescription
Promise<void>Promise used to return the result.

Example

import missionManager from '@ohos.application.missionManager'

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

MissionInfo

Describes the mission information.

System capability: SystemCapability.Ability.AbilityRuntime.Mission

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

NameTypeReadableWritableDescription
missionIdnumberYesYesMission ID.
runningStatenumberYesYesRunning state of the mission.
lockedStatebooleanYesYesLocked state of the mission.
timestampstringYesYesLatest time when the mission was created or updated.
wantWantYesYesWant information of the mission.
labelstringYesYesLabel of the mission.
iconPathstringYesYesPath of the mission icon.
continuablebooleanYesYesWhether the mission can be continued on another device.

你可能感兴趣的鸿蒙文章

harmony(鸿蒙)APIs

harmony(鸿蒙)API Reference Document Description

harmony(鸿蒙)BundleStatusCallback

harmony(鸿蒙)innerBundleManager(deprecated)

harmony(鸿蒙)distributedBundle

harmony(鸿蒙)Bundle

harmony(鸿蒙)Context

harmony(鸿蒙)DataUriUtils

harmony(鸿蒙)EnterpriseAdminExtensionAbility

harmony(鸿蒙)Work Scheduler Callbacks

  • 所属分类: 后端技术
  • 本文标签: 鸿蒙 软件
  • 版权声明: 本文链接 https://seaxiang.com/blog/b5e5abf609524367af0b3c3515c45dc9