Class CalendarEvent

CalendarEvent represents an event coming from a calendar channel.

Hierarchy (View Summary)

Base<number>
- CalendarEvent

Index

Constructors

Constructors

constructor

new CalendarEvent(
    data: {
        autofillWaitlist?: boolean;
        cancellation?: { createdBy: string; description?: string };
        channelId: string;
        color?: number;
        createdAt: string;
        createdBy: string;
        description?: string;
        duration?: number;
        groupId: string;
        id: number;
        isAllDay?: boolean;
        isPrivate?: boolean;
        location?: string;
        mentions?: {
            channels?: { id: string }[];
            everyone?: boolean;
            here?: boolean;
            roles?: { id: number }[];
            users?: { id: string }[];
        };
        name: string;
        repeats?: boolean;
        roleIds?: number[];
        rsvpDisabled?: boolean;
        rsvpLimit?: number;
        seriesId?: string;
        serverId: string;
        startsAt: string;
        url?: string;
    },
    client: Client,
): CalendarEvent
Parameters
- data: {
      autofillWaitlist?: boolean;
      cancellation?: { createdBy: string; description?: string };
      channelId: string;
      color?: number;
      createdAt: string;
      createdBy: string;
      description?: string;
      duration?: number;
      groupId: string;
      id: number;
      isAllDay?: boolean;
      isPrivate?: boolean;
      location?: string;
      mentions?: {
          channels?: { id: string }[];
          everyone?: boolean;
          here?: boolean;
          roles?: { id: number }[];
          users?: { id: string }[];
      };
      name: string;
      repeats?: boolean;
      roleIds?: number[];
      rsvpDisabled?: boolean;
      rsvpLimit?: number;
      seriesId?: string;
      serverId: string;
      startsAt: string;
      url?: string;
  }
  raw data.
  - OptionalautofillWaitlist?: boolean
    Description
    When rsvpLimit is set, users from the waitlist will be added as space becomes available in the event
  - Optionalcancellation?: { createdBy: string; description?: string }
    createdBy: string
    Created by
    
    Description
    The ID of the user who created this event cancellation
    
    Optionaldescription?: string
    Description Format: long-form markdown
    
    Description
    The description of event cancellation
  - channelId: string
    Channel ID Format: uuid
    
    Description
    The ID of the channel
  - Optionalcolor?: number
    Description
    The integer value corresponds to the decimal RGB representation for the color. The color of the event when viewing in the calendar
  - createdAt: string
    Created at Format: date-time
    
    Description
    The ISO 8601 timestamp that the event was created at
  - createdBy: string
    Created by
    
    Description
    The ID of the user who created this event
  - Optionaldescription?: string
    Description Format: long-form markdown
    
    Description
    The description of the event
  - Optionalduration?: number
    Duration
    
    Description
    The duration of the event in minutes
  - groupId: string
    Group ID
    
    Description
    The ID of the group
  - id: number
    Calendar event ID
    
    Description
    The ID of the calendar event
  - OptionalisAllDay?: boolean
    Is all day
    
    Description
    Does the event last all day
  - OptionalisPrivate?: boolean
    Is private
  - Optionallocation?: string
    Location
    
    Description
    The location of the event
  - Optionalmentions?: {
        channels?: { id: string }[];
        everyone?: boolean;
        here?: boolean;
        roles?: { id: number }[];
        users?: { id: string }[];
    }
    Optionalchannels?: { id: string }[]
    Channels
    
    Description
    Info on mentioned channels
    
    Optionaleveryone?: boolean
    Everyone
    
    Description
    If
    
    Everyone
    was mentioned
    
    Optionalhere?: boolean
    Here
    
    Description
    If
    
    Here
    was mentioned
    
    Optionalroles?: { id: number }[]
    Roles
    
    Description
    Info on mentioned roles
    
    Optionalusers?: { id: string }[]
    Users
    
    Description
    Info on mentioned users
  - name: string
    Name
    
    Description
    The name of the event
  - Optionalrepeats?: boolean
    Description
    Is this event a repeating event
  - OptionalroleIds?: number[]
    Role IDs
    
    Description
    The role IDs to restrict the event to
  - OptionalrsvpDisabled?: boolean
    RSVP disabled
    
    Description
    When disabled, users will not be able to RSVP to the event
  - OptionalrsvpLimit?: number
    Description
    The number of RSVPs to allow before waitlisting RSVPs
  - OptionalseriesId?: string
    Calendar event series ID Format: uuid
    
    Description
    The ID of the calendar event series. Only shows if the event is repeating
  - serverId: string
    Server ID
    
    Description
    The ID of the server
  - startsAt: string
    Starts at Format: date-time
    
    Description
    The ISO 8601 timestamp that the event starts at
  - Optionalurl?: string
    Format: uri
    
    Description
    A URL to associate with the event
- client: Client
  client.
Returns CalendarEvent
Overrides Base.constructor
- Defined in lib/structures/CalendarEvent.ts:66

Properties

cancellation

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

Details about event cancellation (if canceled)

Type declaration

undefined
null
{ createdBy: string; description?: string }
- createdBy: string
  Created by
  
  Description
  The ID of the user who created this event cancellation
- Optionaldescription?: string
  Description Format: long-form markdown
  
  Description
  The description of event cancellation

channelID

channelID: string

ID of the channel the event was created on.

client

client: Client

App's client.

color

color: null | number

Event color in calendar.

comments

comments: typedCollection<
    number,
    {
        calendarEventId: number;
        channelId: string;
        content: string;
        createdAt: string;
        createdBy: string;
        id: number;
        mentions?: {
            channels?: { id: string }[];
            everyone?: boolean;
            here?: boolean;
            roles?: { id: number }[];
            users?: { id: string }[];
        };
        updatedAt?: string;
    },
    CalendarComment,
>

Cached Comments

createdAt

createdAt: null | Date

When the event was created.

data

data: {
    autofillWaitlist?: boolean;
    cancellation?: { createdBy: string; description?: string };
    channelId: string;
    color?: number;
    createdAt: string;
    createdBy: string;
    description?: string;
    duration?: number;
    groupId: string;
    id: number;
    isAllDay?: boolean;
    isPrivate?: boolean;
    location?: string;
    mentions?: {
        channels?: { id: string }[];
        everyone?: boolean;
        here?: boolean;
        roles?: { id: number }[];
        users?: { id: string }[];
    };
    name: string;
    repeats?: boolean;
    roleIds?: number[];
    rsvpDisabled?: boolean;
    rsvpLimit?: number;
    seriesId?: string;
    serverId: string;
    startsAt: string;
    url?: string;
}

Raw data

Type declaration

OptionalautofillWaitlist?: boolean
Description
When rsvpLimit is set, users from the waitlist will be added as space becomes available in the event
Optionalcancellation?: { createdBy: string; description?: string }
- createdBy: string
  Created by
  
  Description
  The ID of the user who created this event cancellation
- Optionaldescription?: string
  Description Format: long-form markdown
  
  Description
  The description of event cancellation
channelId: string
Channel ID Format: uuid

Description
The ID of the channel
Optionalcolor?: number
Description
The integer value corresponds to the decimal RGB representation for the color. The color of the event when viewing in the calendar
createdAt: string
Created at Format: date-time

Description
The ISO 8601 timestamp that the event was created at
createdBy: string
Created by

Description
The ID of the user who created this event
Optionaldescription?: string
Description Format: long-form markdown

Description
The description of the event
Optionalduration?: number
Duration

Description
The duration of the event in minutes
groupId: string
Group ID

Description
The ID of the group
id: number
Calendar event ID

Description
The ID of the calendar event
OptionalisAllDay?: boolean
Is all day

Description
Does the event last all day
OptionalisPrivate?: boolean
Is private
Optionallocation?: string
Location

Description
The location of the event
Optionalmentions?: {
    channels?: { id: string }[];
    everyone?: boolean;
    here?: boolean;
    roles?: { id: number }[];
    users?: { id: string }[];
}
- Optionalchannels?: { id: string }[]
  Channels
  
  Description
  Info on mentioned channels
- Optionaleveryone?: boolean
  Everyone
  
  Description
  If
  
  Everyone
  was mentioned
- Optionalhere?: boolean
  Here
  
  Description
  If
  
  Here
  was mentioned
- Optionalroles?: { id: number }[]
  Roles
  
  Description
  Info on mentioned roles
- Optionalusers?: { id: string }[]
  Users
  
  Description
  Info on mentioned users
name: string
Name

Description
The name of the event
Optionalrepeats?: boolean
Description
Is this event a repeating event
OptionalroleIds?: number[]
Role IDs

Description
The role IDs to restrict the event to
OptionalrsvpDisabled?: boolean
RSVP disabled

Description
When disabled, users will not be able to RSVP to the event
OptionalrsvpLimit?: number
Description
The number of RSVPs to allow before waitlisting RSVPs
OptionalseriesId?: string
Calendar event series ID Format: uuid

Description
The ID of the calendar event series. Only shows if the event is repeating
serverId: string
Server ID

Description
The ID of the server
startsAt: string
Starts at Format: date-time

Description
The ISO 8601 timestamp that the event starts at
Optionalurl?: string
Format: uri

Description
A URL to associate with the event

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
    | {
        channels?: { id: string }[];
        everyone?: boolean;
        here?: boolean;
        roles?: { id: number }[];
        users?: { id: string }[];
    }

Mentions in this calendar event.

Type declaration

null
{
    channels?: { id: string }[];
    everyone?: boolean;
    here?: boolean;
    roles?: { id: number }[];
    users?: { id: string }[];
}
- Optionalchannels?: { id: string }[]
  Channels
  
  Description
  Info on mentioned channels
- Optionaleveryone?: boolean
  Everyone
  
  Description
  If
  
  Everyone
  was mentioned
- Optionalhere?: boolean
  Here
  
  Description
  If
  
  Here
  was mentioned
- Optionalroles?: { id: number }[]
  Roles
  
  Description
  Info on mentioned roles
- Optionalusers?: { id: string }[]
  Users
  
  Description
  Info on mentioned users

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,
    {
        calendarEventId: number;
        channelId: string;
        createdAt: string;
        createdBy: string;
        serverId: string;
        status: CalendarEventRsvpStatus;
        updatedAt?: string;
        updatedBy?: string;
        userId: string;
    },
    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

get owner(): undefined | User | Member | Promise<Member>
Retrieve the event's owner, if cached.

Note: this getter can output: Member, User, Promise or undefined.

Returns undefined | User | Member | Promise<Member>
- Defined in lib/structures/CalendarEvent.ts:153

Methods

delete

delete(): Promise<void>
Delete this event

Returns Promise<void>
- Defined in lib/structures/CalendarEvent.ts:165

edit

edit(options: EditCalendarEventOptions): Promise<CalendarEvent>
Edit this event
Parameters
- options: EditCalendarEventOptions
Returns Promise<CalendarEvent>
- Defined in lib/structures/CalendarEvent.ts:170

toJSON

toJSON(): JSONCalendarEvent
Returns JSONCalendarEvent
Overrides Base.toJSON
- Defined in lib/structures/CalendarEvent.ts:178

Class CalendarEvent

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalautofillWaitlist?: boolean

Description

Optionalcancellation?: { createdBy: string; description?: string }

createdBy: string

Description

Optionaldescription?: string

Description

channelId: string

Description

Optionalcolor?: number

Description

createdAt: string

Description

createdBy: string

Description

Optionaldescription?: string

Description

Optionalduration?: number

Description

groupId: string

Description

id: number

Description

OptionalisAllDay?: boolean

Description

OptionalisPrivate?: boolean

Optionallocation?: string

Description

Optionalmentions?: { channels?: { id: string }[]; everyone?: boolean; here?: boolean; roles?: { id: number }[]; users?: { id: string }[];}

Optionalchannels?: { id: string }[]

Description

Optionaleveryone?: boolean

Description

Everyone

Optionalhere?: boolean

Description

Here

Optionalroles?: { id: number }[]

Description

Optionalusers?: { id: string }[]

Description

name: string

Description

Optionalrepeats?: boolean

Description

OptionalroleIds?: number[]

Description

OptionalrsvpDisabled?: boolean

Description

OptionalrsvpLimit?: number

Description

OptionalseriesId?: string

Description

serverId: string

Description

startsAt: string

Description

Optionalurl?: string

Description

Returns CalendarEvent

Properties

cancellation

Type declaration

createdBy: string

Description

Optionaldescription?: string

Description

channelID

client

color

`Optional`autofillWaitlist?: boolean

`Optional`cancellation?: { createdBy: string; description?: string }

`Optional`description?: string

`Optional`color?: number

`Optional`description?: string

`Optional`duration?: number

`Optional`isAllDay?: boolean

`Optional`isPrivate?: boolean

`Optional`location?: string

`Optional`mentions?: {
channels?: { id: string }[];
everyone?: boolean;
here?: boolean;
roles?: { id: number }[];
users?: { id: string }[];
}

`Optional`channels?: { id: string }[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: { id: number }[]

`Optional`users?: { id: string }[]

`Optional`repeats?: boolean

`Optional`roleIds?: number[]

`Optional`rsvpDisabled?: boolean

`Optional`rsvpLimit?: number

`Optional`seriesId?: string

`Optional`url?: string

`Optional`description?: string

`Optional`autofillWaitlist?: boolean

`Optional`cancellation?: { createdBy: string; description?: string }

`Optional`description?: string

`Optional`color?: number

`Optional`description?: string

`Optional`duration?: number

`Optional`isAllDay?: boolean

`Optional`isPrivate?: boolean

`Optional`location?: string

`Optional`mentions?: {
channels?: { id: string }[];
everyone?: boolean;
here?: boolean;
roles?: { id: number }[];
users?: { id: string }[];
}

`Optional`channels?: { id: string }[]

`Optional`everyone?: boolean

`Optional`here?: boolean

`Optional`roles?: { id: number }[]

`Optional`users?: { id: string }[]

`Optional`repeats?: boolean

`Optional`roleIds?: number[]

`Optional`rsvpDisabled?: boolean

`Optional`rsvpLimit?: number

`Optional`seriesId?: string

`Optional`url?: string