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 7a79451c950fa5bce69da48d88254dda15e59ff3..030443b5af334b9c0f3fc87ba19e4c0fea691aee 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 |表示这个触发条件是存储空间不足。