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 bundle 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 stats from '@ohos.bundleState';

Table 1 Major APIs for device usage statistics

How to Develop

1. Configure the device usage statistics permission in the config.json file.

   "module": {
       "package": "com.example.deviceUsageStatistics",
       ...,
       "reqPermissions": [
           {
               "name": "ohos.permission.BUNDLE_ACTIVE_INFO"
           }
       ]
   }
   

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 in the config.json file.

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   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);
   });
   
   
   // Asynchronous callback mode
   stats.queryBundleActiveStates(0, 20000000000000, (err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE queryBundleActiveStates callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE queryBundleActiveStates callback success.');
           for (let i = 0; i < res.length; i++) {
               console.log('BUNDLE_ACTIVE queryBundleActiveStates callback number : ' + (i + 1));
               console.log('BUNDLE_ACTIVE queryBundleActiveStates 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 in the config.json file.

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   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);
   });
   
   
   // Asynchronous callback mode
   stats.queryBundleStateInfos(0, 20000000000000, (err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE queryBundleStateInfos callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE queryBundleStateInfos callback success.');
           let i = 1;
           for(let key in res){
               console.log('BUNDLE_ACTIVE queryBundleStateInfos callback number : ' + i);
               console.log('BUNDLE_ACTIVE queryBundleStateInfos callback result ' + JSON.stringify(res[key]));
               i++;
           }
       }
   });
   

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

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   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);
   });
   
   
   // Asynchronous callback mode
   stats.queryCurrentBundleActiveStates(0, 20000000000000, (err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates callback success.');
           for (let i = 0; i < res.length; i++) {
               console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates callback number : ' + (i + 1));
               console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates 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 in the config.json file.

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   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);
   });
   
   
   // Asynchronous callback mode
   stats.queryBundleStateInfoByInterval(0, 0, 20000000000000, (err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval callback success.');
           for (let i = 0; i < res.length; i++) {
               console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval callback number : ' + (i + 1));
               console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval callback result ' + JSON.stringify(res[i]));
           }
       }
   });
   

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

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   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 mode
   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));
       }
   });
   

7. Check whether the application specified by bundleName is in the idle state. This requires no permission to be configured in the config.json file. A third-party application can only check the idle status of itself.

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   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);
   });
   
   
   // Asynchronous callback mode
   stats.isIdleState("com.ohos.camera", (err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE isIdleState callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE isIdleState callback succeeded, result: ' + JSON.stringify(res));
       }
   });
   

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 in the config.json file.

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   stats.getRecentlyUsedModules(1000).then(res => {
       console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise succeeded');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise result ' + JSON.stringify(res[i]));
       }
   }).catch(err=> {
       console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise failed, because: ' + err.code);
   });
   
   
   // Promise mode when maxNum is not specified
   stats.getRecentlyUsedModules().then(res => {
       console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise succeeded');
       for (let i = 0; i < res.length; i++) {
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise number : ' + (i + 1));
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise result ' + JSON.stringify(res[i]));
       }
   }).catch( err=> {
       console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise failed, because: ' + err.code);
   });
   
   
   // Asynchronous callback mode
   stats.getRecentlyUsedModules(1000, (err, res) => {
       if(err) {
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback succeeded.');
               for (let i = 0; i < res.length; i++) {
                   console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback number : ' + (i + 1));
                   console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback result ' + JSON.stringify(res[i]));
               }
           }
   });
   
   
   // Asynchronous callback mode when maxNum is not specified
   stats.getRecentlyUsedModules((err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback succeeded.');
               for (let i = 0; i < res.length; i++) {
                   console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback number : ' + (i + 1));
                   console.log('BUNDLE_ACTIVE getRecentlyUsedModules 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 in the config.json file.

   import stats from '@ohos.bundleState'
   
   
   // Promise mode
   stats.queryAppNotificationNumber(0, 20000000000000).then(res => {
       console.log('BUNDLE_ACTIVE queryAppNotificationNumber promise success.');
       console.log('BUNDLE_ACTIVE queryAppNotificationNumber promise result ' + JSON.stringify(res));
   }).catch(err => {
       console.log('BUNDLE_ACTIVE queryAppNotificationNumber promise failed, because: ' + err.code);
   });
   
   
   // Asynchronous callback mode
   stats.queryAppNotificationNumber(0, 20000000000000, (err, res) => {
       if (err) {
           console.log('BUNDLE_ACTIVE queryAppNotificationNumber callback failed, because: ' + err.code);
       } else {
           console.log('BUNDLE_ACTIVE queryAppNotificationNumber callback success.');
           console.log('BUNDLE_ACTIVE queryAppNotificationNumber 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 in the config.json file.

    import stats from '@ohos.bundleState'
    
    
    // Promise mode
    stats.queryBundleActiveEventStates(0, 20000000000000).then(res => {
        console.log('BUNDLE_ACTIVE queryBundleActiveEventStates promise success.');
        console.log('BUNDLE_ACTIVE queryBundleActiveEventStates promise result ' + JSON.stringify(res));
    }).catch(err => {
        console.log('BUNDLE_ACTIVE queryBundleActiveEventStates promise failed, because: ' + err.code);
    });
    
    
    // Asynchronous callback mode
    stats.queryBundleActiveEventStates(0, 20000000000000, (err, res) => {
        if (err) {
            console.log('BUNDLE_ACTIVE queryBundleActiveEventStates callback failed, because: ' + err.code);
        } else {
            console.log('BUNDLE_ACTIVE queryBundleActiveEventStates callback success.');
            console.log('BUNDLE_ACTIVE queryBundleActiveEventStates callback result ' + JSON.stringify(res));
        }
    });
    

11. Query the priority group of the current application. This requires no permission to be configured in the config.json file. Query the priority group of a specified application. This requires the ohos.permission.BUNDLE_ACTIVE_INFO permission to be configured in the config.json file.

     import stats from '@ohos.bundleState'
    
    
     // Promise mode when bundleName is not specified
     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);
     });
    
    
     // Asynchronous callback mode when bundleName is not specified
     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));
         }
     });
    let bundleName = "com.ohos.camera";
     // Promise mode when bundleName is specified
     stats.queryAppUsagePriorityGroup(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);
     });
    
    
     // Asynchronous callback mode when bundleName is specified
     stats.queryAppUsagePriorityGroup(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));
         }
     });
    

12. Set the group for the application specified by bundleName.

    import stats from '@ohos.bundleState'
    
    
    // Promise mode
    stats.setBundleGroup(this.bundleName, this.newGroup).then(() => {
        console.log('BUNDLE_ACTIVE SetBundleGroup promise succeeded.');
    }).catch( err => {
        console.log('BUNDLE_ACTIVE SetBundleGroup promise failed. because: ' + err.code);
    });
    // Asynchronous callback mode
    stats.setBundleGroup(this.bundleName, this.newGroup, (err) => {
        if (err) {
            console.log('BUNDLE_ACTIVE SetBundleGroup callback failed. because: ' + err.code);
        } else {
            console.log('BUNDLE_ACTIVE SetBundleGroup 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.

    import stats from '@ohos.bundleState'
    
    
    // Promise mode
    let onBundleGroupChanged = (err,res) => {
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack callback success.');
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result oldGroup is : ' + res.oldGroup);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result newGroup is : ' + res.newGroup);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result changeReason is : ' + res.newGroup);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result userId is : ' + res.userId);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result bundleName is : ' + res.bundleName);
    };
    stats.registerGroupCallBack(onBundleGroupChanged).then(() => {
        console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise succeeded.');
    }).catch(err => {
        console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise failed. because: ' + err.code);
    });
    // Asynchronous callback mode
    let onBundleGroupChanged = (err,res) => {
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack callback success.');
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result's oldGroup is : ' + res.oldGroup);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result's newGroup is : ' + res.newGroup);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result's changeReason is : ' + res.newGroup);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result's userId is : ' + res.userId);
        console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result's bundleName is : ' + res.bundleName);
    };
    stats.registerGroupCallBack(onBundleGroupChanged, (err) => {
        if (err) {
            console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback failed, because: ' + err.code);
        } else {
            console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback success.');
        }
    });
    

14. Deregister the callback for application group changes.

    import stats from '@ohos.bundleState'
    
    
    // Promise mode
    stats.unRegisterGroupCallBack().then(() => {
        console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise succeeded.');
    }).catch(err => {
        console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise failed. because: ' + err.code);
    });
    // Asynchronous callback mode
    stats.unRegisterGroupCallBack((err) => {
        if (err) {
            console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback failed, because: ' + err.code);
        } else {
            console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback success.');
        }
    });
    

你可能感兴趣的鸿蒙文章

harmony(鸿蒙)Device Usage Statistics

harmony(鸿蒙)Device Usage Statistics Overview