Class CalendarChannel

constructor

• new CalendarChannel(data, client): CalendarChannel

• Parameters

  • data: APIGuildChannel

    raw data

  • client: Client

    client

  Returns CalendarChannel

scheduledEvents

createEvent

• createEvent(options, createSeries?): Promise<CalendarEvent>

• Create an event in this channel.

  Parameters

  • options: CreateCalendarEventOptions

    Event options.

  • Optional createSeries: {
        endDate?: string;
        endsAfterOccurrences?: number;
        every?: {
            count: number;
            interval: "day" | "week" | "month" | "year";
        };
        on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
        type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
    }

    (optional) Create a series. (event's repetition)

    • Optional endDate?: string

      The ISO 8601 timestamp that the event ends at. Used to control the end date of the event repeat (only used when type is custom; if used with endsAfterOccurrences, the earliest resultant date of the two will be used)

    • Optional endsAfterOccurrences?: number

      Used to control the end date of the event repeat (only used when type is custom; if used with endDate, the earliest resultant date of the two will be used) (max 24)

    • Optional every?: {
          count: number;
          interval: "day" | "week" | "month" | "year";
      }

      Apply further clarification to your events. This must have type set to custom

      • count: number

        How often between your interval the event should repeat. For example, 1 would be every interval, 2 would be every second occurrence of the interval

      • interval: "day" | "week" | "month" | "year"

        Coupled with count, this indicates the time range you are repeating your event over

    • Optional on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[]

      Used to control the day of the week that the event should repeat on (only used when type is custom and when every.interval is week) (min items 1)

    • type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom"

      How often you want your event to repeat (important note: this will repeat for the next 180 days unless custom is defined) (default once)

  Returns Promise<CalendarEvent>

deleteEvent

• deleteEvent(eventID): Promise<void>

• Delete an event from this channel.

  Parameters

  • eventID: number

    ID of the event to delete.

  Returns Promise<void>

deleteSeries

• deleteSeries(eventID, seriesID): Promise<void>

• Delete an event series set in this channel.

  Parameters

  • eventID: number

    ID of the event.

  • seriesID: string

    ID of the series.

  Returns Promise<void>

editEvent

• editEvent(eventID, options): Promise<CalendarEvent>

• Edit an event from this channel.

  Parameters

  • eventID: number

    ID of a calendar event.

  • options: EditCalendarEventOptions

    Edit options.

  Returns Promise<CalendarEvent>

editSeries

• editSeries(eventID, seriesID, options): Promise<void>

• Edit an event series set in this channel.

  Parameters

  • eventID: number

    ID of the event.

  • seriesID: string

    ID of the series.

  • options: undefined | {
        endDate?: string;
        endsAfterOccurrences?: number;
        every?: {
            count: number;
            interval: "day" | "week" | "month" | "year";
        };
        on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
        type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
    }

    Edit repetition options.

  Returns Promise<void>

toJSON

• toJSON(): JSONCalendarChannel

• Returns JSONCalendarChannel