Work Scheduler Development

When to Use

If your application needs to execute a non-real-time task or a persistent task, for example, data learning, you can harness the Work Scheduler mechanism, which will schedule the task based on the storage space, power consumption, temperature, and more when the preset conditions are met. Your application must implement the callbacks provided by WorkSchedulerExtensionAbility for Work Scheduler tasks. For details about the restrictions, see Restrictions on Using Work Scheduler.

Available APIs

Table 1 Major workScheduler APIs

Table 2 WorkInfo parameters

For details about the restriction on configuring WorkInfo, see Restrictions on Using Work Scheduler.

Table 3 Work Scheduler callbacks

How to Develop

1. Import the modules.

Import the workScheduler module.

   import workScheduler from '@ohos.resourceschedule.workScheduler';

Import the WorkSchedulerExtensionAbility module.

   import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';

1. Develop an ExtensionAbility to execute a Work Scheduler task. For details about the ExtensionAbility, see ExtensionAbility Component Overview and WorkSchedulerExtensionAbility Development.

   import WorkSchedulerExtensionAbility from '@ohos.WorkSchedulerExtensionAbility';
   
   export default class MyExtension extends WorkSchedulerExtensionAbility {
       onWorkStart(workInfo) {
           console.log('MyWorkSchedulerExtensionAbility onWorkStart' + JSON.stringify(workInfo));
       }
       onWorkStop(workInfo) {
           console.log('MyWorkSchedulerExtensionAbility onWorkStop' + JSON.stringify(workInfo));
       }
   }

1. Start a Work Scheduler task.

   import workScheduler from '@ohos.resourceschedule.workScheduler';
       
   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
     }
   }
   try{
     workScheduler.startWork(workInfo);
     console.info('workschedulerLog startWork success');
   } catch (error) {
     console.error(`workschedulerLog startwork failed. code is ${error.code} message is ${error.message}`);
   }

1. Stop the Work Scheduler task.

   import workScheduler from '@ohos.resourceschedule.workScheduler';
   
   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
     }
   }
   try{
     workScheduler.stopWork(workInfo, false);
     console.info('workschedulerLog stopWork success');
   } catch (error) {
     console.error(`workschedulerLog stopWork failed. code is ${error.code} message is ${error.message}`);
   }

1. Obtain a specified Work Scheduler task.

   try{
     workScheduler.getWorkStatus(50, (error, res) => {
       if (error) {
         console.error(`workschedulerLog getWorkStatus failed. code is ${error.code} message is ${error.message}`);
       } else {
         for (let item in res) {
           console.info(`workschedulerLog getWorkStatus success, ${item} is: ${res[item]}`);
         }
       }
     });
   } catch (error) {
     console.error(`workschedulerLog getWorkStatus failed. code is ${error.code} message is ${error.message}`);
   }

1. Obtain all the Work Scheduler tasks.

   try{
     workScheduler.obtainAllWorks((error, res) =>{
       if (error) {
         console.error(`workschedulerLog obtainAllWorks failed. code is ${error.code} message is ${error.message}`);
       } else {
         console.info(`workschedulerLog obtainAllWorks success, data is: ${JSON.stringify(res)}`);
       }
     });
   } catch (error) {
     console.error(`workschedulerLog obtainAllWorks failed. code is ${error.code} message is ${error.message}`);
   }

1. Stop and clear all the Work Scheduler tasks.

   try{
     workScheduler.stopAndClearWorks();
     console.info(`workschedulerLog stopAndClearWorks success`);
   } catch (error) {
     console.error(`workschedulerLog stopAndClearWorks failed. code is ${error.code} message is ${error.message}`);
   }

1. Check whether the last execution of a specified Work Scheduler task has timed out.

   try{
     workScheduler.isLastWorkTimeOut(500, (error, res) =>{
       if (error) {
         console.error(`workschedulerLog isLastWorkTimeOut failed. code is ${error.code} message is ${error.message}`);
       } else {
         console.info(`workschedulerLog isLastWorkTimeOut success, data is: ${res}`);
       }
     });
   } catch (error) {
     console.error(`workschedulerLog isLastWorkTimeOut failed. code is ${error.code} message is ${error.message}`);
   }

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Background Task Management

harmony 鸿蒙Background Task Management Overview

harmony 鸿蒙Continuous Task Development

harmony 鸿蒙Efficiency Resource Request Development

harmony 鸿蒙Agent-Powered Reminder Development

harmony 鸿蒙Agent-Powered Reminder Overview

harmony 鸿蒙Transient Task Development

harmony 鸿蒙WorkSchedulerExtensionAbility Development