wangkailong 6e7285be19 abilityKit
Signed-off-by: wangkailong <wangkailong6@huawei.com>
Change-Id: I3ab630fca0b9bc77b0dadce1a27cda24fd68a753
2024-03-09 16:29:07 +08:00

139 lines
3.3 KiB
TypeScript

/*
* Copyright (c) 2022 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
*/
/**
* Contains basic Ability information, which uniquely identifies an ability.
* You can use this class to obtain values of the fields set in an element,
* such as the device ID, bundle name, and ability name.
*
* @typedef ElementName
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* Contains basic Ability information, which uniquely identifies an ability.
* You can use this class to obtain values of the fields set in an element,
* such as the device ID, bundle name, and ability name.
*
* @typedef ElementName
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
export interface ElementName {
/**
* Indicates device id
*
* @type { ?string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* Indicates device id
*
* @type { ?string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
deviceId?: string;
/**
* @type { string }
* @default Indicates bundle name
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* @type { string }
* @default Indicates bundle name
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
bundleName: string;
/**
* @type { ?string }
* @default Indicates module name
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* @type { ?string }
* @default Indicates module name
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
moduleName?: string;
/**
* Indicates ability name
*
* @type { string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* Indicates ability name
*
* @type { string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
abilityName: string;
/**
* Indicates uri
*
* @type { ?string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* Indicates uri
*
* @type { ?string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
uri?: string;
/**
* Indicates short name
*
* @type { ?string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @since 9
*/
/**
* Indicates short name
*
* @type { ?string }
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @atomicservice
* @since 11
*/
shortName?: string;
}