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