未验证 提交 b119db8e 编写于 作者: O openharmony_ci 提交者: Gitee

!5266 应用信息统计docs文档修改

Merge pull request !5266 from yp99ustc/master
...@@ -19,18 +19,20 @@ import stats from '@ohos.bundleState'; ...@@ -19,18 +19,20 @@ import stats from '@ohos.bundleState';
| function queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<BundleActiveInfoResponse>): void | 通过指定起始和结束时间查询应用使用时长统计信息。 | | function queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<BundleActiveInfoResponse>): void | 通过指定起始和结束时间查询应用使用时长统计信息。 |
| function queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void | 通过指定起始和结束时间查询当前应用的事件集合。 | | function queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void | 通过指定起始和结束时间查询当前应用的事件集合。 |
| function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStateInfo>>): void | 通过指定时间段间隔(天、周、月、年)查询应用使用时长统计信息。 | | function queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStateInfo>>): void | 通过指定时间段间隔(天、周、月、年)查询应用使用时长统计信息。 |
| function queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback<number>): void | 查询当前调用者应用或者指定应用的使用优先级群组。callback形式。 | | function queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void | 查询当前应用的使用优先级群组。callback形式。 |
| function queryAppUsagePriorityGroup(bundleName? : string): Promise<number>; | 查询当前调用者应用或者指定应用的使用优先级群组。promise形式。 | | function queryAppUsagePriorityGroup(): Promise&lt;number&gt;; | 查询当前应用的使用优先级群组。promise形式。 |
| function isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void | 判断指定Bundle Name的应用当前是否是空闲状态。 | | function isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void | 判断指定Bundle Name的应用当前是否是空闲状态。 |
| function getRecentlyUsedModules(maxNum: number, callback: AsyncCallback&lt;BundleActiveModuleInfo&gt;): void | 根据maxNum,查询FA使用记录,返回不超过maxNum条FA使用记录。 | | function getRecentlyUsedModules(maxNum: number, callback: AsyncCallback&lt;BundleActiveModuleInfo&gt;): void | 根据maxNum,查询FA使用记录,返回不超过maxNum条FA使用记录。 |
| function queryAppNotificationNumber(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveEventState&gt;&gt;): void | 通过指定起始和结束时间查询所有应用的通知次数。 | | function queryAppNotificationNumber(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveEventState&gt;&gt;): void | 通过指定起始和结束时间查询所有应用的通知次数。 |
| function queryBundleActiveEventStates(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveEventState&gt;&gt;): void | 通过指定起始和结束时间查询系统事件(休眠、唤醒、解锁、锁屏)统计信息。 | | function queryBundleActiveEventStates(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveEventState&gt;&gt;): void | 通过指定起始和结束时间查询系统事件(休眠、唤醒、解锁、锁屏)统计信息。 |
| function setBundleGroup(bundleName : string, newGroup: GroupType, callback: AsyncCallback<boolean>): void | 给应用名是bundleName的应用分组设置成newGroup,返回设置结果是否成功,以callback形式返回。 | | function queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback&lt;number&gt;): void | 查询当前调用者应用或者指定应用的使用优先级群组。callback形式。 |
| function setBundleGroup(bundleName : string, newGroup : GroupType): Promise<boolean>; | 给应用名是bundleName的应用分组设置成newGroup,返回设置结果是否成功,以promise形式返回。 | | function queryAppUsagePriorityGroup(bundleName? : string): Promise&lt;number&gt;; | 查询当前调用者应用或者指定应用的使用优先级群组。promise形式。 |
| function registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>, callback: AsyncCallback<boolean>): void | 注册应用分组变化监听回调,返回注册是否成功,当应用分组发生变化时,会给所有已注册的监听者返回回调信息,以callback形式返回。 | | function setBundleGroup(bundleName : string, newGroup: GroupType, callback: AsyncCallback&gt;boolean&gt;): void | 给应用名是bundleName的应用分组设置成newGroup,返回设置结果是否成功,以callback形式返回。 |
| function registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>): Promise<boolean>; | 注册应用分组变化监听回调,返回注册是否成功,当应用分组发生变化时,会给所有已注册的监听者返回回调信息,以promise形式返回。 | | function setBundleGroup(bundleName : string, newGroup : GroupType): Promise&gt;boolean&gt;; | 给应用名是bundleName的应用分组设置成newGroup,返回设置结果是否成功,以promise形式返回。 |
| function unRegisterGroupCallBack(callback: AsyncCallback<boolean>): void | 解除应用分组监听回调,以callback形式返回。 | | function registerGroupCallBack(callback: Callback&gt;BundleActiveGroupCallbackInfo&gt;, callback: AsyncCallback&gt;boolean&gt;): void | 注册应用分组变化监听回调,返回注册是否成功,当应用分组发生变化时,会给所有已注册的监听者返回回调信息,以callback形式返回。 |
| function unRegisterGroupCallBack(): Promise<boolean>; | 解除应用分组监听回调,以promise形式返回。 | | function registerGroupCallBack(callback: Callback&gt;BundleActiveGroupCallbackInfo&gt;): Promise&gt;boolean&gt;; | 注册应用分组变化监听回调,返回注册是否成功,当应用分组发生变化时,会给所有已注册的监听者返回回调信息,以promise形式返回。 |
| function unRegisterGroupCallBack(callback: AsyncCallback&gt;boolean&gt;): void | 解除应用分组监听回调,以callback形式返回。 |
| function unRegisterGroupCallBack(): Promise&gt;boolean&gt;; | 解除应用分组监听回调,以promise形式返回。 |
## 开发步骤 ## 开发步骤
...@@ -172,19 +174,19 @@ import stats from '@ohos.bundleState'; ...@@ -172,19 +174,19 @@ import stats from '@ohos.bundleState';
}); });
``` ```
6. 查询(无参)当前调用者应用的使用优先级群组,config.json中不需要配置权限。查询(有参)指定应用的使用优先级群组,config.json中需要配置权限:ohos.permission.BUNDLE_ACTIVE_INFO。 6. 查询(无参)当前调用者应用的使用优先级群组,config.json中不需要配置权限。
```js ```js
import stats from '@ohos.bundleState' import stats from '@ohos.bundleState'
// 无参异步方法promise方式 // promise方式
stats.queryAppUsagePriorityGroup().then( res => { stats.queryAppUsagePriorityGroup().then( res => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise failed. because: ' + err.code);
}); });
// 无参异步方法callback方式 // callback方式
stats.queryAppUsagePriorityGroup((err, res) => { stats.queryAppUsagePriorityGroup((err, res) => {
if (err) { if (err) {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup callback failed. because: ' + err.code); console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup callback failed. because: ' + err.code);
...@@ -192,24 +194,8 @@ import stats from '@ohos.bundleState'; ...@@ -192,24 +194,8 @@ import stats from '@ohos.bundleState';
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup callback succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup callback succeeded. result: ' + JSON.stringify(res));
} }
}); });
//有参异步promise方式
stats.queryAppUsagePriorityGroup(this.bundleName).then( res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});
//有参异步方法callback方式
stats.queryAppUsagePriorityGroup(this.bundleName, (err, res) => {
if(err) {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res));
}
});
``` ```
7. 判断指定Bundle Name的应用当前是否是空闲状态,config.json中不需要配置权限。 7. 判断指定Bundle Name的应用当前是否是空闲状态,config.json中不需要配置权限。
```js ```js
...@@ -334,23 +320,61 @@ import stats from '@ohos.bundleState'; ...@@ -334,23 +320,61 @@ import stats from '@ohos.bundleState';
}); });
``` ```
11. 查询(无参)当前调用者应用的使用优先级群组,config.json中不需要配置权限。查询(有参)指定应用的使用优先级群组,config.json中需要配置权限:ohos.permission.BUNDLE_ACTIVE_INFO。
```js
import stats from '@ohos.bundleState'
// 无参异步方法promise方式
stats.queryAppUsagePriorityGroup().then( res => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise failed. because: ' + err.code);
});
// 无参异步方法callback方式
stats.queryAppUsagePriorityGroup((err, res) => {
if (err) {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup callback succeeded. result: ' + JSON.stringify(res));
}
});
//有参异步promise方式
stats.queryAppUsagePriorityGroup(this.bundleName).then( res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});
//有参异步方法callback方式
stats.queryAppUsagePriorityGroup(this.bundleName, (err, res) => {
if(err) {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res));
}
});
```
11. 给应用名是bundleName的应用分组设置成newGroup,返回设置结果是否成功 11. 给应用名是bundleName的应用分组设置成newGroup,返回设置结果是否成功
```javascript ```javascript
import stats from '@ohos.bundleState' import stats from '@ohos.bundleState'
//异步方法promise //异步方法promise
stats.setBundleGroup(this.bundleName, this.newGroup).then( res => { stats.setBundleGroup(this.bundleName, this.newGroup).then( () => {
console.log('BUNDLE_ACTIVE SetBundleGroup promise succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE SetBundleGroup promise succeeded.');
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE SetBundleGroup promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE SetBundleGroup promise failed. because: ' + err.code);
}); });
//异步方法callback //异步方法callback
stats.setBundleGroup(this.bundleName, this.newGroup, (err, res) => { stats.setBundleGroup(this.bundleName, this.newGroup, (err) => {
if(err) { if(err) {
console.log('BUNDLE_ACTIVE SetBundleGroup callback failed. because: ' + err.code); console.log('BUNDLE_ACTIVE SetBundleGroup callback failed. because: ' + err.code);
} else { } else {
console.log('BUNDLE_ACTIVE SetBundleGroup callback succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE SetBundleGroup callback succeeded.');
} }
}); });
``` ```
...@@ -369,8 +393,8 @@ import stats from '@ohos.bundleState'; ...@@ -369,8 +393,8 @@ import stats from '@ohos.bundleState';
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result userId is : ' + res.userId); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result userId is : ' + res.userId);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result bundleName is : ' + res.bundleName); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result bundleName is : ' + res.bundleName);
}; };
stats.registerGroupCallBack(onBundleGroupChanged).then( res => { stats.registerGroupCallBack(onBundleGroupChanged).then( () => {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise succeeded. result1: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise succeeded.');
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise failed. because: ' + err.code);
}); });
...@@ -383,34 +407,32 @@ import stats from '@ohos.bundleState'; ...@@ -383,34 +407,32 @@ import stats from '@ohos.bundleState';
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s userId is : ' + res.userId); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s userId is : ' + res.userId);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s bundleName is : ' + res.bundleName); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s bundleName is : ' + res.bundleName);
}; };
stats.registerGroupCallBack(onBundleGroupChanged, (err,res)=>{ stats.registerGroupCallBack(onBundleGroupChanged, (err)=>{
if(err) { if(err) {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback failed, because: ' + err.code); console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback failed, because: ' + err.code);
} else { } else {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback success.'); console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE RegisterGroupCallBack result is : ' + JSON.stringify(res));
} }
}); });
``` ```
13. 解除应用分组监听回调 13. 解除应用分组监听回调
```javascript ```javascript
import stats from '@ohos.bundleState' import stats from '@ohos.bundleState'
//promise //promise
stats.unRegisterGroupCallBack().then( res => { stats.unRegisterGroupCallBack().then( () => {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise succeeded.');
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise failed. because: ' + err.code);
}); });
//callback //callback
stats.unRegisterGroupCallBack((err,res)=>{ stats.unRegisterGroupCallBack((err)=>{
if(err) { if(err) {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback failed, because: ' + err.code); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback failed, because: ' + err.code);
} else { } else {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback success.'); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack result is : ' + JSON.stringify(res));
} }
}); });
``` ```
......
...@@ -16,11 +16,12 @@ ...@@ -16,11 +16,12 @@
2. 根据起止时间查询应用的使用时长。 2. 根据起止时间查询应用的使用时长。
3. 根据起止时间查询当前应用的事件集合。 3. 根据起止时间查询当前应用的事件集合。
4. 根据interval(日、周、月、年)类型和起止时间查询应用的使用时长。 4. 根据interval(日、周、月、年)类型和起止时间查询应用的使用时长。
5. 查询调用者应用或指定应用的优先级群组。 5. 查询调用者应用的优先级群组。
6. 判断指定应用当前是否是空闲状态。 6. 判断指定应用当前是否是空闲状态。
7. 查询FA使用记录。返回数量最大不超过maxNum设置的值,FA使用记录由近及远排序,maxNum最大为1000,若不填写maxNum参数,则maxNum默认为1000。 7. 查询FA使用记录。返回数量最大不超过maxNum设置的值,FA使用记录由近及远排序,maxNum最大为1000,若不填写maxNum参数,则maxNum默认为1000。
8. 根据起止时间查询应用通知次数。 8. 根据起止时间查询应用通知次数。
9. 根据起止时间查询系统事件(休眠、唤醒、解锁、锁屏)统计信息。 9. 根据起止时间查询系统事件(休眠、唤醒、解锁、锁屏)统计信息。
9. 查询调用者应用或指定应用的优先级群组。
- 设置接口 - 设置接口
...@@ -35,5 +36,5 @@ ...@@ -35,5 +36,5 @@
1. 解除注册应用分组变化回调监听 1. 解除注册应用分组变化回调监听
### 设备使用信息统计使用权限 ### 设备使用信息统计使用权限
- 设备使用信息统计的queryBundleActiveStates、queryBundleStateInfos、queryBundleStateInfoByInterval、queryBundleActiveEventStates、queryAppNotificationNumber、queryAppUsagePriorityGroup(有参)、setBundleGroup、registerGroupCallBack、unRegisterGroupCallBack接口为系统api,调用前需要申请ohos.permission.BUNDLE_ACTIVE_INFO权限。 - 设备使用信息统计的queryBundleActiveStates、queryBundleStateInfos、queryBundleStateInfoByInterval、queryBundleActiveEventStates、queryAppNotificationNumber、queryAppUsagePriorityGroup(bundleName?)、setBundleGroup、registerGroupCallBack、unRegisterGroupCallBack接口为系统api,调用前需要申请ohos.permission.BUNDLE_ACTIVE_INFO权限。
- 设备使用信息统计的queryCurrentBundleActiveStates、queryAppUsagePriorityGroup(无参)、isIdleState接口为三方api,调用时不需要申请权限。 - 设备使用信息统计的queryCurrentBundleActiveStates、queryAppUsagePriorityGroup()、isIdleState接口为三方api,调用时不需要申请权限。
\ No newline at end of file \ No newline at end of file
...@@ -69,20 +69,12 @@ isIdleState(bundleName: string): Promise&lt;boolean&gt; ...@@ -69,20 +69,12 @@ isIdleState(bundleName: string): Promise&lt;boolean&gt;
## bundleState.queryAppUsagePriorityGroup ## bundleState.queryAppUsagePriorityGroup
queryAppUsagePriorityGroup(bundleName? : string): Promise<number> queryAppUsagePriorityGroup(): Promise<number>
可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。使用Promise形式返回其应用分组。
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO 查询当前应用的优先级分组。使用Promise形式返回其应用分组。
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup **系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ----------------------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName<sup>9+</sup> | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -92,13 +84,6 @@ queryAppUsagePriorityGroup(bundleName? : string): Promise<number> ...@@ -92,13 +84,6 @@ queryAppUsagePriorityGroup(bundleName? : string): Promise<number>
**示例** **示例**
```javascript ```javascript
//有bundleName的promise
bundleState.queryAppUsagePriorityGroup(this.bundleName).then( res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});
//无bundleName的promise
bundleState.queryAppUsagePriorityGroup().then( res => { bundleState.queryAppUsagePriorityGroup().then( res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => { }).catch( err => {
...@@ -108,20 +93,17 @@ bundleState.queryAppUsagePriorityGroup().then( res => { ...@@ -108,20 +93,17 @@ bundleState.queryAppUsagePriorityGroup().then( res => {
## bundleState.queryAppUsagePriorityGroup ## bundleState.queryAppUsagePriorityGroup
queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback<number>): void queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void
可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。使用callback形式返回其应用分组。 查询当前应用的优先级分组。使用callback形式返回其应用分组。
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup **系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ | | -------- | --------------------- | ---- | -------------------------------------------- |
| bundleName<sup>9+</sup> | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 | | callback | AsyncCallback<number> | 是 | 指定的CallBack回调方法。返回查询的应用分组。 |
| callback | AsyncCallback&lt;Array&lt;[BundleActiveModuleInfo](#bundleactivemoduleinfo9)&gt;&gt; | 是 | 指定的CallBack回调方法。返回查询的应用分组。 |
**示例** **示例**
...@@ -523,9 +505,86 @@ getRecentlyUsedModules(maxNum?: number, callback: AsyncCallback&lt;Array&lt;Bund ...@@ -523,9 +505,86 @@ getRecentlyUsedModules(maxNum?: number, callback: AsyncCallback&lt;Array&lt;Bund
}); });
``` ```
## bundleState.queryAppUsagePriorityGroup<sup>9+</sup>
queryAppUsagePriorityGroup(bundleName? : string): Promise<number>
可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。使用Promise形式返回其应用分组。
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ------------------------------------------------------------ |
| bundleName | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 |
**返回值**
| 类型 | 说明 |
| --------------- | ----------------------------------------------- |
| Promise<number> | 指定的Promise回调方法。返回查询的应用分组结果。 |
**示例**
```javascript
//有bundleName的promise
bundleState.queryAppUsagePriorityGroup(this.bundleName).then( res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});
//无bundleName的promise
bundleState.queryAppUsagePriorityGroup().then( res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});
```
## bundleState.queryAppUsagePriorityGroup<sup>9+</sup>
queryAppUsagePriorityGroup(bundleName? : string, callback: AsyncCallback<number>): void
可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。使用callback形式返回其应用分组。
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | --------------------- | ---- | ------------------------------------------------------------ |
| bundleName | string | 否 | 可选参数。设置该参数时查询指定bundleName对应应用的分组。无参数时查询当前应用的分组。 |
| callback | AsyncCallback<number> | 是 | 指定的CallBack回调方法。返回查询的应用分组。 |
**示例**
```javascript
//有bundleName的callback
bundleState.queryAppUsagePriorityGroup(this.bundleName, (err, res) => {
if(err) {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res));
}
});
//无bundleName的callback
bundleState.queryAppUsagePriorityGroup((err, res) => {
if(err) {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res));
}
});
```
## bundleState.setBundleGroup<sup>9+</sup> ## bundleState.setBundleGroup<sup>9+</sup>
setBundleGroup(bundleName: string, newGroup: GroupType): Promise<boolean> setBundleGroup(bundleName: string, newGroup: GroupType): Promise<void>
将指定的bundleName的应用的分组设置为newGroup,使用Promise形式返回设置是否成功。 将指定的bundleName的应用的分组设置为newGroup,使用Promise形式返回设置是否成功。
...@@ -542,9 +601,9 @@ setBundleGroup(bundleName: string, newGroup: GroupType): Promise<boolean> ...@@ -542,9 +601,9 @@ setBundleGroup(bundleName: string, newGroup: GroupType): Promise<boolean>
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ------------------------------------------- | | ------------- | ------------------------------------------- |
| Promise<boolean> | 指定的Promise回调方法。返回本次设置是否成功 | | Promise<void> | 指定的Promise回调方法。返回本次设置是否成功 |
**示例** **示例**
...@@ -552,8 +611,8 @@ setBundleGroup(bundleName: string, newGroup: GroupType): Promise<boolean> ...@@ -552,8 +611,8 @@ setBundleGroup(bundleName: string, newGroup: GroupType): Promise<boolean>
this.bundleName = "com.example.deviceUsageStatistics"; this.bundleName = "com.example.deviceUsageStatistics";
this.newGroup = stats.GroupType.ACTIVE_GROUP_DAILY; this.newGroup = stats.GroupType.ACTIVE_GROUP_DAILY;
bundleState.setBundleGroup(this.bundleName, this.newGroup).then( res => { bundleState.setBundleGroup(this.bundleName, this.newGroup).then( () => {
console.log('BUNDLE_ACTIVE SetBundleGroup promise succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE SetBundleGroup promise succeeded.');
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE SetBundleGroup promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE SetBundleGroup promise failed. because: ' + err.code);
}); });
...@@ -561,7 +620,7 @@ bundleState.setBundleGroup(this.bundleName, this.newGroup).then( res => { ...@@ -561,7 +620,7 @@ bundleState.setBundleGroup(this.bundleName, this.newGroup).then( res => {
## bundleState.setBundleGroup<sup>9+</sup> ## bundleState.setBundleGroup<sup>9+</sup>
setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback<boolean>): void setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback<void>): void
将指定的bundleName的应用的分组设置为newGroup,使用CallBack形式返回设置是否成功。 将指定的bundleName的应用的分组设置为newGroup,使用CallBack形式返回设置是否成功。
...@@ -571,11 +630,11 @@ setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback< ...@@ -571,11 +630,11 @@ setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback<
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ---------------------- | ---- | ------------------------------------------ | | ---------- | ------------------- | ---- | ------------------------------------------ |
| bundleName | string | 是 | 应用名称 | | bundleName | string | 是 | 应用名称 |
| newGroup | GroupType | 是 | 应用分组 | | newGroup | GroupType | 是 | 应用分组 |
| callback | AsyncCallback<boolean> | 是 | 指定的CallBack回调方法。返回设置是否成功。 | | callback | AsyncCallback<void> | 是 | 指定的CallBack回调方法。返回设置是否成功。 |
**示例** **示例**
...@@ -583,18 +642,18 @@ setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback< ...@@ -583,18 +642,18 @@ setBundleGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback<
this.bundleName = "com.example.deviceUsageStatistics"; this.bundleName = "com.example.deviceUsageStatistics";
this.newGroup = stats.GroupType.ACTIVE_GROUP_DAILY; this.newGroup = stats.GroupType.ACTIVE_GROUP_DAILY;
bundleState.setBundleGroup(this.bundleName, this.newGroup, (err, res) => { bundleState.setBundleGroup(this.bundleName, this.newGroup, (err) => {
if(err) { if(err) {
console.log('BUNDLE_ACTIVE SetBundleGroup callback failed. because: ' + err.code); console.log('BUNDLE_ACTIVE SetBundleGroup callback failed. because: ' + err.code);
} else { } else {
console.log('BUNDLE_ACTIVE SetBundleGroup callback succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE SetBundleGroup callback succeeded.');
} }
}); });
``` ```
## bundleState.registerGroupCallBack<sup>9+</sup> ## bundleState.registerGroupCallBack<sup>9+</sup>
registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>): Promise<boolean> registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>): Promise<void>
应用分组变化注册,待用户名下的某个应用分组发生变化时,通过callback形式向所有已注册的应用返回BundleActiveGroupCallbackInfo。使用Promise形式返回注册是否成功。 应用分组变化注册,待用户名下的某个应用分组发生变化时,通过callback形式向所有已注册的应用返回BundleActiveGroupCallbackInfo。使用Promise形式返回注册是否成功。
...@@ -610,9 +669,9 @@ registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>): Promis ...@@ -610,9 +669,9 @@ registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>): Promis
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | --------------------------------------- | | ------------- | --------------------------------------- |
| Promise<boolean> | 指定的Promise回调方法。返回注册是否成功 | | Promise<void> | 指定的Promise回调方法。返回注册是否成功 |
**示例** **示例**
...@@ -625,8 +684,8 @@ let onBundleGroupChanged = (err,res) =>{ ...@@ -625,8 +684,8 @@ let onBundleGroupChanged = (err,res) =>{
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result userId is : ' + res.userId); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result userId is : ' + res.userId);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result bundleName is : ' + res.bundleName); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result bundleName is : ' + res.bundleName);
}; };
bundleState.registerGroupCallBack(onBundleGroupChanged).then( res => { bundleState.registerGroupCallBack(onBundleGroupChanged).then( () => {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise succeeded. result1: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise succeeded.');
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise failed. because: ' + err.code);
}); });
...@@ -634,7 +693,7 @@ bundleState.registerGroupCallBack(onBundleGroupChanged).then( res => { ...@@ -634,7 +693,7 @@ bundleState.registerGroupCallBack(onBundleGroupChanged).then( res => {
## bundleState.registerGroupCallBack<sup>9+</sup> ## bundleState.registerGroupCallBack<sup>9+</sup>
registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>, callback: AsyncCallback<boolean>): void registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>, callback: AsyncCallback<void>): void
应用分组变化注册,待用户名下的某个应用分组发生变化时,通过callback形式向所有已注册的应用返回BundleActiveGroupCallbackInfo。使用异步callback形式返回注册是否成功。 应用分组变化注册,待用户名下的某个应用分组发生变化时,通过callback形式向所有已注册的应用返回BundleActiveGroupCallbackInfo。使用异步callback形式返回注册是否成功。
...@@ -647,7 +706,7 @@ registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>, callbac ...@@ -647,7 +706,7 @@ registerGroupCallBack(callback: Callback<BundleActiveGroupCallbackInfo>, callbac
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | -------------------------- | | -------- | --------------------------------------- | ---- | -------------------------- |
| callback | Callback<BundleActiveGroupCallbackInfo> | 是 | 应用分组变化的回调函数 | | callback | Callback<BundleActiveGroupCallbackInfo> | 是 | 应用分组变化的回调函数 |
| callback | AsyncCallback<boolean> | 是 | 注册是否成功的异步回调函数 | | callback | AsyncCallback<void> | 是 | 注册是否成功的异步回调函数 |
**示例** **示例**
...@@ -660,19 +719,18 @@ let onBundleGroupChanged = (err,res) =>{ ...@@ -660,19 +719,18 @@ let onBundleGroupChanged = (err,res) =>{
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s userId is : ' + res.userId); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s userId is : ' + res.userId);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s bundleName is : ' + res.bundleName); console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s bundleName is : ' + res.bundleName);
}; };
bundleState.registerGroupCallBack(onBundleGroupChanged, (err,res)=>{ bundleState.registerGroupCallBack(onBundleGroupChanged, (err)=>{
if(err) { if(err) {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback failed, because: ' + err.code); console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback failed, because: ' + err.code);
} else { } else {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback success.'); console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE RegisterGroupCallBack result is : ' + JSON.stringify(res));
} }
}); });
``` ```
## bundleState.unRegisterGroupCallBack<sup>9+</sup> ## bundleState.unRegisterGroupCallBack<sup>9+</sup>
unRegisterGroupCallBack(): Promise<boolean> unRegisterGroupCallBack(): Promise<void>
应用分组变化解注册,将之前注册的解除注册。使用Promise形式返回注册是否成功。 应用分组变化解注册,将之前注册的解除注册。使用Promise形式返回注册是否成功。
...@@ -684,15 +742,15 @@ unRegisterGroupCallBack(): Promise<boolean> ...@@ -684,15 +742,15 @@ unRegisterGroupCallBack(): Promise<boolean>
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ----------------------------------------- | | ------------- | ----------------------------------------- |
| Promise<boolean> | 指定的Promise回调方法。返回解注册是否成功 | | Promise<void> | 指定的Promise回调方法。返回解注册是否成功 |
**示例** **示例**
```javascript ```javascript
bundleState.unRegisterGroupCallBack().then( res => { bundleState.unRegisterGroupCallBack().then( () => {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise succeeded. result: ' + JSON.stringify(res)); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise succeeded.');
}).catch( err => { }).catch( err => {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise failed. because: ' + err.code); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise failed. because: ' + err.code);
}); });
...@@ -700,7 +758,7 @@ bundleState.unRegisterGroupCallBack().then( res => { ...@@ -700,7 +758,7 @@ bundleState.unRegisterGroupCallBack().then( res => {
## bundleState.unRegisterGroupCallBack<sup>9+</sup> ## bundleState.unRegisterGroupCallBack<sup>9+</sup>
unRegisterGroupCallBack(callback: AsyncCallback<boolean>): void; unRegisterGroupCallBack(callback: AsyncCallback<void>): void;
应用分组变化解注册,将之前注册的解除注册。使用异步callback形式返回注册是否成功。 应用分组变化解注册,将之前注册的解除注册。使用异步callback形式返回注册是否成功。
...@@ -710,19 +768,18 @@ unRegisterGroupCallBack(callback: AsyncCallback<boolean>): void; ...@@ -710,19 +768,18 @@ unRegisterGroupCallBack(callback: AsyncCallback<boolean>): void;
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------------- | | -------- | ------------------- | ---- | ---------------------------- |
| callback | AsyncCallback<boolean> | 是 | 解注册是否成功的异步回调函数 | | callback | AsyncCallback<void> | 是 | 解注册是否成功的异步回调函数 |
**示例** **示例**
```javascript ```javascript
bundleState.unRegisterGroupCallBack((err,res)=>{ bundleState.unRegisterGroupCallBack((err)=>{
if(err) { if(err) {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback failed, because: ' + err.code); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback failed, because: ' + err.code);
} else { } else {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback success.'); console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack result is : ' + JSON.stringify(res));
} }
}); });
``` ```
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册