• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.app.appstartup.StartupConfig (启动框架配置信息)
2<!--Kit: Ability Kit-->
3<!--Subsystem: Ability-->
4<!--Owner: @yzkp-->
5<!--Designer: @yzkp-->
6<!--Tester: @lixueqing513-->
7<!--Adviser: @huipeizi-->
8
9本模块提供启动任务的配置接口。
10
11> **说明:**
12>
13> 本模块首批接口从API version 12开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
14>
15> 本模块接口仅可在Stage模型下使用。
16
17## 导入模块
18
19```js
20import { StartupConfig } from '@kit.AbilityKit';
21```
22
23## StartupConfig
24
25**系统能力**:SystemCapability.Ability.AppStartup
26
27| 名称 | 类型 | 只读 | 可选 | 说明 |
28| -------- | -------- | -------- | -------- | -------- |
29| timeoutMs | number | 否 | 是 | 执行所有启动任务的超时时间(单位:毫秒),默认值为10000毫秒。 |
30| startupListener | [StartupListener](./js-apis-app-appstartup-startupListener.md) | 否 | 是 | 表示启动框架的监听器,该监听器将在所有启动任务完成时调用。 |
31
32**示例:**
33
34```ts
35import { StartupConfig, StartupConfigEntry, StartupListener } from '@kit.AbilityKit';
36import { BusinessError } from '@kit.BasicServicesKit';
37import { hilog } from '@kit.PerformanceAnalysisKit';
38
39export default class MyStartupConfigEntry extends StartupConfigEntry {
40  onConfig() {
41    hilog.info(0x0000, 'testTag', `onConfig`);
42    let onCompletedCallback = (error: BusinessError<void>) => {
43      hilog.info(0x0000, 'testTag', `onCompletedCallback`);
44      if (error) {
45        hilog.error(0x0000, 'testTag', 'onCompletedCallback: %{public}d, message: %{public}s', error.code,
46          error.message);
47      } else {
48        hilog.info(0x0000, 'testTag', `onCompletedCallback: success.`);
49      }
50    };
51    let startupListener: StartupListener = {
52      'onCompleted': onCompletedCallback
53    };
54    let config: StartupConfig = {
55      'timeoutMs': 10000,
56      'startupListener': startupListener
57    };
58    return config;
59  }
60}
61```
62