MissionSnapshot (System API)

The MissionSnapshot module defines the snapshot of a mission. The snapshot can be obtained through missionManager.getMissionSnapShot.

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. The APIs of this module are system APIs and cannot be called by third-party applications.

Modules to Import

import { missionManager } from '@kit.AbilityKit';

Attributes

System API: This is a system API.

System capability: SystemCapability.Ability.AbilityRuntime.Mission

Name	Type	Readable	Writable	Description
ability	ElementName	Yes	Yes	Ability information of the mission.
snapshot	PixelMap	Yes	Yes	Snapshot of the mission.

How to Use

The mission snapshot information can be obtained by using getMissionSnapShot in missionManager.

Example

import { missionManager } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

try {
  missionManager.getMissionInfos('', 10, (error, missions) => {
    if (error) {
      console.error(`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)}`);
    let id = missions[0].missionId;

    missionManager.getMissionSnapShot('', id, (err, snapshot) => {
      if (err) {
        console.error(`getMissionInfos failed, err.code: ${JSON.stringify(err.code)}, err.message: ${JSON.stringify(err.message)}`);
        return;
      }
      // Carry out normal service processing.
      console.log(`bundleName = ${snapshot.ability.bundleName}`);
    });
  });
} catch (paramError) {
  console.error(`error: ${(paramError as BusinessError).code}, ${(paramError as BusinessError).message}`);
}