提交 a9400c5b 编写于 作者: S shilei

modify docs

Signed-off-by: Nshilei <shilei91@huawei.com>
上级 874641d5
...@@ -6,8 +6,6 @@ ...@@ -6,8 +6,6 @@
> >
> 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 10开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
本模块接口为系统接口。
## 导入模块 ## 导入模块
``` ts ``` ts
...@@ -41,8 +39,8 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean): Promise\<void>; ...@@ -41,8 +39,8 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean): Promise\<void>;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -76,7 +74,7 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean, callback: AsyncCallback ...@@ -76,7 +74,7 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean, callback: AsyncCallback
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| moduleName | string | 是 | overlay特征module的HAP名称。 | | moduleName | string | 是 | overlay特征module的HAP名称。 |
| isEnabled | boolean | 是 | 值为true表示使能,值为false表示禁用。| | isEnabled | boolean | 是 | 值为true表示使能,值为false表示禁用。|
| callback | AsyncCallback\<void> | 是 | 回调函数,当设置处置状态成功,err为undefined,否则为错误对象。 | | callback | AsyncCallback\<void> | 是 | 回调函数,当设置指定module的overlay禁用使能状态成功时,err为undefined,否则为错误对象。 |
**错误码:** **错误码:**
...@@ -84,8 +82,8 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean, callback: AsyncCallback ...@@ -84,8 +82,8 @@ setOverlayEnabled(moduleName:string, isEnabled: boolean, callback: AsyncCallback
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -139,9 +137,9 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b ...@@ -139,9 +137,9 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found. | | 17700001 | The specified bundleName is not found. |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700032 | The specified bundleName does not contain any overlay module. | | 17700032 | The specified bundle does not contain any overlay module. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -181,7 +179,7 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b ...@@ -181,7 +179,7 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b
| bundleName | string | 是 | 指定应用的bundle名称。 | | bundleName | string | 是 | 指定应用的bundle名称。 |
| moduleName | string | 是 | 指定应用的overlay特征module的HAP名称。 | | moduleName | string | 是 | 指定应用的overlay特征module的HAP名称。 |
| isEnabled | boolean | 是 | 值为true表示使能,值为false表示禁用。 | | isEnabled | boolean | 是 | 值为true表示使能,值为false表示禁用。 |
| callback | AsyncCallback\<Want> | 是 | 回调函数。当获取应用的处置状态成功时,err为undefined,data为获取到的处置状态;否则为错误对象。 | | callback | AsyncCallback\<void> | 是 | 回调函数。当设置指定应用的overlay module的禁用使能状态成功时,err为undefined,data为获取到的处置状态;否则为错误对象。 |
**错误码:** **错误码:**
...@@ -190,9 +188,9 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b ...@@ -190,9 +188,9 @@ setOverlayEnabledByBundleName(bundleName:string, moduleName:string, isEnabled: b
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found. | | 17700001 | The specified bundleName is not found. |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700032 | The specified bundleName does not contain any overlay module. | | 17700032 | The specified bundle does not contain any overlay module. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -232,7 +230,7 @@ getOverlayModuleInfo(moduleName: string): Promise\<OverlayModuleInfo>; ...@@ -232,7 +230,7 @@ getOverlayModuleInfo(moduleName: string): Promise\<OverlayModuleInfo>;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<OverlayModuleInfo> | Promise对象,无返回结果的Promise对象 | | Promise\<OverlayModuleInfo> | Promise对象,返回OverlayModuleInfo|
**错误码:** **错误码:**
...@@ -240,8 +238,8 @@ getOverlayModuleInfo(moduleName: string): Promise\<OverlayModuleInfo>; ...@@ -240,8 +238,8 @@ getOverlayModuleInfo(moduleName: string): Promise\<OverlayModuleInfo>;
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -271,7 +269,7 @@ getOverlayModuleInfo(moduleName: string, callback: AsyncCallback\<OverlayModuleI ...@@ -271,7 +269,7 @@ getOverlayModuleInfo(moduleName: string, callback: AsyncCallback\<OverlayModuleI
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| moduleName | string | 是 | 指定当前应用中的overlay特征module的HAP名称。 | | moduleName | string | 是 | 指定当前应用中的overlay特征module的HAP名称。 |
| callback | AsyncCallback\<OverlayModuleInfo> | 是 | 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。 | | callback | AsyncCallback\<OverlayModuleInfo> | 是 | 回调函数,当获取当前应用中指定的module的overlayModuleInfo信息成功时,err返回undefined。否则回调函数返回具体错误对象。 |
**错误码:** **错误码:**
...@@ -279,8 +277,8 @@ getOverlayModuleInfo(moduleName: string, callback: AsyncCallback\<OverlayModuleI ...@@ -279,8 +277,8 @@ getOverlayModuleInfo(moduleName: string, callback: AsyncCallback\<OverlayModuleI
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -317,7 +315,7 @@ getTargetOverlayModuleInfos(targetModuleName: string): Promise\<Array\<OverlayMo ...@@ -317,7 +315,7 @@ getTargetOverlayModuleInfos(targetModuleName: string): Promise\<Array\<OverlayMo
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<Array\<OverlayModuleInfo>> | Promise对象,无返回结果的Promise对象 | | Promise\<Array\<OverlayModuleInfo>> | Promise对象,返回\<Array\<OverlayModuleInfo>> |
**错误码:** **错误码:**
...@@ -325,8 +323,8 @@ getTargetOverlayModuleInfos(targetModuleName: string): Promise\<Array\<OverlayMo ...@@ -325,8 +323,8 @@ getTargetOverlayModuleInfos(targetModuleName: string): Promise\<Array\<OverlayMo
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700034 | The specified moduleName is overlay module. | | 17700034 | The specified module is an overlay module. |
**示例:** **示例:**
...@@ -356,7 +354,7 @@ getTargetOverlayModuleInfos(targetModuleName: string, callback: AsyncCallback\<A ...@@ -356,7 +354,7 @@ getTargetOverlayModuleInfos(targetModuleName: string, callback: AsyncCallback\<A
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| targetModuleName | string | 是 | 指定当前应用中的目标module的HAP名称。 | | targetModuleName | string | 是 | 指定当前应用中的目标module的HAP名称。 |
| callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。 | | callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当获取指定的目标module的OverlayModuleInfo成功时,err返回undefined。否则回调函数返回具体错误对象。 |
**错误码:** **错误码:**
...@@ -364,8 +362,8 @@ getTargetOverlayModuleInfos(targetModuleName: string, callback: AsyncCallback\<A ...@@ -364,8 +362,8 @@ getTargetOverlayModuleInfos(targetModuleName: string, callback: AsyncCallback\<A
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700034 | The specified moduleName is overlay module. | | 17700034 | The specified module is an overlay module. |
**示例:** **示例:**
...@@ -407,7 +405,7 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName?: string): Promi ...@@ -407,7 +405,7 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName?: string): Promi
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<Array\<OverlayModuleInfo>> | Promise对象,无返回结果的Promise对象 | | Promise\<Array\<OverlayModuleInfo>> | Promise对象,返回\<Array\<OverlayModuleInfo> |
**错误码:** **错误码:**
...@@ -416,9 +414,9 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName?: string): Promi ...@@ -416,9 +414,9 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName?: string): Promi
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found | | 17700001 | The specified bundleName is not found |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700032 | The specified bundleName does not contain any overlay module. | | 17700032 | The specified bundle does not contain any overlay module. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -454,7 +452,7 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName: string, callbac ...@@ -454,7 +452,7 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName: string, callbac
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| bundleName | string | 是 | 指定应用的bundle名称。 | | bundleName | string | 是 | 指定应用的bundle名称。 |
| moduleName | string | 是 | 指定应用中的overlay module的HAP名称。缺省该字段时,查询接口将查询指定应用中所有module的OverlayModuleInfo信息。 | | moduleName | string | 是 | 指定应用中的overlay module的HAP名称。缺省该字段时,查询接口将查询指定应用中所有module的OverlayModuleInfo信息。 |
| callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。 | | callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当获取指定应用中指定module的OverlayModuleInfo信息成功时,err返回undefined。否则回调函数返回具体错误对象。 |
**错误码:** **错误码:**
...@@ -463,9 +461,9 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName: string, callbac ...@@ -463,9 +461,9 @@ getOverlayModuleInfoByBundleName(bundleName: string, moduleName: string, callbac
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found | | 17700001 | The specified bundleName is not found |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700032 | The specified bundleName does not contain any overlay module. | | 17700032 | The specified bundle does not contain any overlay module. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -503,7 +501,7 @@ getOverlayModuleInfoByBundleName(bundleName: string, callback: AsyncCallback\<Ar ...@@ -503,7 +501,7 @@ getOverlayModuleInfoByBundleName(bundleName: string, callback: AsyncCallback\<Ar
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| bundleName | string | 是 | 指定应用的bundle名称。 | | bundleName | string | 是 | 指定应用的bundle名称。 |
| callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。 | | callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当获取指定应用中所有module的OverlayModuleInfo信息成功时,err返回undefined。否则回调函数返回具体错误对象。 |
**错误码:** **错误码:**
...@@ -512,9 +510,9 @@ getOverlayModuleInfoByBundleName(bundleName: string, callback: AsyncCallback\<Ar ...@@ -512,9 +510,9 @@ getOverlayModuleInfoByBundleName(bundleName: string, callback: AsyncCallback\<Ar
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found | | 17700001 | The specified bundleName is not found |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700032 | The specified bundleName does not contain any overlay module. | | 17700032 | The specified bundle does not contain any overlay module. |
| 17700033 | The specified moduleName is not overlay module. | | 17700033 | The specified module is not an overlay module. |
**示例:** **示例:**
...@@ -557,7 +555,7 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName?: s ...@@ -557,7 +555,7 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName?: s
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<Array\<OverlayModuleInfo>> | Promise对象,无返回结果的Promise对象 | | Promise\<Array\<OverlayModuleInfo>> | Promise对象,返回\<Array\<OverlayModuleInfo>> |
**错误码:** **错误码:**
...@@ -566,9 +564,9 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName?: s ...@@ -566,9 +564,9 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName?: s
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found | | 17700001 | The specified bundleName is not found |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700034 | The specified moduleName is overlay module. | | 17700034 | The specified module is an overlay module. |
| 17700035 | The specified bundleName is overlay bundle. | | 17700035 | The specified bundle is an overlay bundle. |
**示例:** **示例:**
...@@ -604,7 +602,7 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName: st ...@@ -604,7 +602,7 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName: st
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| targetBundleName | string | 是 | 指定目标应用的bundle名称。 | | targetBundleName | string | 是 | 指定目标应用的bundle名称。 |
| moduleName | string | 否 | 指定应用中的目标module的HAP名称。缺省该字段时,查询接口将查询指定应用中所有module所关联的OverlayModuleInfo信息。 | | moduleName | string | 否 | 指定应用中的目标module的HAP名称。缺省该字段时,查询接口将查询指定应用中所有module所关联的OverlayModuleInfo信息。 |
| callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。 | | callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当获取指定应用中指定module关联的所有OverlayModuleInfo信息成功时,err返回undefined。否则回调函数返回具体错误对象。 |
**错误码:** **错误码:**
...@@ -613,9 +611,9 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName: st ...@@ -613,9 +611,9 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, moduleName: st
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found | | 17700001 | The specified bundleName is not found |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700034 | The specified moduleName is overlay module. | | 17700034 | The specified module is an overlay module. |
| 17700035 | The specified bundleName is overlay bundle. | | 17700035 | The specified bundle is an overlay bundle. |
**示例:** **示例:**
...@@ -653,7 +651,7 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, callback: Asyn ...@@ -653,7 +651,7 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, callback: Asyn
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| targetBundleName | string | 是 | 指定目标应用的bundle名称。 | | targetBundleName | string | 是 | 指定目标应用的bundle名称。 |
| callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当设置处置状态成功时,err返回undefined。否则回调函数返回具体错误对象。 | | callback | AsyncCallback\<Array\<OverlayModuleInfo>> | 是 | 回调函数,当获取指定应用中所有module关联的所有OverlayModuleInfo信息成功时,err返回undefined。否则回调函数返回具体错误对象。 |
**错误码:** **错误码:**
...@@ -662,9 +660,9 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, callback: Asyn ...@@ -662,9 +660,9 @@ getTargetOverlayModuleInfosByBundleName(targetBundleName: string, callback: Asyn
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------ | -------------------------------------- | | ------ | -------------------------------------- |
| 17700001 | The specified bundleName is not found | | 17700001 | The specified bundleName is not found |
| 17700002 | The specified moduleName is not existed. | | 17700002 | The specified module name is not found. |
| 17700034 | The specified moduleName is overlay module. | | 17700034 | The specified module is an overlay module. |
| 17700035 | The specified bundleName is overlay bundle. | | 17700035 | The specified bundle is an overlay bundle. |
**示例:** **示例:**
......
...@@ -425,7 +425,7 @@ The specified bundle does not contain any overlay module. ...@@ -425,7 +425,7 @@ The specified bundle does not contain any overlay module.
## 17700033 指定的module不是overlay特征的module ## 17700033 指定的module不是overlay特征的module
**错误信息**<br/> **错误信息**<br/>
The specified module is not overlay module. The specified module is not an overlay module.
**错误描述**<br/> **错误描述**<br/>
查询指定的overlay特征module的overlayModuleInfo时, 指定的module不是overlay特征module。 查询指定的overlay特征module的overlayModuleInfo时, 指定的module不是overlay特征module。
...@@ -439,7 +439,7 @@ The specified module is not overlay module. ...@@ -439,7 +439,7 @@ The specified module is not overlay module.
## 17700034 指定的module是overlay特征的module ## 17700034 指定的module是overlay特征的module
**错误信息**<br/> **错误信息**<br/>
The specified module is overlay module. The specified module is an overlay module.
**错误描述**<br/> **错误描述**<br/>
查询指定的目标module所关联的overlayModuleInfo时, 指定的module是overlay特征module。 查询指定的目标module所关联的overlayModuleInfo时, 指定的module是overlay特征module。
...@@ -453,7 +453,7 @@ The specified module is overlay module. ...@@ -453,7 +453,7 @@ The specified module is overlay module.
## 17700035 指定的应用只包含overlay特征的module ## 17700035 指定的应用只包含overlay特征的module
**错误信息**<br/> **错误信息**<br/>
The specified bundle is overlay bundle. The specified bundle is an overlay bundle.
**错误描述**<br/> **错误描述**<br/>
查询指定应用的目标module所关联的overlayModuleInfo时, 指定的应用只包含overlay特征的module。 查询指定应用的目标module所关联的overlayModuleInfo时, 指定的应用只包含overlay特征的module。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册