• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# AutoStartupInfo (系统接口)
2<!--Kit: Ability Kit-->
3<!--Subsystem: Ability-->
4<!--Owner: @duan-sizhao-->
5<!--Designer: @ccllee1-->
6<!--Tester: @lixueqing513-->
7<!--Adviser: @huipeizi-->
8定义开机自启动应用组件信息。
9
10> **说明:**
11>
12> 本模块首批接口从API version 11 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
13> 本模块接口仅可在Stage模型下使用。
14> 本模块接口为系统接口。
15
16## 属性
17
18**系统接口**:此接口为系统接口。
19
20**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
21
22| 名称                        | 类型    | 只读 | 可选 | 说明                                           |
23| --------------------------- | ------- | ---- | ---- | ---------------------------------------------- |
24| bundleName                  | string  | 否   | 否   | 应用程序的Bundle名称。                         |
25| moduleName                  | string  | 否   | 是   | 应用程序的Module名称。                         |
26| abilityName                 | string  | 否   | 否   | 应用程序的Ability名称。                        |
27| abilityTypeName             | string  | 否   | 是   | 应用程序的Ability类型。                        |
28| appCloneIndex               | number  | 否   | 是   | 分身应用索引。                                 |
29| userId<sup>20+</sup>        | number  | 是   | 是   | 应用程序所属的用户ID,用于区分同一设备上不同用户账号下的应用。      |
30| setterUserId<sup>20+</sup>  | number  | 是   | 是   | 设置者的用户ID,记录了将当前应用设置为开机自启动的用户ID。         |
31| canUserModify<sup>20+</sup> | boolean | 是   | 是   | 表示是否允许开发者修改此应用的开机自启动状态。 |
32
33**示例:**
34
35```ts
36import { autoStartupManager, common } from '@kit.AbilityKit';
37
38autoStartupManager.setApplicationAutoStartup({
39  bundleName: 'com.example.autostartupapp',
40  moduleName: 'entry',
41  abilityName: 'EntryAbility',
42  abilityTypeName: 'ServiceExtension'
43} as common.AutoStartupInfo, (err) => {
44  if (err) {
45    console.error(`setApplicationAutoStartup failed, err code: ${err.code}, err msg: ${err.message}.`);
46    return;
47  }
48  console.info(`setApplicationAutoStartup success.`);
49});
50```
51