From 59f638939fdfeeee43aa7df0472402df210b9151 Mon Sep 17 00:00:00 2001 From: nobbo Date: Fri, 24 Jun 2022 16:16:50 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85=E6=8E=A5=E5=8F=A3=E5=8F=82?= =?UTF-8?q?=E8=80=83=E7=9A=84=E6=A8=A1=E5=9D=97=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- .../js-apis-WorkSchedulerExtensionAbility.md | 4 + .../apis/js-apis-deviceUsageStatistics.md | 155 ++++++++++-------- .../reference/apis/js-apis-workScheduler.md | 4 + 3 files changed, 94 insertions(+), 69 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md b/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md index 45be5b1eb1..4c8a55def2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-WorkSchedulerExtensionAbility.md @@ -1,5 +1,9 @@ # 延迟任务调度回调 +本模块提供延迟任务回调能力。 + +开发者在开发应用时，通过复写该模块的接口，在延迟任务触发的时候，系统会通过接口回调应用，开发者在回调接口里面可以处理自己的任务逻辑。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9开始支持。API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。 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 92dda87197..12e7843184 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-deviceUsageStatistics.md @@ -1,5 +1,22 @@ # 设备使用信息统计 +本模块提供设备使用信息统计能力。 + +设备使用信息统计，系统应用可调用接口实现如下功能： + +- 查询设备上各应用在不同时间段的使用时长、各应用的事件（前台、后台、长时任务开始、长时任务结束）信息及各应用的通知次数信息。 +- 查询系统事件（休眠、唤醒、解锁、锁屏）统计信息。 +- 查询应用分组信息（指定应用和自身应用）。 +- 查询应用空闲状态（指定应用和自身应用）。 +- 设置应用分组信息（指定应用）。 +- 注册和解除注册应用分组变化监听。 + +三方应用可调用接口实现如下功能： + +- 查询应用空闲状态（仅限自身应用）。 +- 查询应用分组信息（仅限自身应用）。 +- 查询应用事件（仅限自身应用）。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -20,10 +37,10 @@ isIdleState(bundleName: string, callback: AsyncCallback<boolean>): void **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用的bundleName。| - | callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 应用的bundleName。| +| callback | AsyncCallback<boolean> | 是 | 指定的callback回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | **示例**： @@ -47,15 +64,15 @@ isIdleState(bundleName: string): Promise<boolean> **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | bundleName | string | 是 | 应用的bundleName。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| bundleName | string | 是 | 应用的bundleName。| **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<boolean> | 指定的Promise回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | +| 类型 | 说明 | +| -------- | -------- | +| Promise<boolean> | 指定的Promise回调方法。如果指定的bundleName有效，则返回指定bundleName的应用当前是否是空闲状态；否则返回null。 | **示例**： @@ -77,9 +94,9 @@ queryAppUsagePriorityGroup(callback: AsyncCallback<number>): void **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回当前调用者应用的使用优先级群组。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback<number> | 是 | 指定的callback回调方法。返回当前调用者应用的使用优先级群组。| **示例**： @@ -103,9 +120,9 @@ queryAppUsagePriorityGroup(): Promise<number> **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<number> | 指定的Promise回调方法。查询（返回）当前调用者应用的使用优先级群组。| +| 类型 | 说明 | +| -------- | -------- | +| Promise<number> | 指定的Promise回调方法。查询（返回）当前调用者应用的使用优先级群组。| **示例**： @@ -129,11 +146,11 @@ queryBundleStateInfos(begin: number, end: number, callback: AsyncCallback<Bun **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 是 | 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| +| callback | AsyncCallback<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 是 | 指定的callback回调方法。返回指定起始和结束时间内应用使用时长统计信息。| **示例**： @@ -165,16 +182,16 @@ queryBundleStateInfos(begin: number, end: number): Promise<BundleActiveInfoRe **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 指定的Promise回调方法。返回指定起始和结束时间内应用使用时长统计信息。| +| 类型 | 说明 | +| -------- | -------- | +| Promise<[BundleActiveInfoResponse](#bundleactiveinforesponse)> | 指定的Promise回调方法。返回指定起始和结束时间内应用使用时长统计信息。| **示例**： @@ -204,12 +221,12 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。| - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleStateInfo](#bundlestateinfo)>> | 是 | 指定的callback回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。| +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| +| callback | AsyncCallback<Array<[BundleStateInfo](#bundlestateinfo)>> | 是 | 指定的callback回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。| **示例**： @@ -239,17 +256,17 @@ queryBundleStateInfoByInterval(byInterval: IntervalType, begin: number, end: num **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。| - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| byInterval | [IntervalType](#intervaltype) | 是 | 查询类型。| +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleStateInfo](#bundlestateinfo)>> | 指定的Promise回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。| +| 类型 | 说明 | +| -------- | -------- | +| Promise<Array<[BundleStateInfo](#bundlestateinfo)>> | 指定的Promise回调方法。返回指定时间段间隔（天、周、月、年）查询应用使用时长统计信息。| **示例**： @@ -277,11 +294,11 @@ queryBundleActiveStates(begin: number, end: number, callback: AsyncCallback<A **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| +| callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询所有应用的事件集合。| **示例**： @@ -311,16 +328,16 @@ queryBundleActiveStates(begin: number, end: number): Promise<Array<BundleA **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的事件集合。| +| 类型 | 说明 | +| -------- | -------- | +| Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询所有应用的事件集合。| **示例**： @@ -346,11 +363,11 @@ queryCurrentBundleActiveStates(begin: number, end: number, callback: AsyncCallba **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| - | callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| +| callback | AsyncCallback<Array<[BundleActiveState](#bundleactivestate)>> | 是 | 指定的callback回调方法。返回指定起始和结束时间查询当前应用的事件集合。| **示例**： @@ -378,16 +395,16 @@ queryCurrentBundleActiveStates(begin: number, end: number): Promise<Array< **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | begin | number | 是 | 起始时间。| - | end | number | 是 | 结束时间。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| begin | number | 是 | 起始时间。| +| end | number | 是 | 结束时间。| **返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询当前应用的事件集合。| +| 类型 | 说明 | +| -------- | -------- | +| Promise<Array<[BundleActiveState](#bundleactivestate)>> | 指定的Promise回调方法。返回指定起始和结束时间查询当前应用的事件集合。| **示例**： @@ -435,9 +452,9 @@ merge(toMerge: BundleStateInfo): void **参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | toMerge | [BundleStateInfo](#bundlestateinfo) | 是 | 相同包名的应用使用统计信息。| +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| toMerge | [BundleStateInfo](#bundlestateinfo) | 是 | 相同包名的应用使用统计信息。| ## BundleActiveState diff --git a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md index 8f904a1773..9d38fe710f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -1,5 +1,9 @@ # 延迟任务调度 +本模块提供延迟任务注册、取消、查询的能力。 + +开发者在开发应用时，通过调用延迟任务注册接口，注册对实时性要求不高的延迟任务，该任务默认由系统安排，在系统空闲时根据性能、功耗、热等情况进行调度执行。 + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 本模块首批接口从API version 9开始支持。API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。 -- GitLab