From 7748d98374ae7f4100b0aff265a41ffe67688381 Mon Sep 17 00:00:00 2001 From: nobbo Date: Tue, 15 Mar 2022 17:25:40 +0800 Subject: [PATCH 1/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- .../reference/apis/js-apis-workScheduler.md | 740 +++++++++--------- 1 file changed, 370 insertions(+), 370 deletions(-) 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 f16a2d405f0..2c490ce3ff9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -1,375 +1,375 @@ -# 延迟任务调度 - -> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 - - -## 导入模块 - -``` -import workScheduler from '@ohos.workScheduler' -``` - -## workScheduler.startWork -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -workScheduler.startWork(work: WorkInfo): boolean - +# 延迟任务调度 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + +``` +import workScheduler from '@ohos.workScheduler' +``` + +## workScheduler.startWork +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +workScheduler.startWork(work: [WorkInfo](#workScheduler.WorkInfo)): boolean + - **说明**： -通知WorkSchedulerService将工作添加到执行队列。 - +通知WorkSchedulerService将工作添加到执行队列。 + - **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | work | WorkInfo | 是 | 指示要添加到执行队列的工作。 | - + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | work | [WorkInfo](#workScheduler.WorkInfo) | 是 | 指示要添加到执行队列的工作。 | + - **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 | - + + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 | + - **示例**： - - ``` - let workInfo = { - workId: 1, - batteryLevel:50, - batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, - isRepeat: false, - isPersisted: true, - bundleName: "com.example.myapplication", - abilityName: "MyExtension" - } - var res = workScheduler.startWork(workInfo); - console.info("workschedulerLog res:" + res); - ``` - -## workScheduler.stopWork -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -stopWork(work: WorkInfo, needCancel?: boolean): boolean - -- **说明**： -通知WorkSchedulerService停止指定工作。 - -- **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | work | WorkInfo | 是 | 指示要停止的工作。 | - |needCancel|boolean| 是| 是否需要取消的工作。| - -- **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | boolean | 如果成功，则返回true，否则返回false。 | - -- **示例**： - - ``` - let workInfo = { - workId: 1, - batteryLevel:50, - batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, - isRepeat: false, - isPersisted: true, - bundleName: "com.example.myapplication", - abilityName: "MyExtension" - } - var res = workScheduler.stopWork(workInfo, false); - console.info("workschedulerLog res:" + res); - ``` - -## workScheduler.getWorkStatus -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -getWorkStatus(workId: number, callback : AsyncCallback): void - -- **说明**： -获取工作的最新状态，使用Callback形式返回。 - -- **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | - |callback|AsyncCallback| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| - - -- **示例**： - - ``` - workScheduler.getWorkStatus(50, (err, res) => { - if (err) { - console.info('workschedulerLog getWorkStatus failed, because:' + err.data); - } else { - for (let item in res) { - console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); - } - } - }); - ``` - -## workScheduler.getWorkStatus -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -getWorkStatus(workID: number): Promise - -- **说明**： -获取工作的最新状态，使用Promise形式返回。 - -- **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | - -- **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | Promise | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | - -- **示例**： - - ``` - 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.data); - }) - ``` - -## workScheduler.obtainAllWorks -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -obtainAllWorks(callback : AsyncCallback): Array - -- **说明**： -获取与当前应用程序关联的所有工作，使用Callback形式返回。 - -- **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - |callback|AsyncCallback| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。| - - -- **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | Array | 返回与应用程序关联的所有工作。 | - -- **示例**： - - ``` - workScheduler.obtainAllWorks((err, res) =>{ - if (err) { - console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); - } else { - console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); - } - }); - ``` - -## workScheduler.obtainAllWorks -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -obtainAllWorks(): Promise> - -- **说明**： -获取与当前应用程序关联的所有工作，使用Promise形式返回。 - -- **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| - -- **示例**： - - ``` - workScheduler.obtainAllWorks().then((res) => { - console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); - }).catch((err) => { - console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); - }) - ``` - -## workScheduler.stopAndClearWorks -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -stopAndClearWorks(): boolean - -- **说明**： -停止和取消与当前应用程序关联的所有工作。 - -- **示例**： - - ``` - let res = workScheduler.stopAndClearWorks(); - console.info("workschedulerLog res:" + res); - ``` - -## workScheduler.isLastWorkTimeOut -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -isLastWorkTimeOut(workId: number, callback : AsyncCallback): boolean - -- **说明**： -检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。 - -- **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | - |callback|AsyncCallback| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| - -- **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | - -- **示例**： - - ``` - workScheduler.isLastWorkTimeOut(500, (err, res) =>{ - if (err) { - console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); - } else { - console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); - } - }); - ``` - -## workScheduler.isLastWorkTimeOut -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -isLastWorkTimeOut(workId: number): Promise - -- **说明**： -检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。 - -- **参数**： - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | - -- **返回值**： - - | 类型 | 说明 | - | -------- | -------- | - | Promise | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| - -- **示例**： - - ``` - workScheduler.isLastWorkTimeOut(500) - .then(res => { - console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); - }) - .catch(err => { - console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); - }); - }) - ``` - -## workScheduler.WorkInfo -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -提供工作的具体信息。 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - |workId |number |是 |当前工作的ID。| - |bundleName |string |是| 延迟任务包名。| - |abilityName | string| 是| 延迟任务回调通知的组件名（必填）| - |networkType | NetworkType| 否| 网络条件 | - |isCharging | bool| 否|是否充电 | - |chargerType | ChargingType| 否|充电类型 | - |batteryLevel | number| 否|电量| - |batteryStatus| BatteryStatus| 否|电池状态| - |storageRequest|StorageRequest| 否|存储状态| - |isRepeat|boolean|否|是否循环任务| - |repeatCycleTime |number|否|循环间隔| - |repeatCount |number|否|循环次数| - -## workScheduler.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 |表示这个触发条件是有线网络连接。| - -## workScheduler.ChargingType -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -触发工作的充电类型。 - - |名称 |默认值 |说明| - | -------- | -------- | -------- | - |CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。| - |CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。| - |CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。| - |CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。| - -## workScheduler.BatteryStatus -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -触发工作的电池状态。 - - |名称 |默认值 |说明| - | -------- | -------- | -------- | - |BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。| - |BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。| - |BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。| - -## workScheduler.StorageRequest -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -触发工作的存储状态。 - - |名称 |默认值 |说明| - | -------- | -------- | -------- | - |STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。 - |STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。 + + ``` + let workInfo = { + workId: 1, + batteryLevel:50, + batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, + isRepeat: false, + isPersisted: true, + bundleName: "com.example.myapplication", + abilityName: "MyExtension" + } + var res = workScheduler.startWork(workInfo); + console.info("workschedulerLog res:" + res); + ``` + +## workScheduler.stopWork +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +stopWork(work: [WorkInfo](#workScheduler.WorkInfo), needCancel?: boolean): boolean + +- **说明**： +通知WorkSchedulerService停止指定工作。 + +- **参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | work | [WorkInfo](#workScheduler.WorkInfo) | 是 | 指示要停止的工作。 | + |needCancel|boolean| 是| 是否需要取消的工作。| + +- **返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | boolean | 如果成功，则返回true，否则返回false。 | + +- **示例**： + + ``` + let workInfo = { + workId: 1, + batteryLevel:50, + batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, + isRepeat: false, + isPersisted: true, + bundleName: "com.example.myapplication", + abilityName: "MyExtension" + } + var res = workScheduler.stopWork(workInfo, false); + console.info("workschedulerLog res:" + res); + ``` + +## workScheduler.getWorkStatus +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +getWorkStatus(workId: number, callback : AsyncCallback\<[WorkInfo](#workScheduler.WorkInfo)>): void + +- **说明**： +获取工作的最新状态，使用Callback形式返回。 + +- **参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | workId | number | 是 | work的id。 | + |callback|AsyncCallback\<[WorkInfo](#workScheduler.WorkInfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| + + +- **示例**： + + ``` + workScheduler.getWorkStatus(50, (err, res) => { + if (err) { + console.info('workschedulerLog getWorkStatus failed, because:' + err.data); + } else { + for (let item in res) { + console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); + } + } + }); + ``` + +## workScheduler.getWorkStatus +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +getWorkStatus(workID: number): Promise\<[WorkInfo](#workScheduler.WorkInfo)> + +- **说明**： +获取工作的最新状态，使用Promise形式返回。 + +- **参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | workId | number | 是 | work的id。 | + +- **返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | Promise\<[WorkInfo](#workScheduler.WorkInfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | + +- **示例**： + + ``` + 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.data); + }) + ``` + +## workScheduler.obtainAllWorks +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +obtainAllWorks(callback : AsyncCallback\): Array\<[WorkInfo](#workScheduler.WorkInfo)> + +- **说明**： +获取与当前应用程序关联的所有工作，使用Callback形式返回。 + +- **参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + |callback|AsyncCallback\| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。| + + +- **返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | Array\<[WorkInfo](#workScheduler.WorkInfo)> | 返回与应用程序关联的所有工作。 | + +- **示例**： + + ``` + workScheduler.obtainAllWorks((err, res) =>{ + if (err) { + console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); + } else { + console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); + } + }); + ``` + +## workScheduler.obtainAllWorks +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +obtainAllWorks(): Promise> + +- **说明**： +获取与当前应用程序关联的所有工作，使用Promise形式返回。 + +- **返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| + +- **示例**： + + ``` + workScheduler.obtainAllWorks().then((res) => { + console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); + }).catch((err) => { + console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); + }) + ``` + +## workScheduler.stopAndClearWorks +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +stopAndClearWorks(): boolean + +- **说明**： +停止和取消与当前应用程序关联的所有工作。 + +- **示例**： + + ``` + let res = workScheduler.stopAndClearWorks(); + console.info("workschedulerLog res:" + res); + ``` + +## workScheduler.isLastWorkTimeOut +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +isLastWorkTimeOut(workId: number, callback : AsyncCallback\): boolean + +- **说明**： +检查指定工作的最后一次执行是否为超时操作，使用Callback形式返回。 + +- **参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | workId | number | 是 | work的id。 | + |callback|AsyncCallback\| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| + +- **返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | + +- **示例**： + + ``` + workScheduler.isLastWorkTimeOut(500, (err, res) =>{ + if (err) { + console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); + } else { + console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); + } + }); + ``` + +## workScheduler.isLastWorkTimeOut +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +- **接口**： +isLastWorkTimeOut(workId: number): Promise\ + +- **说明**： +检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。 + +- **参数**： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | workId | number | 是 | work的id。 | + +- **返回值**： + + | 类型 | 说明 | + | -------- | -------- | + | Promise\ | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| + +- **示例**： + + ``` + workScheduler.isLastWorkTimeOut(500) + .then(res => { + console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); + }) + .catch(err => { + console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); + }); + }) + ``` + +## workScheduler.WorkInfo +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +提供工作的具体信息。 + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +|workId |number |是 |当前工作的ID。| +|bundleName |string |是| 延迟任务包名。| +|abilityName | string| 是| 延迟任务回调通知的组件名（必填）| +|networkType | [NetworkType](#workScheduler.NetworkType) | 否| 网络条件 | +|isCharging | bool| 否|是否充电 | +|chargerType | [ChargingType](#workScheduler.ChargingType) | 否|充电类型 | +|batteryLevel | number| 否|电量| +|batteryStatus| [BatteryStatus](#workScheduler.BatteryStatus) | 否|电池状态| +|storageRequest|[StorageRequest](#workScheduler.StorageRequest)| 否|存储状态| +|isRepeat|boolean|否|是否循环任务| +|repeatCycleTime |number|否|循环间隔| +|repeatCount |number|否|循环次数| + +## workScheduler.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 |表示这个触发条件是有线网络连接。| + +## workScheduler.ChargingType +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +触发工作的充电类型。 + + |名称 |默认值 |说明| + | -------- | -------- | -------- | + |CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。| + |CHARGING_PLUGGED_AC |1 |表示这个触发条件是直流充电器连接。| + |CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。| + |CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。| + +## workScheduler.BatteryStatus +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +触发工作的电池状态。 + + |名称 |默认值 |说明| + | -------- | -------- | -------- | + |BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。| + |BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。| + |BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。| + +## workScheduler.StorageRequest +- **系统能力**： +SystemCapability.ResourceSchedule.WorkScheduler + +触发工作的存储状态。 + + |名称 |默认值 |说明| + | -------- | -------- | -------- | + |STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。 + |STORAGE_LEVEL_OKAY |1 |表示这个触发条件是从存储空间不足恢复到正常。 |STORAGE_LEVEL_LOW_OR_OKAY |2 |表示这个触发条件是从存储空间不足恢复到正常或者存储空间不足。 \ No newline at end of file -- Gitee From e1910033790c02b977d067a20a05bae8b238374b Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 10:02:02 +0800 Subject: [PATCH 2/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- zh-cn/application-dev/reference/apis/js-apis-workScheduler.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 2c490ce3ff9..c43413507f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -15,7 +15,7 @@ import workScheduler from '@ohos.workScheduler' SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -workScheduler.startWork(work: [WorkInfo](#workScheduler.WorkInfo)): boolean +workScheduler.startWork(work: [WorkInfo](#workscheduler.workinfo)): boolean - **说明**： 通知WorkSchedulerService将工作添加到执行队列。 @@ -24,7 +24,7 @@ workScheduler.startWork(work: [WorkInfo](#workScheduler.WorkInfo)): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | work | [WorkInfo](#workScheduler.WorkInfo) | 是 | 指示要添加到执行队列的工作。 | + | work | [WorkInfo](#workscheduler.workinfo) | 是 | 指示要添加到执行队列的工作。 | - **返回值**： -- Gitee From ed254c3ba088bf28f6f86564ec07b400127b1a4c Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 10:06:34 +0800 Subject: [PATCH 3/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- zh-cn/application-dev/reference/apis/js-apis-workScheduler.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 c43413507f6..6194d059ce3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -15,7 +15,7 @@ import workScheduler from '@ohos.workScheduler' SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -workScheduler.startWork(work: [WorkInfo](#workscheduler.workinfo)): boolean +workScheduler.startWork(work: [WorkInfo](#workinfo)): boolean - **说明**： 通知WorkSchedulerService将工作添加到执行队列。 @@ -301,7 +301,7 @@ isLastWorkTimeOut(workId: number): Promise\ }) ``` -## workScheduler.WorkInfo +## WorkInfo - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler -- Gitee From ff6e6a2aebedbb201c68ec427db214e6c1074e89 Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 10:09:13 +0800 Subject: [PATCH 4/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- zh-cn/application-dev/reference/apis/js-apis-workScheduler.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 6194d059ce3..c43413507f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -15,7 +15,7 @@ import workScheduler from '@ohos.workScheduler' SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -workScheduler.startWork(work: [WorkInfo](#workinfo)): boolean +workScheduler.startWork(work: [WorkInfo](#workscheduler.workinfo)): boolean - **说明**： 通知WorkSchedulerService将工作添加到执行队列。 @@ -301,7 +301,7 @@ isLastWorkTimeOut(workId: number): Promise\ }) ``` -## WorkInfo +## workScheduler.WorkInfo - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler -- Gitee From a9022726a0f4a51392ebcaf34fdad251304de75e Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 10:21:45 +0800 Subject: [PATCH 5/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- .../reference/apis/js-apis-workScheduler.md | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) 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 c43413507f6..7a79451c950 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -15,7 +15,7 @@ import workScheduler from '@ohos.workScheduler' SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -workScheduler.startWork(work: [WorkInfo](#workscheduler.workinfo)): boolean +workScheduler.startWork(work: [WorkInfo](#workinfo)): boolean - **说明**： 通知WorkSchedulerService将工作添加到执行队列。 @@ -24,7 +24,7 @@ workScheduler.startWork(work: [WorkInfo](#workscheduler.workinfo)): boolean | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | work | [WorkInfo](#workscheduler.workinfo) | 是 | 指示要添加到执行队列的工作。 | + | work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 | - **返回值**： @@ -53,7 +53,7 @@ workScheduler.startWork(work: [WorkInfo](#workscheduler.workinfo)): boolean SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -stopWork(work: [WorkInfo](#workScheduler.WorkInfo), needCancel?: boolean): boolean +stopWork(work: [WorkInfo](#workinfo), needCancel?: boolean): boolean - **说明**： 通知WorkSchedulerService停止指定工作。 @@ -62,7 +62,7 @@ stopWork(work: [WorkInfo](#workScheduler.WorkInfo), needCancel?: boolean): boole | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | work | [WorkInfo](#workScheduler.WorkInfo) | 是 | 指示要停止的工作。 | + | work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 | |needCancel|boolean| 是| 是否需要取消的工作。| - **返回值**： @@ -92,7 +92,7 @@ stopWork(work: [WorkInfo](#workScheduler.WorkInfo), needCancel?: boolean): boole SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -getWorkStatus(workId: number, callback : AsyncCallback\<[WorkInfo](#workScheduler.WorkInfo)>): void +getWorkStatus(workId: number, callback : AsyncCallback\<[WorkInfo](#workinfo)>): void - **说明**： 获取工作的最新状态，使用Callback形式返回。 @@ -102,7 +102,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<[WorkInfo](#workSchedule | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | workId | number | 是 | work的id。 | - |callback|AsyncCallback\<[WorkInfo](#workScheduler.WorkInfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| + |callback|AsyncCallback\<[WorkInfo](#workinfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| - **示例**： @@ -124,7 +124,7 @@ getWorkStatus(workId: number, callback : AsyncCallback\<[WorkInfo](#workSchedule SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -getWorkStatus(workID: number): Promise\<[WorkInfo](#workScheduler.WorkInfo)> +getWorkStatus(workID: number): Promise\<[WorkInfo](#workinfo)> - **说明**： 获取工作的最新状态，使用Promise形式返回。 @@ -139,7 +139,7 @@ getWorkStatus(workID: number): Promise\<[WorkInfo](#workScheduler.WorkInfo)> | 类型 | 说明 | | -------- | -------- | - | Promise\<[WorkInfo](#workScheduler.WorkInfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | + | Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | - **示例**： @@ -158,7 +158,7 @@ getWorkStatus(workID: number): Promise\<[WorkInfo](#workScheduler.WorkInfo)> SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -obtainAllWorks(callback : AsyncCallback\): Array\<[WorkInfo](#workScheduler.WorkInfo)> +obtainAllWorks(callback : AsyncCallback\): Array\<[WorkInfo](#workinfo)> - **说明**： 获取与当前应用程序关联的所有工作，使用Callback形式返回。 @@ -174,7 +174,7 @@ obtainAllWorks(callback : AsyncCallback\): Array\<[WorkInfo](#workSchedule | 类型 | 说明 | | -------- | -------- | - | Array\<[WorkInfo](#workScheduler.WorkInfo)> | 返回与应用程序关联的所有工作。 | + | Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 | - **示例**： @@ -193,7 +193,7 @@ obtainAllWorks(callback : AsyncCallback\): Array\<[WorkInfo](#workSchedule SystemCapability.ResourceSchedule.WorkScheduler - **接口**： -obtainAllWorks(): Promise> +obtainAllWorks(): Promise> - **说明**： 获取与当前应用程序关联的所有工作，使用Promise形式返回。 @@ -202,7 +202,7 @@ obtainAllWorks(): Promise> | 类型 | 说明 | | -------- | -------- | - | Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| + | Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| - **示例**： @@ -301,7 +301,7 @@ isLastWorkTimeOut(workId: number): Promise\ }) ``` -## workScheduler.WorkInfo +## WorkInfo - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler @@ -312,17 +312,17 @@ SystemCapability.ResourceSchedule.WorkScheduler |workId |number |是 |当前工作的ID。| |bundleName |string |是| 延迟任务包名。| |abilityName | string| 是| 延迟任务回调通知的组件名（必填）| -|networkType | [NetworkType](#workScheduler.NetworkType) | 否| 网络条件 | +|networkType | [NetworkType](#networktype) | 否| 网络条件 | |isCharging | bool| 否|是否充电 | -|chargerType | [ChargingType](#workScheduler.ChargingType) | 否|充电类型 | +|chargerType | [ChargingType](#chargingtype) | 否|充电类型 | |batteryLevel | number| 否|电量| -|batteryStatus| [BatteryStatus](#workScheduler.BatteryStatus) | 否|电池状态| -|storageRequest|[StorageRequest](#workScheduler.StorageRequest)| 否|存储状态| +|batteryStatus| [BatteryStatus](#batterystatus) | 否|电池状态| +|storageRequest|[StorageRequest](#storagerequest)| 否|存储状态| |isRepeat|boolean|否|是否循环任务| |repeatCycleTime |number|否|循环间隔| |repeatCount |number|否|循环次数| -## workScheduler.NetworkType +## NetworkType - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler @@ -337,7 +337,7 @@ SystemCapability.ResourceSchedule.WorkScheduler |NETWORK_TYPE_WIFI_P2P |4 |表示这个触发条件是Wifi P2P网络连接。| |NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。| -## workScheduler.ChargingType +## ChargingType - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler @@ -350,7 +350,7 @@ SystemCapability.ResourceSchedule.WorkScheduler |CHARGING_PLUGGED_USB |2 |表示这个触发条件是USB充连接。| |CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。| -## workScheduler.BatteryStatus +## BatteryStatus - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler @@ -362,7 +362,7 @@ SystemCapability.ResourceSchedule.WorkScheduler |BATTERY_STATUS_OKAY |1| 表示这个触发条件是从低电恢复到正常电量。| |BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。| -## workScheduler.StorageRequest +## StorageRequest - **系统能力**： SystemCapability.ResourceSchedule.WorkScheduler -- Gitee From 1b3910323df2d97ec64a750cb962533075931f2a Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 15:29:02 +0800 Subject: [PATCH 6/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- .../reference/apis/js-apis-workScheduler.md | 400 ++++++++---------- 1 file changed, 183 insertions(+), 217 deletions(-) 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 7a79451c950..030443b5af3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -11,302 +11,272 @@ import workScheduler from '@ohos.workScheduler' ``` ## workScheduler.startWork -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +startWork(work: WorkInfo): boolean -- **接口**： -workScheduler.startWork(work: [WorkInfo](#workinfo)): boolean - -- **说明**： 通知WorkSchedulerService将工作添加到执行队列。 -- **参数**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 | +**参数**： -- **返回值**： +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| work | [WorkInfo](#workinfo) | 是 | 指示要添加到执行队列的工作。 | - | 类型 | 说明 | - | -------- | -------- | - | boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 | +**返回值**： -- **示例**： +| 类型 | 说明 | +| -------- | -------- | +| boolean | 如果工作成功添加到执行队列，则返回true，否则返回false。 | - ``` - let workInfo = { - workId: 1, - batteryLevel:50, - batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, - isRepeat: false, - isPersisted: true, - bundleName: "com.example.myapplication", - abilityName: "MyExtension" - } - var res = workScheduler.startWork(workInfo); - console.info("workschedulerLog res:" + res); - ``` +**示例**： -## workScheduler.stopWork -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +``` + let workInfo = { + workId: 1, + batteryLevel:50, + batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, + isRepeat: false, + isPersisted: true, + bundleName: "com.example.myapplication", + abilityName: "MyExtension" + } + var res = workScheduler.startWork(workInfo); + console.info("workschedulerLog res:" + res); +``` -- **接口**： -stopWork(work: [WorkInfo](#workinfo), needCancel?: boolean): boolean +## workScheduler.stopWork +stopWork(work: WorkInfo, needCancel?: boolean): boolean -- **说明**： 通知WorkSchedulerService停止指定工作。 -- **参数**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 | - |needCancel|boolean| 是| 是否需要取消的工作。| +**参数**： -- **返回值**： +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| work | [WorkInfo](#workinfo) | 是 | 指示要停止的工作。 | +|needCancel|boolean| 是| 是否需要取消的工作。| - | 类型 | 说明 | - | -------- | -------- | - | boolean | 如果成功，则返回true，否则返回false。 | +**返回值**： -- **示例**： +| 类型 | 说明 | +| -------- | -------- | +| boolean | 如果成功，则返回true，否则返回false。 | - ``` - let workInfo = { - workId: 1, - batteryLevel:50, - batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, - isRepeat: false, - isPersisted: true, - bundleName: "com.example.myapplication", - abilityName: "MyExtension" - } - var res = workScheduler.stopWork(workInfo, false); - console.info("workschedulerLog res:" + res); - ``` +**示例**： -## workScheduler.getWorkStatus -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +``` + let workInfo = { + workId: 1, + batteryLevel:50, + batteryStatus:workScheduler.BatteryStatus.BATTERY_STATUS_LOW, + isRepeat: false, + isPersisted: true, + bundleName: "com.example.myapplication", + abilityName: "MyExtension" + } + var res = workScheduler.stopWork(workInfo, false); + console.info("workschedulerLog res:" + res); +``` -- **接口**： -getWorkStatus(workId: number, callback : AsyncCallback\<[WorkInfo](#workinfo)>): void +## workScheduler.getWorkStatus +getWorkStatus(workId: number, callback : AsyncCallback\): void -- **说明**： 获取工作的最新状态，使用Callback形式返回。 -- **参数**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | - |callback|AsyncCallback\<[WorkInfo](#workinfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| +**参数**： +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| workId | number | 是 | work的id。 | +|callback|AsyncCallback\<[WorkInfo](#workinfo)>| 是| 指定的callback回调方法。如果指定的工作Id有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。| -- **示例**： +**示例**： - ``` - workScheduler.getWorkStatus(50, (err, res) => { - if (err) { - console.info('workschedulerLog getWorkStatus failed, because:' + err.data); - } else { - for (let item in res) { - console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); - } +``` + workScheduler.getWorkStatus(50, (err, res) => { + if (err) { + console.info('workschedulerLog getWorkStatus failed, because:' + err.data); + } else { + for (let item in res) { + console.info('workschedulerLog getWorkStatus success,' + item + ' is:' + res[item]); } - }); - ``` + } + }); +``` ## workScheduler.getWorkStatus -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -getWorkStatus(workID: number): Promise\<[WorkInfo](#workinfo)> +getWorkStatus(workID: number): Promise\ -- **说明**： 获取工作的最新状态，使用Promise形式返回。 -- **参数**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | +**参数**： -- **返回值**： +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| workId | number | 是 | work的id。 | - | 类型 | 说明 | - | -------- | -------- | - | Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | +**返回值**： -- **示例**： +| 类型 | 说明 | +| -------- | -------- | +| Promise\<[WorkInfo](#workinfo)> | 指定的Promise回调方法。如果指定的工作ID有效，则返回从WorkSchedulerService获取的有效工作状态；否则返回null。 | - ``` - 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.data); - }) - ``` +**示例**： -## workScheduler.obtainAllWorks -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +``` + 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.data); + }) +``` -- **接口**： -obtainAllWorks(callback : AsyncCallback\): Array\<[WorkInfo](#workinfo)> +## workScheduler.obtainAllWorks +obtainAllWorks(callback : AsyncCallback\): Array\ -- **说明**： 获取与当前应用程序关联的所有工作，使用Callback形式返回。 -- **参数**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - |callback|AsyncCallback\| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。| +**参数**： +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +|callback|AsyncCallback\| 是| 指定的callback回调方法。返回与应用程序关联的所有工作。| -- **返回值**： +**返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 | +| 类型 | 说明 | +| -------- | -------- | +| Array\<[WorkInfo](#workinfo)> | 返回与应用程序关联的所有工作。 | -- **示例**： +**示例**： - ``` - workScheduler.obtainAllWorks((err, res) =>{ - if (err) { - console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); - } else { - console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); - } - }); - ``` +``` + workScheduler.obtainAllWorks((err, res) =>{ + if (err) { + console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); + } else { + console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); + } + }); +``` ## workScheduler.obtainAllWorks -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - -- **接口**： -obtainAllWorks(): Promise> +obtainAllWorks(): Promise> -- **说明**： 获取与当前应用程序关联的所有工作，使用Promise形式返回。 -- **返回值**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - | 类型 | 说明 | - | -------- | -------- | - | Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| +**返回值**： -- **示例**： +| 类型 | 说明 | +| -------- | -------- | +| Promise> | 指定的Promise回调方法。返回与应用程序关联的所有工作。| - ``` - workScheduler.obtainAllWorks().then((res) => { - console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); - }).catch((err) => { - console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); - }) - ``` +**示例**： -## workScheduler.stopAndClearWorks -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +``` + workScheduler.obtainAllWorks().then((res) => { + console.info('workschedulerLog obtainAllWorks success, data is:' + JSON.stringify(res)); + }).catch((err) => { + console.info('workschedulerLog obtainAllWorks failed, because:' + err.data); + }) +``` -- **接口**： +## workScheduler.stopAndClearWorks stopAndClearWorks(): boolean -- **说明**： 停止和取消与当前应用程序关联的所有工作。 -- **示例**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler - ``` - let res = workScheduler.stopAndClearWorks(); - console.info("workschedulerLog res:" + res); - ``` +**示例**： -## workScheduler.isLastWorkTimeOut -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +``` + 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。| +**参数**： -- **返回值**： +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| workId | number | 是 | work的id。 | +|callback|AsyncCallback\| 是| 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| - | 类型 | 说明 | - | -------- | -------- | - | boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | +**返回值**： -- **示例**： +| 类型 | 说明 | +| -------- | -------- | +| boolean | 指定的callback回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。 | - ``` - workScheduler.isLastWorkTimeOut(500, (err, res) =>{ - if (err) { - console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); - } else { - console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); - } - }); - ``` +**示例**： -## workScheduler.isLastWorkTimeOut -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler +``` + workScheduler.isLastWorkTimeOut(500, (err, res) =>{ + if (err) { + console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); + } else { + console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); + } + }); +``` -- **接口**： +## workScheduler.isLastWorkTimeOut isLastWorkTimeOut(workId: number): Promise\ -- **说明**： 检查指定工作的最后一次执行是否为超时操作，使用Promise形式返回。 -- **参数**： +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + +**参数**： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------- | -------- | -------- | - | workId | number | 是 | work的id。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| workId | number | 是 | work的id。 | -- **返回值**： +**返回值**： - | 类型 | 说明 | - | -------- | -------- | - | Promise\ | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| +| 类型 | 说明 | +| -------- | -------- | +| Promise\ | 指定的Promise回调方法。如果指定工作的最后一次执行是超时操作，则返回true；否则返回false。| -- **示例**： +**示例**： - ``` - workScheduler.isLastWorkTimeOut(500) - .then(res => { - console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); - }) - .catch(err => { - console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); - }); +``` + workScheduler.isLastWorkTimeOut(500) + .then(res => { + console.info('workschedulerLog isLastWorkTimeOut success, data is:' + res); }) - ``` + .catch(err => { + console.info('workschedulerLog isLastWorkTimeOut failed, because:' + err.data); + }); + }) +``` ## WorkInfo -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - 提供工作的具体信息。 +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | |workId |number |是 |当前工作的ID。| @@ -323,11 +293,10 @@ SystemCapability.ResourceSchedule.WorkScheduler |repeatCount |number|否|循环次数| ## NetworkType -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - 触发工作的网络类型。 +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + |名称 |默认值 |说明| | -------- | -------- | -------- | |NETWORK_TYPE_ANY |0 |表示这个触发条件是任何类型的网络连接。| @@ -338,11 +307,10 @@ SystemCapability.ResourceSchedule.WorkScheduler |NETWORK_TYPE_ETHERNET |5 |表示这个触发条件是有线网络连接。| ## ChargingType -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - 触发工作的充电类型。 +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + |名称 |默认值 |说明| | -------- | -------- | -------- | |CHARGING_PLUGGED_ANY |0| 表示这个触发条件是任何类型的充电器连接。| @@ -351,11 +319,10 @@ SystemCapability.ResourceSchedule.WorkScheduler |CHARGING_PLUGGED_WIRELESS |3| 表示这个触发条件是无线充电器连接。| ## BatteryStatus -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - 触发工作的电池状态。 +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + |名称 |默认值 |说明| | -------- | -------- | -------- | |BATTERY_STATUS_LOW |0 |表示这个触发条件是低电告警。| @@ -363,11 +330,10 @@ SystemCapability.ResourceSchedule.WorkScheduler |BATTERY_STATUS_LOW_OR_OKAY |2 |表示这个触发条件是从低电恢复到正常电量或者低电告警。| ## StorageRequest -- **系统能力**： -SystemCapability.ResourceSchedule.WorkScheduler - 触发工作的存储状态。 +**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler + |名称 |默认值 |说明| | -------- | -------- | -------- | |STORAGE_LEVEL_LOW |0 |表示这个触发条件是存储空间不足。 -- Gitee From d0b78d73be2fdff0b8d286b54b6278ba05708136 Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 15:36:10 +0800 Subject: [PATCH 7/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- .../reference/apis/js-apis-workScheduler.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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 030443b5af3..8224175b470 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -275,7 +275,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## WorkInfo 提供工作的具体信息。 -**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -295,7 +295,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## NetworkType 触发工作的网络类型。 -**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler |名称 |默认值 |说明| | -------- | -------- | -------- | @@ -309,7 +309,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## ChargingType 触发工作的充电类型。 -**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler |名称 |默认值 |说明| | -------- | -------- | -------- | @@ -321,7 +321,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## BatteryStatus 触发工作的电池状态。 -**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler |名称 |默认值 |说明| | -------- | -------- | -------- | @@ -332,7 +332,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## StorageRequest 触发工作的存储状态。 -**系统能力**：SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler |名称 |默认值 |说明| | -------- | -------- | -------- | -- Gitee From 407f7446c4a67971c008d249d4a9c6885dfe80ed Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 15:40:18 +0800 Subject: [PATCH 8/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- zh-cn/application-dev/reference/apis/js-apis-workScheduler.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 8224175b470..c7dd2355d6d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -332,7 +332,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## StorageRequest 触发工作的存储状态。 -**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler |名称 |默认值 |说明| | -------- | -------- | -------- | -- Gitee From dd373356ead43807982002811e4463b1db466377 Mon Sep 17 00:00:00 2001 From: nobbo Date: Wed, 16 Mar 2022 15:42:13 +0800 Subject: [PATCH 9/9] =?UTF-8?q?=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: nobbo --- zh-cn/application-dev/reference/apis/js-apis-workScheduler.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 c7dd2355d6d..8224175b470 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md +++ b/zh-cn/application-dev/reference/apis/js-apis-workScheduler.md @@ -332,7 +332,7 @@ isLastWorkTimeOut(workId: number): Promise\ ## StorageRequest 触发工作的存储状态。 -**系统能力**：下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler +**系统能力**：以下各项对应的系统能力均为SystemCapability.ResourceSchedule.WorkScheduler |名称 |默认值 |说明| | -------- | -------- | -------- | -- Gitee