1/*
2 * Copyright (c) 2023 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit AbilityKit
19 */
20
21import { DrawableDescriptor } from './../@ohos.arkui.drawableDescriptor';
22
23/**
24 * Obtains resource information about a launcher ability
25 *
26 * @typedef LauncherAbilityResourceInfo
27 * @syscap SystemCapability.BundleManager.BundleFramework.Resource
28 * @systemapi
29 * @since 11
30 */
31export interface LauncherAbilityResourceInfo {
32  /**
33   * Indicates the bundleName of this ability
34   *
35   * @type { string }
36   * @readonly
37   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
38   * @systemapi
39   * @since 11
40   */
41  readonly bundleName: string;
42
43  /**
44   * Indicates the moduleName of this ability
45   *
46   * @type { string }
47   * @readonly
48   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
49   * @systemapi
50   * @since 11
51   */
52  readonly moduleName: string;
53
54  /**
55   * Indicates the abilityName of this ability
56   *
57   * @type { string }
58   * @readonly
59   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
60   * @systemapi
61   * @since 11
62   */
63  readonly abilityName: string;
64
65  /**
66   * Indicates the icon of this ability, which is base64 format
67   *
68   * @type { string }
69   * @readonly
70   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
71   * @systemapi
72   * @since 11
73   */
74  readonly icon: string;
75
76  /**
77   * Indicates the label of this ability
78   *
79   * @type { string }
80   * @readonly
81   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
82   * @systemapi
83   * @since 11
84   */
85  readonly label: string;
86
87  /**
88   * Indicates the drawable descriptor of this ability icon
89   *
90   * @type { DrawableDescriptor }
91   * @readonly
92   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
93   * @systemapi
94   * @since 12
95   */
96  readonly drawableDescriptor: DrawableDescriptor;
97
98  /**
99   * Indicates the index of the bundle
100   *
101   * @type { number }
102   * @readonly
103   * @syscap SystemCapability.BundleManager.BundleFramework.Resource
104   * @systemapi
105   * @since 12
106   */
107  readonly appIndex: number;
108}
109