Device Usage Statistics Development

When to Use

With device usage statistics APIs, you can have a better understanding of the application, notification, and system usage. For example, in application usage statistics, you can query the application usage, event log, and application group. The application records (usage history statistics and event records) cached by components are updated to the database for persistent storage within 30 minutes after an event is reported.

Available APIs

Import the stats package to implement registration:

import usageStatistics from '@ohos.resourceschedule.usageStatistics';

Table 1 Major APIs for device usage statistics

How to Develop

1. Before obtaining the device usage statistics, check whether the ohos.permission.BUNDLE_ACTIVE_INFO permission is configured.

   For details about how to configure a permission, see Declaring Permissions.

2. Query events of all applications based on the specified start time and end time. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryBundleEvents(0, 20000000000000).then( (res : Array<usageStatistics.BundleEvents>) => {
       console.log('BUNDLE_ACTIVE queryBundleEvents promise success.');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE queryBundleEvents promise number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE queryBundleEvents promise result ' + JSON.stringify(res[i]));
       }
   }).catch((err : BusinessError)=> {
       console.log('BUNDLE_ACTIVE queryBundleEvents promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   usageStatistics.queryBundleEvents(0, 20000000000000, (err : BusinessError, res : Array<usageStatistics.BundleEvents>) => {
       if (err) {
           console.log('BUNDLE_ACTIVE queryBundleEvents callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
           console.log('BUNDLE_ACTIVE queryBundleEvents callback success.');
           for (let i = 0; i < res.length; i++) {
               console.log('BUNDLE_ACTIVE queryBundleEvents callback number : ' + (i + 1));
               console.log('BUNDLE_ACTIVE queryBundleEvents callback result ' + JSON.stringify(res[i]));
           }
       }
   });
   

3. Query the application usage duration statistics based on the specified start time and end time. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryBundleStatsInfos(0, 20000000000000).then( (res : usageStatistics.BundleStatsMap) => {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise success.');
       console.log('BUNDLE_ACTIVE queryBundleStatsInfos callback result ' + JSON.stringify(res));
   }).catch( (err : BusinessError) => {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   usageStatistics.queryBundleStatsInfos(0, 20000000000000, (err : BusinessError, res : usageStatistics.BundleStatsMap) => {
       if (err) {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfos callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfos callback success.');
       console.log('BUNDLE_ACTIVE queryBundleStatsInfos callback result ' + JSON.stringify(res));
       }
   });
   

4. Query events of this application based on the specified start time and end time. This requires no permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryCurrentBundleEvents(0, 20000000000000).then( (res : Array<usageStatistics.BundleEvents>) => {
       console.log('BUNDLE_ACTIVE queryCurrentBundleEvents promise success.');
       for (let i = 0; i < res.length; i++) {
       console.log('BUNDLE_ACTIVE queryCurrentBundleEvents promise number : ' + (i + 1));
       console.log('BUNDLE_ACTIVE queryCurrentBundleEvents promise result ' + JSON.stringify(res[i]));
       }
   }).catch( (err : BusinessError) => {
       console.log('BUNDLE_ACTIVE queryCurrentBundleEvents promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   usageStatistics.queryCurrentBundleEvents(0, 20000000000000, (err : BusinessError, res : Array<usageStatistics.BundleEvents>) => {
       if (err) {
       console.log('BUNDLE_ACTIVE queryCurrentBundleEvents callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE queryCurrentBundleEvents callback success.');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE queryCurrentBundleEvents callback number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE queryCurrentBundleEvents callback result ' + JSON.stringify(res[i]));
       }
       }
   });
   

5. Query the application usage duration statistics in the specified time frame at the specified interval (daily, weekly, monthly, or annually). This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryBundleStatsInfoByInterval(0, 0, 20000000000000).then( (res : Array<usageStatistics.BundleStatsInfo>) => {
   console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval promise success.');
       for (let i = 0; i < res.length; i++) {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval promise number : ' + (i + 1));
       console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval promise result ' + JSON.stringify(res[i]));
       }
   }).catch( (err : BusinessError) => {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   
   
   usageStatistics.queryBundleStatsInfoByInterval(0, 0, 20000000000000, (err : BusinessError, res : Array<usageStatistics.BundleStatsInfo>) => {
       if (err) {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval callback success.');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval callback number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval callback result ' + JSON.stringify(res[i]));
       }
       }
   });
   

6. Query the priority group of the current application. This requires no permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryAppGroup().then( (res : number) => {
       console.log('BUNDLE_ACTIVE queryAppGroup promise succeeded. result: ' + JSON.stringify(res));
   }).catch( (err : BusinessError) => {
       console.log('BUNDLE_ACTIVE queryAppGroup promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Callback mode
   usageStatistics.queryAppGroup((err : BusinessError, res : number) => {
       if(err) {
           console.log('BUNDLE_ACTIVE queryAppGroup callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
           console.log('BUNDLE_ACTIVE queryAppGroup callback succeeded. result: ' + JSON.stringify(res));
       }
   });
   
   
   // Synchronous API
   let priorityGroup = usageStatistics.queryAppGroupSync();
   
   
   

7. Check whether the application specified by bundleName is in the idle state. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.isIdleState("com.ohos.camera").then( (res : boolean) => {
       console.log('BUNDLE_ACTIVE isIdleState promise succeeded, result: ' + JSON.stringify(res));
   }).catch( (err : BusinessError) => {
       console.log('BUNDLE_ACTIVE isIdleState promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   usageStatistics.isIdleState("com.ohos.camera", (err : BusinessError, res : boolean) => {
       if (err) {
       console.log('BUNDLE_ACTIVE isIdleState callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE isIdleState callback succeeded, result: ' + JSON.stringify(res));
       }
   });
   
   
   // Synchronous API
   let isIdleState = usageStatistics.isIdleStateSync("com.ohos.camera");
   

8. Obtain the number of FA usage records specified by maxNum. If maxNum is not specified, the default value 1000 is used. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryModuleUsageRecords(1000).then( (res : Array<usageStatistics.HapModuleInfo>) => {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise succeeded');
       for (let i = 0; i < res.length; i++) {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise number : ' + (i + 1));
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise result ' + JSON.stringify(res[i]));
       }
   }).catch( (err : BusinessError)=> {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Promise mode when maxNum is not specified
   usageStatistics.queryModuleUsageRecords().then( (res : Array<usageStatistics.HapModuleInfo>) => {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise succeeded');
       for (let i = 0; i < res.length; i++) {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise number : ' + (i + 1));
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise result ' + JSON.stringify(res[i]));
       }
   }).catch( (err : BusinessError)=> {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   usageStatistics.queryModuleUsageRecords(1000, (err : BusinessError, res : Array<usageStatistics.HapModuleInfo>) => {
       if(err) {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback succeeded.');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback result ' + JSON.stringify(res[i]));
       }
       }
   });
   
   
   // Asynchronous callback mode when maxNum is not specified
   usageStatistics.queryModuleUsageRecords((err : BusinessError, res : Array<usageStatistics.HapModuleInfo>) => {
       if(err) {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback succeeded.');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE queryModuleUsageRecords callback result ' + JSON.stringify(res[i]));
       }
       }
   });
   

9. Query the number of notifications from all applications based on the specified start time and end time. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

   import { BusinessError } from '@ohos.base';
   
   
   // Promise mode
   usageStatistics.queryNotificationEventStats(0, 20000000000000).then( (res : Array<usageStatistics.DeviceEventStats>) => {
       console.log('BUNDLE_ACTIVE queryNotificationEventStats promise success.');
       console.log('BUNDLE_ACTIVE queryNotificationEventStats promise result ' + JSON.stringify(res));
   }).catch( (err : BusinessError) => {
       console.log('BUNDLE_ACTIVE queryNotificationEventStats promise failed. code is: ' + err.code + ',message is: ' + err.message);
   });
   
   
   // Asynchronous callback mode
   usageStatistics.queryNotificationEventStats(0, 20000000000000, (err : BusinessError, res : Array<usageStatistics.DeviceEventStats>) => {
       if(err) {
       console.log('BUNDLE_ACTIVE queryNotificationEventStats callback failed. code is: ' + err.code + ',message is: ' + err.message);
       } else {
       console.log('BUNDLE_ACTIVE queryNotificationEventStats callback success.');
       console.log('BUNDLE_ACTIVE queryNotificationEventStats callback result ' + JSON.stringify(res));
       }
   });
   

10. Query statistics about system events (hibernation, wakeup, unlocking, and screen locking) that occur between the specified start time and end time. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

    import { BusinessError } from '@ohos.base';
    
    
    // Promise mode
    usageStatistics.queryDeviceEventStats(0, 20000000000000).then( (res : Array<usageStatistics.DeviceEventStats>) => {
        console.log('BUNDLE_ACTIVE queryDeviceEventStates promise success.');
        console.log('BUNDLE_ACTIVE queryDeviceEventStates promise result ' + JSON.stringify(res));
    }).catch( (err : BusinessError) => {
        console.log('BUNDLE_ACTIVE queryDeviceEventStats promise failed. code is: ' + err.code + ',message is: ' + err.message);
    });
    
    
    // Asynchronous callback mode
    usageStatistics.queryDeviceEventStats(0, 20000000000000, (err : BusinessError, res : Array<usageStatistics.DeviceEventStats>) => {
        if(err) {
        console.log('BUNDLE_ACTIVE queryDeviceEventStats callback failed. code is: ' + err.code + ',message is: ' + err.message);
        } else {
        console.log('BUNDLE_ACTIVE queryDeviceEventStats callback success.');
        console.log('BUNDLE_ACTIVE queryDeviceEventStats callback result ' + JSON.stringify(res));
        }
    });
    

11. Query the priority group of the application specified by bundleName. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

    import { BusinessError } from '@ohos.base';
    
    
    // Promise mode when bundleName is specified
    let bundleName = "com.ohos.camera";
    usageStatistics.queryAppGroup(bundleName).then( (res : number) => {
        console.log('BUNDLE_ACTIVE queryAppGroup promise succeeded. result: ' + JSON.stringify(res));
    }).catch( (err : BusinessError) => {
        console.log('BUNDLE_ACTIVE queryAppGroup promise failed. code is: ' + err.code + ',message is: ' + err.message);
    });
    
    
    // Asynchronous callback mode when bundleName is specified
    let bundleName = "com.ohos.camera";
    usageStatistics.queryAppGroup(bundleName, (err : BusinessError, res : number) => {
        if(err) {
        console.log('BUNDLE_ACTIVE queryAppGroup callback failed. code is: ' + err.code + ',message is: ' + err.message);
        } else {
        console.log('BUNDLE_ACTIVE queryAppGroup callback succeeded. result: ' + JSON.stringify(res));
        }
    });
    

12. Set the priority group of for application specified by bundleName. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

    import { BusinessError } from '@ohos.base';
    
    
    // Promise mode
    let bundleName = "com.example.deviceUsageStatistics";
    let newGroup = usageStatistics.GroupType.DAILY_GROUP;
    
    
    usageStatistics.setAppGroup(bundleName, newGroup).then( () => {
        console.log('BUNDLE_ACTIVE setAppGroup promise succeeded.');
    }).catch( (err : BusinessError) => {
        console.log('BUNDLE_ACTIVE setAppGroup promise failed. code is: ' + err.code + ',message is: ' + err.message);
    });
    
    
    // Asynchronous callback mode
    let bundleName = "com.example.deviceUsageStatistics";
    let newGroup = usageStatistics.GroupType.DAILY_GROUP;
    usageStatistics.setAppGroup(bundleName, newGroup, (err : BusinessError) => {
        if(err) {
        console.log('BUNDLE_ACTIVE setAppGroup callback failed. code is: ' + err.code + ',message is: ' + err.message);
        } else {
        console.log('BUNDLE_ACTIVE setAppGroup callback succeeded.');
        }
    });
    

13. Register a callback for application group changes. When an application group of the user changes, the change is returned to all applications that have registered the callback. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

    import { BusinessError } from '@ohos.base';
    
    
    // Promise mode
    function  onBundleGroupChanged (res : usageStatistics.AppGroupCallbackInfo) {
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack RegisterGroupCallBack callback success.');
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack result appOldGroup is : ' + res.appOldGroup);
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack result appNewGroup is : ' + res.appNewGroup);
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack result changeReason is : ' + res.changeReason);
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack result userId is : ' + res.userId);
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack result bundleName is : ' + res.bundleName);
    };
    usageStatistics.registerAppGroupCallBack(onBundleGroupChanged).then( () => {
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack promise succeeded.');
    }).catch( (err : BusinessError) => {
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack promise failed. code is: ' + err.code + ',message is: ' + err.message);
    });
    
    
    // Asynchronous callback mode
    function onBundleGroupChanged (res : usageStatistics.AppGroupCallbackInfo) {
    console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack callback success.');
    console.log('BUNDLE_ACTIVE registerAppGroupCallBack result appOldGroup is : ' + res.appOldGroup);
    console.log('BUNDLE_ACTIVE registerAppGroupCallBack result appNewGroup is : ' + res.appNewGroup);
    console.log('BUNDLE_ACTIVE registerAppGroupCallBack result changeReason is : ' + res.changeReason);
    console.log('BUNDLE_ACTIVE registerAppGroupCallBack result userId is : ' + res.userId);
    console.log('BUNDLE_ACTIVE registerAppGroupCallBack result bundleName is : ' + res.bundleName);
    };
    usageStatistics.registerAppGroupCallBack(onBundleGroupChanged, (err : BusinessError) => {
    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.');
    }
    });
    

14. Deregister the callback for application group changes. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured.

    import { BusinessError } from '@ohos.base';
    
    
    // promise
    usageStatistics.unregisterAppGroupCallBack().then( () => {
        console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack promise succeeded.');
    }).catch( (err : BusinessError) => {
        console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack promise failed. code is: ' + err.code + ',message is: ' + err.message);
    });
    
    
    // callback
    usageStatistics.unregisterAppGroupCallBack((err : BusinessError) => {
        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.');
        }
    });
    

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Device Usage Statistics

harmony 鸿蒙Device Usage Statistics Overview