Class Channels

Hierarchy

Channels

Index

Constructors

Methods

archiveChannel bulkCalendarRsvpUpdate bulkDeleteReactions completeListItem createAnnouncement createAnnouncementComment createCalendarComment createCalendarEvent createCalendarEventSeries createDoc createDocComment createForumComment createForumThread createListItem createMessage createReaction createReactionToSubcategory deleteAnnouncement deleteAnnouncementComment deleteCalendarComment deleteCalendarEvent deleteCalendarEventSeries deleteCalendarRsvp deleteDoc deleteDocComment deleteForumComment deleteForumThread deleteListItem deleteMessage deleteReaction deleteReactionFromSubcategory editAnnouncement editAnnouncementComment editCalendarComment editCalendarEvent editCalendarEventSeries editCalendarRsvp editDoc editDocComment editForumComment editForumThread editListItem editMessage getAnnouncement getAnnouncementComment getAnnouncementComments getAnnouncements getCalendarEvent getCalendarEventComment getCalendarEventComments getCalendarEvents getCalendarRsvp getCalendarRsvps getChannel getDoc getDocComment getDocComments getDocs getForumComment getForumComments getForumThread getForumThreads getListItem getListItems getMessage getMessages lockForumThread pinForumThread pinMessage restoreChannel uncompleteListItem unlockForumThread unpinForumThread unpinMessage

Constructors

constructor

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

Methods

archiveChannel

archiveChannel(channelID): Promise<void>
Archive a channel.
Parameters
- channelID: string
  
  ID of the channel to archive
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1075

bulkCalendarRsvpUpdate

bulkCalendarRsvpUpdate(channelID, eventID, memberIDs, options): Promise<void>
Bulk create/update calendar rsvps.
Parameters
- channelID: string
  
  ID of the Calendar channel.
- eventID: number
  
  ID of a calendar event.
- memberIDs: string[]
  
  List of multiple member ids.
- options: EditCalendarRSVPOptions
  
  Update options.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:866

bulkDeleteReactions

bulkDeleteReactions(channelID, channelType, targetID, filter?): Promise<void>
Bulk delete every reaction from a target.
Parameters
- channelID: string
  
  ID of a channel.
- channelType: "ChannelMessage"
  
  Type of channel.
- targetID: string | number
  
  Target to remove reactions from it.
- Optional filter: DELETEMessageReactionQuery
Returns Promise<void>
- Defined in lib/routes/Channels.ts:444

completeListItem

completeListItem(channelID, itemID): 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:918

createAnnouncement

createAnnouncement(channelID, options): Promise<Announcement>
Create a new announcement within an announcement channel.
Parameters
- channelID: string
  
  ID of the Announcement channel.
- options: POSTChannelAnnouncementBody
  
  Announcement creation options.
Returns Promise<Announcement>
- Defined in lib/routes/Channels.ts:941

createAnnouncementComment

createAnnouncementComment(channelID, announcementID, options): Promise<AnnouncementComment>
Create a comment inside an announcement.
Parameters
- channelID: string
  
  ID of the Announcement channel.
- announcementID: string
  
  ID of the announcement to create the comment in.
- options: POSTChannelAnnouncementCommentBody
  
  Comment creation options.
Returns Promise<AnnouncementComment>
- Defined in lib/routes/Channels.ts:1009

createCalendarComment

createCalendarComment(channelID, eventID, options): 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:785

createCalendarEvent

createCalendarEvent(channelID, options, createSeries?): 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:709

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

createDoc

createDoc(channelID, options): 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:628

createDocComment

createDocComment(channelID, docID, options): 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:668

createForumComment

createForumComment(channelID, threadID, options): 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:588

createForumThread

createForumThread<T>(channelID, options): 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:505

createListItem

createListItem(channelID, content, note?): 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:882

createMessage

createMessage<T>(channelID, options, params?): 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:361

createReaction

createReaction(channelID, channelType, targetID, reaction): 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:402

createReactionToSubcategory

createReactionToSubcategory(channelID, subcategoryType, subcategoryID, targetID, reaction): Promise<void>
Add a reaction to a target 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 target 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:466

deleteAnnouncement

deleteAnnouncement(channelID, announcementID): Promise<void>
Delete an announcement.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- announcementID: string
  
  ID of the announcement to delete.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:968

deleteAnnouncementComment

deleteAnnouncementComment(channelID, announcementID, commentID): Promise<void>
Delete an announcement comment.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- announcementID: string
  
  ID of the announcement where the comment is in.
- commentID: number
  
  ID of the comment to delete.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1038

deleteCalendarComment

deleteCalendarComment(channelID, eventID, commentID): 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:814

deleteCalendarEvent

deleteCalendarEvent(channelID, eventID): 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:825

deleteCalendarEventSeries

deleteCalendarEventSeries(channelID, eventID, seriesID): 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:772

deleteCalendarRsvp

deleteCalendarRsvp(channelID, eventID, memberID): 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:852

deleteDoc

deleteDoc(channelID, docID): 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:655

deleteDocComment

deleteDocComment(channelID, docID, commentID): 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:697

deleteForumComment

deleteForumComment(channelID, threadID, commentID): 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:617

deleteForumThread

deleteForumThread(channelID, threadID): 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:532

deleteListItem

deleteListItem(channelID, itemID): 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:907

deleteMessage

deleteMessage(channelID, messageID): 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:389

deleteReaction

deleteReaction(channelID, channelType, targetID, reaction): 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")
- targetID: string | number
  
  ID of the target 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:423

deleteReactionFromSubcategory

deleteReactionFromSubcategory(channelID, subcategoryType, subcategoryID, targetID, reaction): Promise<void>
Remove a reaction from a target 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 target you'd like to remove the reaction from. (e.g: a comment id)
- reaction: number
  
  ID of the reaction to add.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:487

editAnnouncement

editAnnouncement(channelID, announcementID, options): Promise<Announcement>
Edit an existing announcement.
Parameters
- channelID: string
  
  ID of the Announcement channel.
- announcementID: string
  
  ID of the announcement to edit.
- options: PATCHChannelAnnouncementBody
  
  Edit options
Returns Promise<Announcement>
- Defined in lib/routes/Channels.ts:955

editAnnouncementComment

editAnnouncementComment(channelID, announcementID, commentID, options): Promise<AnnouncementComment>
Edit an announcement comment.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- announcementID: string
  
  ID of an announcement where the comment is in.
- commentID: number
  
  ID of the comment to edit.
- options: PATCHChannelAnnouncementCommentBody
  
  Edit options.
Returns Promise<AnnouncementComment>
- Defined in lib/routes/Channels.ts:1024

editCalendarComment

editCalendarComment(channelID, eventID, commentID, options): 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:800

editCalendarEvent

editCalendarEvent(channelID, eventID, options): 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:729

editCalendarEventSeries

editCalendarEventSeries(channelID, eventID, seriesID, options): 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:758

editCalendarRsvp

editCalendarRsvp(channelID, eventID, memberID, options): 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:838

editDoc

editDoc(channelID, docID, options): 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:642

editDocComment

editDocComment(channelID, docID, commentID, options): 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:683

editForumComment

editForumComment(channelID, threadID, commentID, options?): 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:603

editForumThread

editForumThread<T>(channelID, threadID, options): 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:519

editListItem

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

editMessage

editMessage<T>(channelID, messageID, newMessage, params?): 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:376

getAnnouncement

getAnnouncement(channelID, announcementID): Promise<Announcement>
Get a specific announcement from a channel.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- announcementID: string
  
  ID of the announcement to get.
Returns Promise<Announcement>
- Defined in lib/routes/Channels.ts:996

getAnnouncementComment

getAnnouncementComment(channelID, announcementID, commentID): Promise<AnnouncementComment>
Get a specific comment from an announcement.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- announcementID: string
  
  ID of the announcement where the comment is in.
- commentID: number
  
  ID of the comment to get.
Returns Promise<AnnouncementComment>
- Defined in lib/routes/Channels.ts:1063

getAnnouncementComments

getAnnouncementComments(channelID, announcementID): Promise<AnnouncementComment[]>
Get comments from an announcement.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- announcementID: string
  
  ID of an announcement.
Returns Promise<AnnouncementComment[]>
- Defined in lib/routes/Channels.ts:1050

getAnnouncements

getAnnouncements(channelID, filter?): Promise<Announcement[]>
Get a list of announcements from a channel.
Parameters
- channelID: string
  
  ID of an Announcement channel.
- Optional filter: GETChannelAnnouncementsQuery
  
  Filter to apply.
Returns Promise<Announcement[]>
- Defined in lib/routes/Channels.ts:980

getCalendarEvent

getCalendarEvent(channelID, eventID): 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:258

getCalendarEventComment

getCalendarEventComment(channelID, eventID, commentID): 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:289

getCalendarEventComments

getCalendarEventComments(channelID, eventID): 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:301

getCalendarEvents

getCalendarEvents(channelID, filter?): 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:269

getCalendarRsvp

getCalendarRsvp(channelID, eventID, memberID): 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:315

getCalendarRsvps

getCalendarRsvps(channelID, eventID): 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:326

getChannel

getChannel(channelID): 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:106

getDoc

getDoc(channelID, docID): 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:150

getDocComment

getDocComment(channelID, docID, commentID): 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:192

getDocComments

getDocComments(channelID, docID): 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:179

getDocs

getDocs(channelID, filter?): 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:161

getForumComment

getForumComment(channelID, threadID, commentID): 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:234

getForumComments

getForumComments(channelID, threadID): 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:245

getForumThread

getForumThread(channelID, threadID): 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:205

getForumThreads

getForumThreads(channelID, filter?): 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:216

getListItem

getListItem(channelID, itemID): 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:337

getListItems

getListItems(channelID): 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:347

getMessage

getMessage<T>(channelID, messageID, params?): 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:118

getMessages

getMessages(channelID, filter?): 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:129

lockForumThread

lockForumThread(channelID, threadID): 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:565

pinForumThread

pinForumThread(channelID, threadID): 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:543

pinMessage

pinMessage(channelID, messageID): Promise<void>
Pin a message.
Parameters
- channelID: string
  
  ID of the channel where the message to pin is in
- messageID: string
  
  ID of the message to pin
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1099

restoreChannel

restoreChannel(channelID): Promise<void>
Restore a channel.
Parameters
- channelID: string
  
  ID of the channel to restore
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1087

uncompleteListItem

uncompleteListItem(channelID, itemID): 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:929

unlockForumThread

unlockForumThread(channelID, threadID): 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:576

unpinForumThread

unpinForumThread(channelID, threadID): 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:554

unpinMessage

unpinMessage(channelID, messageID): Promise<void>
Unpin a message.
Parameters
- channelID: string
  
  ID of the channel where the message to unpin is in
- messageID: string
  
  ID of the message to unpin
Returns Promise<void>
- Defined in lib/routes/Channels.ts:1111

Class Channels

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Channels

Methods

archiveChannel

Parameters

channelID: string

Returns Promise<void>

bulkCalendarRsvpUpdate

Parameters

channelID: string

eventID: number

memberIDs: string[]

options: EditCalendarRSVPOptions

Returns Promise<void>

bulkDeleteReactions

Parameters

channelID: string

channelType: "ChannelMessage"

targetID: string | number

Optional filter: DELETEMessageReactionQuery

Returns Promise<void>

completeListItem

Parameters

channelID: string

itemID: string

Returns Promise<void>

createAnnouncement

Parameters

channelID: string

options: POSTChannelAnnouncementBody

Returns Promise<Announcement>

createAnnouncementComment

Parameters

channelID: string

announcementID: string

options: POSTChannelAnnouncementCommentBody

Returns Promise<AnnouncementComment>

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

`Optional` filter: DELETEMessageReactionQuery

`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