提交 0a88e08d 编写于 作者: qq_41863798's avatar qq_41863798

接口文档修改

Signed-off-by: qq_41863798's avatarlijiaying <1640106564@qq.com>
上级 3820cdaa
...@@ -10,7 +10,7 @@ Ability assistant(Ability助手,简称为aa)是实现应用、原子化服 ...@@ -10,7 +10,7 @@ Ability assistant(Ability助手,简称为aa)是实现应用、原子化服
- **help** - **help**
用于显示 aa 相关的帮助信息。 用于显示aa相关的帮助信息。
**返回值:** **返回值:**
......
...@@ -20,7 +20,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -20,7 +20,7 @@ SystemCapability.BundleManager.BundleFramework
## bundle.getApplicationInfo ## bundle.getApplicationInfo
getApplicationInfo(bundleName: string, bundleFlags: number, userId: number): Promise\<ApplicationInfo> getApplicationInfo(bundleName: string, bundleFlags: number, userId?: number): Promise\<ApplicationInfo>
以异步方法根据给定的包名获取ApplicationInfo,使用Promise形式返回结果。 以异步方法根据给定的包名获取ApplicationInfo,使用Promise形式返回结果。
...@@ -38,7 +38,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -38,7 +38,7 @@ SystemCapability.BundleManager.BundleFramework
| ----------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId | number | | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
**返回值:** **返回值:**
...@@ -82,7 +82,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -82,7 +82,7 @@ SystemCapability.BundleManager.BundleFramework
| ----------- | ------------------------------- | ---- | ------------------------------------------------------------ | | ----------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 要查询的应用程序包名称。 | | bundleName | string | 是 | 要查询的应用程序包名称。 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| userId | number | | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 | | userId | number | | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 | | callback | AsyncCallback\<ApplicationInfo> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 |
**示例:** **示例:**
...@@ -101,6 +101,42 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => { ...@@ -101,6 +101,42 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => {
``` ```
## bundle.getApplicationInfo
getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\<ApplicationInfo>): void
以异步方法根据给定的包名获取ApplicationInfo,使用callback形式返回结果。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED,ohos.permission.GET_BUNDLE_INFO
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | ------------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 要查询的应用程序包名称。 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| callback | AsyncCallback\<ApplicationInfo> | 是 | 程序启动作为入参的回调函数,返回应用程序信息。 |
**示例:**
```js
let bundleName = "com.example.myapplication";
let bundleFlags = 0;
bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## bundle.getAllBundleInfo ## bundle.getAllBundleInfo
...@@ -237,7 +273,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -237,7 +273,7 @@ SystemCapability.BundleManager.BundleFramework
| ----------- | ------ | ---- | ------------------------------------------------------------ | | ----------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 包名 | | bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| options | BundleOptions | 否 | 包含userid和networkid。 | | options | BundleOptions | 否 | 包含userid。 |
**返回值:** **返回值:**
...@@ -251,8 +287,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -251,8 +287,7 @@ SystemCapability.BundleManager.BundleFramework
let bundleName = "com.example.myapplication"; let bundleName = "com.example.myapplication";
let bundleFlags = 1; let bundleFlags = 1;
let options = { let options = {
"userId" : 100, "userId" : 100
"networkId" : null
}; };
bundle.getBundleInfo(bundleName, bundleFlags, options) bundle.getBundleInfo(bundleName, bundleFlags, options)
.then((data) => { .then((data) => {
...@@ -321,7 +356,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -321,7 +356,7 @@ SystemCapability.BundleManager.BundleFramework
| ----------- | -------------------------- | ---- | ------------------------------------------------------------ | | ----------- | -------------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 包名 | | bundleName | string | 是 | 包名 |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 | | bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。 |
| options | BundleOptions | 是 | 包含userid和networkid。 | | options | BundleOptions | 是 | 包含userid。 |
| callback | AsyncCallback\<BundleInfo> | 是 | 程序启动作为入参的回调函数,返回包信息。 | | callback | AsyncCallback\<BundleInfo> | 是 | 程序启动作为入参的回调函数,返回包信息。 |
**示例:** **示例:**
...@@ -330,8 +365,7 @@ SystemCapability.BundleManager.BundleFramework ...@@ -330,8 +365,7 @@ SystemCapability.BundleManager.BundleFramework
let bundleName = "com.example.myapplication"; let bundleName = "com.example.myapplication";
let bundleFlags = 1; let bundleFlags = 1;
let options = { let options = {
"userId" : 100, "userId" : 100
"networkId" : null
}; };
bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => { bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => {
if (err) { if (err) {
...@@ -345,7 +379,7 @@ bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => { ...@@ -345,7 +379,7 @@ bundle.getBundleInfo(bundleName, bundleFlags, options, (err, data) => {
## bundle.getAllApplicationInfo ## bundle.getAllApplicationInfo
getAllApplicationInfo(bundleFlags: number, userId: number): Promise<Array\<ApplicationInfo>> getAllApplicationInfo(bundleFlags: number, userId?: number): Promise<Array\<ApplicationInfo>>
获取指定用户下所有已安装的应用信息,通过Promise获取返回值。 获取指定用户下所有已安装的应用信息,通过Promise获取返回值。
...@@ -422,6 +456,42 @@ bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => { ...@@ -422,6 +456,42 @@ bundle.getAllApplicationInfo(bundleFlags, userId, (err, data) => {
``` ```
## bundle.getAllApplicationInfo
function getAllApplicationInfo(bundleFlags: number, callback: AsyncCallback<Array<ApplicationInfo>>) : void;
获取指定用户下所有已安装的应用信息,使用callback形式返回结果。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ----------- | -------------------------------------- | ---- | ------------------------------------------------------ |
| bundleFlags | number | 是 | 用于指定返回的应用信息对象中包含信息的标记。默认值:0,取值范围:大于等于0。|
| callback | AsyncCallback<Array\<ApplicationInfo>> | 是 | 程序启动作为入参的回调函数,返回应用信息列表。 |
**示例:**
```js
let bundleFlags = 8;
bundle.getAllApplicationInfo(bundleFlags, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## bundle.queryAbilityByWant ## bundle.queryAbilityByWant
...@@ -764,6 +834,67 @@ bundle.getNameForUid(uid, (err, data) => { ...@@ -764,6 +834,67 @@ bundle.getNameForUid(uid, (err, data) => {
}) })
``` ```
## bundle.getAbilityIcon
function getAbilityIcon(bundleName: string, abilityName: string): Promise<image.PixelMap>;
以异步方法通过bundleName和abilityName获取对应Icon的PixelMap,使用Promise形式返回结果。
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- |
| bundleName | string | 是 | 要查询的bundleName。 |
| abilityName | string | 是 | 要查询的abilityName。 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------------------------------------------ |
| Promise\<image.PixelMap> | 返回值为PixelMap。 |
**示例:**
```js
let bundleName = com.example.myapplication;
let abilityName = com.example.myapplication.MainAbility;
bundle.getAbilityIcon(bundleName, abilityName)
.then((data) => {
console.info('Operation successful. Data: ' + JSON.stringify(data));
}).catch((error) => {
console.error('Operation failed. Cause: ' + JSON.stringify(error));
})
```
## bundle.getAbilityIcon
function getAbilityIcon(bundleName: string, abilityName: string, callback: AsyncCallback<image.PixelMap>): void;
以异步方法通过bundleName和abilityName获取对应的PixelMap,使用callback形式返回结果。
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ------ | ---- | -------- |
| bundleName | string | 是 | 要查询的bundleName。 |
| abilityName | string | 是 | 要查询的abilityName。 |
| callback | AsyncCallback\<image.PixelMap> | 是 | 程序启动作为入参的回调函数,返回指定PixelMap。 |
**示例:**
```js
let bundleName = com.example.myapplication;
let abilityName = com.example.myapplication.MainAbility;
bundle.getAbilityIcon(bundleName, abilityName, (err, data) => {
if (err) {
console.error('Operation failed. Cause: ' + JSON.stringify(err));
return;
}
console.info('Operation successful. Data:' + JSON.stringify(data));
})
```
## ElementName ## ElementName
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask **系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册