• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AutoStartupCallback (System API)
2
3The module defines the callback to be invoked when auto-startup is set or canceled for an application component.
4
5> **NOTE**
6>
7> The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8>
9> The APIs of this module can be used only in the stage model.
10> The APIs provided by this module are system APIs.
11
12## AutoStartupCallback.onAutoStartupOn
13
14onAutoStartupOn(info: AutoStartupInfo): void;
15
16Called when auto-startup is set for an application component.
17
18**System API**: This is a system API.
19
20**System capability**: SystemCapability.Ability.AbilityRuntime.Core
21
22**Parameters**
23
24| Name| Type| Mandatory| Description|
25| -------- | -------- | -------- | -------- |
26| info | [AutoStartupInfo](js-apis-inner-application-autoStartupInfo-sys.md)   | Yes| Information about the target application component.|
27
28**Example**
29
30```ts
31import { autoStartupManager, common } from '@kit.AbilityKit';
32import { BusinessError } from '@kit.BasicServicesKit';
33
34let autoStartupCallback: common.AutoStartupCallback = {
35  onAutoStartupOn(data: common.AutoStartupInfo) {
36    console.info(`autostartupmanager onAutoStartupOn, data: ${JSON.stringify(data)}.`);
37  },
38  onAutoStartupOff(data: common.AutoStartupInfo) {
39    console.info(`autostartupmanager onAutoStartupOff, data: ${JSON.stringify(data)}.`);
40  }
41}
42
43try {
44  autoStartupManager.on('systemAutoStartup', autoStartupCallback);
45} catch (err) {
46  let code = (err as BusinessError).code;
47  let msg = (err as BusinessError).message;
48  console.error(`autoStartupManager.on failed, err code: ${code}, err msg: ${msg}.`);
49}
50```
51
52## AutoStartupCallback.onAutoStartupOff
53
54onAutoStartupOff(info: AutoStartupInfo): void;
55
56Called when the auto-startup setting of an application component is canceled.
57
58**System API**: This is a system API.
59
60**System capability**: SystemCapability.Ability.AbilityRuntime.Core
61
62**Parameters**
63
64| Name| Type           | Mandatory| Description                |
65| ------ | --------------- | ---- | -------------------- |
66| info   | [AutoStartupInfo](js-apis-inner-application-autoStartupInfo-sys.md)   | Yes  | Information about the target application component.|
67
68**Example**
69
70```ts
71import { autoStartupManager, common } from '@kit.AbilityKit';
72import { BusinessError } from '@kit.BasicServicesKit';
73
74let autoStartupCallback: common.AutoStartupCallback = {
75  onAutoStartupOn(data: common.AutoStartupInfo) {
76    console.info(`autostartupmanager onAutoStartupOn, data: ${JSON.stringify(data)}.`);
77  },
78  onAutoStartupOff(data: common.AutoStartupInfo) {
79    console.info(`autostartupmanager onAutoStartupOff, data: ${JSON.stringify(data)}.`);
80  }
81}
82
83try {
84  autoStartupManager.on('systemAutoStartup', autoStartupCallback);
85} catch (err) {
86  let code = (err as BusinessError).code;
87  let msg = (err as BusinessError).message;
88  console.error(`autoStartupManager.on failed, err code: ${code}, err msg: ${msg}.`);
89}
90```
91