• 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 *
21 * @typedef ElementName
22 * @syscap SystemCapability.BundleManager.BundleFramework.Core
23 * @since 9
24 */
25/**
26 * Contains basic Ability information, which uniquely identifies an ability.
27 * You can use this class to obtain values of the fields set in an element,
28 * such as the device ID, bundle name, and ability name.
29 *
30 * @typedef ElementName
31 * @syscap SystemCapability.BundleManager.BundleFramework.Core
32 * @atomicservice
33 * @since 11
34 */
35export interface ElementName {
36  /**
37   * Indicates device id
38   *
39   * @type { ?string }
40   * @syscap SystemCapability.BundleManager.BundleFramework.Core
41   * @since 9
42   */
43  /**
44   * Indicates device id
45   *
46   * @type { ?string }
47   * @syscap SystemCapability.BundleManager.BundleFramework.Core
48   * @atomicservice
49   * @since 11
50   */
51  deviceId?: string;
52
53  /**
54   * @type { string }
55   * @default Indicates bundle name
56   * @syscap SystemCapability.BundleManager.BundleFramework.Core
57   * @since 9
58   */
59  /**
60   * @type { string }
61   * @default Indicates bundle name
62   * @syscap SystemCapability.BundleManager.BundleFramework.Core
63   * @atomicservice
64   * @since 11
65   */
66  bundleName: string;
67
68  /**
69   * @type { ?string }
70   * @default Indicates module name
71   * @syscap SystemCapability.BundleManager.BundleFramework.Core
72   * @since 9
73   */
74  /**
75   * @type { ?string }
76   * @default Indicates module name
77   * @syscap SystemCapability.BundleManager.BundleFramework.Core
78   * @atomicservice
79   * @since 11
80   */
81  moduleName?: string;
82
83  /**
84   * Indicates ability name
85   *
86   * @type { string }
87   * @syscap SystemCapability.BundleManager.BundleFramework.Core
88   * @since 9
89   */
90  /**
91   * Indicates ability name
92   *
93   * @type { string }
94   * @syscap SystemCapability.BundleManager.BundleFramework.Core
95   * @atomicservice
96   * @since 11
97   */
98  abilityName: string;
99
100  /**
101   * Indicates uri
102   *
103   * @type { ?string }
104   * @syscap SystemCapability.BundleManager.BundleFramework.Core
105   * @since 9
106   */
107  /**
108   * Indicates uri
109   *
110   * @type { ?string }
111   * @syscap SystemCapability.BundleManager.BundleFramework.Core
112   * @atomicservice
113   * @since 11
114   */
115  uri?: string;
116
117  /**
118   * Indicates short name
119   *
120   * @type { ?string }
121   * @syscap SystemCapability.BundleManager.BundleFramework.Core
122   * @since 9
123   */
124  /**
125   * Indicates short name
126   *
127   * @type { ?string }
128   * @syscap SystemCapability.BundleManager.BundleFramework.Core
129   * @atomicservice
130   * @since 11
131   */
132  shortName?: string;
133}
134