Interface IReloadTaskUpdate

interface IReloadTaskUpdate {
    autoReload?: boolean;
    autoReloadPartial?: boolean;
    endDateTime?: string;
    partial?: boolean;
    recurrence?: string[];
    startDateTime?: string;
    state?: "Enabled" | "Disabled";
    timeZone?: string;
    type?: string;
}

Hierarchy

Properties

autoReload? autoReloadPartial? endDateTime? partial? recurrence? startDateTime? state? timeZone? type?

Properties

Optional autoReload

autoReload?: boolean

A flag that indicates whether a reload is triggered when data of the app is changed

Default

false

Optional autoReloadPartial

autoReloadPartial?: boolean

A flag that indicates whether it is a partial reload or not for the auto reload

Default

false

Optional endDateTime

endDateTime?: string

The time that the task will stop recurring.

Default

empty string

Example

2022-09-18T14:45:00

Optional partial

partial?: boolean

The task is partial reload or not

Default

false

Optional recurrence

recurrence?: string[]

List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events

Example

"RRULE:FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
"RRULE:FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"

Optional startDateTime

startDateTime?: string

The time that the task execution start recurring. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

Example

2022-09-18T14:45:00

Optional state

state?: "Enabled" | "Disabled"

Optional timeZone

timeZone?: string

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format.

Default

Europe/London

Optional type

type?: string

Deprecated

type of task being created - deprecated

Settings

Member Visibility

Theme

On This Page