@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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. If the specified bundleName is valid, the idle state of the application is returned; otherwise, null is returned.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.

Example

import { BusinessError } from '@ohos.base';

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));
  }
});

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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
Promise<boolean>	Promise used to return the result. If the specified bundleName is valid, the idle state of the application is returned; otherwise, null is returned.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.

Example

import { BusinessError } from '@ohos.base';

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);
});

usageStatistics.isIdleStateSync¹⁰⁺

isIdleStateSync(bundleName: string): boolean

Checks whether the application specified by bundleName is in the idle state. 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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
boolean	Returns true if the application is in the idle state; returns false otherwise, on the prerequisite that the specified bundleName is valid.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.

Example

let isIdleState: boolean = usageStatistics.isIdleStateSync("com.ohos.camera");

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

Type	Description
Promise<number>	Promise used to return the group.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000005	Application is not installed.
10000006	Failed to get the application information.
10100002	Failed to get the application group information.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the group.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000005	Application is not installed.
10000006	Failed to get the application information.
10100002	Failed to get the application group information.

Example

import { BusinessError } from '@ohos.base';

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));
  }
});

usageStatistics.queryAppGroupSync¹⁰⁺

queryAppGroupSync(): number;

Queries the group of this application.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Return value

Type	Description
number	Group of the application.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000005	Application is not installed.
10000006	Failed to get the application information.
10100002	Failed to get the application group information.

Example

let priorityGroup: number = usageStatistics.queryAppGroupSync();

usageStatistics.queryAppGroupSync¹⁰⁺

queryAppGroupSync(bundleName: string): number

Queries the group of the application specified by bundleName.

Required permissions: ohos.permission.BUNDLE_ACTIVE_INFO

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
number	Group of the application.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000005	Application is not installed.
10000006	Failed to get the application information.
10100002	Failed to get the application group information.

Example

let priorityGroup: number = usageStatistics.queryAppGroupSync("com.ohos.camera");

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.
callback	AsyncCallback<BundleStatsMap>	Yes	Callback used to return the application usage duration statistics.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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));
  }
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.

Return value

Type	Description
Promise<BundleStatsMap>	Promise used to return the application usage duration statistics.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

usageStatistics.queryBundleStatsInfos(0, 20000000000000).then((res:usageStatistics.BundleStatsMap) => {
  console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise success.');
  console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise result ' + JSON.stringify(res));
}).catch((err: BusinessError) => {
  console.log('BUNDLE_ACTIVE queryBundleStatsInfos promise failed. code is: ' + err.code + ',message is: ' + err.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

Name	Type	Mandatory	Description
byInterval	IntervalType	Yes	Type of information to be queried.
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.
callback	AsyncCallback<Array<BundleStatsInfo>>	Yes	Callback used to return the application usage duration statistics.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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]));
    }
  }
});

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

Name	Type	Mandatory	Description
byInterval	IntervalType	Yes	Type of information to be queried.
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.

Return value

Type	Description
Promise<Array<BundleStatsInfo>>	Promise used to return the application usage duration statistics.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.
callback	AsyncCallback<Array<BundleEvents>>	Yes	Callback used to return the events obtained.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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]));
    }
  }
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.

Return value

Type	Description
Promise<Array<BundleEvents>>	Promise used to return the events obtained.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.
callback	AsyncCallback<Array<BundleEvents>>	Yes	Callback used to return the events obtained.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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]));
    }
  }
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.

Return value

Type	Description
Promise<Array<BundleEvents>>	Promise used to return the events obtained.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Type	Description
Promise<Array<HapModuleInfo>>	Promise used to return a maximum of 1000 FA usage records.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

// Invocation when maxNum is not passed
import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
callback	AsyncCallback<Array<HapModuleInfo>>	Yes	Callback used to return a maximum of maxNum FA usage records.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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]));
    }
  }
});

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

Name	Type	Mandatory	Description
maxNum	number	Yes	Maximum number of returned records. The maximum and default value is 1000.

Return value

Type	Description
Promise<Array<HapModuleInfo>>	Promise used to return a maximum of maxNum FA usage records.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
maxNum	number	Yes	Maximum number of returned records. The maximum value is 1000.
callback	AsyncCallback<Array<HapModuleInfo>>	Yes	Callback used to return a maximum of maxNum FA usage records.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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]));
    }
  }
});

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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.

Return value

Type	Description
Promise<number>	Promise used to return the group.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000005	Application is not installed.
10000006	Failed to get the application information.
10100002	Failed to get the application group information.

Example

// Promise mode when bundleName is specified
import { BusinessError } from '@ohos.base';

let bundleName: string = "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);
});

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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
callback	AsyncCallback<number>	Yes	Callback used to return the group.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000005	Application is not installed.
10000006	Failed to get the application information.
10100002	Failed to get the application group information.

Example

import { BusinessError } from '@ohos.base';

let bundleName: string = "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));
  }
});

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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
newGroup	GroupType	Yes	Group to set.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10100001	Repeated operation on the application group.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

let bundleName: string = "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);
});

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

Name	Type	Mandatory	Description
bundleName	string	Yes	Bundle name of the application.
newGroup	GroupType	Yes	Group to set.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10100001	Repeated operation on the application group.

Example

import { BusinessError } from '@ohos.base';

let bundleName: string = "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.');
  }
});

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

Name	Type	Mandatory	Description
callback	Callback<AppGroupCallbackInfo>	Yes	Callback used to return the application group changes.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10100001	Repeated operation on the application group.

Return value

Type	Description
Promise<void>	Promise used to return the result.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
groupCallback	Callback<AppGroupCallbackInfo>	Yes	Callback used to return the application group changes.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10100001	Repeated operation on the application group.

Example

import { BusinessError } from '@ohos.base';

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.');
  }
});

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

Type	Description
Promise<void>	Promise used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10100001	Repeated operation on the application group.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10100001	Repeated operation on the application group.

Example

import { BusinessError } from '@ohos.base';

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.');
  }
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.

Return value

Type	Description
Promise<Array<DeviceEventStats>>	Promise used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.
callback	AsyncCallback<Array<DeviceEventStats>>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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));
  }
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.

Return value

Type	Description
Promise<Array<DeviceEventStats>>	Promise used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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);
});

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

Name	Type	Mandatory	Description
begin	number	Yes	Start time, in milliseconds.
end	number	Yes	End time, in milliseconds.
callback	AsyncCallback<Array<DeviceEventStats>>	Yes	Callback used to return the result.

Error codes

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

ID	Error Message
10000001	Memory operation failed.
10000002	Parcel operation failed.
10000003	System service operation failed.
10000004	IPC failed.
10000006	Failed to get the application information.
10000007	Failed to get the system time.

Example

import { BusinessError } from '@ohos.base';

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));
  }
});

HapModuleInfo

Provides the information about the FA usage.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Type	Mandatory	Description
deviceId	string	No	ID of the device to which the FA belongs.
bundleName	string	Yes	Name of the bundle to which the FA belongs.
moduleName	string	Yes	Name of the module to which the FA belongs.
abilityName	string	No	MainAbility name of the FA.
appLabelId	number	No	Application label ID of the FA.
labelId	number	No	Label ID of the module to which the FA belongs.
descriptionId	number	No	Description ID of the application to which the FA belongs.
abilityLableId	number	No	MainAbility label ID of the FA.
abilityDescriptionId	number	No	MainAbility description ID of the FA.
abilityIconId	number	No	MainAbility icon ID of the FA.
launchedCount	number	Yes	Number of FA startup times.
lastModuleUsedTime	number	Yes	Last time when the FA was used.
formRecords	Array<HapFormInfo>	Yes	Array of widget usage records in the FA.

HapFormInfo

Provides the FA widget usage information.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Type	Mandatory	Description
formName	string	Yes	Widget name.
formDimension	number	Yes	Widget dimensions.
formId	number	Yes	Widget ID.
formLastUsedTime	number	Yes	Last time when the widget was clicked.
count	number	Yes	Number of clicks on the widget.

AppGroupCallbackInfo

Provides the application group changes returned through a callback.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Name	Type	Mandatory	Description
appOldGroup	number	Yes	Application group before the change.
appNewGroup	number	Yes	Application group after the change.
userId	number	Yes	User ID.
changeReason	number	Yes	Reason for the group change.
bundleName	string	Yes	Bundle name of the application.

BundleStatsInfo

Provides the usage duration information of an application.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Type	Mandatory	Description
bundleName	string	No	Bundle name of the application.
abilityPrevAccessTime	number	No	Last time when the application was used.
abilityInFgTotalTime	number	No	Total time that the application runs in the foreground.
id	number	Yes	User ID.
abilityPrevSeenTime	number	No	Last time when the application was visible in the foreground.
abilitySeenTotalTime	number	No	Total time that the application is visible in the foreground.
fgAbilityAccessTotalTime	number	No	Total time that the application accesses the foreground.
fgAbilityPrevAccessTime	number	No	Last time when the application accessed the foreground.
infosBeginTime	number	No	Time logged in the first application usage record in the BundleActiveInfo object.
infosEndTime	number	No	Time logged in the last application usage record in the BundleActiveInfo object.

BundleEvents

Provides information about an application event.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Type	Mandatory	Description
bundleName	string	No	Bundle name of the application.
eventId	number	No	Application event type.
eventOccurredTime	number	No	Timestamp when the application event occurs.
appGroup	number	No	Usage priority group of the application.
indexOfLink	string	No	Shortcut ID.
nameOfClass	string	No	Class name.

BundleStatsMap

Provides the usage duration information of an application.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Type	Mandatory	Description
[key: string]	BundleStatsInfo	Yes	Usage duration information by application.

DeviceEventStats

Provides statistics about notifications and system events.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Type	Mandatory	Description
name	string	Yes	Bundle name of the notification sending application or system event name.
eventId	number	Yes	Type of the notification or system event.
count	number	Yes	Number of application notifications or system event triggering times.

IntervalType

Enumerates the interval types for querying the application usage duration.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.App

System API: This is a system API.

Name	Value	Description
BY_OPTIMIZED	0	The system queries the application usage duration statistics in the specified time frame at the interval the system deems appropriate.
BY_DAILY	1	The system queries the application usage duration statistics in the specified time frame on a daily basis.
BY_WEEKLY	2	The system queries the application usage duration statistics in the specified time frame on a weekly basis.
BY_MONTHLY	3	The system queries the application usage duration statistics in the specified time frame on a monthly basis.
BY_ANNUALLY	4	The system queries the application usage duration statistics in the specified time frame on an annual basis.

GroupType

Enumerates the application group types.

System capability: SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

System API: This is a system API.

Name	Value	Description
ALIVE_GROUP	10	Group of active applications.
DAILY_GROUP	20	Group of frequently used applications that are not in the active state.
FIXED_GROUP	30	Group of applications that are used periodically but not every day.
RARE_GROUP	40	Group of rarely used applications.
LIMITED_GROUP	50	Group of restricted applications.
NEVER_GROUP	60	Group of applications that have been installed but never run.

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)