diff --git a/zh-cn/application-dev/device_standby/device-standby-use-guide.md b/zh-cn/application-dev/device_standby/device-standby-use-guide.md index 04944c39650c6ab4e91e9214c0e432deb90e8121..292a5aeb723e06a530c448abfaf5fe414b8e0d60 100644 --- a/zh-cn/application-dev/device_standby/device-standby-use-guide.md +++ b/zh-cn/application-dev/device_standby/device-standby-use-guide.md @@ -1,14 +1,7 @@ -# 设备待机续航部件开发指南 -## 场景介绍 -当前设备在灭屏进入待机睡眠前，应用不会被冻结、Work任务不会被延迟、Timer时间不会变慢、CPU锁不会释放、应用网络访问不会停止，导致设备灭屏功耗大，影响整机续航。 -因此，在进入待机空闲状态下，需要限制后台应用使用资源，降低整机功耗。
-解决以下场景
-一、采集系统设备进入待机空闲特征，进入待机时机，退出待机条件
-二、检测设备进入浅睡眠状态和深睡眠状态
-三、设备每隔一段时间暂停睡眠，进入维护状态
-四、检测到设备进入待机空闲状态，触发资源管控 +# 设备待机模块开发指南 +## 设备待机模块概述 +为提高设备续航，降低设备功耗，在设备进入待机空闲状态时，限制后台应用使用资源。开发者可以根据自身情况，为自己的应用申请纳入待机资源管控或者暂时不被待机资源管控。 -本文档旨在帮助开发者理解设备待机空闲下的相关功能和资源使用规范。 ## 待机低续航模式介绍 待机低续航模式会延迟应用后台cpu和网络活动，从而延长电池续航时间。
包括： @@ -17,9 +10,12 @@
3.running_lock锁：释放应用申请的cpu running_lock锁
4.Timer响应：延迟应用的timer响应 ## 接口说明 -一、应用查询待机空闲状态接口
-isDeviceInStandby -二、应用申请待机空闲状态正常使用资源的接口
-getExemptedApps -requestExemptionResource -releaseExemptionResource +[设备待机模块接口api开发文档](https://gitee.com/openharmony/docs/blob/4b89700885537543d26e2dfc96b4dee15a544229/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md) + +主要接口 +| 接口 | 说明 | +|--------------------------|----| +| isDeviceInStandby | 查询应用是否处于待机空闲状态，如果处于空闲状态，该应用可能被纳入资源管控。 | +| getExemptedApps | 获取不会被纳入待机资源管控的应用列表 | +| requestExemptionResource | 为应用申请暂时不会被纳入待机资源管控的能力 | +| releaseExemptionResource | 取消应用暂时不会被纳入待机资源管控能力 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md index 0677bc144e144fa217d7afcc0fed5e60543cc1c3..a4e934b60f8dc029b38d9dd0da12f8d8a3ddcccd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-deviceStandby.md @@ -1,9 +1,5 @@ # @ohos.resourceschedule.deviceStandby（设备待机模块） -本模块提供设备待机空闲部件管理功能 - -API使用场景： -当设备长时间未被使用或通过按键，可以使设备进入待机模式。待机模式不影响应用使用，还可以延长电池续航时间。 -通过本模块接口，可查询设备是否为待机模式，以及使应用灵活申请开启或关闭待机模式。 +本模块提供设备待机空闲部件管理功能。当设备长时间未被使用或通过按键，可以使设备进入待机模式。待机模式不影响应用使用，还可以延长电池续航时间。通过本模块接口，可查询设备是否为待机模式，以及使应用灵活申请开启或关闭待机模式。 > **说明：** > - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -26,6 +22,7 @@ isDeviceInStandby(callback: AsyncCallback): void; | callback | Callback<boolean> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | **错误码**： + 以下错误码的详细介绍请参见[后台任务错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。 | 错误码ID | 错误信息 | @@ -73,8 +70,8 @@ getExemptedApps(resourceTypes: number, callback: AsyncCallback | 是 | [ExemptedAppInfo ](#exemptedappinfo)| +| [ResourceType](#resourcetype)|number | 是 | 资源类型 | +| callback | AsyncCallback | 是 |豁免应用信息 | **错误码**： @@ -101,13 +98,13 @@ getExemptedApps(resourceTypes: number): Promise; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | -| resourceTypes |number | 是 | [ResourceType](#resourcetype) | +| [ResourceType](#resourcetype)|number | 是 |资源类型| **返回值**： | 类型 | 说明 | | --------------------- | ---------------------------------------- | -| Promise | [ExemptedAppInfo ](#exemptedappinfo)| +| Promise | 豁免应用信息 | **错误码**： @@ -127,7 +124,7 @@ getExemptedApps(resourceTypes: number): Promise; ## deviceStandby.requestExemptionResource requestExemptionResource(request: ResourceRequest): void; -订阅申请豁免。 +订阅申请豁免，为应用申请临时不进入待机管控能力。 **系统能力:** SystemCapability.ResourceSchedule.DeviceStandby.Exemption @@ -137,7 +134,7 @@ requestExemptionResource(request: ResourceRequest): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | -| request |ResourceRequest | 是 | [ResourceRequest ](#resourcerequest) | +| request |[ResourceRequest](#resourcerequest)| 是 | 资源请求 | **错误码**： @@ -154,7 +151,7 @@ requestExemptionResource(request: ResourceRequest): void; ## deviceStandby.releaseExemptionResource releaseExemptionResource(request: ResourceRequest): void; -去除订阅申请豁免。 +去除订阅申请豁免，去除应用暂时不进入待机管控的能力。 **系统能力:** SystemCapability.ResourceSchedule.DeviceStandby.Exemption @@ -164,7 +161,7 @@ releaseExemptionResource(request: ResourceRequest): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | -| request |ResourceRequest | 是 | [ResourceRequest ](#resourcerequest) | +| request |[ResourceRequest](#resourcerequest)| 是 | 资源请求 | **错误码**： @@ -178,9 +175,8 @@ releaseExemptionResource(request: ResourceRequest): void; | 9800004 | System service operation failed. | | 18700001 | Caller information verification failed when applying for efficiency resources. | -## 枚举类和请求体 -### ResourceType -豁免应用资源枚举 +## ResourceType +应用资源枚举。
|名称 |值 |说明| @@ -193,10 +189,8 @@ releaseExemptionResource(request: ResourceRequest): void; |PUSH |32 | 非待机pushkit资源| |FREEZE |64 | 非待机冻结应用资源| -### ExemptedAppInfo -豁免应用信息 -.. - +## ExemptedAppInfo +豁免应用信息，不进入待机管控的应用信息。
|名称 |类型 |说明 | @@ -205,8 +199,8 @@ releaseExemptionResource(request: ResourceRequest): void; |name |string | 应用名 | |duration | number | 豁免时长 | -### ResourceRequest -待机资源请求体 +## ResourceRequest +待机资源请求体。
|名称 |类型 |说明 |