Type Alias TaskBase

type TaskBase = {
    appId?: string;
    autoReload?: boolean;
    autoReloadPartial?: boolean;
    endDateTime?: string;
    partial?: boolean;
    recurrence?: string[];
    startDateTime?: string;
    timeZone?: string;
}
Index

Properties

appId? autoReload? autoReloadPartial? endDateTime? partial? recurrence? startDateTime? timeZone?

Properties

appId?: string

The ID of the app.

autoReload?: boolean

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

autoReloadPartial?: boolean

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

endDateTime?: string

The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.

partial?: boolean

The task is partial reload or not

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

startDateTime?: string

The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

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.

Settings

Member Visibility

On This Page

Properties