• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2022 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 * Contains basic Ability information, which uniquely identifies an ability.
18 * You can use this class to obtain values of the fields set in an element,
19 * such as the device ID, bundle name, and ability name.
20 * @typedef ElementName
21 * @syscap SystemCapability.BundleManager.BundleFramework.Core
22 * @since 9
23 */
24export interface ElementName {
25  /**
26   * Indicates device id
27   * @type {?string}
28   * @syscap SystemCapability.BundleManager.BundleFramework.Core
29   * @since 9
30   */
31  deviceId?: string;
32
33  /**
34   * @default Indicates bundle name
35   * @type {string}
36   * @syscap SystemCapability.BundleManager.BundleFramework.Core
37   * @since 9
38   */
39  bundleName: string;
40
41  /**
42  * @default Indicates module name
43  * @type {?string}
44  * @syscap SystemCapability.BundleManager.BundleFramework.Core
45  * @since 9
46  */
47  moduleName?: string;
48
49  /**
50   * Indicates ability name
51   * @type {string}
52   * @syscap SystemCapability.BundleManager.BundleFramework.Core
53   * @since 9
54   */
55  abilityName: string;
56
57  /**
58   * Indicates uri
59   * @type {?string}
60   * @syscap SystemCapability.BundleManager.BundleFramework.Core
61   * @since 9
62   */
63  uri?: string;
64
65  /**
66   * Indicates short name
67   * @type {?string}
68   * @syscap SystemCapability.BundleManager.BundleFramework.Core
69   * @since 9
70   */
71  shortName?: string;
72}
73