harmony(鸿蒙)@ohos.bundle.distributedBundle (distributedBundle模块)

2022-10-28
浏览 (405)

@ohos.bundle.distributedBundle (distributedBundle模块)

本模块提供分布式包的管理能力

说明：

本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

本模块接口为系统接口。

导入模块

import distributedBundle from '@ohos.bundle.distributedBundle';

系统能力

SystemCapability.BundleManager.DistributedBundleFramework

权限列表

权限	权限等级	说明
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED	system_basic	可查询所有应用信息。

权限等级参考权限等级说明。

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback<RemoteAbilityInfo>): void;

以异步方法根据给定的ElementName获取有关远程设备AbilityInfo信息。使用callback异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementName	ElementName	是	ElementName信息。
callback	AsyncCallback<RemoteAbilityInfo>	是	回调函数，操作成功返回err为null，data为RemoteAbilityInfo对象；否则为错误对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        {
            deviceId: '1',
            bundleName: 'com.example.application',
            abilityName: 'MainAbility'
        }, (err, data) => {
          if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
          } else {
            console.info('Operation succeed:' + JSON.stringify(data));
          }
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementName: ElementName): Promise<RemoteAbilityInfo>;

以异步方法根据给定的ElementName获取有关远程设备AbilityInfo信息。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementName	ElementName	是	ElementName信息。

返回值：

类型	说明
Promise<RemoteAbilityInfo>	Promise对象，返回RemoteAbilityInfo对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        {
            deviceId: '1',
            bundleName: 'com.example.application',
            abilityName: 'MainAbility'
        }).then(data => {
            console.info('Operation succeed:' + JSON.stringify(data));
        }).catch(err => {
            console.error('Operation failed:' + JSON.stringify(err));
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementNames: Array<ElementName>, callback: AsyncCallback<Array<RemoteAbilityInfo>>): void;

以异步方法根据给定的ElementName获取有关远程设备AbilityInfo数组信息。使用callback异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementNames	Array<ElementName>	是	ElementName信息,最大数组长度为10。
callback	AsyncCallback<Array<RemoteAbilityInfo>>	是	回调函数，调用成功返回err为null，data为RemoteAbilityInfo数组对象；否则返回错误对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        [
            {
                deviceId: '1',
                bundleName: 'com.example.application1',
                abilityName: 'MainAbility1'
            },
            {
                deviceId: '1',
                bundleName: 'com.example.application2',
                abilityName: 'MainAbility'
            }
        ], (err, data) => {
          if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
          } else {
            console.info('Operation succeed:' + JSON.stringify(data));
          }
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementNames: Array<ElementName>): Promise<Array<RemoteAbilityInfo>>;

以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo数组信息。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementNames	Array<ElementName>	是	ElementName信息，最大数组长度为10。

返回值：

类型	说明
Promise<Array<RemoteAbilityInfo>>	Promise对象，返回RemoteAbilityInfo数组对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        [
            {
                deviceId: '1',
                bundleName: 'com.example.application',
                abilityName: 'MainAbility'
            },
            {
                deviceId: '1',
                bundleName: 'com.example.application2',
                abilityName: 'MainAbility'
            }
        ]).then(data => {
            console.info('Operation succeed:' + JSON.stringify(data));
        }).catch(err => {
            console.error('Operation failed:' + JSON.stringify(err));
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementName: ElementName, locale: string, callback: AsyncCallback<RemoteAbilityInfo>): void;

以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo信息。使用callback异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementName	ElementName	是	ElementName信息。
locale	string	是	语言地区。
callback	AsyncCallback<RemoteAbilityInfo>	是	回调函数，操作成功返回err为null，data为RemoteAbilityInfo对象；否则为错误对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        {
            deviceId: '1',
            bundleName: 'com.example.application',
            abilityName: 'MainAbility'
        }, 'zh-Hans-CN', (err, data) => {
          if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
          } else {
            console.info('Operation succeed:' + JSON.stringify(data));
          }
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementName: ElementName, locale: string): Promise<RemoteAbilityInfo>;

以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo信息。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementName	ElementName	是	ElementName信息。
locale	string	是	语言地区。

返回值：

类型	说明
Promise<RemoteAbilityInfo>	Promise对象，返回RemoteAbilityInfo对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        {
            deviceId: '1',
            bundleName: 'com.example.application',
            abilityName: 'MainAbility'
        }, 'zh-Hans-CN').then(data => {
            console.info('Operation succeed:' + JSON.stringify(data));
        }).catch(err => {
            console.error('Operation failed:' + JSON.stringify(err));
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementNames: Array<ElementName>, locale: string, callback: AsyncCallback<Array<RemoteAbilityInfo>>): void;

以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo数组信息。使用callback异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementNames	Array<ElementName>	是	ElementName信息,最大数组长度为10。
locale	string	是	语言地区。
callback	AsyncCallback<Array<RemoteAbilityInfo>>	是	回调函数，调用成功返回err为null，data为RemoteAbilityInfo数组对象；否则返回错误对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        [
            {
                deviceId: '1',
                bundleName: 'com.example.application1',
                abilityName: 'MainAbility1'
            },
            {
                deviceId: '1',
                bundleName: 'com.example.application2',
                abilityName: 'MainAbility'
            }
        ], 'zh-Hans-CN', (err, data) => {
          if (err) {
            console.error('Operation failed:' + JSON.stringify(err));
          } else {
            console.info('Operation succeed:' + JSON.stringify(data));
          }
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}

distributedBundle.getRemoteAbilityInfo

getRemoteAbilityInfo(elementNames: Array<ElementName>, locale: string): Promise<Array<RemoteAbilityInfo>>;

以异步方法根据给定的ElementName和locale获取有关远程设备AbilityInfo数组信息。使用Promise异步回调。

系统接口： 此接口为系统接口。

需要权限： ohos.permission.GET_BUNDLE_INFO_PRIVILEGED

系统能力： SystemCapability.BundleManager.DistributedBundleFramework

参数：

参数名	类型	必填	说明
elementNames	Array<ElementName>	是	ElementName信息,最大数组长度为10。
locale	string	是	语言地区。

返回值：

类型	说明
Promise<Array<RemoteAbilityInfo>>	Promise对象，返回RemoteAbilityInfo数组对象。

错误码：

以下错误码的详细介绍请参见ohos.bundle错误码。

错误码ID	错误信息
17700001	The specified bundle name is not found.
17700003	The specified ability name is not found.
17700007	The specified device ID is not found.
17700027	The distributed service is not running.

示例：

try {
    distributedBundle.getRemoteAbilityInfo(
        [
            {
                deviceId: '1',
                bundleName: 'com.example.application',
                abilityName: 'MainAbility'
            },
            {
                deviceId: '1',
                bundleName: 'com.example.application2',
                abilityName: 'MainAbility'
            }
        ], 'zh-Hans-CN').then(data => {
            console.info('Operation succeed:' + JSON.stringify(data));
        }).catch(err => {
            console.error('Operation failed:' + JSON.stringify(err));
        });
} catch (err) {
    console.error('Operation failed:' + JSON.stringify(err));
}