Class CalendarEvent

CalendarEvent represents an event coming from a calendar channel.

Hierarchy

  • Base<number>
    • CalendarEvent

Constructors

constructor

Properties

cancelation channelID client color comments createdAt data description duration guildID id isPrivate location mentions name ownerID rsvpLimit rsvps startsAt url

Accessors

owner

Methods

delete edit toJSON

Constructors

constructor

Properties

cancelation

cancelation: undefined | null | {
    createdBy: string;
    description?: string;
}

Details about event cancelation (if canceled)

Type declaration

  • createdBy: string

    The ID of the user who created this event cancellation

  • Optional description?: string

    The description of event cancellation (min length 1; max length 140)

channelID

channelID: string

ID of the channel the event was created on.

client

client: Client

Bot's client.

color

color: null | number

Event color in calendar.

comments

comments: TypedCollection<number, APICalendarEventComment, CalendarEventComment, []>

Cached Comments

createdAt

createdAt: null | Date

When the event was created.

data

data: APICalendarEvent

Raw data

description

description: null | string

Event's description

duration

duration: number

Duration in ms of the event.

guildID

guildID: string

Guild/server ID

id

id: number

Item ID

isPrivate

isPrivate: boolean

If true, this event is private.

location

location: null | string

Event user-specified location

mentions

mentions: null | APIMentions

Mentions in this calendar event.

name

name: string

Name of the event

ownerID

ownerID: string

ID of the owner of this event.

rsvpLimit

rsvpLimit: null | number

Limit of event entry.

rsvps

rsvps: TypedCollection<number, APICalendarEventRSVP, CalendarEventRSVP, []>

Cached RSVPS.

startsAt

startsAt: null | Date

Timestamp (unix epoch time) of the event starting time.

url

url: null | string

Event user-specified url

Accessors

owner

Methods

delete

edit

toJSON

Settings

Member Visibility

Theme

On This Page