• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2024 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
21/**
22 * Obtains configuration information about an skill
23 *
24 * @typedef Skill
25 * @syscap SystemCapability.BundleManager.BundleFramework.Core
26 * @atomicservice
27 * @since arkts {'1.1':'12', '1.2':'20'}
28 * @arkts 1.1&1.2
29 */
30export interface Skill {
31  /**
32   * Indicates the actions of the skill
33   *
34   * @type { Array<string> }
35   * @readonly
36   * @syscap SystemCapability.BundleManager.BundleFramework.Core
37   * @atomicservice
38   * @since arkts {'1.1':'12', '1.2':'20'}
39   * @arkts 1.1&1.2
40   */
41  readonly actions: Array<string>;
42
43  /**
44   * Indicates the entities of the skill
45   *
46   * @type { Array<string> }
47   * @readonly
48   * @syscap SystemCapability.BundleManager.BundleFramework.Core
49   * @atomicservice
50   * @since arkts {'1.1':'12', '1.2':'20'}
51   * @arkts 1.1&1.2
52   */
53  readonly entities: Array<string>;
54
55  /**
56   * Indicates the uris of the skill
57   *
58   * @type { Array<SkillUri> }
59   * @readonly
60   * @syscap SystemCapability.BundleManager.BundleFramework.Core
61   * @atomicservice
62   * @since arkts {'1.1':'12', '1.2':'20'}
63   * @arkts 1.1&1.2
64   */
65  readonly uris: Array<SkillUri>;
66
67  /**
68   * Indicates the domainVerify of the skill
69   *
70   * @type { boolean }
71   * @readonly
72   * @syscap SystemCapability.BundleManager.BundleFramework.Core
73   * @atomicservice
74   * @since arkts {'1.1':'12', '1.2':'20'}
75   * @arkts 1.1&1.2
76   */
77  readonly domainVerify: boolean;
78}
79
80/**
81 * Obtains configuration information about an skillUri
82 *
83 * @typedef SkillUri
84 * @syscap SystemCapability.BundleManager.BundleFramework.Core
85 * @atomicservice
86 * @since arkts {'1.1':'12', '1.2':'20'}
87 * @arkts 1.1&1.2
88 */
89export interface SkillUri {
90  /**
91   * Indicates the scheme of the skillUri
92   *
93   * @type { string }
94   * @readonly
95   * @syscap SystemCapability.BundleManager.BundleFramework.Core
96   * @atomicservice
97   * @since arkts {'1.1':'12', '1.2':'20'}
98   * @arkts 1.1&1.2
99   */
100  readonly scheme: string;
101
102  /**
103   * Indicates the host of the skillUri
104   *
105   * @type { string }
106   * @readonly
107   * @syscap SystemCapability.BundleManager.BundleFramework.Core
108   * @atomicservice
109   * @since arkts {'1.1':'12', '1.2':'20'}
110   * @arkts 1.1&1.2
111   */
112  readonly host: string;
113
114  /**
115   * Indicates the port of the skillUri
116   *
117   * @type { number }
118   * @readonly
119   * @syscap SystemCapability.BundleManager.BundleFramework.Core
120   * @atomicservice
121   * @since arkts {'1.1':'12', '1.2':'20'}
122   * @arkts 1.1&1.2
123   */
124  readonly port: number;
125
126  /**
127   * Indicates the path of the skillUri
128   *
129   * @type { string }
130   * @readonly
131   * @syscap SystemCapability.BundleManager.BundleFramework.Core
132   * @atomicservice
133   * @since arkts {'1.1':'12', '1.2':'20'}
134   * @arkts 1.1&1.2
135   */
136  readonly path: string;
137
138  /**
139   * Indicates the pathStartWith of the skillUri
140   *
141   * @type { string }
142   * @readonly
143   * @syscap SystemCapability.BundleManager.BundleFramework.Core
144   * @atomicservice
145   * @since arkts {'1.1':'12', '1.2':'20'}
146   * @arkts 1.1&1.2
147   */
148  readonly pathStartWith: string;
149
150  /**
151   * Indicates the pathRegex of the skillUri
152   *
153   * @type {string }
154   * @readonly
155   * @syscap SystemCapability.BundleManager.BundleFramework.Core
156   * @atomicservice
157   * @since arkts {'1.1':'12', '1.2':'20'}
158   * @arkts 1.1&1.2
159   */
160  readonly pathRegex: string;
161
162  /**
163   * Indicates the type of the skillUri
164   *
165   * @type { string }
166   * @readonly
167   * @syscap SystemCapability.BundleManager.BundleFramework.Core
168   * @atomicservice
169   * @since arkts {'1.1':'12', '1.2':'20'}
170   * @arkts 1.1&1.2
171   */
172  readonly type: string;
173
174  /**
175   * Indicates the utd of the skillUri
176   *
177   * @type { string }
178   * @readonly
179   * @syscap SystemCapability.BundleManager.BundleFramework.Core
180   * @atomicservice
181   * @since arkts {'1.1':'12', '1.2':'20'}
182   * @arkts 1.1&1.2
183   */
184  readonly utd: string;
185
186  /**
187   * Indicates the maxFileSupported of the skillUri
188   *
189   * @type { number }
190   * @readonly
191   * @syscap SystemCapability.BundleManager.BundleFramework.Core
192   * @atomicservice
193   * @since arkts {'1.1':'12', '1.2':'20'}
194   * @arkts 1.1&1.2
195   */
196  readonly maxFileSupported: number;
197
198  /**
199   * Indicates the linkFeature of the skillUri
200   *
201   * @type { string }
202   * @readonly
203   * @syscap SystemCapability.BundleManager.BundleFramework.Core
204   * @atomicservice
205   * @since arkts {'1.1':'12', '1.2':'20'}
206   * @arkts 1.1&1.2
207   */
208  readonly linkFeature: string;
209}