From 14f5ce97a3b78292826cf38ebf27a0aeef56a7f2 Mon Sep 17 00:00:00 2001 From: wyuanchao Date: Mon, 21 Mar 2022 11:46:40 +0800 Subject: [PATCH] modify docs format Signed-off-by: wyuanchao --- .../apis/js-apis-deviceUsageStatistics.md | 79 ++++++++++++++----- 1 file changed, 58 insertions(+), 21 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md index c056a071804..92dda87197d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md @@ -11,7 +11,9 @@ import bundleState from '@ohos.bundleState' ``` ## bundleState.isIdleState -isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void
+ +isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void + 判断指定bundleName的应用当前是否是空闲状态，使用Callback形式返回。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup @@ -36,7 +38,9 @@ isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void
+ +isIdleState(bundleName: string): Promise<boolean> + 判断指定bundleName的应用当前是否是空闲状态，使用Promise形式返回。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup @@ -64,7 +68,9 @@ isIdleState(bundleName: string): Promise<boolean>
``` ## bundleState.queryAppUsagePriorityGroup -queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void
+ +queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void + 查询（返回）当前调用者应用的使用优先级群组，使用Callback形式返回。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup @@ -88,7 +94,9 @@ queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void
``` ## bundleState.queryAppUsagePriorityGroup -queryAppUsagePriorityGroup(): Promise<number>
+ +queryAppUsagePriorityGroup(): Promise<number> + 查询（返回）当前调用者应用的使用优先级群组，使用Promise形式返回。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.AppGroup @@ -110,8 +118,11 @@ queryAppUsagePriorityGroup(): Promise<number>
``` ## bundleState.queryBundleStateInfos -queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<BundleActiveInfoResponse>): void
-通过指定起始和结束时间查询应用使用时长统计信息，使用Callback形式返回。
+ +queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<BundleActiveInfoResponse>): void + +通过指定起始和结束时间查询应用使用时长统计信息，使用Callback形式返回。 + **需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -143,8 +154,11 @@ queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<Bun ``` ## bundleState.queryBundleStateInfos -queryBundleStateInfos(begin: number, end: number): Promise<BundleActiveInfoResponse>
-通过指定起始和结束时间查询应用使用时长统计信息，使用Promise形式返回。
+ +queryBundleStateInfos(begin: number, end: number): Promise<BundleActiveInfoResponse> + +通过指定起始和结束时间查询应用使用时长统计信息，使用Promise形式返回。 + **需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -179,8 +193,11 @@ queryBundleStateInfos(begin: number, end: number): Promise<BundleActiveInfoRe ``` ## bundleState.queryBundleStateInfoByInterval -queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStateInfo>>): void
-通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，使用Callback形式返回。
+ +queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback<Array<BundleStateInfo>>): void + +通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，使用Callback形式返回。 + **需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -211,8 +228,11 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num ``` ## bundleState.queryBundleStateInfoByInterval -queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise<Array<BundleStateInfo>>
-通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，使用Promise形式返回。
+ +queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise<Array<BundleStateInfo>> + +通过指定时间段间隔（天、周、月、年）查询应用使用时长统计信息，使用Promise形式返回。 + **需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -246,8 +266,11 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num ``` ## bundleState.queryBundleActiveStates -queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void
-通过指定起始和结束时间查询所有应用的事件集合，使用Callback形式返回。
+ +queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void + +通过指定起始和结束时间查询所有应用的事件集合，使用Callback形式返回。 + **需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -277,8 +300,11 @@ queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback<A ``` ## bundleState.queryBundleActiveStates -queryBundleActiveStates(begin: number, end: number): Promise<Array<BundleActiveState>>
-通过指定起始和结束时间查询所有应用的事件集合，使用Promise形式返回。
+ +queryBundleActiveStates(begin: number, end: number): Promise<Array<BundleActiveState>> + +通过指定起始和结束时间查询所有应用的事件集合，使用Promise形式返回。 + **需要权限**：ohos.permission.BUNDLE_ACTIVE_INFO **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -311,7 +337,9 @@ queryBundleActiveStates(begin: number, end: number): Promise<Array<BundleA ``` ## bundleState.queryCurrentBundleActiveStates -queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void
+ +queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback<Array<BundleActiveState>>): void + 通过指定起始和结束时间查询当前应用的事件集合，使用Callback形式返回。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -341,7 +369,9 @@ queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallba ``` ## bundleState.queryCurrentBundleActiveStates -queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array<BundleActiveState>>
+ +queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array<BundleActiveState>> + 通过指定起始和结束时间查询当前应用的事件集合，使用Promise形式返回。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -377,6 +407,7 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array< 提供应用使用时长的具体信息。 ### 属性 + **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App | 参数名 | 类型 | 必填 | 说明 | @@ -390,11 +421,14 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array< | fgAbilityAccessTotalTime | number | 否 | 应用访问前台的总时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| | fgAbilityPrevAccessTime | number | 否 | 应用最后一次访问前台的时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| | infosBeginTime | number | 否 | BundleActiveInfo对象中第一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| -| infosBeginTime | number | 否 | BundleActiveInfo对象中最后一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| +| infosEndTime | number | 否 | BundleActiveInfo对象中最后一条应用使用统计的记录时间。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| ### merge + merge(toMerge: BundleStateInfo): void -合并相同包名的应用使用信息。
+ +合并相同包名的应用使用信息。 + 本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App @@ -406,6 +440,7 @@ merge(toMerge: BundleStateInfo): void | toMerge | [BundleStateInfo](#bundlestateinfo) | 是 | 相同包名的应用使用统计信息。| ## BundleActiveState + 提供应用事件的具体信息。 **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App @@ -420,15 +455,17 @@ merge(toMerge: BundleStateInfo): void | nameOfClass | string | 否 | 类名。
本接口在OpenHarmony 3.1 Release版本仅为接口定义，暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。| ## BundleActiveInfoResponse + 提供应用使用时长的具体信息。 **系统能力**：SystemCapability.ResourceSchedule.UsageStatistics.App | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | -| [key: string]: BundleStateInfo | [BundleStateInfo](#bundlestateinfo) | 是 | 不同应用的使用时长统计信息。| +| [key: string]: BundleStateInfo | [key: string]: [BundleStateInfo](#bundlestateinfo) | 是 | 不同应用的使用时长统计信息。| ## IntervalType + 提供应用使用时长的查询类型。 **系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App -- Gitee