interface_sdk-js/api/bundleManager/PluginBundleInfo.d.ts
liumingyue 5669ac0762 新增插件查询接口
Signed-off-by: liumingyue <liumingyue12@huawei.com>
2025-03-19 16:00:56 +08:00

160 lines
3.5 KiB
TypeScript

/*
* Copyright (c) 2025 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
*/
/**
* Provides information about a plugin.
*
* @typedef PluginBundleInfo
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
export interface PluginBundleInfo {
/**
* Indicates the label of the plugin
*
* @type { string }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly label: string;
/**
* Indicates the label id of the plugin
*
* @type { number }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly labelId: number;
/**
* Indicates the icon of the plugin
*
* @type { string }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly icon: string;
/**
* Indicates the icon id of the plugin
*
* @type { number }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly iconId: number;
/**
* Indicates the name of the plugin
*
* @type { string }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly pluginBundleName: string;
/**
* Indicates the version code of the plugin
*
* @type { number }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly versionCode: number;
/**
* Indicates the version name of the plugin
*
* @type { string }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly versionName: string;
/**
* Indicates the information about the plugin module
*
* @type { Array<PluginModuleInfo> }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly pluginModuleInfos: Array<PluginModuleInfo>;
}
/**
* Indicates the plugin module info.
*
* @typedef PluginModuleInfo
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
export interface PluginModuleInfo {
/**
* Indicates the moduleName of the plugin
*
* @type { string }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly moduleName: string;
/**
* Indicates the description of the plugin
*
* @type { number }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly descriptionId: number;
/**
* Describes the plugin
*
* @type { string }
* @readonly
* @syscap SystemCapability.BundleManager.BundleFramework.Core
* @systemapi
* @since 18
*/
readonly description: string;
}