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 acc7eaaa6af45ddfd1205554c8dac6ea0e5c4de0..992240ecb4b4433c72ee8215bd7ab58d97eaf987 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,12 +1,10 @@ -# @ohos.resourceschedule.deviceStandby（设备待机空闲部件功能） +# @ohos.resourceschedule.deviceStandby（设备待机模块） 本模块提供设备待机空闲部件管理功能 + API使用场景： -如果用户长时间没有主动使用设备，且屏幕已关闭，则系统会使设备进入待机低功耗续航模式。待机续航模式会延迟应用后台CPU和网络活动，从而延长电池续航时间。 包括： -1、应用限网：限制后台应用访问网络 -2、Work待机任务：延迟应用的work任务响应 -3、running_lock锁：临时释放应用的background running_lock锁 -4、Timer响应：延迟应用的timer响应 -5、待规划：停止wifi扫描、停止蓝牙扫描、云同步账户等 +当设备长时间未被使用或通过按键，可以使设备进入待机模式。待机模式不影响应用使用，还可以延长电池续航时间。 +通过本模块接口，可查询设备是否为待机模式，以及使应用灵活申请开启或关闭待机模式。 + > **说明：** > - 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 @@ -15,22 +13,23 @@ API使用场景： import deviceStandby from '@ohos.resourceschedule.deviceStandby'; ``` ## deviceStandby.isDeviceInStandby -function isDeviceInStandby(callback: AsyncCallback): void; -当前设备是否进入待机低功耗续航模式 +isDeviceInStandby(callback: AsyncCallback): void; + +当前设备是否进入待机低功耗续航模式，使用Callback异步回调。 + **系统能力:** SystemCapability.ResourceSchedule.DeviceStandby + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | -| callback | Callback<void> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | +| callback | Callback<boolean> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | **错误码**： -以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errorcode-backgroundTaskMgr.md)错误码。 +以下错误码的详细介绍请参见[后台任务错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。 | 错误码ID | 错误信息 | | ---- | --------------------- | -| 201 | Permission denied. | -| 401 | Parameter error. | | 9800001 | Memory operation failed. | | 9800002 | Parcel operation failed. | | 9800003 | IPC failed. | @@ -38,9 +37,12 @@ function isDeviceInStandby(callback: AsyncCallback): void; | 18700001 | Caller information verification failed when applying for efficiency resources. | ## deviceStandby.isDeviceInStandby -function isDeviceInStandby(): Promise<boolean> -当前设备是否进入待机低功耗续航模式 +isDeviceInStandby(): Promise<boolean> + +当前设备是否进入待机低功耗续航模式，使用Promise异步回调。 + **系统能力:** SystemCapability.ResourceSchedule.DeviceStandby + **返回值**： | 类型 | 说明 | @@ -48,12 +50,10 @@ function isDeviceInStandby(): Promise<boolean> | Promise<boolean> | 指定的Promise回调方法。返回是否进入待机低功耗续航模式。| **错误码**： -以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errorcode-backgroundTaskMgr.md)错误码。 +以下错误码的详细介绍请参见[后台任务错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。 | 错误码ID | 错误信息 | | ---- | --------------------- | -| 201 | Permission denied. | -| 401 | Parameter error. | | 9800001 | Memory operation failed. | | 9800002 | Parcel operation failed. | | 9800003 | IPC failed. | @@ -61,52 +61,57 @@ function isDeviceInStandby(): Promise<boolean> | 18700001 | Caller information verification failed when applying for efficiency resources. | ## deviceStandby.getExemptedApps -function getExemptedApps(resourceTypes: number, callback: AsyncCallback): void; -返回豁免应用名单 +getExemptedApps(resourceTypes: number, callback: AsyncCallback): void; + +获取进入待机模式的应用名单，使用Callback异步回调。 + **系统能力:** SystemCapability.ResourceSchedule.DeviceStandby + **系统API:** 此接口为系统接口。 **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | -| resourceTypes |number | 是 | 资源类型，具体结构见文末枚举 | -| callback | AsyncCallback | 是 | 回调函数，具体结构见文末 | +| resourceTypes |number | 是 | [ResourceType](#ResourceType) | +| callback | AsyncCallback | 是 | [ExemptedAppInfo ](#ExemptedAppInfo)| **错误码**： -以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errorcode-backgroundTaskMgr.md)错误码。 +以下错误码的详细介绍请参见[后台任务错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。 | 错误码ID | 错误信息 | | ---- | --------------------- | -| 201 | Permission denied. | -| 202 | Not System App. | -| 401 | Parameter error. | | 9800001 | Memory operation failed. | | 9800002 | Parcel operation failed. | | 9800003 | IPC failed. | | 9800004 | System service operation failed. | | 18700001 | Caller information verification failed when applying for efficiency resources. | + ## deviceStandby.getExemptedApps -function getExemptedApps(resourceTypes: number): Promise; -返回豁免应用名单 +getExemptedApps(resourceTypes: number): Promise; + +获取进入待机模式的应用名单，使用Promise异步回调。 + **系统能力:** SystemCapability.ResourceSchedule.DeviceStandby + **系统API:** 此接口为系统接口。 + **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | -| resourceTypes |number | 是 | 资源类型。 | +| resourceTypes |number | 是 | [ResourceType](#ResourceType) | **返回值**： | 类型 | 说明 | | --------------------- | ---------------------------------------- | -| Promise | 指定的Promise回调方法。返回豁免应用名单，具体结构见文末| +| Promise | [ExemptedAppInfo ](#ExemptedAppInfo)| **错误码**： -以下错误码的详细介绍请参见[@ohos.resourceschedule.backgroundTaskManager (后台任务管理)](../errorcodes/errorcode-backgroundTaskMgr.md)错误码。 +以下错误码的详细介绍请参见[后台任务错误码](../errorcodes/errorcode-backgroundTaskMgr.md)。 | 错误码ID | 错误信息 | | ---- | --------------------- | @@ -120,25 +125,26 @@ function getExemptedApps(resourceTypes: number): Promise -|名称 |枚举值 |说明| +|名称 |值 |说明| | ------------ | ------------ |--------------| -|NETWORK |1 |The resource for non-standby network access.| -|RUNNING_LOCK |1 << 1 |The resource for non-standby cpu-runninglock.| -|TIMER |1 << 2 |The resource for non-standby timer.| -|WORK_SCHEDULER |1 << 3 |The resource for non-standby workscheduler.| -|AUTO_SYNC |1 << 4 |The resource for non-standby Automatic synchronization.| -|PUSH |1 << 5 |The resource for non-standby pushkit.| -|FREEZE |1 << 6 |The resource for non-standby freezing application.| +|NETWORK |1 |非待机网络访问资源| +|RUNNING_LOCK |2 |非待机cpu-runninglock资源| +|TIMER |4 | 非待机timer任务资源| +|WORK_SCHEDULER |8 | 非待机work任务资源| +|AUTO_SYNC |16 | 非待机自动同步的资源 | +|PUSH |32 | 非待机pushkit资源| +|FREEZE |64 | 非待机冻结应用资源| ### ExemptedAppInfo -The information of exemption application. +豁免应用信息 +.. +
-|对象名 |类型 |说明 | +|名称 |类型 |说明 | | ------------ | ------------ | ------------ | -|resourceTypes | number |The set of resource types that app wants to apply. | -|name |string | The app name. | -|duration | number | The exemption duration. | +|resourceTypes | number |应用的资源类型 | +|name |string | 应用名 | +|duration | number | 豁免时长 | ### ResourceRequest -The request of standby resources. +待机资源请求体
-|对象名 |类型 |说明 | +|名称 |类型 |说明 | | ------------ | ------------ | ------------ | -|resourceTypes | number |The set of resource types that app wants to apply. | -|uid | number |The app uid. | -|name |string | The app name. | -|duration | number | The exemption duration. | -|reason |string | The apply reason. | \ No newline at end of file +|resourceTypes | number |应用的资源类型 | +|uid | number |应用uid | +|name |string | 应用名称 | +|duration | number | 豁免时长 | +|reason |string | 申请原因 | \ No newline at end of file