1/*
2 * Copyright (c) 2022-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
21import * as _UIAbilityContext from './application/UIAbilityContext';
22import type * as _UIExtensionContext from './application/UIExtensionContext';
23import type * as _AutoFillExtensionContext from './application/AutoFillExtensionContext';
24import * as _AbilityStageContext from './application/AbilityStageContext';
25import * as _ApplicationContext from './application/ApplicationContext';
26import * as _BaseContext from './application/BaseContext';
27import * as _Context from './application/Context';
28import * as _ExtensionContext from './application/ExtensionContext';
29import * as _FormExtensionContext from './application/FormExtensionContext';
30import * as _ServiceExtensionContext from './application/ServiceExtensionContext';
31import * as _EventHub from './application/EventHub';
32import { PacMap as _PacMap } from './ability/dataAbilityHelper';
33import { AbilityResult as _AbilityResult } from './ability/abilityResult';
34import type _AbilityStartCallback from './application/AbilityStartCallback';
35import { ConnectOptions as _ConnectOptions } from './ability/connectOptions';
36import type * as _VpnExtensionContext from './application/VpnExtensionContext';
37import type { AutoStartupCallback as _AutoStartupCallback } from './application/AutoStartupCallback';
38import type { AutoStartupInfo as _AutoStartupInfo } from './application/AutoStartupInfo';
39import type * as _EmbeddableUIAbilityContext from './application/EmbeddableUIAbilityContext';
40import type * as _PhotoEditorExtensionContext from './application/PhotoEditorExtensionContext';
41import * as _UIServiceExtensionContext from './application/UIServiceExtensionContext';
42import * as _UIServiceProxy from './application/UIServiceProxy';
43import * as _UIServiceHostProxy from './application/UIServiceHostProxy';
44import * as _UIServiceExtensionConnectCallback from './application/UIServiceExtensionConnectCallback';
45
46/**
47 * This module provides application context classes and common data structures.
48 *
49 * @namespace common
50 * @syscap SystemCapability.Ability.AbilityRuntime.Core
51 * @stagemodelonly
52 * @since 9
53 */
54/**
55 * This module provides application context classes and common data structures.
56 *
57 * @namespace common
58 * @syscap SystemCapability.Ability.AbilityRuntime.Core
59 * @stagemodelonly
60 * @crossplatform
61 * @since 10
62 */
63/**
64 * This module provides application context classes and common data structures.
65 *
66 * @namespace common
67 * @syscap SystemCapability.Ability.AbilityRuntime.Core
68 * @crossplatform
69 * @atomicservice
70 * @since 11
71 */
72declare namespace common {
73  /**
74   * The context of an ability. It allows access to ability-specific resources.
75   *
76   * @syscap SystemCapability.Ability.AbilityRuntime.Core
77   * @stagemodelonly
78   * @since 9
79   */
80  /**
81   * The context of an ability. It allows access to ability-specific resources.
82   *
83   * @syscap SystemCapability.Ability.AbilityRuntime.Core
84   * @stagemodelonly
85   * @crossplatform
86   * @since 10
87   */
88  /**
89   * The context of an ability. It allows access to ability-specific resources.
90   *
91   * @typedef { _UIAbilityContext.default }
92   * @syscap SystemCapability.Ability.AbilityRuntime.Core
93   * @stagemodelonly
94   * @crossplatform
95   * @atomicservice
96   * @since 11
97   */
98  export type UIAbilityContext = _UIAbilityContext.default;
99
100  /**
101   * The context of an abilityStage. It allows access to abilityStage-specific resources.
102   *
103   * @syscap SystemCapability.Ability.AbilityRuntime.Core
104   * @stagemodelonly
105   * @since 9
106   */
107  /**
108   * The context of an abilityStage. It allows access to abilityStage-specific resources.
109   *
110   * @syscap SystemCapability.Ability.AbilityRuntime.Core
111   * @stagemodelonly
112   * @crossplatform
113   * @since 10
114   */
115  /**
116   * The context of an abilityStage. It allows access to abilityStage-specific resources.
117   *
118   * @typedef { _AbilityStageContext.default }
119   * @syscap SystemCapability.Ability.AbilityRuntime.Core
120   * @stagemodelonly
121   * @crossplatform
122   * @atomicservice
123   * @since 11
124   */
125  export type AbilityStageContext = _AbilityStageContext.default;
126
127  /**
128   * The context of an application. It allows access to application-specific resources.
129   *
130   * @syscap SystemCapability.Ability.AbilityRuntime.Core
131   * @stagemodelonly
132   * @since 9
133   */
134  /**
135   * The context of an application. It allows access to application-specific resources.
136   *
137   * @syscap SystemCapability.Ability.AbilityRuntime.Core
138   * @stagemodelonly
139   * @crossplatform
140   * @since 10
141   */
142  /**
143   * The context of an application. It allows access to application-specific resources.
144   *
145   * @typedef { _ApplicationContext.default }
146   * @syscap SystemCapability.Ability.AbilityRuntime.Core
147   * @stagemodelonly
148   * @crossplatform
149   * @atomicservice
150   * @since 11
151   */
152  export type ApplicationContext = _ApplicationContext.default;
153
154  /**
155   * The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode.
156   *
157   * @syscap SystemCapability.Ability.AbilityRuntime.Core
158   * @stagemodelonly
159   * @since 9
160   */
161  /**
162   * The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode.
163   *
164   * @syscap SystemCapability.Ability.AbilityRuntime.Core
165   * @stagemodelonly
166   * @crossplatform
167   * @since 10
168   */
169  /**
170   * The base context of 'app.Context' for FA Mode or 'application.Context' for Stage Mode.
171   *
172   * @typedef { _BaseContext.default }
173   * @syscap SystemCapability.Ability.AbilityRuntime.Core
174   * @stagemodelonly
175   * @crossplatform
176   * @atomicservice
177   * @since 11
178   */
179  export type BaseContext = _BaseContext.default;
180
181  /**
182   * The base context of an ability or an application. It allows access to
183   * application-specific resources.
184   *
185   * @syscap SystemCapability.Ability.AbilityRuntime.Core
186   * @stagemodelonly
187   * @since 9
188   */
189  /**
190   * The base context of an ability or an application. It allows access to
191   * application-specific resources.
192   *
193   * @syscap SystemCapability.Ability.AbilityRuntime.Core
194   * @stagemodelonly
195   * @crossplatform
196   * @since 10
197   */
198  /**
199   * The base context of an ability or an application. It allows access to
200   * application-specific resources.
201   *
202   * @typedef { _Context.default }
203   * @syscap SystemCapability.Ability.AbilityRuntime.Core
204   * @stagemodelonly
205   * @crossplatform
206   * @atomicservice
207   * @since 11
208   */
209  export type Context = _Context.default;
210
211  /**
212   * The context of an extension. It allows access to extension-specific resources.
213   *
214   * @syscap SystemCapability.Ability.AbilityRuntime.Core
215   * @stagemodelonly
216   * @since 9
217   */
218  /**
219   * The context of an extension. It allows access to extension-specific resources.
220   *
221   * @typedef { _ExtensionContext.default }
222   * @syscap SystemCapability.Ability.AbilityRuntime.Core
223   * @stagemodelonly
224   * @atomicservice
225   * @since 11
226   */
227  export type ExtensionContext = _ExtensionContext.default;
228
229  /**
230   * The context of form extension. It allows access to
231   * formExtension-specific resources.
232   *
233   * @syscap SystemCapability.Ability.AbilityRuntime.Core
234   * @stagemodelonly
235   * @since 9
236   */
237  /**
238   * The context of form extension. It allows access to
239   * formExtension-specific resources.
240   *
241   * @typedef { _FormExtensionContext.default }
242   * @syscap SystemCapability.Ability.AbilityRuntime.Core
243   * @stagemodelonly
244   * @atomicservice
245   * @since 11
246   */
247  export type FormExtensionContext = _FormExtensionContext.default;
248
249  /**
250   * The context of service extension. It allows access to
251   * serviceExtension-specific resources.
252   *
253   * @typedef { _ServiceExtensionContext.default }
254   * @syscap SystemCapability.Ability.AbilityRuntime.Core
255   * @systemapi
256   * @stagemodelonly
257   * @since 9
258   */
259  export type ServiceExtensionContext = _ServiceExtensionContext.default;
260
261  /**
262   * The event center of a context, support the subscription and publication of events.
263   *
264   * @syscap SystemCapability.Ability.AbilityRuntime.Core
265   * @stagemodelonly
266   * @since 9
267   */
268  /**
269   * The event center of a context, support the subscription and publication of events.
270   *
271   * @syscap SystemCapability.Ability.AbilityRuntime.Core
272   * @stagemodelonly
273   * @atomicservice
274   * @since 11
275   */
276  /**
277   * The event center of a context, support the subscription and publication of events.
278   *
279   * @typedef { _EventHub.default }
280   * @syscap SystemCapability.Ability.AbilityRuntime.Core
281   * @stagemodelonly
282   * @crossplatform
283   * @atomicservice
284   * @since 12
285   */
286  export type EventHub = _EventHub.default;
287
288  /**
289   * Defines a PacMap object for storing a series of values.
290   *
291   * @syscap SystemCapability.Ability.AbilityRuntime.Core
292   * @stagemodelonly
293   * @since 9
294   */
295  /**
296   * Defines a PacMap object for storing a series of values.
297   *
298   * @typedef { _PacMap }
299   * @syscap SystemCapability.Ability.AbilityRuntime.Core
300   * @atomicservice
301   * @since 11
302   */
303  export type PacMap = _PacMap;
304
305  /**
306   * Indicates the result of startAbility.
307   *
308   * @syscap SystemCapability.Ability.AbilityRuntime.Core
309   * @stagemodelonly
310   * @since 9
311   */
312  /**
313   * Indicates the result of startAbility.
314   *
315   * @typedef { _AbilityResult }
316   * @syscap SystemCapability.Ability.AbilityRuntime.Core
317   * @stagemodelonly
318   * @atomicservice
319   * @since 11
320   */
321  export type AbilityResult = _AbilityResult;
322
323  /**
324   * Indicates the callback of connection
325   *
326   * @typedef { _ConnectOptions }
327   * @syscap SystemCapability.Ability.AbilityRuntime.Core
328   * @stagemodelonly
329   * @since 9
330   */
331  export type ConnectOptions = _ConnectOptions;
332
333  /**
334   * The context of UI extension. It allows access to
335   * UIExtension-specific resources.
336   *
337   * @typedef { _UIExtensionContext.default }
338   * @syscap SystemCapability.Ability.AbilityRuntime.Core
339   * @stagemodelonly
340   * @since 10
341   */
342  export type UIExtensionContext = _UIExtensionContext.default;
343
344  /**
345   * The context of auto fill extension. It allows access to
346   * AutoFillExtension-specific resources.
347   *
348   * @typedef { _AutoFillExtensionContext.default }
349   * @syscap SystemCapability.Ability.AbilityRuntime.Core
350   * @systemapi
351   * @stagemodelonly
352   * @since 11
353   */
354  export type AutoFillExtensionContext = _AutoFillExtensionContext.default;
355
356  /**
357   * The function Called when some error occurred except disconnected from UIAbility or UIExtensionAbility
358   *
359   * @typedef { _AbilityStartCallback }
360   * @syscap SystemCapability.Ability.AbilityRuntime.Core
361   * @stagemodelonly
362   * @atomicservice
363   * @since 11
364   */
365  export type AbilityStartCallback = _AbilityStartCallback;
366
367  /**
368   * The class of auto startup info.
369   *
370   * @typedef { _AutoStartupInfo }
371   * @syscap SystemCapability.Ability.AbilityRuntime.Core
372   * @systemapi
373   * @stagemodelonly
374   * @since 11
375   */
376  export type AutoStartupInfo = _AutoStartupInfo;
377
378  /**
379   * The class of auto startup callback.
380   *
381   * @typedef { _AutoStartupCallback }
382   * @syscap SystemCapability.Ability.AbilityRuntime.Core
383   * @systemapi
384   * @stagemodelonly
385   * @since 11
386   */
387  export type AutoStartupCallback = _AutoStartupCallback;
388
389  /**
390   * The context of vpn extension. It allows access to
391   * vpnExtension-specific resources.
392   * The class of auto startup info.
393   *
394   * @typedef { _VpnExtensionContext.default }
395   * @syscap SystemCapability.Ability.AbilityRuntime.Core
396   * @stagemodelonly
397   * @since 11
398   */
399  export type VpnExtensionContext = _VpnExtensionContext.default;
400
401  /**
402   * The context of an embeddable UIAbility.
403   *
404   * @typedef { _EmbeddableUIAbilityContext.default }
405   * @syscap SystemCapability.Ability.AbilityRuntime.Core
406   * @stagemodelonly
407   * @atomicservice
408   * @since 12
409   */
410  export type EmbeddableUIAbilityContext = _EmbeddableUIAbilityContext.default;
411
412  /**
413   * The context of an photo editor extension ability.
414   *
415   * @typedef { _PhotoEditorExtensionContext.default }
416   * @syscap SystemCapability.Ability.AppExtension.PhotoEditorExtension
417   * @stagemodelonly
418   * @since 12
419   */
420    export type PhotoEditorExtensionContext = _PhotoEditorExtensionContext.default;
421
422  /**
423   * The context of a UI service ability.
424   *
425   * @typedef { _UIServiceExtensionContext.default }
426   * @syscap SystemCapability.Ability.AbilityRuntime.Core
427   * @systemapi
428   * @stagemodelonly
429   * @since 14
430   */
431  export type UIServiceExtensionContext = _UIServiceExtensionContext.default;
432
433  /**
434   * The UI service proxy.
435   *
436   * @typedef { _UIServiceProxy.default }
437   * @syscap SystemCapability.Ability.AbilityRuntime.Core
438   * @stagemodelonly
439   * @atomicservice
440   * @since 14
441   */
442  export type UIServiceProxy = _UIServiceProxy.default;
443
444  /**
445   * The UI service host proxy.
446   *
447   * @typedef { _UIServiceHostProxy.default }
448   * @syscap SystemCapability.Ability.AbilityRuntime.Core
449   * @systemapi
450   * @stagemodelonly
451   * @since 14
452   */
453  export type UIServiceHostProxy = _UIServiceHostProxy.default;
454
455  /**
456   * The UI service extension connect callback.
457   *
458   * @typedef { _UIServiceExtensionConnectCallback.default }
459   * @syscap SystemCapability.Ability.AbilityRuntime.Core
460   * @stagemodelonly
461   * @atomicservice
462   * @since 14
463   */
464  export type UIServiceExtensionConnectCallback = _UIServiceExtensionConnectCallback.default;
465}
466
467export default common;
468