!10524 包管理-分布式distributedBundle接口资料

Merge pull request !10524 from wangtiantian/distributed

!10524 包管理-分布式distributedBundle接口资料
Merge pull request !10524 from wangtiantian/distributed
b97f31e6 · openharmony_ci · Gitee · 3002445a · f8c59fc7 · b97f31e6
7 changed file
--- a/zh-cn/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-Bundle-distributedBundle.md
@@ -24,7 +24,9 @@ SystemCapability.BundleManager.DistributedBundleFramework

 权限等级参考[权限等级说明](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/security/accesstoken-overview.md#%E6%9D%83%E9%99%90%E7%AD%89%E7%BA%A7%E8%AF%B4%E6%98%8E)

-## distributedBundle.getRemoteAbilityInfo
+## distributedBundle.getRemoteAbilityInfo<sup>deprecated<sup>
+
+> 从API version 9开始不再维护，建议使用[getRemoteAbilityInfo](js-apis-distributedBundle.md)替代。

 getRemoteAbilityInfo(elementName: ElementName, callback: AsyncCallback&lt;RemoteAbilityInfo&gt;): void;

@@ -51,7 +53,9 @@ SystemCapability.BundleManager.DistributedBundleFramework



-## distributedBundle.getRemoteAbilityInfo
+## distributedBundle.getRemoteAbilityInfo<sup>deprecated<sup>
+
+> 从API version 9开始不再维护，建议使用[getRemoteAbilityInfo](js-apis-distributedBundle.md)替代。

 getRemoteAbilityInfo(elementName: ElementName): Promise&lt;RemoteAbilityInfo&gt;

@@ -81,7 +85,9 @@ SystemCapability.BundleManager.DistributedBundleFramework
 | ------------------------------------------------------------ | --------------------------------- |
 | Promise\<[RemoteAbilityInfo](js-apis-bundle-remoteAbilityInfo.md)> | Promise形式返回远程基本能力信息。 |

-## distributedBundle.getRemoteAbilityInfos
+## distributedBundle.getRemoteAbilityInfos<sup>deprecated<sup>
+
+> 从API version 9开始不再维护，建议使用[getRemoteAbilityInfo](js-apis-distributedBundle.md)替代。

 getRemoteAbilityInfos(elementNames: Array&lt;ElementName&gt;, callback: AsyncCallback&lt;Array&lt;RemoteAbilityInfo&gt;&gt;): void;

@@ -108,7 +114,9 @@ SystemCapability.BundleManager.DistributedBundleFramework



-## distributedBundle.getRemoteAbilityInfos
+## distributedBundle.getRemoteAbilityInfos<sup>deprecated<sup>
+
+> 从API version 9开始不再维护，建议使用[getRemoteAbilityInfo](js-apis-distributedBundle.md)替代。

 getRemoteAbilityInfos(elementNames: Array&lt;ElementName&gt;): Promise&lt;Array&lt;RemoteAbilityInfo&gt;&gt;


--- a/zh-cn/application-dev/reference/apis/js-apis-bundle-ElementName.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-ElementName.md
@@ -7,7 +7,9 @@

 ElementName信息，通过接口[Context.getElementName](js-apis-Context.md)获取。

-## ElementName
+## ElementName<sup>(deprecated)<sup>
+
+> 从API version 9开始不再维护，建议使用[ElementName](js-apis-bundleManager-elementName.md)替代。

 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework。


--- a/zh-cn/application-dev/reference/apis/js-apis-bundle-remoteAbilityInfo.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-bundle-remoteAbilityInfo.md
@@ -9,7 +9,10 @@

 包含基本远程能力信息

-## RemoteAbilityInfo
+## RemoteAbilityInfo<sup>(deprecated)<sup>
+
+> 从API version 9开始不再维护，建议使用[RemoteAbilityInfo](js-apis-bundleManager-remoteAbilityInfo.md)替代。
+

 **系统能力:** 以下各项对应的系统能力均为SystemCapability.BundleManager.DistributedBundleFramework


--- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-elementName.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-elementName.md
+# ElementName
+
+ElementName信息，通过接口[Context.getElementName](js-apis-Context.md)获取。
+
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+## ElementName
+
+ **系统能力:** SystemCapability.BundleManager.BundleFramework
+
+| 名称                     | 类型     | 可读 | 可写 | 说明                       |
+| ----------------------- | ---------| ---- | ---- | ------------------------- |
+| deviceId                | string   | 是   | 是   | 设备id。                   |
+| bundleName              | string   | 是   | 是   | 应用包名。                  |
+| abilityName             | string   | 是   | 是   | Ability名称。               |
+| uri                     | string   | 是   | 是   | 资源标识符。                 |
+| shortName               | string   | 是   | 是   | Ability短名称。               |
+| moduleName              | string   | 是   | 是   | Ability所属的HAP包的模块名称。   |
\ No newline at end of file
--- a/zh-cn/application-dev/reference/apis/js-apis-bundleManager-remoteAbilityInfo.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-bundleManager-remoteAbilityInfo.md
+# RemoteAbilityInfo
+
+包含远程的ability信息，通过接口[distributedBundle.getRemoteAbilityInfo](js-apis-distributedBundle.md)获取。
+
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
+
+本模块接口为系统接口。
+
+## RemoteAbilityInfo
+
+ **系统能力:** SystemCapability.BundleManager.DistributedBundleFramework
+
+ **系统接口：**  此接口为系统接口。
+
+| 名称        | 类型                                         | 可读 | 可写 | 说明                    |
+| ----------- | -------------------------------------------- | ---- | ---- | ----------------------- |
+| elementName | [ElementName](js-apis-bundleManager-elementName.md) | 是   | 否   | 指明远程ability的ElementName信息       |
+| label       | string                                       | 是   | 否   | 指明远程ability的标签信息   |
+| icon        | string                                       | 是   | 否   | 指明的远程ability的图标信息 |
--- a/zh-cn/application-dev/reference/apis/js-apis-distributedBundle.md
+++ b/zh-cn/application-dev/reference/apis/js-apis-distributedBundle.md
--- a/zh-cn/application-dev/reference/errorcodes/errcode-bundle.md
+++ b/zh-cn/application-dev/reference/errorcodes/errcode-bundle.md
+#  包管理子系统通用错误码
+
+## 17700001 指定的bundleName不存在
+
+**错误信息**<br/>
+The specified bundle name is not found.
+
+**错误描述**<br/>
+调用接口时，传入的bundleName不存在。
+
+**可能原因**<br/>
+1. 输入的bundleName有误。
+2. 系统中对应的应用没有安装。
+
+**处理步骤**<br/>
+1. 检查bundleName拼写是否正确。
+2. 确认对应的应用是否安装。
+
+## 17700002 指定的moduleName不存在
+
+**错误信息**<br/>
+The specified module name is not found.
+
+**错误描述**<br/>
+调用接口时，传入的moduleName不存在。
+
+**可能原因**<br/>
+1. 输入的moduleName有误。
+2. 系统中对应的应用没有安装该模块。
+
+**处理步骤**<br/>
+1. 检查bundleName拼写是否正确。
+2. 确认对应的应用是否安装该模块。
+
+## 17700003 指定的abilityName不存在
+
+**错误信息**<br/>
+The specified ability name is not found.
+
+**错误描述**<br/>
+调用接口时，传入的abilityName不存在。
+
+**可能原因**<br/>
+1. 输入的abilityName有误。
+2. 系统中对应的应用没有安装。
+
+**处理步骤**<br/>
+1. 检查abilityName拼写是否正确。
+2. 确认对应的应用是否安装该模块。
+
+## 17700004 指定的用户不存在
+
+**错误信息**<br/>
+The specified user id is not found.
+
+**错误描述**<br/>
+调用接口时，传入的用户不存在。
+
+**可能原因**<br/>
+输入的用户名有误，系统中没有该用户。
+
+**处理步骤**<br/>
+1. 检查用户名拼写是否正确。
+2. 确认系统中存在该用户。
+
+## 17700005 指定的appId不存在
+
+**错误信息**<br/>
+The specified appId is not found.
+
+**错误描述**<br/>
+调用接口时，传入的appId为空字符串。
+
+**可能原因**<br/>
+传入的appId为空字符串。
+
+**处理步骤**<br/>
+检查appId是否为空字符串。
+
+## 17700006 查询的权限不存在
+
+**错误信息**<br/>
+The specified permission is not found.
+
+**错误描述**<br/>
+调用接口时，传入的权限不存在。
+
+**可能原因**<br/>
+1. 传入的permission名称拼写有误。
+2. 系统中不存在对应的权限。
+
+**处理步骤**<br/>
+1. 检查permission拼写是否正确。
+2. 确认系统中是否有该权限。
+
+## 17700007 输入的设备Id有误
+
+**错误信息**<br/>
+The specified deviceId is not found.
+
+**错误描述**<br/>
+调用接口时，传入的设备id有误。
+
+**可能原因**<br/>
+1. 传入的deviceId拼写有误。
+2. deviceId不存在。
+
+**处理步骤**<br/>
+1. 检查deviceId拼写是否正确。
+2. 确认deviceId是否存在。
+
+## 17700010 文件解析失败导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the hap fails to be parsed.
+
+**错误描述**<br/>
+文件解析失败导致应用安装失败。
+
+**可能原因**<br/>
+1. hap包的格式不是zip格式。
+2. hap包的配置文件不满足json格式。
+3. hap包的配置文件缺少必要的字段。
+
+**处理步骤**<br/>
+1. 确认hap的格式是zip。
+2. 确认hap的配置文件满足[配置文件json格式](../../quick-start/stage-structure.md)。
+3. 检查DevEco Studio编译hap时是否有错误提示，缺省字段时会有相应的报错。
+
+## 17700011 签名校验失败失败导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the hap signature fails to be verified.
+
+**错误描述**<br/>
+签名校验失败失败导致应用安装失败。
+
+**可能原因**<br/>
+1. hap包没有签名。
+2. hap签名信息来源不可靠。
+3. 升级的hap包与已安装的hap包签名信息不一致。
+4. 多个hap的签名信息不一致。
+
+**处理步骤**<br/>
+1. 确认hap是否签名成功。
+2. 确认多个hap签名时使用的证书相同。
+3. 确认升级的hap签名证书与已安装的hap相同。
+
+## 17700012 安装包路径无效导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the path of the hap is invalid.
+
+**错误描述**<br/>
+安装包路径无效导致应用安装失败。
+
+**可能原因**<br/>
+1. 输入错误，hap包的文件路径不存在。
+2. hap包的路径无法访问。
+
+**处理步骤**<br/>
+1. 确认hap是否存在。
+2. 查看hap的可执行权限，是否可读。
+
+## 17700013 应用包过大导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the hap is too large.
+
+**错误描述**<br/>
+应用包过大导致应用安装失败。
+
+**可能原因**<br/>
+hap包过大，一个hap不能超过4GB。
+
+**处理步骤**<br/>
+确认hap包的大小。
+
+## 17700014 应用包后缀有误导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the extension name of the hap is not .hap.
+
+**错误描述**<br/>
+应用包后缀有误导致应用安装失败。
+
+**可能原因**<br/>
+hap包的文件后缀名不为.hap。
+
+**处理步骤**<br/>
+确认hap包的后缀是否为.hap。
+
+## 17700015 多个hap包配置信息不同导致应用安装失败
+
+**错误信息**<br/>
+Failed to install haps since the configuration information of multi haps is inconsistent.
+
+**错误描述**<br/>
+多个hap包配置信息不同导致应用安装失败。
+
+**可能原因**<br/>
+多个hap包中配置文件app下面的字段不一致。
+
+**处理步骤**<br/>
+确认多个hap包中配置文件app下面的字段是否一致。
+
+## 17700016 系统磁盘空间不足导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the system disk space is insufficient.
+
+**错误描述**<br/>
+系统磁盘空间不足导致应用安装失败。
+
+**可能原因**<br/>
+系统空间不足。
+
+**处理步骤**<br/>
+确认系统是否有足够的空间。
+
+## 17700017 新安装的应用版本号低于已安装的版本号导致应用安装失败
+
+**错误信息**<br/>
+Failed to install the hap since the version of the newly installed hap is too early.
+
+**错误描述**<br/>
+新安装的应用版本号低于已安装的版本号导致应用安装失败。
+
+**可能原因**<br/>
+新安装的应用版本号低于已安装的版本号。
+
+**处理步骤**<br/>
+确认新安装的应用版本号是否比已安装的同应用版本号高。
+
+## 17700020 预置应用无法卸载
+
+**错误信息**<br/>
+The preinstalled app cannot be uninstalled.
+
+**错误描述**<br/>
+预置应用无法卸载。
+
+**可能原因**<br/>
+1. 传入的bundleName拼写有误。
+2. 对应的预置应用无法卸载。
+
+**处理步骤**<br/>
+1. 确认bundleName是否拼写正确。
+1. 确认对应的预置应用是否可卸载。
+
+## 17700021 指定的uid无效
+
+**错误信息**<br/>
+The specified uid is invalid.
+
+**错误描述**<br/>
+指定的uid无效。
+
+**可能原因**<br/>
+1. 传入的uid拼写有误。
+2. 传入的uid在系统中不存在。
+
+**处理步骤**<br/>
+1. 检查uid的拼写。
+2. 检查系统中是否存在该uid。
+
+## 17700022 输入的待解析源文件无效
+
+**错误信息**<br/>
+The input source file is invalid.
+
+**错误描述**<br/>
+输入的待解析源文件无效。
+
+**可能原因**<br/>
+1. 待解析的源文件不存在。
+2. 待解析的源文件不符合zip格式。
+
+**处理步骤**<br/>
+1. 确认待解析的源文件是否存在。
+2. 确认待解析的源文件符合zip格式。
+
+## 17700023 指定的默认应用不存在
+
+**错误信息**<br/>
+The specified default app does not exist.
+
+**错误描述**<br/>
+指定的默认应用不存在。
+
+**可能原因**<br/>
+设备没有设置对应的默认应用。
+
+**处理步骤**<br/>
+确认设备是否设置了对应的默认应用。
+
+## 17700024 没有相应的配置文件
+
+**错误信息**<br/>
+Failed to get profile since no profile in the hap.
+
+**错误描述**<br/>
+没有相应的配置文件。
+
+**可能原因**<br/>
+1. 输入的metadata name在配置文件中不存在。
+2. 配置文件的内容不是json格式。
+
+**处理步骤**<br/>
+1. 确认要查询的ability或者extensionAbility中的metadata name是否存在。
+2. 确认指定查询的profile文件的内容是否为json格式。
+
+## 17700025 输入的type无效
+
+**错误信息**<br/>
+The specified type is invalid.
+
+**错误描述**<br/>
+输入的type无效。
+
+**可能原因**<br/>
+1. 输入的type拼写有误。
+2. 输入的type不存在。
+
+**处理步骤**<br/>
+确认输入的type是否拼写正确。
+
+## 17700026 指定应用被禁用
+
+**错误信息**<br/>
+The specified bundle is disabled.
+
+**错误描述**<br/>
+指定应用被禁用。
+
+**可能原因**<br/>
+设备上对应的应用已经被禁用，无法查询。
+
+**处理步骤**<br/>
+确认设备上对应的应用是否被禁用。
+
+## 17700027 分布式服务未启动
+
+**错误信息**<br/>
+The distributed service is not running.
+
+**错误描述**<br/>
+分布式服务未启动。
+
+**可能原因**<br/>
+设备未组网。
+
+**处理步骤**<br/>
+确认设备是否组网成功。
+## 17700028 输入的ability与type不匹配
+
+**错误信息**<br/>
+The distributed service is not running.
+
+**错误描述**<br/>
+输入的ability与type不匹配。
+
+**可能原因**<br/>
+输入的ability和type拼写有误。
+
+**处理步骤**<br/>
+确认输入的ability和type拼写是否正确。