• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2022-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 { DataAbilityHelper as _DataAbilityHelper } from './ability/dataAbilityHelper';
22import { PacMap as _PacMap } from './ability/dataAbilityHelper';
23import { DataAbilityOperation as _DataAbilityOperation } from './ability/dataAbilityOperation';
24import { DataAbilityResult as _DataAbilityResult } from './ability/dataAbilityResult';
25import { AbilityResult as _AbilityResult } from './ability/abilityResult';
26import { ConnectOptions as _ConnectOptions } from './ability/connectOptions';
27import { StartAbilityParameter as _StartAbilityParameter } from './ability/startAbilityParameter';
28
29/**
30 * The class of an ability.
31 *
32 * @namespace ability
33 * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
34 * @FAModelOnly
35 * @since 9
36 */
37/**
38 * The class of an ability.
39 *
40 * @namespace ability
41 * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
42 * @since 11
43 */
44declare namespace ability {
45  /**
46   * DataAbilityHelper
47   *
48   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
49   * @FAModelOnly
50   * @since 9
51   */
52  export type DataAbilityHelper = _DataAbilityHelper;
53
54  /**
55   * Defines a PacMap object for storing a series of values.
56   *
57   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
58   * @FAModelOnly
59   * @since 9
60   */
61  /**
62   * Defines a PacMap object for storing a series of values.
63   *
64   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
65   * @since 11
66   */
67  export type PacMap = _PacMap;
68
69  /**
70   * DataAbilityOperation secondary module.Define the DataAbility data operation method,
71   * which can be used as an input parameter for [executeBatch] to manipulate database information.
72   *
73   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
74   * @FAModelOnly
75   * @since 9
76   */
77  export type DataAbilityOperation = _DataAbilityOperation;
78
79  /**
80   * DataAbilityResult secondary module.Define the DataAbility data operation result.
81   * When operating the database through [executeBatch], the operation result is returned
82   * using the DataAbility Result object.
83   *
84   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
85   * @FAModelOnly
86   * @since 9
87   */
88  export type DataAbilityResult = _DataAbilityResult;
89
90  /**
91   * AbilityResult secondary module.The result code and data returned after the ability is pulled
92   * up and exited can be defined. The ability result object returned after the ability is pulled
93   * up and exited can be obtained through [startAbilityForResult], and the ability object pulled up
94   * by startAbilityForResult can be returned through [terminateSelfWithResult].
95   *
96   * @syscap SystemCapability.Ability.AbilityBase
97   * @FAModelOnly
98   * @since 9
99   */
100  export type AbilityResult = _AbilityResult;
101
102  /**
103   * ConnectOptions secondary module.As an input parameter when connecting to a specified backend service,
104   * used to receive state changes during the connection process
105   *
106   * @syscap SystemCapability.Ability.AbilityRuntime.Core
107   * @FAModelOnly
108   * @since 9
109   */
110  export type ConnectOptions = _ConnectOptions;
111
112  /**
113   * StartAbilityParameter secondary module.Define the Start Ability parameter, which can be used as
114   * an input parameter to call [startAbility] to start the specified Ability.
115   *
116   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
117   * @FAModelOnly
118   * @since 9
119   */
120  export type StartAbilityParameter = _StartAbilityParameter;
121}
122
123export default ability;
124