提交 28aa2bc9 编写于 作者: Y yupeng74@huawei.com

文档修改,支持错误码和变更说明和跳转

Signed-off-by: Nyupeng74@huawei.com <yupeng74@huawei.com>
上级 7aaa3738
# 设备使用信息统计
- [设备使用信息统计概述](device-usage-statistics-overview.md)
- [设备使用信息统计开发指导(待废弃)](device-usage-statistics-dev-guide.md)
- [设备使用信息统计开发指导(新版本)](device-usage-statistics-use-guide.md)
\ No newline at end of file
- [设备使用信息统计开发指导(API7)](device-usage-statistics-dev-guide.md)
- [设备使用信息统计开发指导(API9)](device-usage-statistics-use-guide.md)
\ No newline at end of file
......@@ -15,7 +15,8 @@
- 查询应用事件(仅限自身应用)。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。从API version 9开始,导入模块由@ohos.backgroundTaskManager迁移至@ohos.resourceschedule.backgroundTaskManager
> 设备使用信息统计错误码见[DeviceUsageStatistics错误码](../errorcodes/errcode-DeviceUsageStatistics.md)。
## 导入模块
......@@ -24,12 +25,16 @@
import bundleState from '@ohos.bundleState'
```
## bundleState.isIdleState
## bundleState.isIdleState<sup>(deprecated)</sup>
isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
判断指定bundleName的应用当前是否是空闲状态,三方应用只能查询自身的空闲状态,使用Callback形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.isIdleState](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsisidlestate)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数**
......@@ -51,12 +56,16 @@ isIdleState(bundleName: string, callback: AsyncCallback&lt;boolean&gt;): void
});
```
## bundleState.isIdleState
## bundleState.isIdleState<sup>(deprecated)</sup>
isIdleState(bundleName: string): Promise&lt;boolean&gt;
判断指定bundleName的应用当前是否是空闲状态,三方应用只能查询自身的空闲状态,使用Promise形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.isIdleState](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsisidlestate)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数**
......@@ -81,12 +90,16 @@ isIdleState(bundleName: string): Promise&lt;boolean&gt;
});
```
## bundleState.queryAppUsagePriorityGroup
## bundleState.queryAppUsagePriorityGroup<sup>(deprecated)</sup>
queryAppUsagePriorityGroup(): Promise&lt;number&gt;
查询当前应用的优先级分组。使用Promise形式返回其应用分组。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryAppGroup](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsqueryappgroup)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**返回值**
......@@ -105,12 +118,16 @@ bundleState.queryAppUsagePriorityGroup().then( res => {
});
```
## bundleState.queryAppUsagePriorityGroup
## bundleState.queryAppUsagePriorityGroup<sup>(deprecated)</sup>
queryAppUsagePriorityGroup(callback: AsyncCallback&lt;number&gt;): void
查询当前应用的优先级分组。使用callback形式返回其应用分组。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryAppGroup](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsqueryappgroup)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.AppGroup
**参数**
......@@ -131,12 +148,16 @@ bundleState.queryAppUsagePriorityGroup((err, res) => {
});
```
## bundleState.queryBundleStateInfos
## bundleState.queryBundleStateInfos<sup>(deprecated)</sup>
queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback&lt;BundleActiveInfoResponse&gt;): void
通过指定起始和结束时间查询应用使用时长统计信息,使用Callback形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryBundleStatsInfos](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerybundlestatsinfos)
>
> 从API7开始支持
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -169,12 +190,16 @@ queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback&lt;Bun
});
```
## bundleState.queryBundleStateInfos
## bundleState.queryBundleStateInfos<sup>(deprecated)</sup>
queryBundleStateInfos(begin: number, end: number): Promise&lt;BundleActiveInfoResponse&gt;
通过指定起始和结束时间查询应用使用时长统计信息,使用Promise形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryBundleStatsInfos](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerybundlestatsinfos)
>
> 从API7开始支持
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -210,12 +235,16 @@ queryBundleStateInfos(begin: number, end: number): Promise&lt;BundleActiveInfoRe
});
```
## bundleState.queryBundleStateInfoByInterval
## bundleState.queryBundleStateInfoByInterval<sup>(deprecated)</sup>
queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleStateInfo&gt;&gt;): void
通过指定时间段间隔(天、周、月、年)查询应用使用时长统计信息,使用Callback形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryBundleStatsInfoByInterval](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerybundlestatsinfobyinterval)
>
> 从API7开始支持
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -247,12 +276,16 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num
});
```
## bundleState.queryBundleStateInfoByInterval
## bundleState.queryBundleStateInfoByInterval<sup>(deprecated)</sup>
queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: number): Promise&lt;Array&lt;BundleStateInfo&gt;&gt;
通过指定时间段间隔(天、周、月、年)查询应用使用时长统计信息,使用Promise形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryBundleStatsInfoByInterval](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerybundlestatsinfobyinterval)
>
> 从API7开始支持
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -287,12 +320,16 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num
});
```
## bundleState.queryBundleActiveStates
## bundleState.queryBundleActiveStates<sup>(deprecated)</sup>
queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveState&gt;&gt;): void
通过指定起始和结束时间查询所有应用的事件集合,使用Callback形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryBundleEvents](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerybundleevents)
>
> 从API7开始支持
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -323,12 +360,16 @@ queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;A
});
```
## bundleState.queryBundleActiveStates
## bundleState.queryBundleActiveStates<sup>(deprecated)</sup>
queryBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleActiveState&gt;&gt;
通过指定起始和结束时间查询所有应用的事件集合,使用Promise形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryBundleEvents](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerybundleevents)
>
> 从API7开始支持
**需要权限**:ohos.permission.BUNDLE_ACTIVE_INFO
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -362,12 +403,16 @@ queryBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleA
});
```
## bundleState.queryCurrentBundleActiveStates
## bundleState.queryCurrentBundleActiveStates<sup>(deprecated)</sup>
queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallback&lt;Array&lt;BundleActiveState&gt;&gt;): void
通过指定起始和结束时间查询当前应用的事件集合,使用Callback形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryCurrentBundleEvents](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerycurrentbundleevents)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
**参数**
......@@ -394,12 +439,16 @@ queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallba
});
```
## bundleState.queryCurrentBundleActiveStates
## bundleState.queryCurrentBundleActiveStates<sup>(deprecated)</sup>
queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;BundleActiveState&gt;&gt;
通过指定起始和结束时间查询当前应用的事件集合,使用Promise形式返回。
> **说明** 从API version 9开始废弃,建议使用[usageStatistics.queryCurrentBundleEvents](./js-apis-resourceschedule-deviceUsageStatistics.md/#usagestatisticsquerycurrentbundleevents)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
**参数**
......@@ -429,10 +478,14 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;
});
```
## BundleStateInfo
## BundleStateInfo<sup>(deprecated)</sup>
提供应用使用时长的具体信息。
> **说明** 从API version 9开始废弃,建议使用[BundleStatsInfo](./js-apis-resourceschedule-deviceUsageStatistics.md/#bundlestatsinfo)
>
> 从API7开始支持
### 属性
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App
......@@ -450,10 +503,16 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;
| infosBeginTime | number | 否 | BundleActiveInfo对象中第一条应用使用统计的记录时间。<br>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| infosEndTime | number | 否 | BundleActiveInfo对象中最后一条应用使用统计的记录时间。<br>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
## BundleActiveState
## BundleActiveState<sup>(deprecated)</sup>
提供应用事件的具体信息。
提供应用使用时长的具体信息。
> **说明** 从API version 9开始废弃,建议使用[BundleEvents](./js-apis-resourceschedule-deviceUsageStatistics.md/#bundleevents)
>
> 从API7开始支持
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App
| 参数名 | 类型 | 必填 | 说明 |
......@@ -465,20 +524,28 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise&lt;Array&lt;
| indexOfLink | string | 否 | 快捷方式id。<br>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
| nameOfClass | string | 否 | 类名。<br>本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。 |
## BundleActiveInfoResponse
## BundleActiveInfoResponse<sup>(deprecated)</sup>
提供应用使用时长的具体信息。
> **说明** 从API version 9开始废弃,建议使用[BundleStatsMap](./js-apis-resourceschedule-deviceUsageStatistics.md/#bundlestatsmap)
>
> 从API7开始支持
**系统能力**:SystemCapability.ResourceSchedule.UsageStatistics.App
| 参数名 | 类型 | 必填 | 说明 |
| ------------------------------ | ---------------------------------------- | ---- | -------------- |
| [key: string]: BundleStateInfo | [key: string]: [BundleStateInfo](#bundlestateinfo) | 是 | 不同应用的使用时长统计信息。 |
## IntervalType
## IntervalType<sup>(deprecated)</sup>
提供应用使用时长的查询类型。
> **说明** 从API version 9开始废弃,建议使用[IntervalType](./js-apis-resourceschedule-deviceUsageStatistics.md/#intervaltype)
>
> 从API7开始支持
**系统能力**:以下各项对应的系统能力均为SystemCapability.ResourceSchedule.UsageStatistics.App
| 名称 | 默认值 | 说明 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册