hoshii / Exports / CalendarEvent

CalendarEvent

Represents a calendar event

Hierarchy

• Base<number>

  ↳ CalendarEvent

Table of contents

Constructors

• constructor

Properties

• cancellation
• channelID
• client
• color
• createdAt
• createdBy
• data
• description
• duration
• id
• isPrivate
• location
• mentions
• name
• rsvpLimit
• rsvps
• serverID
• startsAt
• url

Accessors

• owner

Methods

• delete
• edit
• toJSON
• update

Constructors

constructor

• new CalendarEvent(data, client)

Create a new CalendarEvent

Parameters

Name	Type	Description
data	RawCalendarEvent	The raw data of the event
client	Client	The client

Overrides

Base.constructor

Defined in

lib/structures/CalendarEvent.ts:173

Properties

cancellation

• cancellation: CalendarEventCancellation

The cancellation information of the event

Defined in

lib/structures/CalendarEvent.ts:82

---

channelID

• channelID: string

The ID of the channel the event is in

Defined in

lib/structures/CalendarEvent.ts:87

---

client

• client: Client

The bot client

Inherited from

Base.client

Defined in

lib/structures/Base.ts:13

---

color

• color: number

The colour of the event

Defined in

lib/structures/CalendarEvent.ts:92

---

createdAt

• createdAt: Date

The date the event was created at

Defined in

lib/structures/CalendarEvent.ts:97

---

createdBy

• createdBy: string

The ID of the user who created the event

Defined in

lib/structures/CalendarEvent.ts:102

---

data

• data: RawCalendarEvent

The raw data of the event

Defined in

lib/structures/CalendarEvent.ts:107

---

description

• description: string

The description of the event

Defined in

lib/structures/CalendarEvent.ts:112

---

duration

• duration: number

The duration of the event in minutes

Defined in

lib/structures/CalendarEvent.ts:117

---

id

• id: number

The ID of the item

Inherited from

Base.id

Defined in

lib/structures/Base.ts:16

---

isPrivate

• isPrivate: boolean

Whether the event is private

Defined in

lib/structures/CalendarEvent.ts:122

---

location

• location: string

The location of the event

Defined in

lib/structures/CalendarEvent.ts:127

---

mentions

• mentions: Mentions

The mentions of the event

Defined in

lib/structures/CalendarEvent.ts:132

---

name

• name: string

The name of the event

Defined in

lib/structures/CalendarEvent.ts:137

---

rsvpLimit

• rsvpLimit: number

The RSVP limit of the event

Defined in

lib/structures/CalendarEvent.ts:142

---

rsvps

• rsvps: TypedCollection<number, RawCalendarEventRSVP, CalendarEventRSVP, []>

A collection of cached RSVPs

Defined in

lib/structures/CalendarEvent.ts:147

---

serverID

• serverID: string

The ID of the server the event is in

Defined in

lib/structures/CalendarEvent.ts:156

---

startsAt

• startsAt: Date

The date the event starts at

Defined in

lib/structures/CalendarEvent.ts:161

---

url

• url: string

The URL of the event

Defined in

lib/structures/CalendarEvent.ts:166

Accessors

owner

• get owner(): User | ServerMember | Promise<ServerMember>

The owner of the event

Returns

User | ServerMember | Promise<ServerMember>

Defined in

lib/structures/CalendarEvent.ts:204

Methods

delete

▸ delete(): Promise<void>

Delete the calendar event

Returns

Promise<void>

Defined in

lib/structures/CalendarEvent.ts:224

---

edit

▸ edit(options): Promise<CalendarEvent>

Edit the calendar event

Parameters

Name	Type	Description
options	CalendarEventOptions	The options to edit the calendar event with

Returns

Promise<CalendarEvent>

Defined in

lib/structures/CalendarEvent.ts:233

---

toJSON

▸ toJSON(): CalendarEventData

Returns the JSON representation of the item

Returns

CalendarEventData

Overrides

Base.toJSON

Defined in

lib/structures/CalendarEvent.ts:237

---

update

▸ Protected update(data): void

Parameters

Name	Type
data	RawCalendarEvent

Returns

void

Overrides

Base.update

Defined in

lib/structures/CalendarEvent.ts:260