Class CalendarChannel

Represents a calendar channel.

Hierarchy (view full)

GuildChannel
- CalendarChannel

Index

Constructors

constructor

new CalendarChannel(data, client): CalendarChannel
Parameters
- data: {
      archivedAt?: string;
      archivedBy?: string;
      categoryId?: number;
      createdAt: string;
      createdBy: string;
      groupId: string;
      id: string;
      messageId?: string;
      name: string;
      parentId?: string;
      priority?: number;
      rootId?: string;
      serverId: string;
      topic?: string;
      type: ServerChannelType;
      updatedAt?: string;
      visibility?: null | "private" | "public";
  }
  raw data
  - OptionalarchivedAt?: string
    Archived at Format: date-time
    
    Description
    The ISO 8601 timestamp that the channel was archived at, if relevant
  - OptionalarchivedBy?: string
    Archived by
    
    Description
    The ID of the user who archived this channel
  - OptionalcategoryId?: number
    Description
    The category that the channel exists in. Only relevant for server channels
  - createdAt: string
    Created at Format: date-time
    
    Description
    The ISO 8601 timestamp that the channel was created at
  - createdBy: string
    Created by
    
    Description
    The ID of the user who created this channel
  - groupId: string
    Group ID
    
    Description
    The ID of the group
  - id: string
    Channel ID Format: uuid
    
    Description
    The ID of the channel
  - OptionalmessageId?: string
    Message ID Format: uuid
    
    Description
    The ID of the message that this channel was created off of. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present
  - name: string
    Description
    The name of the channel
  - OptionalparentId?: string
    Channel ID Format: uuid
    
    Description
    ID of the immediate parent channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present
  - Optionalpriority?: number
    Priority
    
    Description
    The priority of the channel will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in ascending order. Due to legacy issues, sending a null value is not possible
  - OptionalrootId?: string
    Channel ID Format: uuid
    
    Description
    ID of the root channel or thread in the channel hierarchy. Only applicable to "chat", "voice", and "stream" channels and indicates that this channel is a thread, if present
  - serverId: string
    Server ID
    
    Description
    The ID of the server
  - Optionaltopic?: string
    Description
    The topic of the channel. Not applicable to threads
  - type: ServerChannelType
    Description
    The type of channel. This will determine what routes to use for creating content in a channel. For example, if this "chat", then one must use the routes for creating channel messages
  - OptionalupdatedAt?: string
    Updated at Format: date-time
    
    Description
    The ISO 8601 timestamp that the channel was updated at, if relevant
  - Optionalvisibility?: null | "private" | "public"
    Description
    What users can access the channel. Only applicable to server channels. If not present, this channel will respect normal permissions. public is accessible to everyone, even those who aren't of the server. private is only accessible to explicitly mentioned users. Currently, threads cannot be public and other channels cannot be private. Additionally, private threads can only exist with an associated messageId that is for a private message
- client: Client
  client
Returns CalendarChannel
Overrides GuildChannel.constructor
- Defined in lib/structures/CalendarChannel.ts:30

Properties

archivedAt

archivedAt: null | Date

When the channel was last archived.

archivedBy

archivedBy: null | string

ID of the member that archived the channel (if archived)

categoryID

categoryID: null | number

ID of the category the channel is in.

client

client: Client

App's client.

createdAt

createdAt: Date

When this channel was created.

creatorID

creatorID: string

ID of the member who created this channel.

description

description: null | string

Channel description

editedTimestamp

editedTimestamp: null | Date

Timestamp at which this channel was last edited.

groupID

groupID: string

ID of the group the channel is in.

guildID

guildID: string

Guild ID

id

id: string

Item ID

isPublic

isPublic: boolean

If the channel is public, this boolean is set to true.

name

name: string

Channel name

parentID

parentID: null | string

ID of the parent category.

scheduledEvents

scheduledEvents: TypedCollection<number, {
    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;
}, CalendarEvent, []>

Cached scheduled events.

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

type

type: string

Channel type

visibility

visibility: string

Channel visibility

Methods

createEvent

createEvent(options, createSeries?): Promise<CalendarEvent>
Create an event in this channel.
Parameters
- options: CreateCalendarEventOptions
  Event options.
- OptionalcreateSeries: {
      endDate?: string;
      endsAfterOccurrences?: number;
      every?: {
          count: number;
          interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval;
      };
      on?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[];
      type: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoType;
  }
  (optional) Create a series. (event's repetition)
  - OptionalendDate?: string
    Ends at Format: date-time
    
    Description
    The ISO 8601 timestamp that the event ends at. Used to control the end date of the event repeat (only used when type is custom; if used with endsAfterOccurrences, the earliest resultant date of the two will be used)
  - OptionalendsAfterOccurrences?: number
    Occurrences
    
    Description
    Used to control the end date of the event repeat (only used when type is custom; if used with endDate, the earliest resultant date of the two will be used)
  - Optionalevery?: {
    count: number;
    interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval;
    }
    Description
    Apply further clarification to your events. This must have type set to custom
    - count: number
      Count
      
      Description
      How often between your interval the event should repeat. For example, 1 would be every interval, 2 would be every second occurrence of the interval
    - interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval
      Interval
      
      Description
      Coupled with count, this indicates the time range you are repeating your event over
  - Optionalon?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[]
    Description
    Used to control the day of the week that the event should repeat on (only used when type is custom and when every.interval is week)
  - type: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoType
    Repeat Type
    Description
    How often you want your event to repeat (important note: this will repeat for the next 365 days unless custom is defined)
    
    Default
    once @enum {string}
Returns Promise<CalendarEvent>
- Defined in lib/structures/CalendarChannel.ts:44

delete

delete(): Promise<void>
Delete the channel.

Returns Promise<void>
Inherited from GuildChannel.delete
- Defined in lib/structures/GuildChannel.ts:135

deleteEvent

deleteEvent(eventID): Promise<void>
Delete an event from this channel.
Parameters
- eventID: number
  ID of the event to delete.
Returns Promise<void>
- Defined in lib/structures/CalendarChannel.ts:55

deleteSeries

deleteSeries(eventID, seriesID): Promise<void>
Delete an event series set in this channel.
Parameters
- eventID: number
  ID of the event.
- seriesID: string
  ID of the series.
Returns Promise<void>
- Defined in lib/structures/CalendarChannel.ts:64

edit

edit(options): Promise<Channel>
Edit the channel.
Parameters
- options: EditChannelOptions
Returns Promise<Channel>
Inherited from GuildChannel.edit
- Defined in lib/structures/GuildChannel.ts:139

editEvent

editEvent(eventID, options): Promise<CalendarEvent>
Edit an event from this channel.
Parameters
- eventID: number
  ID of a calendar event.
- options: EditCalendarEventOptions
  Edit options.
Returns Promise<CalendarEvent>
- Defined in lib/structures/CalendarChannel.ts:72

editSeries

editSeries(eventID, seriesID, options): Promise<void>
Edit an event series set in this channel.
Parameters
- eventID: number
  ID of the event.
- seriesID: string
  ID of the series.
- options: undefined | {
      endDate?: string;
      endsAfterOccurrences?: number;
      every?: {
          count: number;
          interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval;
      };
      on?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[];
      type: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoType;
  }
  Edit repetition options.
Returns Promise<void>
- Defined in lib/structures/CalendarChannel.ts:82

restore

restore(): Promise<void>
Restore the archived channel

Returns Promise<void>
Inherited from GuildChannel.restore
- Defined in lib/structures/GuildChannel.ts:143

toJSON

toJSON(): JSONCalendarChannel
Returns JSONCalendarChannel
Overrides GuildChannel.toJSON
- Defined in lib/structures/CalendarChannel.ts:95

Class CalendarChannel

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalarchivedAt?: string

Description

OptionalarchivedBy?: string

Description

OptionalcategoryId?: number

Description

createdAt: string

Description

createdBy: string

Description

groupId: string

Description

id: string

Description

OptionalmessageId?: string

Description

name: string

Description

OptionalparentId?: string

Description

Optionalpriority?: number

Description

OptionalrootId?: string

Description

serverId: string

Description

Optionaltopic?: string

Description

type: ServerChannelType

Description

OptionalupdatedAt?: string

Description

Optionalvisibility?: null | "private" | "public"

Description

Returns CalendarChannel

Properties

archivedAt

archivedBy

categoryID

client

createdAt

creatorID

description

editedTimestamp

groupID

guildID

id

isPublic

name

parentID

scheduledEvents

Type declaration

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

`Optional`archivedAt?: string

`Optional`archivedBy?: string

`Optional`categoryId?: number

`Optional`messageId?: string

`Optional`parentId?: string

`Optional`priority?: number

`Optional`rootId?: string

`Optional`topic?: string

`Optional`updatedAt?: string

`Optional`visibility?: null | "private" | "public"

`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`endDate?: string

`Optional`endsAfterOccurrences?: number

`Optional`every?: {
count: number;
interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval;
}

`Optional`on?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[]