• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AutoStartupCallback (系统接口)
2
3应用设置为开机自启动时的回调函数。
4
5> **说明：**
6>
7> 本模块首批接口从API version 11开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8> 本模块接口仅可在Stage模型下使用。
9> 本模块接口为系统接口。
10
11## AutoStartupCallback.onAutoStartupOn
12
13onAutoStartupOn(info: AutoStartupInfo): void;
14
15应用设置为开机自启动时调用。
16
17**系统接口**：此接口为系统接口。
18
19**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
20
21**参数：**
22
23| 参数名 | 类型 | 必填 | 说明 |
24| -------- | -------- | -------- | -------- |
25| info | [AutoStartupInfo](js-apis-inner-application-autoStartupInfo-sys.md)   | 是 | 设置为开机自启动的应用组件信息。 |
26
27**示例：**
28
29```ts
30import { autoStartupManager, common } from '@kit.AbilityKit';
31import { BusinessError } from '@kit.BasicServicesKit';
32
33let autoStartupCallback: common.AutoStartupCallback = {
34  onAutoStartupOn(data: common.AutoStartupInfo) {
35    console.info(`autostartupmanager onAutoStartupOn, data: ${JSON.stringify(data)}.`);
36  },
37  onAutoStartupOff(data: common.AutoStartupInfo) {
38    console.info(`autostartupmanager onAutoStartupOff, data: ${JSON.stringify(data)}.`);
39  }
40}
41
42try {
43  autoStartupManager.on('systemAutoStartup', autoStartupCallback);
44} catch (err) {
45  let code = (err as BusinessError).code;
46  let msg = (err as BusinessError).message;
47  console.error(`autoStartupManager.on failed, err code: ${code}, err msg: ${msg}.`);
48}
49```
50
51## AutoStartupCallback.onAutoStartupOff
52
53onAutoStartupOff(info: AutoStartupInfo): void;
54
55取消应用开机自启动时调用。
56
57**系统接口**：此接口为系统接口。
58
59**系统能力**：SystemCapability.Ability.AbilityRuntime.Core
60
61**参数：**
62
63| 参数名 | 类型            | 必填 | 说明                 |
64| ------ | --------------- | ---- | -------------------- |
65| info   | [AutoStartupInfo](js-apis-inner-application-autoStartupInfo-sys.md)   | 是   | 取消开机自启动的应用组件信息。 |
66
67**示例：**
68
69```ts
70import { autoStartupManager, common } from '@kit.AbilityKit';
71import { BusinessError } from '@kit.BasicServicesKit';
72
73let autoStartupCallback: common.AutoStartupCallback = {
74  onAutoStartupOn(data: common.AutoStartupInfo) {
75    console.info(`autostartupmanager onAutoStartupOn, data: ${JSON.stringify(data)}.`);
76  },
77  onAutoStartupOff(data: common.AutoStartupInfo) {
78    console.info(`autostartupmanager onAutoStartupOff, data: ${JSON.stringify(data)}.`);
79  }
80}
81
82try {
83  autoStartupManager.on('systemAutoStartup', autoStartupCallback);
84} catch (err) {
85  let code = (err as BusinessError).code;
86  let msg = (err as BusinessError).message;
87  console.error(`autoStartupManager.on failed, err code: ${code}, err msg: ${msg}.`);
88}
89```
90