Class CalendarEvent

Represents a calendar event on Guilded.

Example

new CalendarEvent(channel, rawEvent);

Hierarchy

Base<number>
- CalendarEvent

Index

Constructors

constructor

new CalendarEvent(channel: CalendarChannel, raw: APICalendarEvent, cache?: boolean): CalendarEvent
Parameters
- channel: CalendarChannel
  
  The calendar channel the event belongs to.
- raw: APICalendarEvent
  
  The raw data of the calendar event.
- Optional cache: boolean
  
  Whether to cache the calendar event.
Returns CalendarEvent
Overrides Base.constructor
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:50

Properties

`Optional` `Readonly` cancellation

cancellation?: APICalendarEventCancellation

The cancellation of the calendar event.

`Readonly` channel

channel: CalendarChannel

`Readonly` channelId

channelId: string

The ID of the channel the calendar event belongs to.

`Readonly` client

client: Client

`Optional` `Readonly` color

color?: number

The color of the calendar event.

`Readonly` createdAt

createdAt: Date

The date the calendar event was created.

`Readonly` createdBy

createdBy: string

The ID of the user that created the calendar event.

`Optional` `Readonly` description

description?: string

The description of the calendar event.

`Optional` `Readonly` duration

duration?: number

The duration of the calendar event.

`Readonly` id

id: number

`Optional` `Readonly` isPrivate

isPrivate?: boolean

Whether the calendar event is private.

`Optional` `Readonly` location

location?: string

The location of the calendar event.

`Optional` `Readonly` mentions

mentions?: APIMentions

The mentions of the calendar event.

`Readonly` name

name: string

The name of the calendar event.

`Readonly` raw

raw: APICalendarEvent

`Optional` `Readonly` rsvpLimit

rsvpLimit?: number

The limit of RSVPs of the calendar event.

`Readonly` rsvps

rsvps: CalendarEventRsvpManager

A manager of RSVPs that belong to the calendar event.

`Readonly` serverId

serverId: string

The ID of the server the calendar event belongs to.

`Readonly` startsAt

startsAt: Date

The date the calendar event starts.

`Optional` `Readonly` url

url?: string

The url of the calendar event.

Accessors

author

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

Returns undefined | ServerMember
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:62

authorId

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

Returns string
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:64

createdTimestamp

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

Returns number
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:60

endsAt

get endsAt(): Date
The date the calendar event ends.

Returns Date
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:58

isCached

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

Returns boolean
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:52

server

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

Returns undefined | Server
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:54

startsIn

get startsIn(): number
The time until the calendar event starts.

Returns number
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:56

Methods

delete

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

Returns
The deleted calendar event.

Example
```
event.delete();
```
Returns Promise<CalendarEvent>
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:98

edit

edit(payload: Partial<APICalendarEventPayload>): Promise<CalendarEvent>
Edit the calendar event.

Returns
The edited calendar event.

Example
```
event.edit({ name: 'New name' });
```
Parameters
- payload: Partial<APICalendarEventPayload>
  
  The payload of the calendar event.
Returns Promise<CalendarEvent>
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:92

fetch

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

Returns
The fetched calendar event.

Example
```
event.fetch();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the calendar event with.
Returns Promise<CalendarEvent>
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:71

fetchAuthor

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

Returns
The fetched server member.

Example
```
event.fetchAuthor();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server member with.
Returns Promise<ServerMember>
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:85

fetchServer

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

Returns
The fetched server.

Example
```
event.fetchServer();
```
Parameters
- Optional options: FetchOptions
  
  The options to fetch the server with.
Returns Promise<Server>
- Defined in guilded.ts/dist/structures/calendarEvent/CalendarEvent.d.ts:78

Class CalendarEvent

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

channel: CalendarChannel

raw: APICalendarEvent

Optional cache: boolean

Returns CalendarEvent

Properties

Optional Readonly cancellation

Readonly channel

Readonly channelId

Readonly client

Optional Readonly color

Readonly createdAt

Readonly createdBy

Optional Readonly description

Optional Readonly duration

Readonly id

Optional Readonly isPrivate

Optional Readonly location

Optional Readonly mentions

Readonly name

Readonly raw

Optional Readonly rsvpLimit

Readonly rsvps

Readonly serverId

Readonly startsAt

Optional Readonly url

Accessors

author

Returns undefined | ServerMember

authorId

Returns string

createdTimestamp

Returns number

endsAt

Returns Date

isCached

Returns boolean

server

Returns undefined | Server

startsIn

Returns number

Methods

delete

Returns

Example

Returns Promise<CalendarEvent>

edit

Returns

Example

Parameters

payload: Partial<APICalendarEventPayload>

Returns Promise<CalendarEvent>

fetch

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<CalendarEvent>

fetchAuthor

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<ServerMember>

fetchServer

Returns

Example

Parameters

Optional options: FetchOptions

Returns Promise<Server>

`Optional` cache: boolean

`Optional` `Readonly` cancellation

`Readonly` channel

`Readonly` channelId

`Readonly` client

`Optional` `Readonly` color

`Readonly` createdAt

`Readonly` createdBy

`Optional` `Readonly` description

`Optional` `Readonly` duration

`Readonly` id

`Optional` `Readonly` isPrivate

`Optional` `Readonly` location

`Optional` `Readonly` mentions

`Readonly` name

`Readonly` raw

`Optional` `Readonly` rsvpLimit

`Readonly` rsvps

`Readonly` serverId

`Readonly` startsAt

`Optional` `Readonly` url

`Optional` options: FetchOptions

`Optional` options: FetchOptions

`Optional` options: FetchOptions