diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 14235be027c838156c500c5c16682c272d7c01a0..57457cf420474ffec0d07914dd286c75a405cbf4 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -310,6 +310,7 @@ - [@ohos.reminderAgent (后台代理提醒)](js-apis-reminderAgent.md) - [@ohos.systemParameter (系统属性)](js-apis-system-parameter.md) - [@ohos.usb (USB管理)](js-apis-usb-deprecated.md) + - [@ohos.workScheduler (延迟任务调度)](js-apis-workScheduler.md) - [@system.app (应用上下文)](js-apis-system-app.md) - [@system.battery (电量信息)](js-apis-system-battery.md) - [@system.bluetooth (蓝牙)](js-apis-system-bluetooth.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md index b363572eecbea607524e9ef94f5a5794df03f124..36c67f2fcc03d8c0f59b0462ac09054eae21d960 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-backgroundTaskManager.md @@ -34,7 +34,7 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | | reason | string | 是 | 延迟挂起申请的原因。 | | callback | Callback<void> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | @@ -72,7 +72,7 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | --------------------------- | ---- | ---------------------------------------- | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 | | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。 | @@ -103,7 +103,7 @@ getRemainingDelayTime(requestId: number): Promise<number> **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------- | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 | @@ -135,7 +135,7 @@ cancelSuspendDelay(requestId: number): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------- | | requestId | number | 是 | 延迟挂起的请求ID。这个值通过调用[requestSuspendDelay](#backgroundtaskmanagerrequestsuspenddelay)方法获取。 | @@ -159,7 +159,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | @@ -251,7 +251,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | bgMode | [BackgroundMode](#backgroundmode8) | 是 | 向系统申请的后台模式。 | @@ -337,7 +337,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | @@ -393,7 +393,7 @@ stopBackgroundRunning(context: Context): Promise<void> **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | @@ -436,13 +436,76 @@ export default class MainAbility extends Ability { }; ``` +## backgroundTaskManager.applyEfficiencyResources9+ + +applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresourcesrequest9)): boolean + +向系统申请或释放能效资源，使用boolean形式返回结果。 +通过EfficiencyResourcesRequest参数中的isApply变量，设置是申请还是释放。 +应用使用此接口，需要向应用中心申请获得相应特权。 +进程和它所属的应用可以同时申请某一类资源，例如CPU资源，但是应用释放资源的时候会将进程的资源一起释放。 + +**系统能力**: SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply + +**系统API**: 此接口为系统接口。 + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | ---------------------------------------- | +| request | [EfficiencyResourcesRequest](#efficiencyresourcesrequest9) | 是 | 请求的必要信息。包括资源类型，超时时间等信息。详见[EfficiencyResourcesRequest](#efficiencyresourcesrequest9)。 | + +**返回值**： + +| 类型 | 说明 | +| -------------- | ---------------- | +| boolean | true代表申请成功，false代表申请失败。 | + +**示例**： + +```js +import backgroundTaskManager from '@ohos.backgroundTaskManager'; + +let request = { + resourceTypes: backgroundTaskManager.ResourceType.CPU, + // 如果将isApply置为false，则表示释放资源 + isApply: true, + timeOut: 0, + reason: "apply", + isPersist: true, + isProcess: false, +}; +let res = backgroundTaskManager.applyEfficiencyResources(request); +console.info("result of applyEfficiencyResources is: " + res) +``` + +## backgroundTaskManager.resetAllEfficiencyResources9+ + +resetAllEfficiencyResources(): void + +释放所有已经申请的资源。 +应用使用此接口，需要向应用中心申请获得相应特权。 + +**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply + +**系统API**: 此接口为系统接口。 + +**示例**： + +```js +import backgroundTaskManager from '@ohos.backgroundTaskManager'; + +backgroundTaskManager.resetAllEfficiencyResources(); + +``` + ## DelaySuspendInfo 延迟挂起信息。 **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------- | ------ | ---- | ---------------------------------------- | | requestId | number | 是 | 延迟挂起的请求ID。 | | actualDelayTime | number | 是 | 应用的实际挂起延迟时间，以毫秒为单位。
一般情况下默认值为180000，低电量（依据系统低电量广播）时默认值为60000。 | @@ -452,14 +515,49 @@ export default class MainAbility extends Ability { **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask -| 参数名 | 描述 | -| ----------------------- | --------------------- | -| DATA_TRANSFER | 数据传输。 | -| AUDIO_PLAYBACK | 音频播放。 | -| AUDIO_RECORDING | 录音。 | -| LOCATION | 定位导航。 | -| BLUETOOTH_INTERACTION | 蓝牙相关。 | -| MULTI_DEVICE_CONNECTION | 多设备互联。 | -| WIFI_INTERACTION | WLAN相关（此接口为系统接口）。 | -| VOIP | 音视频通话（此接口为系统接口）。 | -| TASK_KEEPING | 计算任务（仅在特定设备生效）。 | \ No newline at end of file +| 名称 | 值 | 描述 | +| ----------------------- | ---- | --------------------- | +| DATA_TRANSFER | 1 | 数据传输。 | +| AUDIO_PLAYBACK | 2 | 音频播放。 | +| AUDIO_RECORDING | 3 | 录音。 | +| LOCATION | 4 | 定位导航。 | +| BLUETOOTH_INTERACTION | 5 | 蓝牙相关。 | +| MULTI_DEVICE_CONNECTION | 6 | 多设备互联。 | +| WIFI_INTERACTION | 7 | WLAN相关
此接口为系统接口。 | +| VOIP | 8 | 音视频通话
此接口为系统接口。 | +| TASK_KEEPING | 9 | 计算任务（仅在特定设备生效）。 | + +## EfficiencyResourcesRequest9+ + +能效资源申请参数。 + +**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply + +**系统API**: 此接口为系统接口。 + +| 名称 | 类型 | 必填 | 说明 | +| --------------- | ------ | ---- | ---------------------------------------- | +| resourceTypes | number | 是 | 申请的资源类型。 | +| isApply | boolean | 是 | 申请资源或者是释放资源。 | +| timeOut | number | 是 | 资源的使用时间，以毫秒为单位。 | +| isPersist | boolean | 否 | 是否永久持有资源，如果是true，那么timeOut就无效。 | +| isProcess | boolean | 否 | 应用申请或者是进程申请。 | +| reason | string | 是 | 申请资源的原因。 | + +## ResourceType9+ + +能效资源类型。 + +**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.EfficiencyResourcesApply + +**系统API**: 此接口为系统接口。 + +| 名称 | 值 | 描述 | +| ----------------------- | ---- | --------------------- | +| CPU | 1 | CPU资源，申请后不被挂起。 | +| COMMON_EVENT | 2 | 公共事件，申请后挂起状态下不被代理掉。 | +| TIMER | 4 | 计时器，申请后挂起状态下不被代理掉。 | +| WORK_SCHEDULER | 8 | 延迟任务，申请后有更长的执行时间。 | +| BLUETOOTH | 16 | 蓝牙相关，申请后挂起状态下不被代理掉。 | +| GPS | 32 | GPS相关，申请后挂起状态下不被代理掉。 | +| AUDIO | 64 | 音频资源，申请后挂起状态下不被代理掉。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md index 4289e22a78269e582ec9d7e8e94003d406ad786a..26b0cbbc9c1063494d2619cb274b8f6af3af894a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-backgroundTaskManager.md @@ -32,7 +32,7 @@ requestSuspendDelay(reason: string, callback: Callback<void>): DelaySuspen **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------ | | reason | string | 是 | 延迟挂起申请的原因。 | | callback | Callback<void> | 是 | 延迟即将超时的回调函数，一般在超时前6秒通过此回调通知应用。 | @@ -86,7 +86,7 @@ getRemainingDelayTime(requestId: number, callback: AsyncCallback<number>): **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | --------------------------- | ---- | ---------------------------------------- | | requestId | number | 是 | 延迟挂起的请求ID。 | | callback | AsyncCallback<number> | 是 | 指定的callback回调方法。用于返回应用程序进入挂起状态之前的剩余时间，以毫秒为单位。 | @@ -137,7 +137,7 @@ getRemainingDelayTime(requestId: number): Promise<number> **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------- | | requestId | number | 是 | 延迟挂起的请求ID。 | @@ -188,7 +188,7 @@ cancelSuspendDelay(requestId: number): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ------ | ---- | ---------- | | requestId | number | 是 | 延迟挂起的请求ID。 | @@ -231,7 +231,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | bgMode | [BackgroundMode](#backgroundmode) | 是 | 向系统申请的后台模式。 | @@ -305,7 +305,7 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------- | ---------------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | bgMode | [BackgroundMode](#backgroundmode) | 是 | 向系统申请的后台模式。 | @@ -378,7 +378,7 @@ stopBackgroundRunning(context: Context, callback: AsyncCallback<void>): vo **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | | callback | AsyncCallback<void> | 是 | callback形式返回启动长时任务的结果。 | @@ -434,7 +434,7 @@ stopBackgroundRunning(context: Context): Promise<void> **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | ---------------------------------------- | | context | Context | 是 | 应用运行的上下文。
FA模型的应用Context定义见[Context](js-apis-Context.md)。
Stage模型的应用Context定义见[Context](js-apis-ability-context.md)。 | @@ -492,7 +492,7 @@ applyEfficiencyResources(request: [EfficiencyResourcesRequest](#efficiencyresour **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | ---------------------------------------- | | request | [EfficiencyResourcesRequest](#efficiencyresourcesrequest) | 是 | 请求的必要信息。包括资源类型，超时时间等信息。详见[EfficiencyResourcesRequest](#efficiencyresourcesrequest)。 | @@ -570,7 +570,7 @@ try { **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------- | ------ | ---- | ---------------------------------------- | | requestId | number | 是 | 延迟挂起的请求ID。 | | actualDelayTime | number | 是 | 应用的实际挂起延迟时间，以毫秒为单位。
一般情况下默认值为180000，低电量（依据系统低电量广播）时默认值为60000。 | @@ -580,7 +580,7 @@ try { **系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask -| 参数名 | 参数值 | 描述 | +| 名称 | 值 | 描述 | | ----------------------- | ---- | --------------------- | | DATA_TRANSFER | 1 | 数据传输。 | | AUDIO_PLAYBACK | 2 | 音频播放。 | @@ -600,7 +600,7 @@ try { **系统API**: 此接口为系统接口。 -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------- | ------ | ---- | ---------------------------------------- | | resourceTypes | number | 是 | 申请的资源类型。 | | isApply | boolean | 是 | 申请资源或者是释放资源。 | @@ -617,13 +617,13 @@ try { **系统API**: 此接口为系统接口。 -| 参数名 | 描述 | -| ----------------------- | --------------------- | -| CPU | CPU资源，申请后不被挂起。 | -| COMMON_EVENT | 公共事件，申请后挂起状态下不被代理掉。 | -| TIMER | 计时器，申请后挂起状态下不被代理掉。 | -| WORK_SCHEDULER | 延迟任务，申请后有更长的执行时间。 | -| BLUETOOTH | 蓝牙相关，申请后挂起状态下不被代理掉。 | -| GPS | GPS相关，申请后挂起状态下不被代理掉。 | -| AUDIO | 音频资源，申请后挂起状态下不被代理掉。 | +| 名称 | 值 | 描述 | +| ----------------------- | ---- | --------------------- | +| CPU | 1 | CPU资源，申请后不被挂起。 | +| COMMON_EVENT | 2 | 公共事件，申请后挂起状态下不被代理掉。 | +| TIMER | 4 | 计时器，申请后挂起状态下不被代理掉。 | +| WORK_SCHEDULER | 8 | 延迟任务，申请后有更长的执行时间。 | +| BLUETOOTH | 16 | 蓝牙相关，申请后挂起状态下不被代理掉。 | +| GPS | 32 | GPS相关，申请后挂起状态下不被代理掉。 | +| AUDIO | 64 | 音频资源，申请后挂起状态下不被代理掉。 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md index 41cb656ad6e883056069734d28d1ec309b85a566..0ddce05d36ce0774e91590d3b3d01a566badc23f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resourceschedule-workScheduler.md @@ -26,7 +26,7 @@ startWork(work: WorkInfo): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---- | --------------------- | ---- | -------------- | | work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 | @@ -77,7 +77,7 @@ stopWork(work: WorkInfo, needCancel?: boolean): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ---------- | --------------------- | ---- | ---------- | | work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 | | needCancel | boolean | 是 | 是否需要取消的工作。 | @@ -127,7 +127,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | ------------------------------------- | ---- | ---------------------------------------- | | workId | number | 是 | work的id。 | | callback | AsyncCallback\<[WorkInfo](#workinfo)> | 是 | 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | @@ -170,7 +170,7 @@ getWorkStatus(workId: number): Promise\ **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------- | | workId | number | 是 | work的id。 | @@ -216,7 +216,7 @@ obtainAllWorks(callback : AsyncCallback\): Array\ **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ------------------------------- | | callback | AsyncCallback\ | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。 | @@ -326,7 +326,7 @@ isLastWorkTimeOut(workId: number, callback : AsyncCallback\): boolean **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | -------- | -------------------- | ---- | ---------------------------------------- | | workId | number | 是 | work的id。 | | callback | AsyncCallback\ | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | @@ -372,7 +372,7 @@ isLastWorkTimeOut(workId: number): Promise\ **参数**： -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | -------- | | workId | number | 是 | work的id。 | @@ -413,7 +413,7 @@ isLastWorkTimeOut(workId: number): Promise\ **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler -| 参数名 | 类型 | 必填 | 说明 | +| 名称 | 类型 | 必填 | 说明 | | --------------- | --------------------------------- | ---- | ---------------- | | workId | number | 是 | 当前工作的ID | | bundleName | string | 是 | 延迟任务包名 | @@ -437,45 +437,45 @@ isLastWorkTimeOut(workId: number): Promise\ **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler -| 名称 | 说明 | -| ---------------------- | ----------------------- | -| NETWORK_TYPE_ANY | 表示这个触发条件是任何类型的网络连接。 | -| NETWORK_TYPE_MOBILE | 表示这个触发条件是Mobile网络连接。 | -| NETWORK_TYPE_WIFI | 表示这个触发条件是Wifi类型的网络连接。 | -| NETWORK_TYPE_BLUETOOTH | 表示这个触发条件是Bluetooth网络连接。 | -| NETWORK_TYPE_WIFI_P2P | 表示这个触发条件是Wifi P2P网络连接。 | -| NETWORK_TYPE_ETHERNET | 表示这个触发条件是有线网络连接。 | +| 名称 | 值 | 说明 | +| ---------------------- | ---- | ----------------------- | +| NETWORK_TYPE_ANY | 0 | 表示这个触发条件是任何类型的网络连接。 | +| NETWORK_TYPE_MOBILE | 1 | 表示这个触发条件是Mobile网络连接。 | +| NETWORK_TYPE_WIFI | 2 | 表示这个触发条件是Wifi类型的网络连接。 | +| NETWORK_TYPE_BLUETOOTH | 3 | 表示这个触发条件是Bluetooth网络连接。 | +| NETWORK_TYPE_WIFI_P2P | 4 | 表示这个触发条件是Wifi P2P网络连接。 | +| NETWORK_TYPE_ETHERNET | 5 | 表示这个触发条件是有线网络连接。 | ## ChargingType 触发工作的充电类型。 **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler -| 名称 | 说明 | -| ------------------------- | -------------------- | -| CHARGING_PLUGGED_ANY | 表示这个触发条件是任何类型的充电器连接。 | -| CHARGING_PLUGGED_AC | 表示这个触发条件是直流充电器连接。 | -| CHARGING_PLUGGED_USB | 表示这个触发条件是USB充连接。 | -| CHARGING_PLUGGED_WIRELESS | 表示这个触发条件是无线充电器连接。 | +| 名称 | 值 | 说明 | +| ------------------------- | ---- | -------------------- | +| CHARGING_PLUGGED_ANY | 0 | 表示这个触发条件是任何类型的充电器连接。 | +| CHARGING_PLUGGED_AC | 1 | 表示这个触发条件是直流充电器连接。 | +| CHARGING_PLUGGED_USB | 2 | 表示这个触发条件是USB充连接。 | +| CHARGING_PLUGGED_WIRELESS | 3 | 表示这个触发条件是无线充电器连接。 | ## BatteryStatus 触发工作的电池状态。 **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler -| 名称 | 说明 | -| -------------------------- | -------------------------- | -| BATTERY_STATUS_LOW | 表示这个触发条件是低电告警。 | -| BATTERY_STATUS_OKAY | 表示这个触发条件是从低电恢复到正常电量。 | -| BATTERY_STATUS_LOW_OR_OKAY | 表示这个触发条件是从低电恢复到正常电量或者低电告警。 | +| 名称 | 值 | 说明 | +| -------------------------- | ---- | -------------------------- | +| BATTERY_STATUS_LOW | 0 | 表示这个触发条件是低电告警。 | +| BATTERY_STATUS_OKAY | 1 | 表示这个触发条件是从低电恢复到正常电量。 | +| BATTERY_STATUS_LOW_OR_OKAY | 2 | 表示这个触发条件是从低电恢复到正常电量或者低电告警。 | ## StorageRequest 触发工作的存储状态。 **系统能力**：SystemCapability.ResourceSchedule.WorkScheduler -| 名称 | 说明 | -| ------------------------- | ------------------------------ | -| STORAGE_LEVEL_LOW | 表示这个触发条件是存储空间不足。 | -| STORAGE_LEVEL_OKAY | 表示这个触发条件是从存储空间不足恢复到正常。 | -| STORAGE_LEVEL_LOW_OR_OKAY | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 | \ No newline at end of file +| 名称 | 值 | 说明 | +| ------------------------- | ---- | ------------------------------ | +| STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 | +| STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 | +| STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md new file mode 100644 index 0000000000000000000000000000000000000000..546e615bff5693e2738953352d77fbdefebc77bd --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -0,0 +1,362 @@ +# 延迟任务调度 + +本模块提供延迟任务注册、取消、查询的能力。 + +开发者在开发应用时，通过调用延迟任务注册接口，注册对实时性要求不高的延迟任务，该任务默认由系统安排，在系统空闲时根据性能、功耗、热等情况进行调度执行。 + +> **说明：** +> +> - 从API Version 9 开始，该接口不再维护，推荐使用新接口[@ohos.resourceschedule.workScheduler (延迟任务调度)](js-apis-resourceschedule-workScheduler.md)。 +> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 本模块接口仅可在Stage模型下使用。 +> - 延迟任务调度约束见[延迟任务调度约束](../../task-management/background-task-overview.md#延迟任务调度约束)。 + + +## 导入模块 + +```js +import workScheduler from '@ohos.workScheduler'; +``` + +## workScheduler.startWork +startWork(work: WorkInfo): boolean + +通知WorkSchedulerService将工作添加到执行队列。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| ---- | --------------------- | ---- | -------------- | +| work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 | + +**返回值**： + +| 类型 | 说明 | +| ------- | -------------------------------- | +| boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 | + +**示例**： + +```js + let workInfo = { + workId: 1, + batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, + isRepeat: false, + isPersisted: true, + bundleName: "com.example.myapplication", + abilityName: "MyExtension", + parameters: { + mykey0: 1, + mykey1: "string value", + mykey2: true, + mykey3: 1.5 + } + } + let res = workScheduler.startWork(workInfo); + console.info(`workschedulerLog res: ${res}`); +``` + +## workScheduler.stopWork +stopWork(work: WorkInfo, needCancel?: boolean): boolean + +通知WorkSchedulerService停止指定工作。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| ---------- | --------------------- | ---- | ---------- | +| work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 | +| needCancel | boolean | 是 | 是否需要取消的工作。 | + +**返回值**： + +| 类型 | 说明 | +| ------- | ----------------------- | +| boolean | 如果成功，则返回true，否则返回false。 | + +**示例**： + +```js + let workInfo = { + workId: 1, + batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, + isRepeat: false, + isPersisted: true, + bundleName: "com.example.myapplication", + abilityName: "MyExtension", + parameters: { + mykey0: 1, + mykey1: "string value", + mykey2: true, + mykey3: 1.5 + } + } + let res = workScheduler.stopWork(workInfo, false); + console.info(`workschedulerLog res: ${res}`); +``` + +## workScheduler.getWorkStatus +getWorkStatus(workId: number, callback : AsyncCallback\): void + +获取工作的最新状态，使用Callback形式返回。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------- | ---- | ---------------------------------------- | +| workId | number | 是 | work的id。 | +| callback | AsyncCallback\<[WorkInfo](#workinfo)> | 是 | 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | + +**示例**： + +```js + workScheduler.getWorkStatus(50, (err, res) => { + if (err) { + console.info(`workschedulerLog getWorkStatus failed, because: ${err.code}`); + } else { + for (let item in res) { + console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`); + } + } + }); +``` + +## workScheduler.getWorkStatus +getWorkStatus(workId: number): Promise\ + +获取工作的最新状态，使用Promise形式返回。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------- | +| workId | number | 是 | work的id。 | + +**返回值**： + +| 类型 | 说明 | +| ------------------------------- | ---------------------------------------- | +| Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | + +**示例**： + +```js + workScheduler.getWorkStatus(50).then((res) => { + for (let item in res) { + console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`); + } + }).catch((err) => { + console.info(`workschedulerLog getWorkStatus failed, because: ${err.code}`); + }) +``` + +## workScheduler.obtainAllWorks +obtainAllWorks(callback : AsyncCallback\): Array\ + +获取与当前应用程序关联的所有工作，使用Callback形式返回。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ------------------------------- | +| callback | AsyncCallback\ | 是 | 指定的callback回调方法。返回与应用程序关联的所有工作。 | + +**返回值**： + +| 类型 | 说明 | +| ----------------------------- | --------------- | +| Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 | + +**示例**： + +```js + workScheduler.obtainAllWorks((err, res) =>{ + if (err) { + console.info(`workschedulerLog obtainAllWorks failed, because: ${err.code}`); + } else { + console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`); + } + }); +``` + +## workScheduler.obtainAllWorks +obtainAllWorks(): Promise> + +获取与当前应用程序关联的所有工作，使用Promise形式返回。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**返回值**： + +| 类型 | 说明 | +| -------------------------------------- | ------------------------------ | +| Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。 | + +**示例**： + +```js + workScheduler.obtainAllWorks().then((res) => { + console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`); + }).catch((err) => { + console.info(`workschedulerLog obtainAllWorks failed, because: ${err.code}`); + }) +``` + +## workScheduler.stopAndClearWorks +stopAndClearWorks(): boolean + +停止和取消与当前应用程序关联的所有工作。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**示例**： + +```js + let res = workScheduler.stopAndClearWorks(); + console.info(`workschedulerLog res: ${res}`); +``` + +## workScheduler.isLastWorkTimeOut +isLastWorkTimeOut(workId: number, callback : AsyncCallback\): boolean + +检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| -------- | -------------------- | ---- | ---------------------------------------- | +| workId | number | 是 | work的id。 | +| callback | AsyncCallback\ | 是 | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | + +**返回值**： + +| 类型 | 说明 | +| ------- | ---------------------------------------- | +| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | + +**示例**： + +```js + workScheduler.isLastWorkTimeOut(500, (err, res) =>{ + if (err) { + console.info(`workschedulerLog isLastWorkTimeOut failed, because: ${err.code}`); + } else { + console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`); + } + }); +``` + +## workScheduler.isLastWorkTimeOut +isLastWorkTimeOut(workId: number): Promise\ + +检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： + +| 名称 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------- | +| workId | number | 是 | work的id。 | + +**返回值**： + +| 类型 | 说明 | +| ----------------- | ---------------------------------------- | +| Promise\ | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | + +**示例**： + +```js + workScheduler.isLastWorkTimeOut(500) + .then(res => { + console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`); + }) + .catch(err => { + console.info(`workschedulerLog isLastWorkTimeOut failed, because: ${err.code}`); + }); +``` + +## WorkInfo +提供工作的具体信息。WorkInfo设置参数约束见[延迟任务调度概述](../../task-management/background-task-overview.md#延迟任务调度约束) + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +| 名称 | 类型 | 必填 | 说明 | +| --------------- | --------------------------------- | ---- | ---------------- | +| workId | number | 是 | 当前工作的ID | +| bundleName | string | 是 | 延迟任务包名 | +| abilityName | string | 是 | 延迟任务回调通知的组件名（必填） | +| networkType | [NetworkType](#networktype) | 否 | 网络类型 | +| isCharging | boolean | 否 | 是否充电 | +| chargerType | [ChargingType](#chargingtype) | 否 | 充电类型 | +| batteryLevel | number | 否 | 电量 | +| batteryStatus | [BatteryStatus](#batterystatus) | 否 | 电池状态 | +| storageRequest | [StorageRequest](#storagerequest) | 否 | 存储状态 | +| isRepeat | boolean | 否 | 是否循环任务 | +| repeatCycleTime | number | 否 | 循环间隔 | +| repeatCount | number | 否 | 循环次数 | +| isPersisted | boolean | 否 | 是否持久化保存工作 | +| isDeepIdle | boolean | 否 | 是否要求设备进入空闲状态 | +| idleWaitTime | number | 否 | 空闲等待时间 | +| parameters | {[key: string]: any} | 否 | 携带参数信息 | + +## NetworkType +触发工作的网络类型。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +| 名称 | 值 | 说明 | +| ---------------------- | ---- | ----------------------- | +| NETWORK_TYPE_ANY | 0 | 表示这个触发条件是任何类型的网络连接。 | +| NETWORK_TYPE_MOBILE | 1 | 表示这个触发条件是Mobile网络连接。 | +| NETWORK_TYPE_WIFI | 2 | 表示这个触发条件是Wifi类型的网络连接。 | +| NETWORK_TYPE_BLUETOOTH | 3 | 表示这个触发条件是Bluetooth网络连接。 | +| NETWORK_TYPE_WIFI_P2P | 4 | 表示这个触发条件是Wifi P2P网络连接。 | +| NETWORK_TYPE_ETHERNET | 5 | 表示这个触发条件是有线网络连接。 | + +## ChargingType +触发工作的充电类型。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +| 名称 | 值 | 说明 | +| ------------------------- | ---- | -------------------- | +| CHARGING_PLUGGED_ANY | 0 | 表示这个触发条件是任何类型的充电器连接。 | +| CHARGING_PLUGGED_AC | 1 | 表示这个触发条件是直流充电器连接。 | +| CHARGING_PLUGGED_USB | 2 | 表示这个触发条件是USB充连接。 | +| CHARGING_PLUGGED_WIRELESS | 3 | 表示这个触发条件是无线充电器连接。 | + +## BatteryStatus +触发工作的电池状态。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +| 名称 | 值 | 说明 | +| -------------------------- | ---- | -------------------------- | +| BATTERY_STATUS_LOW | 0 | 表示这个触发条件是低电告警。 | +| BATTERY_STATUS_OKAY | 1 | 表示这个触发条件是从低电恢复到正常电量。 | +| BATTERY_STATUS_LOW_OR_OKAY | 2 | 表示这个触发条件是从低电恢复到正常电量或者低电告警。 | + +## StorageRequest +触发工作的存储状态。 + +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +| 名称 | 值 | 说明 | +| ------------------------- | ---- | ------------------------------ | +| STORAGE_LEVEL_LOW | 0 | 表示这个触发条件是存储空间不足。 | +| STORAGE_LEVEL_OKAY | 1 | 表示这个触发条件是从存储空间不足恢复到正常。 | +| STORAGE_LEVEL_LOW_OR_OKAY | 2 | 表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 | \ No newline at end of file