Class Channels

Hierarchy

Channels

Constructors

constructor

new Channels(manager: RESTManager): Channels
Parameters
- manager: RESTManager
Returns Channels
- Defined in lib/routes/Channels.ts:62

Methods

completeListItem

completeListItem(channelID: string, itemID: string): Promise<void>
Mark a list item as completed.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:615

createCalendarEvent

createCalendarEvent(channelID: string, options: CreateCalendarEventOptions): Promise<CalendarEvent>
Create an event into a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- options: CreateCalendarEventOptions
  
  Event options.
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:510

createDoc

createDoc(channelID: string, options: CreateDocOptions): Promise<Doc>
Create a doc in a "Docs" channel.
Parameters
- channelID: string
  
  ID pf a "Docs" channel.
- options: CreateDocOptions
  
  Doc's options.
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:472

createForumComment

createForumComment(channelID: string, threadID: number, options: CreateForumCommentOptions): Promise<ForumThreadComment>
Add a comment to a forum thread.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
- options: CreateForumCommentOptions
  
  Comment's options.
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:432

createForumThread

createForumThread<T>(channelID: string, options: CreateForumThreadOptions): Promise<ForumThread<T>>
Create a forum thread in a specified forum channel.
Type Parameters
- T extends ForumChannel<T> = ForumChannel
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- options: CreateForumThreadOptions
  
  Thread's options including title & content.
Returns Promise<ForumThread<T>>
- Defined in lib/routes/Channels.ts:349

createListItem

createListItem(channelID: string, content: string, note?: {
content: string;
}): Promise<ListItem>
Create a new item in a list channel.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- content: string
  
  String content of the new item.
- Optional note: {
  content: string;
  }
  
  Add a note to the new item.
  - content: string
    
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:578

createMessage

createMessage<T>(channelID: string, options: CreateMessageOptions, params?: object): Promise<Message<T>>
Send a message in a specified channel.
Type Parameters
- T extends TextChannel<T> = TextChannel
Parameters
- channelID: string
  
  ID of the channel.
- options: CreateMessageOptions
  
  Message options
- Optional params: object
  
  Optional parameters.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:274

createReaction

createReaction(channelID: string, channelType: ChannelReactionTypes, objectID: string | number, reaction: number): Promise<void>
Add a reaction to a specified object.
Parameters
- channelID: string
  
  ID of a channel that supports reaction.
- channelType: ChannelReactionTypes
  
  Type of the selected channel. (e.g: "ChannelMessage")
- objectID: string | number
  
  ID of the object you'd like to add the reaction to. (e.g: a message id)
- reaction: number
  
  ID of the reaction.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:315

deleteCalendarEvent

deleteCalendarEvent(channelID: string, eventID: number): Promise<void>
Delete an event from a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:539

deleteCalendarRsvp

deleteCalendarRsvp(channelID: string, eventID: number, memberID: string): Promise<void>
Delete a RSVP from a calendar event.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
- memberID: string
  
  ID of a member.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:566

deleteDoc

deleteDoc(channelID: string, docID: number): Promise<void>
Delete a doc from a "Docs" channel.
Parameters
- channelID: string
  
  ID of a "Docs" channel.
- docID: number
  
  ID of a doc.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:499

deleteForumComment

deleteForumComment(channelID: string, threadID: number, commentID: number): Promise<void>
Delete a forum thread comment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
- commentID: number
  
  ID of a forum thread comment.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:461

deleteForumThread

deleteForumThread(channelID: string, threadID: number): Promise<void>
Delete a forum thread from a specific forum channel
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:376

deleteListItem

deleteListItem(channelID: string, itemID: string): Promise<void>
Delete an item from a list channel.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:604

deleteMessage

deleteMessage(channelID: string, messageID: string): Promise<void>
Delete a specific message.
Parameters
- channelID: string
  
  ID of the channel containing the message.
- messageID: string
  
  ID of the message you'd like to delete.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:302

deleteReaction

deleteReaction(channelID: string, channelType: ChannelReactionTypes, objectID: string | number, reaction: number): Promise<void>
Remove a reaction from a specified message.
Parameters
- channelID: string
  
  ID of a channel that supports reaction.
- channelType: ChannelReactionTypes
  
  Type of the selected channel. (e.g: "ChannelMessage")
- objectID: string | number
  
  ID of the object you'd like to add the reaction to. (e.g: a message id)
- reaction: number
  
  ID of the reaction.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:333

editCalendarEvent

editCalendarEvent(channelID: string, eventID: number, options: EditCalendarEventOptions): Promise<CalendarEvent>
Edit an event from a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
- options: EditCalendarEventOptions
  
  Edit options.
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:525

editCalendarRsvp

editCalendarRsvp(channelID: string, eventID: number, memberID: string, options: EditCalendarRSVPOptions): Promise<CalendarEventRSVP>
Add/Edit a RSVP in a calendar event.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
- memberID: string
  
  ID of a member.
- options: EditCalendarRSVPOptions
  
  Edit options.
Returns Promise<CalendarEventRSVP>
- Defined in lib/routes/Channels.ts:552

editDoc

editDoc(channelID: string, docID: number, options: EditDocOptions): Promise<Doc>
Edit a doc from a "Docs" channel.
Parameters
- channelID: string
  
  ID of a "Docs" channel.
- docID: number
  
  ID of a doc.
- options: EditDocOptions
  
  Edit options.
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:486

editForumComment

editForumComment(channelID: string, threadID: number, commentID: number, options?: EditForumCommentOptions): Promise<ForumThreadComment>
Edit a forum thread's comment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
- commentID: number
  
  ID of a thread comment.
- Optional options: EditForumCommentOptions
  
  Edit options.
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:447

editForumThread

editForumThread<T>(channelID: string, threadID: number, options: EditForumThreadOptions): Promise<ForumThread<T>>
Edit a forum thread from a specified forum channel.
Type Parameters
- T extends ForumChannel<T> = ForumChannel
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
- options: EditForumThreadOptions
  
  Edit options.
Returns Promise<ForumThread<T>>
- Defined in lib/routes/Channels.ts:363

editListItem

editListItem(channelID: string, itemID: string, content: string, note?: {
content: string;
}): Promise<ListItem>
Edit an item from a list channel.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
- content: string
  
  New item's content.
- Optional note: {
  content: string;
  }
  
  Add a note to the item.
  - content: string
    
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:592

editMessage

editMessage<T>(channelID: string, messageID: string, newMessage: EditMessageOptions, params?: object): Promise<Message<T>>
Edit a specific message coming from a specified channel.
Type Parameters
- T extends TextChannel<T> = TextChannel
Parameters
- channelID: string
  
  The ID of the channel.
- messageID: string
  
  The ID of the message you'd like to edit.
- newMessage: EditMessageOptions
  
  object containing new message's options.
- Optional params: object
  
  Optional parameters.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:289

getCalendarEvent

getCalendarEvent(channelID: string, eventID: number): Promise<CalendarEvent>
This method is used to get a specific calendar event.

Note: this method requires a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a Calendar channel.
- eventID: number
  
  ID of a Calendar event.
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:196

getCalendarEvents

getCalendarEvents(channelID: string, filter?: GetCalendarEventsFilter): Promise<CalendarEvent[]>
This method is used to get a list of CalendarEvent
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- Optional filter: GetCalendarEventsFilter
  
  Object to filter the output.
Returns Promise<CalendarEvent[]>
- Defined in lib/routes/Channels.ts:207

getCalendarRsvp

getCalendarRsvp(channelID: string, eventID: number, memberID: string): Promise<CalendarEventRSVP>
This method is used to get a specific CalendarEventRSVP.

Note: this method requires a Calendar channel.
Parameters
- channelID: string
  
  ID of a Calendar channel
- eventID: number
  
  ID of a Calendar Event
- memberID: string
  
  ID of a Guild Member
Returns Promise<CalendarEventRSVP>
- Defined in lib/routes/Channels.ts:228

getCalendarRsvps

getCalendarRsvps(channelID: string, eventID: number): Promise<CalendarEventRSVP[]>
This method is used to get a list of CalendarEventRSVP.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of a calendar event.
Returns Promise<CalendarEventRSVP[]>
- Defined in lib/routes/Channels.ts:239

getChannel

getChannel(channelID: string): Promise<AnyChannel>
This method is used to get a guild channel.
Parameters
- channelID: string
  
  The ID of the channel to get.
Returns Promise<AnyChannel>
- Defined in lib/routes/Channels.ts:69

getDoc

getDoc(channelID: string, docID: number): Promise<Doc>
This method is used to get a channel doc.

Note: This method requires a "Docs" channel.
Parameters
- channelID: string
  
  ID of the Docs channel.
- docID: number
  
  ID of the channel doc.
Returns Promise<Doc>
- Defined in lib/routes/Channels.ts:113

getDocs

getDocs(channelID: string, filter?: {
before?: string;
limit?: number;
}): Promise<Doc[]>
This method is used to get a list of "Channel" Doc.
Parameters
- channelID: string
  
  ID of a "Docs" channel.
- Optional filter: {
  before?: string;
  limit?: number;
  }
  
  Object to filter the output.
  - Optional before?: string
  - Optional limit?: number
Returns Promise<Doc[]>
- Defined in lib/routes/Channels.ts:124

getForumComment

getForumComment(channelID: string, threadID: number, commentID: number): Promise<ForumThreadComment>
This method is used to get a specific forum thread comment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a Forum thread.
- commentID: number
  
  ID of a Forum thread comment.
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:172

getForumComments

getForumComments(channelID: string, threadID: number): Promise<ForumThreadComment[]>
This method is used to get a list of ForumThreadComment.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a Forum Thread.
Returns Promise<ForumThreadComment[]>
- Defined in lib/routes/Channels.ts:183

getForumThread

getForumThread(channelID: string, threadID: number): Promise<ForumThread<ForumChannel>>
This method is used to get a specific forum thread.

Note: This method requires a "Forum" channel.
Parameters
- channelID: string
  
  ID of a speific Forum channel.
- threadID: number
  
  ID of the specific Forum Thread.
Returns Promise<ForumThread<ForumChannel>>
- Defined in lib/routes/Channels.ts:143

getForumThreads

getForumThreads(channelID: string, filter?: GetForumThreadsFilter): Promise<ForumThread<ForumChannel>[]>
This method is used to get a list of ForumThread.
Parameters
- channelID: string
  
  ID of a "Forum" channel.
- Optional filter: GetForumThreadsFilter
  
  Object to filter the output.
Returns Promise<ForumThread<ForumChannel>[]>
- Defined in lib/routes/Channels.ts:154

getListItem

getListItem(channelID: string, itemID: string): Promise<ListItem>
This method is used to get a specific list item.
Parameters
- channelID: string
  
  ID of a "List" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:250

getListItems

getListItems(channelID: string): Promise<ListItem[]>
This method is used to get a list of ListItem.
Parameters
- channelID: string
  
  ID of a "List" channel.
Returns Promise<ListItem[]>
- Defined in lib/routes/Channels.ts:260

getMessage

getMessage<T>(channelID: string, messageID: string, params?: object): Promise<Message<T>>
This method is used to get a channel message.
Type Parameters
- T extends TextChannel<T> = TextChannel
Parameters
- channelID: string
  
  The ID of the channel containing the message.
- messageID: string
  
  The ID of the message to get.
- Optional params: object
  
  Optional parameters.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:81

getMessages

getMessages(channelID: string, filter?: GetChannelMessagesFilter): Promise<Message<TextChannel>[]>
This method is used to get a list of Message
Parameters
- channelID: string
  
  ID of a "Chat" channel.
- Optional filter: GetChannelMessagesFilter
  
  Object to filter the output.
Returns Promise<Message<TextChannel>[]>
- Defined in lib/routes/Channels.ts:92

lockForumThread

lockForumThread(channelID: string, threadID: number): Promise<void>
Lock a forum thread.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:409

pinForumThread

pinForumThread(channelID: string, threadID: number): Promise<void>
Pin a forum thread.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:387

uncompleteListItem

uncompleteListItem(channelID: string, itemID: string): Promise<void>
Mark a list item as uncompleted.
Parameters
- channelID: string
  
  ID of a "Lists" channel.
- itemID: string
  
  ID of a list item.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:626

unlockForumThread

unlockForumThread(channelID: string, threadID: number): Promise<void>
Unlock a forum thread.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:420

unpinForumThread

unpinForumThread(channelID: string, threadID: number): Promise<void>
Unpin a forum thread.
Parameters
- channelID: string
  
  ID of a "Forums" channel.
- threadID: number
  
  ID of a forum thread.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:398

Class Channels

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Channels

Methods

completeListItem

Parameters

channelID: string

itemID: string

Returns Promise<void>

createCalendarEvent

Parameters

channelID: string

options: CreateCalendarEventOptions

Returns Promise<CalendarEvent>

createDoc

Parameters

channelID: string

options: CreateDocOptions

Returns Promise<Doc>

createForumComment

Parameters

channelID: string

threadID: number

options: CreateForumCommentOptions

Returns Promise<ForumThreadComment>

createForumThread

Type Parameters

T extends ForumChannel<T> = ForumChannel

Parameters

channelID: string

options: CreateForumThreadOptions

Returns Promise<ForumThread<T>>

createListItem

Parameters

channelID: string

content: string

Optional note: { content: string; }

content: string

Returns Promise<ListItem>

createMessage

Type Parameters

T extends TextChannel<T> = TextChannel

Parameters

channelID: string

options: CreateMessageOptions

Optional params: object

Returns Promise<Message<T>>

createReaction

Parameters

channelID: string

channelType: ChannelReactionTypes

objectID: string | number

reaction: number

Returns Promise<void>

deleteCalendarEvent

Parameters

channelID: string

eventID: number

Returns Promise<void>

deleteCalendarRsvp

Parameters

channelID: string

eventID: number

memberID: string

Returns Promise<void>

deleteDoc

Parameters

channelID: string

docID: number

Returns Promise<void>

deleteForumComment

Parameters

channelID: string

`Optional` note: {
content: string;
}

`Optional` params: object

`Optional` options: EditForumCommentOptions

`Optional` note: {
content: string;
}