@ohos.app.ability.StartOptions (StartOptions) (System API)

StartOptions can be used as an input parameter for APIs used to launch a UIAbility (for example, startAbility()). It specifies the options for starting the target UIAbility, including but not limited to the window mode and the display where the target UIAbility is started.

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.StartOptions (StartOptions).

Modules to Import

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

StartOptions

System capability: SystemCapability.Ability.AbilityRuntime.Core

System API: This is a system API.

Name	Type	Read-only	Optional	Description
windowFocused12+	boolean	No	Yes	Whether the window has focus. The default value is true, indicating that the window has focus. Constraints: 1. This property takes effect only on 2-in-1 devices and tablets. 2. This property takes effect only in UIAbilityContext.startAbility.

Example

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

export default class EntryAbility extends UIAbility {

  onForeground() {
    let want: Want = {
      deviceId: '',
      bundleName: 'com.example.myapplication',
      abilityName: 'EntryAbility'
    };
    let options: StartOptions = {
      displayId: 0
    };

    try {
      this.context.startAbility(want, options, (err: BusinessError) => {
        if (err.code) {
          // Process service logic errors.
          console.error(`startAbility failed, code is ${err.code}, message is ${err.message}`);
          return;
        }
        // Carry out normal service processing.
        console.info('startAbility succeed');
      });
    } catch (err) {
      // Process input parameter errors.
      let code = (err as BusinessError).code;
      let message = (err as BusinessError).message;
      console.error(`startAbility failed, code is ${code}, message is ${message}`);
    }
  }
}