@ohos.app.appstartup.StartupConfig (启动框架配置信息)

本模块提供应用启动框架配置信息的定义。

说明:

本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

本模块接口仅可在Stage模型下使用。

导入模块

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

StartupConfig

用于配置任务超时时间和启动框架的监听器。详细使用方法可参考设置启动参数章节。

系统能力:SystemCapability.Ability.AppStartup

名称 类型 只读 可选 说明
timeoutMs number 执行所有启动任务的超时时间(单位:毫秒),默认值为10000毫秒。
startupListener StartupListener 表示启动框架的监听器,该监听器将在所有启动任务完成时调用。

示例:

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.error(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;
  }
}