@ohos.app.appstartup.StartupConfigEntry (AppStartup Configuration Entry)

The module provides the capability to configure AppStartup.

NOTE

The initial APIs of this module are supported since API version 12. 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 { StartupConfigEntry } from '@kit.AbilityKit';

StartupConfigEntry

onConfig

onConfig?(): StartupConfig

Called if the HAP of the AbilityStage has defined the AppStartup configuration file. This callback is triggered before AbilityStage.onCreate.

You can set the AppStartup configuration within this callback. For details, see Setting Startup Parameters.

System capability: SystemCapability.Ability.AppStartup

Return value

Type	Description
StartupConfig	AppStartup configuration.

Example

import { StartupConfig, StartupConfigEntry, StartupListener } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { hilog } from '@kit.PerformanceAnalysisKit';

export default class MyStartupConfigEntry extends StartupConfigEntry {
  onConfig() {
    hilog.info(0x0000, 'testTag', `onConfig`);
    let onCompletedCallback = (error: BusinessError<void>) => {
      hilog.info(0x0000, 'testTag', `onCompletedCallback`);
      if (error) {
        hilog.info(0x0000, 'testTag', 'onCompletedCallback: %{public}d, message: %{public}s', error.code,
          error.message);
      } else {
        hilog.info(0x0000, 'testTag', `onCompletedCallback: success.`);
      }
    }
    let startupListener: StartupListener = {
      'onCompleted': onCompletedCallback
    }
    let config: StartupConfig = {
      'timeoutMs': 10000,
      'startupListener': startupListener
    }
    return config;
  }
}

onRequestCustomMatchRule²⁰⁺

onRequestCustomMatchRule(want: Want): string

Called if the HAP of the AbilityStage has defined the AppStartup configuration file. This callback is triggered after StartupConfigEntry.onConfig but before AbilityStage.onCreate.

You can use this callback to return different custom matching rules based on parameters in the Want object passed by the caller to start the UIAbility. . AppStartup matches these rules with the customization field in matchRules of the startup task configuration. If a match is successful, the task is executed automatically. For details about the matching rules, see Adding Task Matching Rules.

This API is typically used in scenarios where tasks cannot be matched directly using URI, action, or intent name rules. It allows for further refinement of matching rules.

System capability: SystemCapability.Ability.AppStartup

Parameters

Name	Type	Mandatory	Description
want	Want	Yes	Want information about the target UIAbility.

Return value

Type	Description
string	Custom matching rule, which is used to determine whether to automatically execute the task.

Example

import { StartupConfigEntry, Want } from '@kit.AbilityKit';

export default class MyStartupConfigEntry extends StartupConfigEntry {
  // ...

  onRequestCustomMatchRule(want: Want): string {
    if (want?.parameters?.customParam == 'param1') {
      return 'customRule1';
    }
    return '';
  }
}