• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-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 Want from '../@ohos.app.ability.Want';
17
18/**
19 * Define startup Ability parameters, which can be used as input parameters.
20 *
21 * @typedef StartAbilityParameter
22 * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
23 * @since 6
24 */
25export interface StartAbilityParameter {
26  /**
27   * Indicates the Want containing information about the target ability to start.
28   *
29   * @type { Want }
30   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
31   * @FAModelOnly
32   * @since 6
33   */
34  want: Want;
35
36  /**
37   * Indicates the special start setting used in starting ability.
38   *
39   * @type { ?object }
40   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
41   * @FAModelOnly
42   * @since 6
43   */
44  abilityStartSetting?: { [key: string]: any };
45
46  /**
47   * Indicates the special start setting used in starting ability.
48   * The ability of this property is same as abilityStartSetting. If both are set, this property will be used.
49   *
50   * @type { ?Record<string, Object>}
51   * @syscap SystemCapability.Ability.AbilityRuntime.FAModel
52   * @FAModelOnly
53   * @since 11
54   */
55  abilityStartSettings?: Record<string, Object>;
56}
57