Class ScheduleCreateRequestDataAttributesLayersItems

Describes a schedule layer, including rotation intervals, members, restrictions, and timeline settings.

Hierarchy

  • ScheduleCreateRequestDataAttributesLayersItems

Constructors

constructor

Properties

additionalProperties? effectiveDate endDate? interval members name restrictions? rotationStart

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

effectiveDate

effectiveDate: Date

The date/time when this layer becomes active (in ISO 8601).

Optional endDate

endDate?: Date

The date/time after which this layer no longer applies (in ISO 8601).

interval

interval: ScheduleCreateRequestDataAttributesLayersItemsInterval

Defines how frequently the rotation repeats, using days and/or seconds (up to certain limits).

members

members: ScheduleCreateRequestDataAttributesLayersItemsMembersItems[]

A list of members who participate in this layer's rotation.

name

name: string

The name of this layer.

Optional restrictions

restrictions?: ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems[]

Zero or more time-based restrictions (for example, only weekdays, during business hours).

rotationStart

rotationStart: Date

The date/time when the rotation for this layer starts (in ISO 8601).

Settings

Member Visibility

Theme

Generated using TypeDoc