@ohos.resourceschedule.usageStatistics (Device Usage Statistics)

This module provides APIs for collecting statistics on device usage.

System applications can call these APIs to implement the following features:

• Query the usage duration in different time segments, events (foreground, background, start and end of continuous tasks), and the number of notifications, on a per application basis.
• Query statistics about system events (sleep, wakeup, unlock, and screen lock).
• Query the bundle group information of applications, including the invoking application itself.
• Query the idle status of applications, including the invoking application itself.
• Set the bundle group for other applications.
• Register and deregister the callback for application group changes.

Third-party applications can call these APIs to implement the following features:

• Query the idle status of the invoking application itself.
• Query the bundle group information of the invoking application itself.
• Query the events of the invoking application itself.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import usageStatistics from '@ohos.resourceschedule.usageStatistics'

usageStatistics.isIdleState

isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void

Checks whether the application specified by bundleName is in the idle state. This API uses an asynchronous callback to return the result. A third-party application can only check the idle status of itself.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.isIdleState("com.ohos.camera", (err, res) => {
          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));
          }
      });
  } catch(error) {
      console.log('BUNDLE_ACTIVE isIdleState throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.isIdleState

isIdleState(bundleName: string): Promise<boolean>

Checks whether the application specified by bundleName is in the idle state. This API uses a promise to return the result. A third-party application can only check the idle status of itself.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.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. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE isIdleState throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryAppGroup

queryAppGroup(): Promise<number>

Queries the group of this application. This API uses a promise to return the result.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    try{
        usageStatistics.queryAppGroup().then( res => {
            console.log('BUNDLE_ACTIVE queryAppGroup promise succeeded. result: ' + JSON.stringify(res));
        }).catch( err => {
            console.log('BUNDLE_ACTIVE queryAppGroup promise failed. code is: ' + err.code + ',message is: ' + err.message);
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE queryAppGroup throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.queryAppGroup

queryAppGroup(callback: AsyncCallback<number>): void

Queries the group of this application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    try{
        usageStatistics.queryAppGroup((err, res) => {
            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));
            }
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE queryAppGroup throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.queryBundleStatsInfos

queryBundleStatsInfos(begin: number, end: number, callback: AsyncCallback<BundleStatsMap>): void

Queries the application usage duration statistics based on the specified start time and end time. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryBundleStatsInfos(0, 20000000000000, (err, res) => {
          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.');
              let i = 1;
              for(let key in res){
                  console.log('BUNDLE_ACTIVE queryBundleStatsInfos callback number : ' + i);
                  console.log('BUNDLE_ACTIVE queryBundleStatsInfos callback result ' + JSON.stringify(res[key]));
                  i++;
              }
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryBundleStatsInfos throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryBundleStatsInfos

queryBundleStatsInfos(begin: number, end: number): Promise<BundleStatsMap>

Queries the application usage duration statistics based on the specified start time and end time. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryBundleStatsInfos(0, 20000000000000).then( res => {
          console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise success.');
          let i = 1;
          for(let key in res){
              console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise number : ' + i);
              console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise result ' + JSON.stringify(res[key]));
              i++;
          }
      }).catch( err => {
          console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryBundleStatsInfos throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryBundleStatsInfoByInterval

queryBundleStatsInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStatsInfo>>): void

Queries the application usage duration statistics in the specified time frame at the specified interval (daily, weekly, monthly, or annually). This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryBundleStatsInfoByInterval(0, 0, 20000000000000, (err, res) => {
          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]));
              }
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryBundleStatsInfoByInterval

queryBundleStatsInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise<Array<BundleStatsInfo>>

Queries the application usage duration statistics in the specified time frame at the specified interval (daily, weekly, monthly, or annually). This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryBundleStatsInfoByInterval(0, 0, 20000000000000).then( res => {
          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 => {
          console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryBundleStatsInfoByInterval throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryBundleEvents

queryBundleEvents(begin: number, end: number, callback: AsyncCallback<Array<BundleEvents>>): void

Queries events of all applications based on the specified start time and end time. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryBundleEvents(0, 20000000000000, (err, res) => {
          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]));
              }
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryBundleEvents throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryBundleEvents

queryBundleEvents(begin: number, end: number): Promise<Array<BundleEvents>>

Queries events of all applications based on the specified start time and end time. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryBundleEvents(0, 20000000000000).then( res => {
          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 => {
          console.log('BUNDLE_ACTIVE queryBundleEvents promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryBundleEvents throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryCurrentBundleEvents

queryCurrentBundleEvents(begin: number, end: number, callback: AsyncCallback<Array<BundleEvents>>): void

Queries events of this application based on the specified start time and end time. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryCurrentBundleEvents(0, 20000000000000, (err, res) => {
          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]));
              }
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryCurrentBundleEvents throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryCurrentBundleEvents

queryCurrentBundleEvents(begin: number, end: number): Promise<Array<BundleEvents>>

Queries events of this application based on the specified start time and end time. This API uses a promise to return the result.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryCurrentBundleEvents(0, 20000000000000).then( res => {
          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 => {
          console.log('BUNDLE_ACTIVE queryCurrentBundleEvents promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryCurrentBundleEvents throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryModuleUsageRecords

queryModuleUsageRecords(): Promise<Array<HapModuleInfo>>

Queries FA usage records. This API uses a promise to return a maximum of 1000 FA usage records sorted by time (most recent first).

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  // Invocation when maxNum is not passed
  try{
      usageStatistics.queryModuleUsageRecords().then( res => {
          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=> {
          console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryModuleUsageRecords throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryModuleUsageRecords

queryModuleUsageRecords(callback: AsyncCallback<Array<HapModuleInfo>>): void

Queries FA usage records. This API uses an asynchronous callback to return a maximum of 1000 FA usage records sorted by time (most recent first).

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryModuleUsageRecords((err, res) => {
      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]));
          }
      }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryModuleUsageRecords throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryModuleUsageRecords

queryModuleUsageRecords(maxNum: number): Promise<Array<HapModuleInfo>>

Queries the number of FA usage records specified by maxNum. This API uses a promise to return the records sorted by time (most recent first).

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryModuleUsageRecords(1000).then( res => {
          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=> {
          console.log('BUNDLE_ACTIVE queryModuleUsageRecords promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryModuleUsageRecords throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryModuleUsageRecords

queryModuleUsageRecords(maxNum: number, callback: AsyncCallback<Array<HapModuleInfo>>): void

Queries the number of FA usage records. This API uses an asynchronous callback to return the records sorted by time (most recent first).

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryModuleUsageRecords(1000, (err, res) => {
          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]));
              }
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryModuleUsageRecords throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryAppGroup

queryAppGroup(bundleName : string): Promise<number>

Queries the group of the application specified by bundleName. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

// Promise mode when bundleName is specified
    let bundleName = "com.ohos.camera";
    try{
        usageStatistics.queryAppGroup(bundleName).then( res => {
            console.log('BUNDLE_ACTIVE queryAppGroup promise succeeded. result: ' + JSON.stringify(res));
        }).catch( err => {
            console.log('BUNDLE_ACTIVE queryAppGroup promise failed. code is: ' + err.code + ',message is: ' + err.message);
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE queryAppGroup throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.queryAppGroup

queryAppGroup(bundleName : string, callback: AsyncCallback<number>): void

Queries the group of the application specified by bundleName. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    let bundleName = "com.ohos.camera";
    try{
        usageStatistics.queryAppGroup(bundleName, (err, res) => {
            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));
            }
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE queryAppGroup throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.setAppGroup

setAppGroup(bundleName: string, newGroup: GroupType): Promise<void>

Sets a group for the application specified by bundleName. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Return value

Example

    let bundleName = "com.example.deviceUsageStatistics";
    let newGroup = usageStatistics.GroupType.DAILY_GROUP;

    try{
        usageStatistics.setAppGroup(bundleName, newGroup).then( () => {
            console.log('BUNDLE_ACTIVE setAppGroup promise succeeded.');
        }).catch( err => {
            console.log('BUNDLE_ACTIVE setAppGroup promise failed. code is: ' + err.code + ',message is: ' + err.message);
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE setAppGroup throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.setAppGroup

setAppGroup(bundleName: string, newGroup: GroupType, callback: AsyncCallback<void>): void

Sets a group for the application specified by bundleName. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    let bundleName = "com.example.deviceUsageStatistics";
    let newGroup = usageStatistics.GroupType.DAILY_GROUP;

    try{
        usageStatistics.setAppGroup(bundleName, newGroup, (err) => {
            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.');
            }
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE setAppGroup throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.registerAppGroupCallBack

registerAppGroupCallBack(groupCallback: Callback<AppGroupCallbackInfo>): Promise<void>

Registers a callback for application group changes. When an application group of the user changes, an AppGroupCallbackInfo instance is returned to all applications that have registered the callback. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Return value

Example

    let onBundleGroupChanged = (res) =>{
        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);
    };
    try{
        usageStatistics.registerAppGroupCallBack(onBundleGroupChanged).then( () => {
            console.log('BUNDLE_ACTIVE registerAppGroupCallBack promise succeeded.');
        }).catch( err => {
            console.log('BUNDLE_ACTIVE registerAppGroupCallBack promise failed. code is: ' + err.code + ',message is: ' + err.message);
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.registerAppGroupCallBack

registerAppGroupCallBack(groupCallback: Callback<AppGroupCallbackInfo>, callback: AsyncCallback<void>): void

Registers a callback for application group changes. When an application group of the user changes, an AppGroupCallbackInfo instance is returned to all applications that have registered the callback. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    // @ts-nocheck
    let onBundleGroupChanged = (err, res) =>{
        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);
    };
    try{
        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.');
            }
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE registerAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.unregisterAppGroupCallBack

unregisterAppGroupCallBack(): Promise<void>

Deregisters the callback for application group changes. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    try{
        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);
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.unregisterAppGroupCallBack

unregisterAppGroupCallBack(callback: AsyncCallback<void>): void;

Deregisters the callback for application group changes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

    try{
        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.');
            }
        });
    } catch (error) {
        console.log('BUNDLE_ACTIVE unregisterAppGroupCallBack throw error, code is: ' + error.code + ',message is: ' + error.message);
    }

usageStatistics.queryDeviceEventStats

queryDeviceEventStats(begin: number, end: number): Promise<Array<DeviceEventStats>>

Queries statistics about system events (hibernation, wakeup, unlocking, and screen locking) that occur between the specified start time and end time. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryDeviceEventStats(0, 20000000000000).then( res => {
          console.log('BUNDLE_ACTIVE queryDeviceEventStates promise success.');
          console.log('BUNDLE_ACTIVE queryDeviceEventStates promise result ' + JSON.stringify(res));
      }).catch( err=> {
          console.log('BUNDLE_ACTIVE queryDeviceEventStats promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryDeviceEventStats throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryDeviceEventStats

queryDeviceEventStats(begin: number, end: number, callback: AsyncCallback<Array<DeviceEventStats>>): void

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryDeviceEventStats(0, 20000000000000, (err, res) => {
          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));
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryDeviceEventStats throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryNotificationEventStats

queryNotificationEventStats(begin: number, end: number): Promise<Array<DeviceEventStats>>

Queries the number of notifications from all applications based on the specified start time and end time. This API uses a promise to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryNotificationEventStats(0, 20000000000000).then( res => {
          console.log('BUNDLE_ACTIVE queryNotificationEventStats promise success.');
          console.log('BUNDLE_ACTIVE queryNotificationEventStats promise result ' + JSON.stringify(res));
      }).catch( err=> {
          console.log('BUNDLE_ACTIVE queryNotificationEventStats promise failed. code is: ' + err.code + ',message is: ' + err.message);
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryNotificationEventStats throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

usageStatistics.queryNotificationEventStats

queryNotificationEventStats(begin: number, end: number, callback: AsyncCallback<Array<DeviceEventStats>>): void

Queries the number of notifications from all applications based on the specified start time and end time. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see DeviceUsageStatistics Error Codes.

Example

  try{
      usageStatistics.queryNotificationEventStats(0, 20000000000000, (err, res) => {
          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));
          }
      });
  } catch (error) {
      console.log('BUNDLE_ACTIVE queryNotificationEventStats throw error, code is: ' + error.code + ',message is: ' + error.message);
  }

HapModuleInfo

Provides the information about the FA usage.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

HapFormInfo

Provides the FA widget usage information.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

AppGroupCallbackInfo

Provides the application group changes returned through a callback.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

BundleStatsInfo

Provides the usage duration information of an application.

Attributes

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

BundleEvents

Provides information about an application event.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

BundleStatsMap

Provides the usage duration information of an application.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

DeviceEventStats

Provides statistics about notifications and system events.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

IntervalType

Enumerates the interval types for querying the application usage duration.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

GroupType

Enumerates the application group types.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.