@ohos.app.ability.AbilityConstant (AbilityConstant) (System API)
The AbilityConstant module defines the enums of the window types in the UIAbility.
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 (AbilityConstant).
Modules to Import
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
AbilityConstant.WindowMode
Enumerates the window modes in which an ability can be displayed at startup. It can be used in startAbility() to specify the window mode when the ability is started.
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_FULLSCREEN | 1 | The ability is displayed in full screen. |
WINDOW_MODE_SPLIT_PRIMARY | 100 | The left screen in horizontal direction or the upper screen in vertical direction is the primary window. |
WINDOW_MODE_SPLIT_SECONDARY | 101 | The right screen in horizontal direction or the lower screen in vertical direction is the secondary window. |
WINDOW_MODE_FLOATING | 102 | The ability is displayed in a floating window. |
Example
import UIAbility from '@ohos.app.ability.UIAbility';
import StartOptions from '@ohos.app.ability.StartOptions';
import Want from '@ohos.app.ability.Want';
import { BusinessError } from '@ohos.base';
import AbilityConstant from '@ohos.app.ability.AbilityConstant';
let want: Want = {
bundleName: 'com.example.myapplication',
abilityName: 'EntryAbility'
};
let option: StartOptions = {
windowMode: AbilityConstant.WindowMode.WINDOW_MODE_FULLSCREEN
};
// Ensure that the context is obtained.
class MyAbility extends UIAbility {
onCreate(want: Want, launchParam: AbilityConstant.LaunchParam) {
this.context.startAbility(want, option).then(()=>{
console.log('Succeed to start ability.');
}).catch((error: BusinessError)=>{
console.error('Failed to start ability with error: ${JSON.stringify(error)}');
});
}
}