interface_sdk-js/api/ability/startAbilityParameter.d.ts
wangkailong 6e7285be19 abilityKit
Signed-off-by: wangkailong <wangkailong6@huawei.com>
Change-Id: I3ab630fca0b9bc77b0dadce1a27cda24fd68a753
2024-03-09 16:29:07 +08:00

62 lines
1.7 KiB
TypeScript

/*
* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import Want from '../@ohos.app.ability.Want';
/**
* Define startup Ability parameters, which can be used as input parameters.
*
* @typedef StartAbilityParameter
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @since 6
*/
export interface StartAbilityParameter {
/**
* Indicates the Want containing information about the target ability to start.
*
* @type { Want }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 6
*/
want: Want;
/**
* Indicates the special start setting used in starting ability.
*
* @type { ?object }
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 6
*/
abilityStartSetting?: { [key: string]: any };
/**
* Indicates the special start setting used in starting ability.
* The ability of this property is same as abilityStartSetting. If both are set, this property will be used.
*
* @type { ?Record<string, Object>}
* @syscap SystemCapability.Ability.AbilityRuntime.FAModel
* @FAModelOnly
* @since 11
*/
abilityStartSettings?: Record<string, Object>;
}