TaskScheduler

TaskScheduler
TaskScheduler

The TaskScheduler data object is the base type for the scheduler objects.

The hierarchy of scheduler objects is as follows:

    TaskScheduler
        [AfterStartupTaskScheduler](../../data-structures/AfterStartupTaskScheduler/)
        [OnceTaskScheduler](../../data-structures/OnceTaskScheduler/)
        [RecurrentTaskScheduler](../../data-structures/RecurrentTaskScheduler/)
            [HourlyTaskScheduler](../../data-structures/HourlyTaskScheduler/)
                [DailyTaskScheduler](../../data-structures/DailyTaskScheduler/)
                    [WeeklyTaskScheduler](../../data-structures/WeeklyTaskScheduler/)
                    [MonthlyTaskScheduler](../../data-structures/MonthlyTaskScheduler/)
                        [MonthlyByDayTaskScheduler](../../data-structures/MonthlyByDayTaskScheduler/)
                        [MonthlyByWeekdayTaskScheduler](../../data-structures/MonthlyByWeekdayTaskScheduler/)

Use a scheduler object to set the time(s) for task execution. You can use two scheduling modes - single execution or recurring execution:

  • Use the AfterStartupTaskScheduler or the OnceTaskScheduler to schedule a single instance of task execution.
  • Use one of the recurrent task schedulers to schedule hourly, daily, weekly, or monthly task execution.

After you have established the task timing, use the scheduler object for the ScheduledTaskSpec scheduler property value.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "activeTime": "string",
    "expireTime": "string"
}
string As date-time As date-time
activeTime
Optional

The time that the schedule for the task takes effect.

Task activation is distinct from task execution. When you activate a task, its schedule starts, and when the next execution time occurs, the task will run. If you do not set activeTime, the activation time defaults to the time that you create the scheduled task.

string As date-time As date-time
expireTime
Optional

The time the schedule for the task expires.

If you do not set expireTime, the schedule does not expire.

Property Of
Used By