Class CalendarEvent

Represents a calendar event on Guilded

Hierarchy

Constructors

constructor

Properties

_createdAt autofillWaitlist? cancellation? channelId client color? createdBy description? duration? id isAllDay? isPrivate? location? mentions? name raw repeats? roleIds? rsvpLimit? rsvps seriesId? serverId startsAt url?

Accessors

author createdAt

Methods

_clone _update

Constructors

constructor

Properties

Readonly _createdAt

_createdAt: number

The ISO 8601 timestamp that the event was created at

Optional autofillWaitlist

autofillWaitlist?: null | boolean

When rsvpLimit is set, users from the waitlist will be added as space becomes available in the event

Optional cancellation

cancellation?: {}

The cancellations for this event

Type declaration

    Readonly channelId

    channelId: string

    The ID of the channel

    Readonly client

    client: Client

    Optional color

    color?: null | number

    The color of the event when viewing in the calendar (min 0; max 16777215)

    Readonly createdBy

    createdBy: string

    The ID of the user who created this event

    Optional description

    description?: null | string

    The description of the event (min length 1; max length 8000)

    Optional duration

    duration?: null | number

    The duration of the event in minutes (min 1)

    Readonly id

    id: number

    The ID of the calendar event (min 1)

    Optional isAllDay

    isAllDay?: null | boolean

    Whether this event lasts all day

    Optional isPrivate

    isPrivate?: boolean

    Whether this event is private or not

    Optional location

    location?: null | string

    The location of the event (min length 1; max length 8000)

    Optional mentions

    mentions?: MentionsPayload

    The mentions in this calendar event

    name

    name: string

    The name of the event (min length 1; max length 60)

    raw

    raw: CalendarEventPayload

    Bare data of this structure

    Optional repeats

    repeats?: null | boolean

    Whether this event is repeating

    Optional roleIds

    roleIds?: null | number[]

    The role IDs to restrict the event to (min items 1; must have unique items true)

    Optional rsvpLimit

    rsvpLimit?: null | number

    The number of rsvps to allow before waitlisting rsvps (min 1)

    rsvps

    rsvps: Collection<string, CalendarEventRsvp>

    A collection of cached rsvps for this calendar event

    Optional seriesId

    seriesId?: null | string

    The ID of the calendar event series. Only shows if the event is repeating

    Readonly serverId

    serverId: string

    The ID of the server

    startsAt

    startsAt: string

    The ISO 8601 timestamp that the event starts at

    Optional url

    url?: null | string

    A URL to associate with the event

    Accessors

    author

    createdAt

    Methods

    _clone

    _update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc