• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AutoStartupCallback (System API)
2
3The **AutoStartupCallback** 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 from '@ohos.app.ability.autoStartupManager';
32import common from '@ohos.app.ability.common';
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}
42try {
43  AutoStartupManager.on('systemAutoStartup', autoStartupCallback)
44} catch (err) {
45  console.info('===> autostartupmanager on callback err: ' + JSON.stringify(err));
46}
47```
48
49## AutoStartupCallback.onAutoStartupOff
50
51onAutoStartupOff(info: AutoStartupInfo): void;
52
53Called when the auto-startup setting of an application component is canceled.
54
55**System API**: This is a system API.
56
57**System capability**: SystemCapability.Ability.AbilityRuntime.Core
58
59**Parameters**
60
61| Name| Type           | Mandatory| Description                |
62| ------ | --------------- | ---- | -------------------- |
63| info   | [AutoStartupInfo](js-apis-inner-application-autoStartupInfo-sys.md)   | Yes  | Information about the target application component.|
64
65**Example**
66
67```ts
68import AutoStartupManager from '@ohos.app.ability.autoStartupManager';
69import common from '@ohos.app.ability.common';
70
71let autoStartupCallback: common.AutoStartupCallback = {
72  onAutoStartupOn(data: common.AutoStartupInfo) {
73    console.info('===> autostartupmanager onAutoStartupOn data: ' + JSON.stringify(data));
74  },
75  onAutoStartupOff(data: common.AutoStartupInfo) {
76    console.info('===> autostartupmanager onAutoStartupOff data: ' + JSON.stringify(data));
77  }
78}
79try {
80  AutoStartupManager.on('systemAutoStartup', autoStartupCallback)
81} catch (err) {
82  console.info('===> autostartupmanager on callback err: ' + JSON.stringify(err));
83}
84```
85