Class CalendarEventRsvp

Represents a calendar event RSVP on Guilded.

Example

new CalendarEventRsvp(calendarEvent, rawCalendarEventRsvp);

Hierarchy

Base
- CalendarEventRsvp

Index

Constructors

constructor

new CalendarEventRsvp(calendarEvent: CalendarEvent, raw: APICalendarEventRsvp, cache?: boolean): CalendarEventRsvp
Parameters
- calendarEvent: CalendarEvent
  
  The calendar event the RSVP belongs to.
- raw: APICalendarEventRsvp
  
  The raw data of the calendar event RSVP.
- cache: boolean = ...
  
  Whether to cache the calendar event RSVP.
Returns CalendarEventRsvp
Overrides Base.constructor
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:35

Properties

`Readonly` calendarEvent

calendarEvent: CalendarEvent

The calendar event the RSVP belongs to.

`Readonly` calendarEventId

calendarEventId: number

The ID of the calendar event the RSVP belongs to.

`Readonly` channelId

channelId: string

The ID of the channel the calendar event RSVP belongs to.

`Readonly` client

client: Client

The client the data model belongs to.

`Readonly` createdAt

createdAt: Date

The date the calendar event RSVP was created.

`Readonly` createdBy

createdBy: string

The ID of the user that created the calendar event RSVP.

`Optional` `Readonly` editedAt

editedAt?: Date

The date the calendar event RSVP was edited.

`Optional` `Readonly` editedBy

editedBy?: string

The ID of the user that edited the calendar event RSVP.

`Readonly` id

id: string

The ID of the structure.

`Readonly` raw

raw: APICalendarEventRsvp

The raw data of the calendar event RSVP.

`Readonly` serverId

serverId: string

The ID of the server the calendar event RSVP belongs to.

`Readonly` status

status: CalendarEventRsvpStatus

The status of the calendar event RSVP.

`Readonly` userId

userId: string

The ID of the user the calendar event RSVP belongs to.

Accessors

author

get author(): undefined | ServerMember
The server member that created the calendar event RSVP.

Returns undefined | ServerMember
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:74

authorId

get authorId(): string
The ID of the user that created the calendar event RSVP.

Returns string
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:79

channel

get channel(): CalendarChannel
The channel the calendar event RSVP belongs to.

Returns CalendarChannel
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:59

createdTimestamp

get createdTimestamp(): number
The timestamp the calendar event RSVP was created.

Returns number
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:84

editedTimestamp

get editedTimestamp(): undefined | number
The timestamp the calendar event RSVP was edited.

Returns undefined | number
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:94

editor

get editor(): undefined | ServerMember
The server member that edited the calendar event RSVP.

Returns undefined | ServerMember
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:89

isCached

get isCached(): boolean
Whether the calendar event RSVP is cached.

Returns boolean
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:54

server

get server(): undefined | Server
The server the calendar event RSVP belongs to.

Returns undefined | Server
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:64

user

get user(): undefined | User
The user the calendar event RSVP belongs to.

Returns undefined | User
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:69

Methods

delete

delete(): Promise<CalendarEventRsvp>
Delete the calendar event RSVP.

Returns
The deleted calendar event RSVP.

Example
```
calendarEventRsvp.delete();
```
Returns Promise<CalendarEventRsvp>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:164

edit

edit(status: CalendarEventRsvpStatus): Promise<CalendarEventRsvp>
Edit the calendar event RSVP.

Returns
The edited calendar event RSVP.

Example
```
calendarEventRsvp.edit('going');
```
Parameters
- status: CalendarEventRsvpStatus
  
  The status of the calendar event RSVP.
Returns Promise<CalendarEventRsvp>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:155

fetch

fetch(options?: FetchOptions): Promise<CalendarEventRsvp>
Fetch the calendar event RSVP.

Returns
The fetched calendar event RSVP.

Example
```
calendarEventRsvp.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the calendar event RSVP with.
Returns Promise<CalendarEventRsvp>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:104

fetchAuthor

fetchAuthor(options?: FetchOptions): Promise<ServerMember>
Fetch the server member that created the calendar event RSVP.

Returns
The fetched server member.

Example
```
calendarEventRsvp.fetchAuthor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<ServerMember>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:133

fetchEditor

fetchEditor(options?: FetchOptions): Promise<undefined | ServerMember>
Fetch the server member that edited the calendar event RSVP.

Returns
The fetched server member.

Example
```
calendarEventRsvp.fetchEditor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<undefined | ServerMember>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:144

fetchServer

fetchServer(options?: FetchOptions): Promise<Server>
Fetch the server the calendar event RSVP belongs to.

Returns
The fetched server.

Example
```
calendarEventRsvp.fetchServer();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server with.
Returns Promise<Server>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:114

fetchUser

fetchUser(): Promise<User>
Fetch the user the calendar event RSVP belongs to.

Returns
The fetched user.

Example
```
calendarEventRsvp.fetchUser();
```
Returns Promise<User>
- Defined in guilded.ts/src/structures/calendarEvent/CalendarEventRsvp.ts:123

Class CalendarEventRsvp

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

calendarEvent: CalendarEvent

raw: APICalendarEventRsvp

cache: boolean = ...

Returns CalendarEventRsvp

Properties

Readonly calendarEvent

Readonly calendarEventId

Readonly channelId

Readonly client

Readonly createdAt

Readonly createdBy

Optional Readonly editedAt

Optional Readonly editedBy

Readonly id

Readonly raw

Readonly serverId

Readonly status

Readonly userId

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

channel

Returns CalendarChannel

createdTimestamp

Returns number

editedTimestamp

Returns undefined | number

editor

Returns undefined | ServerMember

isCached

Returns boolean

server

Returns undefined | Server

user

Returns undefined | User

Methods

delete

Returns

Example

Returns Promise<CalendarEventRsvp>

edit

Returns

Example

Parameters

status: CalendarEventRsvpStatus

Returns Promise<CalendarEventRsvp>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<CalendarEventRsvp>

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchEditor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<undefined | ServerMember>

fetchServer

Returns

Example

`Readonly` calendarEvent

`Readonly` calendarEventId

`Readonly` channelId

`Readonly` client

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` editedAt

`Optional` `Readonly` editedBy

`Readonly` id

`Readonly` raw

`Readonly` serverId

`Readonly` status

`Readonly` userId

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions