@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

Name	Type	Read-only	Mandatory	Description
windowMode	number	No	No	Window mode. System API: This is a system API and cannot be called by third-party applications.
displayId	number	No	No	Display ID mode. The default value is 0, indicating the current display.
withAnimation¹¹⁺	boolean	No	No	Whether the ability has the animation effect.
windowLeft¹¹⁺	number	No	No	Left position of the window.
windowTop¹¹⁺	number	No	No	Top position of the window.
windowWidth¹¹⁺	number	No	No	Width of the window.
windowHeight¹¹⁺	number	No	No	Height of the window.

Example

import UIAbility from '@ohos.app.ability.UIAbility';
import Want from '@ohos.app.ability.Want';
import StartOptions from '@ohos.app.ability.StartOptions';
import { BusinessError } from '@ohos.base';

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}`);
    }
  }
}