The calendar event router for the Guilded REST API.

Example

new CalendarEventRouter(rest);

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods

  • Create a calendar event on Guilded.

    Returns

    The created calendar event.

    Example

    calendarEvents.create('abc', { name: 'Event!' });
    

    Parameters

    • channelId: string

      The ID of the channel the calendar event belongs to.

    • payload: APICalendarEventPayload

      The payload of the calendar event.

    Returns Promise<APICalendarEvent>

  • Delete a calendar event from Guilded.

    Example

    calendarEvents.delete('abc', 123);
    

    Parameters

    • channelId: string

      The ID of the channel the calendar event belongs to.

    • calendarEventId: number

      The ID of the calendar event to delete.

    Returns Promise<void>

  • Edit a calendar event on Guilded.

    Returns

    The edited calendar event.

    Example

    calendarEvents.edit('abc', 123, { name: 'Event!' });
    

    Parameters

    • channelId: string

      The ID of the channel the calendar event belongs to.

    • calendarEventId: number

      The ID of the calendar event to edit.

    • payload: Partial<APICalendarEventPayload>

      The payload of the calendar event.

    Returns Promise<APICalendarEvent>

  • Fetch a calendar event from Guilded.

    Returns

    The fetched calendar event.

    Example

    calendarEvents.fetch('abc', 123);
    

    Parameters

    • channelId: string

      The ID of the channel the calendar event belongs to.

    • calendarEventId: number

      The ID of the calendar event to fetch.

    Returns Promise<APICalendarEvent>

  • Fetch calendar events from Guilded.

    Returns

    The fetched calendar events.

    Example

    calendarEvents.fetch('abc');
    

    Parameters

    • channelId: string

      The ID of the channel the calendar events belong to.

    • Optional options: APICalendarEventFetchManyOptions

      The options to fetch calendar events with.

    Returns Promise<APICalendarEvent[]>