Skip to content

D
Docs

OpenHarmony / Docs
12 个月 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 9beaf5bc 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!11124 deviceUsageStatistics仓文档信息修改 

Merge pull request !11124 from yp99ustc/master
上级 c229fcde 3f65e220
显示空白变更内容
内联 并排
Showing with 157 addition and 287 deletion
zh-cn/application-dev/device-usage-statistics/Readme-CN.md
浏览文件 @ 9beaf5bc
# 设备使用信息统计
- [设备使用信息统计概述](device-usage-statistics-overview.md)
- [设备使用信息统计开发指导(API7)](device-usage-statistics-dev-guide.md)
- [设备使用信息统计开发指导(API9)](device-usage-statistics-use-guide.md)
\ No newline at end of file
- [设备使用信息统计开发指导](device-usage-statistics-use-guide.md)
\ No newline at end of file
zh-cn/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md 已删除 100644 → 0
浏览文件 @ c229fcde
# 设备使用信息统计(API7)
## 场景介绍
设备使用信息统计，包括app usage/notification usage/system usage等使用统计。例如应用使用信息统计，用于保存和查询应用使用详情（app usage）、事件日志数据（event log）、应用分组（bundle group）情况。
部件缓存的应用记录（使用历史统计和使用事件记录）会在事件上报后30分钟内刷新到数据库持久化保存。
根据设备的使用信息统计接口，开发者可以开发出健康管理类应用来实现个人设备健康使用功能，并向用户展示其个人设备的使用记录。
## 接口说明
注册相关接口包导入：
```js
import stats from '@ohos.bundleState';
```
**表1** 设备使用信息统计主要接口
| 接口名 | 描述 |
| -------- | -------- |
| function queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void | 通过指定起始和结束时间查询所有应用的事件集合。 |
| function queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<BundleActiveInfoResponse>): 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 queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void | 查询当前应用的使用优先级群组。callback形式。 |
| function queryAppUsagePriorityGroup(): Promise<number>; | 查询当前应用的使用优先级群组。promise形式。 |
| function isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void | 判断指定Bundle Name的应用当前是否是空闲状态。 |
## 开发步骤
1. 获取设备使用信息之前，需要检查是否已经配置请求相应的权限。
系统提供的设备使用信息统计的权限是ohos.permission.BUNDLE_ACTIVE_INFO
具体配置方式请参考[权限申请声明](../security/accesstoken-guidelines.md)
2. 通过指定起始和结束时间查询所有应用的事件集合，需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
```js
import stats from '@ohos.bundleState'
stats.queryBundleActiveStates(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise success.');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise result ' + JSON.stringify(res[i]));
}
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise failed, because: ' + err.code);
});
```
3. 通过指定起始和结束时间查询应用使用时长统计信息，需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
```js
import stats from '@ohos.bundleState'
stats.queryBundleStateInfos(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise success.');
let i = 1;
for (let key in res){
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise number : ' + i);
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise result ' + JSON.stringify(res[key]));
i++;
}
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise failed, because: ' + err.code);
});
```
4. 通过指定起始和结束时间查询当前应用的事件集合，不需要配置权限。
```js
import stats from '@ohos.bundleState'
stats.queryCurrentBundleActiveStates(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise success.');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise result ' + JSON.stringify(res[i]));
}
}).catch(err => {
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise failed, because: ' + err.code);
});
```
5. 通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
```js
import stats from '@ohos.bundleState'
stats.queryBundleStateInfoByInterval(0, 0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise success.');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise result ' + JSON.stringify(res[i]));
}
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise failed, because: ' + err.code);
});
```
6. 查询（无参）当前调用者应用的使用优先级群组，不需要配置权限。
```js
import stats from '@ohos.bundleState'
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);
});
```
7. 判断指定Bundle Name的应用当前是否是空闲状态，需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限，三方应用只能查询自身的空闲状态。
```js
import stats from '@ohos.bundleState'
stats.isIdleState("com.ohos.camera").then(res => {
console.log('BUNDLE_ACTIVE isIdleState promise succeeded, result: ' + JSON.stringify(res));
}).catch(err => {
console.log('BUNDLE_ACTIVE isIdleState promise failed, because: ' + err.code);
});
```
## 相关实例
针对设备使用信息统计，有以下相关实例可供参考：
- [`DeviceUsageStatistics`：设备使用信息统计（ArkTS）（API8）（Full SDK）](https://gitee.com/openharmony/applications_app_samples/tree/master/device/DeviceUsageStatistics)
zh-cn/application-dev/device-usage-statistics/device-usage-statistics-use-guide.md
浏览文件 @ 9beaf5bc
......@@ -197,7 +197,7 @@ import usageStatistics from '@ohos.resourceschedule.usageStatistics';
}
```
6. 查询（无参）当前调用者应用的使用优先级群组，不需要配置权限。
6. 查询当前应用的使用优先级群组，不需要配置权限。
```js
import usageStatistics from '@ohos.resourceschedule.usageStatistics'
......@@ -391,7 +391,7 @@ import usageStatistics from '@ohos.resourceschedule.usageStatistics';
}
```
11. 查询（无参）当前调用者应用的使用优先级群组，config.json中不需要配置权限。查询（有参）指定应用的使用优先级群组，需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
11. 查询指定bundleName的应用的使用优先级群组，返回查询的优先级分组结果，需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
```js
import usageStatistics from '@ohos.resourceschedule.usageStatistics'
......@@ -423,7 +423,7 @@ import usageStatistics from '@ohos.resourceschedule.usageStatistics';
}
```
11. 给应用名是bundleName的应用分组设置成newGroup，返回设置结果是否成功, 需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
12. 给指定bundleName的应用的优先级分组设置成newGroup。 需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
```javascript
import usageStatistics from '@ohos.resourceschedule.usageStatistics'
......@@ -459,7 +459,7 @@ import usageStatistics from '@ohos.resourceschedule.usageStatistics';
}
```
12. 注册应用分组变化监听回调，返回注册是否成功，当应用分组发生变化时，会给所有已注册的监听者返回回调信息， 需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限
13. 注册应用分组变化监听回调，返回注册是否成功，当应用分组发生变化时，会给所有已注册的监听者返回回调信息， 需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限
```javascript
import usageStatistics from '@ohos.resourceschedule.usageStatistics'
......@@ -493,8 +493,8 @@ import usageStatistics from '@ohos.resourceschedule.usageStatistics';
console.log('BUNDLE_ACTIVE registerAppGroupCallBack result bundleName is : ' + res.bundleName);
};
try{
usageStatistics.registerAppGroupCallBack(onBundleGroupChanged, error => {
if(error) {
usageStatistics.registerAppGroupCallBack(onBundleGroupChanged, err => {
if(err) {
console.log('BUNDLE_ACTIVE registerAppGroupCallBack callback failed. code is: ' + err.code + ',message is: ' + err.message);
} else {
console.log('BUNDLE_ACTIVE registerAppGroupCallBack callback success.');
......@@ -505,33 +505,33 @@ import usageStatistics from '@ohos.resourceschedule.usageStatistics';
}
```
13. 解除应用分组监听回调， 需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限
14. 解除应用分组监听回调， 需要配置ohos.permission.BUNDLE_ACTIVE_INFO权限。
```javascript
import usageStatistics from '@ohos.resourceschedule.usageStatistics'
// promise
try{
usageStatistics.unRegisterAppGroupCallBack().then( () => {
console.log('BUNDLE_ACTIVE unRegisterAppGroupCallBack promise succeeded.');
usageStatistics.unregisterAppGroupCallBack().then( () => {
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack promise succeeded.');
}).catch( err => {
console.log('BUNDLE_ACTIVE unRegisterAppGroupCallBack promise failed. code is: ' + err.code + ',message is: ' + err.message);
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack promise failed. code is: ' + err.code + ',message is: ' + err.message);
});
} catch (error) {
console.log('BUNDLE_ACTIVE unRegisterAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
}
// callback
try{
usageStatistics.unRegisterAppGroupCallBack(error => {
if(error) {
console.log('BUNDLE_ACTIVE unRegisterAppGroupCallBack callback failed. code is: ' + err.code + ',message is: ' + err.message);
usageStatistics.unregisterAppGroupCallBack(err => {
if(err) {
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack callback failed. code is: ' + err.code + ',message is: ' + err.message);
} else {
console.log('BUNDLE_ACTIVE unRegisterAppGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack callback success.');
}
});
} catch (error) {
console.log('BUNDLE_ACTIVE unRegisterAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
}
```
## 相关实例
......
zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceUsageStatistics.md
浏览文件 @ 9beaf5bc
......@@ -57,8 +57,7 @@ isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
| 10000006 | Get application info failed. |
**示例**：
```
```js
try{
usageStatistics.isIdleState("com.ohos.camera", (err, res) => {
if (err) {
......@@ -1160,8 +1159,8 @@ registerAppGroupCallBack(groupCallback: Callback&lt;AppGroupCallbackInfo&gt;, ca
console.log('BUNDLE_ACTIVE registerAppGroupCallBack result bundleName is : ' + res.bundleName);
};
try{
usageStatistics.registerAppGroupCallBack(onBundleGroupChanged, error => {
if(error) {
usageStatistics.registerAppGroupCallBack(onBundleGroupChanged, err => {
if(err) {
console.log('BUNDLE_ACTIVE registerAppGroupCallBack callback failed. code is: ' + err.code + ',message is: ' + err.message);
} else {
console.log('BUNDLE_ACTIVE registerAppGroupCallBack callback success.');
......@@ -1252,8 +1251,8 @@ unregisterAppGroupCallBack(callback: AsyncCallback&lt;void&gt;): void;
```javascript
try{
usageStatistics.unregisterAppGroupCallBack(error => {
if(error) {
usageStatistics.unregisterAppGroupCallBack(err => {
if(err) {
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack callback failed. code is: ' + err.code + ',message is: ' + err.message);
} else {
console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack callback success.');
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或