Interface APICalendarEvent

interface APICalendarEvent {
    autofillWaitlist?: boolean;
    cancellation?: {
        createdBy: string;
        description?: string;
    };
    channelId: string;
    color?: number;
    createdAt: string;
    createdBy: string;
    description?: string;
    duration?: number;
    id: number;
    isAllDay?: boolean;
    isPrivate?: boolean;
    location?: string;
    mentions?: APIMentions;
    name: string;
    rsvpLimit?: number;
    serverId: string;
    startsAt: string;
    url?: string;
}

Properties

autofillWaitlist? cancellation? channelId color? createdAt createdBy description? duration? id isAllDay? isPrivate? location? mentions? name rsvpLimit? serverId startsAt url?

Properties

Optional autofillWaitlist

autofillWaitlist?: boolean

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

Optional cancellation

cancellation?: {
    createdBy: string;
    description?: string;
}

Type declaration

  • createdBy: string

    The ID of the user who created this event cancellation

  • Optional description?: string

    The description of event cancellation (min length 1; max length 140)

channelId

channelId: string

The ID of the channel

Optional color

color?: number

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

createdAt

createdAt: string

The ISO 8601 timestamp that the event was created at

createdBy

createdBy: string

The ID of the user who created this event

Optional description

description?: string

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

Optional duration

duration?: number

The duration of the event in minutes (min 1)

id

id: number

The ID of the calendar event (min 1)

Optional isAllDay

isAllDay?: boolean

Does the event last all day

Optional isPrivate

isPrivate?: boolean

Optional location

location?: string

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

Optional mentions

mentions?: APIMentions

Calendar Event's mentions

name

name: string

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

Optional rsvpLimit

rsvpLimit?: number

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

serverId

serverId: string

The ID of the server

startsAt

startsAt: string

The ISO 8601 timestamp that the event starts at

Optional url

url?: string

A URL to associate with the event

Settings

Member Visibility

Theme

On This Page