提交 de1dd04d 编写于 作者: S SoftSquirrel

#I5ENEP: #I5E3WQ: add default application doc, system api.

Description: add default application doc, system api.
Sig: SIG_ApplicaitonFramework
Feature or Bugfix: Feature
Binary Source: No
Signed-off-by: NSoftSquirrel <xuhao47@huawei.com>
上级 d8104240
...@@ -95,7 +95,11 @@ defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err, ...@@ -95,7 +95,11 @@ defaultAppMgr.isDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, (err,
getDefaultApplication(type: string, userId?: number): Promise\<BundleInfo> getDefaultApplication(type: string, userId?: number): Promise\<BundleInfo>
以异步方法获取默认应用,使用Promise形式返回结果。 以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型获取默认应用信息,使用Promise形式返回结果。
**需要权限:**
ohos.permission.GET_DEFAULT_APPLICATION
**系统能力:** **系统能力:**
...@@ -105,70 +109,44 @@ SystemCapability.BundleManager.BundleFramework ...@@ -105,70 +109,44 @@ SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| type | string | 是 | 要查询的默认应用名称,取[ApplicationType](#defaultappmgrapplicationtype)中的值 | | type | string | 是 | 要查询的默认应用名称,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。 |
| type | userId | 否 | 用户id。 | | userId | number | 否 | 用户ID。默认值:调用方所在用户。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------ | | ------------------------- | ------------------ |
| Promise\<BundleInfo> | Promise形式返回默认应用信息。 | | Promise\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | Promise形式返回默认应用包信息。 |
**示例:** **示例:**
```js ```js
defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER) defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER)
.then((data) => { .then((data) => {
console.info('Operation successful. bundleInfo : ' + JSON.stringify(data)); console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
}).catch((error) => { })
.catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error)); console.error('Operation failed. Cause: ' + JSON.stringify(error));
}); });
```
## defaultAppMgr.setDefaultApplication
setDefaultApplication(type: string, elementName: ElementName, userId?: number): Promise\<void>
以异步方法设置应用,使用Promise形式返回结果。
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- |
| type | string | 是 | 要查询的默认应用名称,取[ApplicationType](#defaultappmgrapplicationtype)中的值。 |
| elementName | ElementName | 是 | 组件信息。 |
| type | userId | 否 | 用户id。 |
**返回值:**
| 类型 | 说明 |
| ------------------------- | ------------------ |
| Promise\<void> | Promise形式返回是否设置成功。 |
**示例:**
```js defaultAppMgr.getDefaultApplication("image/png")
defaultAppMgr.setDefaultApplication(defaultAppMgr.ApplicationType.BROWSER{
bundleName: "com.test.defaultApp",
moduleName: "module01",
abilityName: "IMAGE-USER"
})
.then((data) => { .then((data) => {
console.info('Operation successful.'); console.info('Operation successful. bundleInfo: ' + JSON.stringify(data));
}).catch((error) => { })
.catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error)); console.error('Operation failed. Cause: ' + JSON.stringify(error));
}); });
``` ```
## defaultAppMgr.resetDefaultApplication ## defaultAppMgr.getDefaultApplication
getDefaultApplication(type: string, userId: number, callback: AsyncCallback\<BundleInfo>) : void
以异步方法根据系统已定义的应用类型或者符合媒体类型格式(type/subtype)的文件类型获取默认应用信息,使用callback形式返回结果。
resetDefaultApplication(type: string, userId?: number): Promise\<void> **需要权限:**
以异步方法重置应用,使用Promise形式返回结果。 ohos.permission.GET_DEFAULT_APPLICATION
**系统能力:** **系统能力:**
...@@ -178,22 +156,26 @@ SystemCapability.BundleManager.BundleFramework ...@@ -178,22 +156,26 @@ SystemCapability.BundleManager.BundleFramework
| 名称 | 类型 | 必填 | 描述 | | 名称 | 类型 | 必填 | 描述 |
| ----------- | ------ | ---- | --------------------------------------- | | ----------- | ------ | ---- | --------------------------------------- |
| type | string | 是 | 要查询的默认应用名称,取[ApplicationType](#defaultappmgrapplicationtype)中的值。 | | type | string | 是 | 要查询的默认应用名称,取[ApplicationType](#defaultappmgrapplicationtype)中的值,或者符合媒体类型格式的文件类型。 |
| type | userId | 否 | 用户id。 | | userId | number | 是 | 用户ID。 |
| callback | AsyncCallback\<[BundleInfo](js-apis-bundle-BundleInfo.md)> | 是 | 程序启动作为入参的回调函数,返回包信息。 |
**返回值:**
| 类型 | 说明 |
| ------------------------- | ------------------ |
| Promise\<void> | Promise形式返回是否重置成功。 |
**示例:** **示例:**
```js ```js
defaultAppMgr.resetDefaultApplication(defaultAppMgr.ApplicationType.BROWSER) defaultAppMgr.getDefaultApplication(defaultAppMgr.ApplicationType.BROWSER, 100, (err, data) => {
.then((data) => { if (err) {
console.info('Operation successful.'); console.error('Operation failed. Cause: ' + JSON.stringify(err));
}).catch((error) => { return;
console.error('Operation failed. Cause: ' + JSON.stringify(error)); }
console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
});
defaultAppMgr.getDefaultApplication("image/png", 100, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. bundleInfo:' + JSON.stringify(data));
}); });
``` ```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册