@ohos.app.ability.AbilityConstant (Ability-related Constants) (System APIs)

AbilityConstant provides enums related to abilities, including the window mode.

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.

This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.app.ability.AbilityConstant (Ability-related Constants).

Modules to Import

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

WindowMode¹²⁺

Enumerates the window modes in which a UIAbility can be displayed at startup. It can be used in startAbility.

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API.

Name	Value	Description
WINDOW_MODE_UNDEFINED	0	Undefined window mode.
WINDOW_MODE_FLOATING	102	The ability is displayed in a floating window.

Example

import { UIAbility, StartOptions, Want, AbilityConstant } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let want: Want = {
  bundleName: 'com.example.myapplication',
  abilityName: 'EntryAbility'
};
let option: StartOptions = {
  windowMode: AbilityConstant.WindowMode.WINDOW_MODE_FULLSCREEN
};

// Ensure that the context is obtained.
export default class MyAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
    this.context.startAbility(want, option).then(() => {
      console.info('Succeed to start ability.');
    }).catch((error: BusinessError) => {
      console.error(`Failed to start ability with error: ${JSON.stringify(error)}`);
    });
  }
}