Class CalendarEventRsvpRouter

The calendar event RSVP router for the Guilded REST API.

Example

new CalendarEventRsvpRouter(rest);

Hierarchy

BaseRouter
- CalendarEventRsvpRouter

Index

Constructors

constructor

new CalendarEventRsvpRouter(rest: RESTManager): CalendarEventRsvpRouter
Parameters
- rest: RESTManager
  
  The REST API manager the router belongs to.
Returns CalendarEventRsvpRouter
Inherited from BaseRouter.constructor
- Defined in rest/src/routers/BaseRouter.ts:9

Properties

`Readonly` rest

rest: RESTManager

The REST API manager the router belongs to.

Methods

delete

delete(channelId: string, calendarEventId: number, userId: string): Promise<void>
Delete a calendar event RSVP from Guilded.

Example
```
calendarEventRsvps.delete('abc', 123, 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the calendar event RSVP belongs to.
- calendarEventId: number
  
  The ID of the calendar event the RSVP belongs to.
- userId: string
  
  The ID of the user the RSVP belongs to.
Returns Promise<void>
- Defined in rest/src/routers/calendarEvent/CalendarEventRsvpRouter.ts:86

edit

edit(channelId: string, calendarEventId: number, userId: string, status: CalendarEventRsvpStatus): Promise<APICalendarEventRsvp>
Edit a calendar event RSVP on Guilded.

Returns
The edited calendar event RSVP.

Example
```
calendarEventRsvps.edit('abc', 123, 'abc', 'going');
```
Parameters
- channelId: string
  
  The ID of the channel the calendar event RSVP belongs to.
- calendarEventId: number
  
  The ID of the calendar event the RSVP belongs to.
- userId: string
  
  The ID of the user the RSVP belongs to.
- status: CalendarEventRsvpStatus
  
  The status of the RSVP.
Returns Promise<APICalendarEventRsvp>
- Defined in rest/src/routers/calendarEvent/CalendarEventRsvpRouter.ts:66

fetch

fetch(channelId: string, calendarEventId: number, userId: string): Promise<APICalendarEventRsvp>
Fetch a calendar event RSVP from Guilded.

Returns
The fetched calendar event RSVP.

Example
```
calendarEvents.fetch('abc', 123, 'abc');
```
Parameters
- channelId: string
  
  The ID of the channel the calendar event RSVP belongs to.
- calendarEventId: number
  
  The ID of the calendar event the RSVP belongs to.
- userId: string
  
  The ID of the user the RSVP belongs to.
Returns Promise<APICalendarEventRsvp>
- Defined in rest/src/routers/calendarEvent/CalendarEventRsvpRouter.ts:22
fetch(channelId: string, calendarEventId: number): Promise<APICalendarEventRsvp[]>
Fetch calendar event RSVPs from Guilded.

Returns
The fetched calendar event RSVPs.

Example
```
calendarEvents.fetch('abc', 123);
```
Parameters
- channelId: string
  
  The ID of the channel the calendar event RSVPs belong to.
- calendarEventId: number
  
  The ID of the calendar event the RSVPs belong to.
Returns Promise<APICalendarEventRsvp[]>
- Defined in rest/src/routers/calendarEvent/CalendarEventRsvpRouter.ts:34

Class CalendarEventRsvpRouter

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rest: RESTManager

Returns CalendarEventRsvpRouter

Properties

Readonly rest

Methods

delete

Example

Parameters

channelId: string

calendarEventId: number

userId: string

Returns Promise<void>

edit

Returns

Example

Parameters

channelId: string

calendarEventId: number

userId: string

status: CalendarEventRsvpStatus

Returns Promise<APICalendarEventRsvp>

fetch

Returns

Example

Parameters

channelId: string

calendarEventId: number

userId: string

Returns Promise<APICalendarEventRsvp>

Returns

Example

Parameters

channelId: string

calendarEventId: number

Returns Promise<APICalendarEventRsvp[]>

Settings

Member Visibility

Theme

`Readonly` rest