@ohos.app.ability.StartOptions (StartOptions)

StartOptions is used as an input parameter of startAbility to specify the window mode of an ability.

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. The APIs of this module can be used only in the stage model.

Modules to Import

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

Attributes

System capability: SystemCapability.Ability.AbilityRuntime.Core

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

Name Type Mandatory Description
windowMode number No Window mode.
displayId number No Display ID.

Example

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

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

    let startOptions = {
        windowMode : 101,
        displayId: 0
    };
    missionManager.moveMissionToFront(id, startOptions).then(() => {
	    console.log('moveMissionToFront is called ');
    });
  });
} catch (paramError) {
  console.log('error: ' + paramError.code + ', ' + paramError.message);
}