harmony 鸿蒙@ohos.bundleState (设备使用信息统计)

  • 2022-08-09
  • 浏览 (712)

@ohos.bundleState (设备使用信息统计)

本模块提供设备使用信息统计能力。

设备使用信息统计，系统应用可调用接口实现如下功能：

  • 查询设备上各应用在不同时间段的使用时长、各应用的事件（前台、后台、长时任务开始、长时任务结束）信息及各应用的通知次数信息。
  • 查询应用分组信息（仅限自身应用）。
  • 查询应用空闲状态（其他应用和自身应用）。

三方应用可调用接口实现如下功能：

  • 查询应用空闲状态（仅限自身应用）。
  • 查询应用分组信息（仅限自身应用）。
  • 查询应用事件（仅限自身应用）。

说明：

从API version9开始，该接口不再维护，推荐使用新接口@ohos.resourceschedule.usageStatistics(设备使用信息统计)

本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import bundleState from '@ohos.bundleState'

bundleState.isIdleState

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

判断指定bundleName的应用当前是否是空闲状态，三方应用只能查询自身的空闲状态，查询其他应用空闲状态，需要申请权限ohos.permission.BUNDLE_ACTIVE_INFO，使用Callback形式返回。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

参数：

参数名 类型 必填 说明
bundleName string 是 应用的bundleName。
callback AsyncCallback<boolean> 是 指定的callback回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。

示例：

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

bundleState.isIdleState("com.ohos.camera", (err: BusinessError, res: boolean) => {
  if (err) {
    console.log('BUNDLE_ACTIVE isIdleState callback failed, because: ' + err.code);
  } else {
    console.log('BUNDLE_ACTIVE isIdleState callback succeeded, result: ' + JSON.stringify(res));
  }
});

bundleState.isIdleState

isIdleState(bundleName: string): Promise<boolean>

判断指定bundleName的应用当前是否是空闲状态，三方应用只能查询自身的空闲状态，查询其他应用空闲状态，需要申请权限ohos.permission.BUNDLE_ACTIVE_INFO，使用Promise形式返回。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

参数：

参数名 类型 必填 说明
bundleName string 是 应用的bundleName。

返回值：

类型 说明
Promise<boolean> 指定的Promise回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。

示例：

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

bundleState.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, because: ' + err.code);
});

bundleState.queryAppUsagePriorityGroup

queryAppUsagePriorityGroup(): Promise<number>

查询当前应用的优先级分组。使用Promise形式返回其应用分组。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

返回值：

类型 说明
Promise<number> 指定的Promise回调方法。返回查询的应用分组结果。

示例：

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

bundleState.queryAppUsagePriorityGroup().then((res: number) => {
  console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch((err: BusinessError) => {
  console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});

bundleState.queryAppUsagePriorityGroup

queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void

查询当前应用的优先级分组。使用callback形式返回其应用分组。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup

参数：

参数名 类型 必填 说明
callback AsyncCallback<number> 是 指定的CallBack回调方法。返回查询的应用分组。

示例：

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

bundleState.queryAppUsagePriorityGroup((err: BusinessError, res: number) => {
  if(err) {
    console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code);
  } else {
    console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res));
  }
});

bundleState.queryBundleStateInfos

queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<BundleActiveInfoResponse>): void

通过指定起始和结束时间查询应用使用时长统计信息，使用Callback形式返回。

需要权限：ohos.permission.BUNDLE_ACTIVE_INFO

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

系统API：此接口为系统接口，三方应用不支持调用。

参数：

参数名 类型 必填 说明
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。
callback AsyncCallback<BundleActiveInfoResponse> 是 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。

示例：

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

bundleState.queryBundleStateInfos(0, 20000000000000, (err: BusinessError ,
  res: bundleState.BundleActiveInfoResponse ) => {
  if (err) {
    console.log('BUNDLE_ACTIVE queryBundleStateInfos callback failed, because: ' + err.code);
  } else {
    console.log('BUNDLE_ACTIVE queryBundleStateInfos callback success.');
    console.log('BUNDLE_ACTIVE queryBundleStateInfos callback result ' + JSON.stringify(res));
  }
});

bundleState.queryBundleStateInfos

queryBundleStateInfos(begin: number, end: number): Promise<BundleActiveInfoResponse>

通过指定起始和结束时间查询应用使用时长统计信息，使用Promise形式返回。

需要权限：ohos.permission.BUNDLE_ACTIVE_INFO

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

系统API：此接口为系统接口，三方应用不支持调用。

参数：

参数名 类型 必填 说明
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。

返回值：

类型 说明
Promise<BundleActiveInfoResponse> 指定的Promise回调方法。返回指定起始和结束时间内应用使用时长统计信息。

示例：

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

bundleState.queryBundleStateInfos(0, 20000000000000).then((res: bundleState.BundleActiveInfoResponse) => {
  console.log('BUNDLE_ACTIVE queryBundleStateInfos promise success.');
  console.log('BUNDLE_ACTIVE queryBundleStateInfos promise result ' + JSON.stringify(res));
}).catch((err: BusinessError) => {
  console.log('BUNDLE_ACTIVE queryBundleStateInfos promise failed, because: ' + err.code);
});

bundleState.queryBundleStateInfoByInterval

queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStateInfo>>): void

通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，使用Callback形式返回。

需要权限：ohos.permission.BUNDLE_ACTIVE_INFO

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

系统API：此接口为系统接口，三方应用不支持调用。

参数：

参数名 类型 必填 说明
byInterval IntervalType 是 查询类型。
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。
callback AsyncCallback<Array<BundleStateInfo>> 是 指定的callback回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。

示例：

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

bundleState.queryBundleStateInfoByInterval(bundleState.IntervalType.BY_OPTIMIZED, 0, 20000000000000, (err: BusinessError, res: Array<bundleState.BundleStateInfo>) => {
  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]));
    }
  }
});

bundleState.queryBundleStateInfoByInterval

queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise&lt;Array&lt;BundleStateInfo&gt;&gt;

通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，使用Promise形式返回。

需要权限：ohos.permission.BUNDLE_ACTIVE_INFO

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

系统API：此接口为系统接口，三方应用不支持调用。

参数：

参数名 类型 必填 说明
byInterval IntervalType 是 查询类型。
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。

返回值：

类型 说明
Promise&lt;Array&lt;BundleStateInfo&gt;&gt; 指定的Promise回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。

示例：

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

bundleState.queryBundleStateInfoByInterval(bundleState.IntervalType.BY_OPTIMIZED, 0, 20000000000000).then((res: Array<bundleState.BundleStateInfo>) => {
  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: BusinessError) => {
  console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise failed, because: ' + err.code);
});

bundleState.queryBundleActiveStates

queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveState&gt;&gt;): void

通过指定起始和结束时间查询所有应用的事件集合，使用Callback形式返回。

需要权限：ohos.permission.BUNDLE_ACTIVE_INFO

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

系统API：此接口为系统接口，三方应用不支持调用。

参数：

参数名 类型 必填 说明
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。
callback AsyncCallback&lt;Array&lt;BundleActiveState&gt;&gt; 是 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。

示例：

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

bundleState.queryBundleActiveStates(0, 20000000000000, (err: BusinessError, res: Array<bundleState.BundleActiveState>) => {
  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]));
    }
  }
});

bundleState.queryBundleActiveStates

queryBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleActiveState&gt;&gt;

通过指定起始和结束时间查询所有应用的事件集合，使用Promise形式返回。

需要权限：ohos.permission.BUNDLE_ACTIVE_INFO

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

系统API：此接口为系统接口，三方应用不支持调用。

参数：

参数名 类型 必填 说明
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。

返回值：

类型 说明
Promise&lt;Array&lt;BundleActiveState&gt;&gt; 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的事件集合。

示例：

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

bundleState.queryBundleActiveStates(0, 20000000000000).then((res: Array<bundleState.BundleActiveState>) => {
  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: BusinessError) => {
  console.log('BUNDLE_ACTIVE queryBundleActiveStates promise failed, because: ' + err.code);
});

bundleState.queryCurrentBundleActiveStates

queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveState&gt;&gt;): void

通过指定起始和结束时间查询当前应用的事件集合，使用Callback形式返回。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

参数：

参数名 类型 必填 说明
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。
callback AsyncCallback&lt;Array&lt;BundleActiveState&gt;&gt; 是 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。

示例：

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

bundleState.queryCurrentBundleActiveStates(0, 20000000000000, (err: BusinessError, res: Array<bundleState.BundleActiveState>) => {
  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]));
    }
  }
});

bundleState.queryCurrentBundleActiveStates

queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleActiveState&gt;&gt;

通过指定起始和结束时间查询当前应用的事件集合，使用Promise形式返回。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

参数：

参数名 类型 必填 说明
begin number 是 起始时间，单位毫秒。
end number 是 结束时间，单位毫秒。

返回值：

类型 说明
Promise&lt;Array&lt;BundleActiveState&gt;&gt; 指定的Promise回调方法。返回指定起始和结束时间查询当前应用的事件集合。

示例：

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

bundleState.queryCurrentBundleActiveStates(0, 20000000000000).then((res: Array<bundleState.BundleActiveState>) => {
  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: BusinessError) => {
  console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise failed, because: ' + err.code);
});

BundleStateInfo

提供应用使用时长的具体信息。

属性

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App

名称 类型 必填 说明
bundleName string 是 应用包名。
abilityPrevAccessTime number 是 应用最后一次使用的时间。
abilityInFgTotalTime number 是 应用在前台使用的总时间。
id number 否 用户id。
abilityPrevSeenTime number 否 应用最后一次在前台可见的时间。
abilitySeenTotalTime number 否 应用在前台可见的总时间。
fgAbilityAccessTotalTime number 否 应用访问前台的总时间。
fgAbilityPrevAccessTime number 否 应用最后一次访问前台的时间。
infosBeginTime number 否 BundleActiveInfo对象中第一条应用使用统计的记录时间。
infosEndTime number 否 BundleActiveInfo对象中最后一条应用使用统计的记录时间。

merge(deprecated)

merge(toMerge: BundleStateInfo): void

合并相同包名的应用使用信息。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

参数：

参数名 类型 必填 说明
toMerge BundleStateInfo 是 相同包名的应用使用统计信息。

BundleActiveState

提供应用事件的具体信息。

提供应用使用时长的具体信息。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App

名称 类型 必填 说明
bundleName string 是 应用包名。
stateType number 是 应用事件类型。
stateOccurredTime number 是 应用事件发生的时间戳。
appUsagePriorityGroup number 否 应用程序的使用优先级组。
indexOfLink string 否 快捷方式id。
nameOfClass string 否 类名。

BundleActiveInfoResponse

提供应用使用时长的具体信息。

系统能力：SystemCapability.ResourceSchedule.UsageStatistics.App

参数名 类型 必填 说明
[key: string]: BundleStateInfo [key: string]: BundleStateInfo 是 不同应用的使用时长统计信息。

IntervalType

提供应用使用时长的查询类型。

系统能力：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App

名称 值 说明
BY_OPTIMIZED 0 表示系统自行判断最合适的查询类型（天、周、月、年）去查询指定时间段间隔的应用使用时长信息。
BY_DAILY 1 表示系统按照天去查询指定时间段间隔的应用使用时长信息。
BY_WEEKLY 2 表示系统按照周去查询指定时间段间隔的应用使用时长信息。
BY_MONTHLY 3 表示系统按照月去查询指定时间段间隔的应用使用时长信息。
BY_ANNUALLY 4 表示系统按照年去查询指定时间段间隔的应用使用时长信息。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

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

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

0  赞
  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/80fe8d8a98414c0c8f5998a0cb415f9f
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录