Class Channels

Hierarchy

Channels

Index

Constructors

Methods

completeListItem createCalendarComment createCalendarEvent createCalendarEventSeries createDoc createDocComment createForumComment createForumThread createListItem createMessage createReaction createReactionToSubcategory deleteCalendarComment deleteCalendarEvent deleteCalendarEventSeries deleteCalendarRsvp deleteDoc deleteDocComment deleteForumComment deleteForumThread deleteListItem deleteMessage deleteReaction deleteReactionFromSubcategory editCalendarComment editCalendarEvent editCalendarEventSeries editCalendarRsvp editDoc editDocComment editForumComment editForumThread editListItem editMessage getCalendarEvent getCalendarEventComment getCalendarEventComments getCalendarEvents getCalendarRsvp getCalendarRsvps getChannel getDoc getDocComment getDocComments getDocs getForumComment getForumComments getForumThread getForumThreads getListItem getListItems getMessage getMessages lockForumThread pinForumThread uncompleteListItem unlockForumThread unpinForumThread

Constructors

constructor

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

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:859

createCalendarComment

createCalendarComment(channelID: string, eventID: number, options: CreateCalendarCommentOptions): Promise<CalendarEventComment>
Create a comment inside a calendar event.
Parameters
- channelID: string
  
  The ID of a "Calendar" channel.
- eventID: number
  
  The ID of a calendar event.
- options: CreateCalendarCommentOptions
  
  Comment options, includes content, and more.
Returns Promise<CalendarEventComment>
- Defined in lib/routes/Channels.ts:743

createCalendarEvent

createCalendarEvent(channelID: string, options: CreateCalendarEventOptions, createSeries?: {
    endDate?: string;
    endsAfterOccurrences?: number;
    every?: {
        count: number;
        interval: "day" | "week" | "month" | "year";
    };
    on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
    type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
}): Promise<CalendarEvent>
Create an event into a "Calendar" channel.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- options: CreateCalendarEventOptions
  
  Event options.
- Optional createSeries: {
      endDate?: string;
      endsAfterOccurrences?: number;
      every?: {
          count: number;
          interval: "day" | "week" | "month" | "year";
      };
      on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
      type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
  }
  
  (optional) Create a series. (event's repetition)
  - Optional endDate?: string
    
    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)
  - Optional endsAfterOccurrences?: number
    
    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) (max 24)
  - Optional every?: {
    count: number;
    interval: "day" | "week" | "month" | "year";
    }
    
    Apply further clarification to your events. This must have type set to custom
    - count: number
      
      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: "day" | "week" | "month" | "year"
      
      Coupled with count, this indicates the time range you are repeating your event over
  - Optional on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[]
    
    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) (min items 1)
  - type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom"
    
    How often you want your event to repeat (important note: this will repeat for the next 180 days unless custom is defined) (default once)
Returns Promise<CalendarEvent>
- Defined in lib/routes/Channels.ts:667

createCalendarEventSeries

createCalendarEventSeries(): Error
The Guilded API only allows series on the event's creation.

Use createCalendarEvent and set the createSeries property to create a series.

Returns Error
- Defined in lib/routes/Channels.ts:705

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:586

createDocComment

createDocComment(channelID: string, docID: number, options: CreateDocCommentOptions): Promise<DocComment>
Create a comment in a doc.
Parameters
- channelID: string
  
  ID of the docs channel.
- docID: number
  
  ID of the doc.
- options: CreateDocCommentOptions
  
  Create options.
Returns Promise<DocComment>
- Defined in lib/routes/Channels.ts:626

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:546

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:463

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:822

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:344

createReaction

createReaction(channelID: string, channelType: ChannelReactionTypes, targetID: string | number, reaction: number): Promise<void>
Add a reaction to a specified object from a channel.
Parameters
- channelID: string
  
  ID of a channel that supports reaction.
- channelType: ChannelReactionTypes
  
  Type of the selected channel. (e.g: "ChannelMessage")
- targetID: 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 to add.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:385

createReactionToSubcategory

createReactionToSubcategory(channelID: string, subcategoryType: ChannelSubcategoryReactionTypes, subcategoryID: string | number, targetID: string | number, reaction: number): Promise<void>
Add a reaction to an object from a subcategory (e.g: a comment from Forum Thread)
Parameters
- channelID: string
  
  ID of a channel that supports reaction.
- subcategoryType: ChannelSubcategoryReactionTypes
  
  Type of the selected subcategory. (e.g: "CalendarEvent")
- subcategoryID: string | number
  
  ID of the subcategory you selected.
- targetID: string | number
  
  ID of the object you'd like to add the reaction to. (e.g: a comment id)
- reaction: number
  
  ID of the reaction to add.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:426

deleteCalendarComment

deleteCalendarComment(channelID: string, eventID: number, commentID: number): Promise<void>
Delete a comment from a calendar event.
Parameters
- channelID: string
  
  ID of the channel containing the event.
- eventID: number
  
  ID of the event containing the comment.
- commentID: number
  
  ID of the comment to delete.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:772

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:783

deleteCalendarEventSeries

deleteCalendarEventSeries(channelID: string, eventID: number, seriesID: string): Promise<void>
Delete a CalendarEventSeries.
Parameters
- channelID: string
  
  ID of the channel.
- eventID: number
  
  ID of the event.
- seriesID: string
  
  ID of the series.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:730

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:810

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:613

deleteDocComment

deleteDocComment(channelID: string, docID: number, commentID: number): Promise<void>
Delete a doc comment.
Parameters
- channelID: string
  
  ID of the docs channel.
- docID: number
  
  ID of the doc.
- commentID: number
  
  ID of the comment to delete.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:655

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:575

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:490

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:848

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:372

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:405

deleteReactionFromSubcategory

deleteReactionFromSubcategory(channelID: string, subcategoryType: ChannelSubcategoryReactionTypes, subcategoryID: string | number, targetID: string | number, reaction: number): Promise<void>
Remove a reaction from an object from a subcategory (e.g: a comment from Forum Thread)
Parameters
- channelID: string
  
  ID of a channel that supports reaction.
- subcategoryType: ChannelSubcategoryReactionTypes
  
  Type of the selected subcategory. (e.g: "CalendarEvent")
- subcategoryID: string | number
  
  ID of the subcategory you selected.
- targetID: string | number
  
  ID of the object you'd like to remove the reaction to. (e.g: a comment id)
- reaction: number
  
  ID of the reaction to add.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:446

editCalendarComment

editCalendarComment(channelID: string, eventID: number, commentID: number, options: EditCalendarCommentOptions): Promise<CalendarEventComment>
Edit an existing calendar event comment.
Parameters
- channelID: string
  
  The ID of a "Calendar" channel.
- eventID: number
  
  The ID of an event from the channel.
- commentID: number
  
  The ID of the comment to edit.
- options: EditCalendarCommentOptions
  
  Edit options.
Returns Promise<CalendarEventComment>
- Defined in lib/routes/Channels.ts:758

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:687

editCalendarEventSeries

editCalendarEventSeries(channelID: string, eventID: number, seriesID: string, options: undefined | {
    endDate?: string;
    endsAfterOccurrences?: number;
    every?: {
        count: number;
        interval: "day" | "week" | "month" | "year";
    };
    on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
    type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
}): Promise<void>
Edit a CalendarEventSeries.
Parameters
- channelID: string
  
  ID of the channel.
- eventID: number
  
  ID of the event.
- seriesID: string
  
  ID of the series.
- options: undefined | {
      endDate?: string;
      endsAfterOccurrences?: number;
      every?: {
          count: number;
          interval: "day" | "week" | "month" | "year";
      };
      on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[];
      type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom";
  }
  
  Edit repetition options.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:716

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:796

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:600

editDocComment

editDocComment(channelID: string, docID: number, commentID: number, options: EditDocCommentOptions): Promise<DocComment>
Edit a doc comment.
Parameters
- channelID: string
  
  ID of the docs channel.
- docID: number
  
  ID of the doc.
- commentID: number
  
  ID of the comment to edit.
- options: EditDocCommentOptions
  
  Edit options.
Returns Promise<DocComment>
- Defined in lib/routes/Channels.ts:641

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:561

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:477

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:836

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:359

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:241

getCalendarEventComment

getCalendarEventComment(channelID: string, eventID: number, commentID: number): Promise<CalendarEventComment>
This method is used to get a specific event comment coming from a calendar. Note: this method doesn't cache scheduled events due to the API's restrictions.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of an event containing the comment to get.
- commentID: number
  
  ID of the comment to get.
Returns Promise<CalendarEventComment>
- Defined in lib/routes/Channels.ts:272

getCalendarEventComments

getCalendarEventComments(channelID: string, eventID: number): Promise<CalendarEventComment[]>
This method is used to get a list of CalendarEventComment Note: due to API's restrictions, we're not able to cache scheduled events from this method.
Parameters
- channelID: string
  
  ID of a "Calendar" channel.
- eventID: number
  
  ID of the event containing comments.
Returns Promise<CalendarEventComment[]>
- Defined in lib/routes/Channels.ts:284

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:252

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:298

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:309

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:89

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:133

getDocComment

getDocComment(channelID: string, docID: number, commentID: number): Promise<DocComment>
Get a specific comment from a doc.
Parameters
- channelID: string
  
  ID of the channel containing the doc.
- docID: number
  
  ID of the doc the comment is in.
- commentID: number
  
  ID of the comment to get.
Returns Promise<DocComment>
- Defined in lib/routes/Channels.ts:175

getDocComments

getDocComments(channelID: string, docID: number): Promise<DocComment[]>
Get every comments from a doc.
Parameters
- channelID: string
  
  ID of the channel containing the doc.
- docID: number
  
  ID of the doc the comment is in.
Returns Promise<DocComment[]>
- Defined in lib/routes/Channels.ts:162

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:144

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:217

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:228

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:188

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:199

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:320

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:330

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:101

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:112

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:523

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:501

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:870

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:534

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:512

Class Channels

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Channels

Methods

completeListItem

Parameters

channelID: string

itemID: string

Returns Promise<void>

createCalendarComment

Parameters

channelID: string

eventID: number

options: CreateCalendarCommentOptions

Returns Promise<CalendarEventComment>

createCalendarEvent

Parameters

channelID: string

options: CreateCalendarEventOptions

Optional endDate?: string

Optional endsAfterOccurrences?: number

Optional every?: { count: number; interval: "day" | "week" | "month" | "year"; }

count: number

interval: "day" | "week" | "month" | "year"

Optional on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[]

type: "once" | "everyDay" | "everyWeek" | "everyMonth" | "custom"

Returns Promise<CalendarEvent>

createCalendarEventSeries

Returns Error

createDoc

Parameters

channelID: string

options: CreateDocOptions

Returns Promise<Doc>

createDocComment

Parameters

channelID: string

docID: number

options: CreateDocCommentOptions

Returns Promise<DocComment>

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

targetID: string | number

`Optional` endDate?: string

`Optional` endsAfterOccurrences?: number

`Optional` every?: {
count: number;
interval: "day" | "week" | "month" | "year";
}

`Optional` on?: ("sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday")[]

`Optional` note: {
content: string;
}

`Optional` params: object