Class DowntimeRecurrence

An object defining the recurrence of the downtime.

Hierarchy

  • DowntimeRecurrence

Constructors

constructor

Properties

additionalProperties? period? rrule? type? untilDate? untilOccurrences? weekDays?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional period

period?: number

How often to repeat as an integer. For example, to repeat every 3 days, select a type of days and a period of 3.

Optional rrule

rrule?: string

The RRULE standard for defining recurring events (requires to set "type" to rrule) For example, to have a recurring event on the first day of each month, set the type to rrule and set the FREQ to MONTHLY and BYMONTHDAY to 1. Most common rrule options from the iCalendar Spec are supported.

Note: Attributes specifying the duration in RRULE are not supported (for example, DTSTART, DTEND, DURATION). More examples available in this downtime guide

Optional type

type?: string

The type of recurrence. Choose from days, weeks, months, years, rrule.

Optional untilDate

untilDate?: number

The date at which the recurrence should end as a POSIX timestamp. until_occurences and until_date are mutually exclusive.

Optional untilOccurrences

untilOccurrences?: number

How many times the downtime is rescheduled. until_occurences and until_date are mutually exclusive.

Optional weekDays

weekDays?: string[]

A list of week days to repeat on. Choose from Mon, Tue, Wed, Thu, Fri, Sat or Sun. Only applicable when type is weeks. First letter must be capitalized.

Settings

Member Visibility

Theme

Generated using TypeDoc