Type alias CalendarEventPayload

CalendarEventPayload: {
    autofillWaitlist?: boolean;
    cancellation?: {
        createdBy: string;
        description?: string;
    };
    channelId: string;
    color?: number;
    createdAt: string;
    createdBy: string;
    description?: string;
    duration?: number;
    groupId: string;
    id: number;
    isAllDay?: boolean;
    isPrivate?: boolean;
    location?: string;
    mentions?: MentionsPayload;
    name: string;
    repeats?: boolean;
    roleIds?: number[];
    rsvpDisabled?: boolean;
    rsvpLimit?: number;
    seriesId?: string;
    serverId: string;
    startsAt: string;
    url?: string;
}

Type declaration

  • Optional autofillWaitlist?: boolean

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

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

      The ID of the user who created this event cancellation

    • Optional description?: string

      The description of event cancellation

  • channelId: string

    The ID of the channel

  • Optional color?: number

    The integer value corresponds to the decimal RGB representation for the color. The color of the event when viewing in the calendar

  • createdAt: string

    The ISO 8601 timestamp that the event was created at

  • createdBy: string

    The ID of the user who created this event

  • Optional description?: string

    The description of the event

  • Optional duration?: number

    The duration of the event in minutes

  • groupId: string

    The ID of the group

  • id: number

    The ID of the calendar event

  • Optional isAllDay?: boolean

    Does the event last all day

  • Optional isPrivate?: boolean
  • Optional location?: string

    The location of the event

  • Optional mentions?: MentionsPayload
  • name: string

    The name of the event

  • Optional repeats?: boolean

    Is this event a repeating event

  • Optional roleIds?: number[]

    The role IDs to restrict the event to

  • Optional rsvpDisabled?: boolean

    When disabled, users will not be able to RSVP to the event

  • Optional rsvpLimit?: number

    The number of RSVPs to allow before waitlisting RSVPs

  • Optional seriesId?: string

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

  • serverId: string

    The ID of the server

  • startsAt: string

    The ISO 8601 timestamp that the event starts at

  • Optional url?: string

    A URL to associate with the event

Settings

Member Visibility

Theme

Generated using TypeDoc