Class Channels

Index

Constructors

Methods

archive bulkCalendarRSVPUpdate bulkDeleteReactions completeListItem createAnnouncement createAnnouncementComment createCalendarComment createCalendarEvent createCalendarEventSeries createDoc createDocComment createForumComment createForumThread createListItem createMessage createPermission createReaction createReactionToSubcategory delete deleteAnnouncement deleteAnnouncementComment deleteCalendarComment deleteCalendarEvent deleteCalendarEventSeries deleteCalendarRSVP deleteDoc deleteDocComment deleteForumComment deleteForumThread deleteListItem deleteMessage deletePermission deleteReaction deleteReactionFromSubcategory edit editAnnouncement editAnnouncementComment editCalendarComment editCalendarEvent editCalendarEventSeries editCalendarRSVP editDoc editDocComment editForumComment editForumThread editListItem editMessage editPermission get getAnnouncement getAnnouncementComment getAnnouncementComments getAnnouncements getCalendarEvent getCalendarEventComment getCalendarEventComments getCalendarEvents getCalendarRSVP getCalendarRSVPs getDoc getDocComment getDocComments getDocs getForumComment getForumComments getForumThread getForumThreads getListItem getListItems getMessage getMessages getPermission getPermissions getRolePermissions getUserPermissions lockForumThread pinForumThread pinMessage restore uncompleteListItem unlockForumThread unpinForumThread unpinMessage

Constructors

constructor

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

Methods

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

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.
- Optionalfilter: {
  emoteId?: number;
  }
  Filter options.
  - OptionalemoteId?: number
    Example
    90000000
Returns Promise<void>
- Defined in lib/routes/Channels.ts:169

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

createAnnouncement

createAnnouncement(channelID, options): Promise<Announcement>
Create a new announcement within an announcement channel.
Parameters
- channelID: string
  ID of the Announcement channel.
- options: {
  content: string | Record<string, never>;
  title: string;
  }
  Announcement creation options.
  - content: string | Record<string, never>
    Content
    
    Description
    The content of the announcement
  - title: string
    Title
    
    Description
    The title of the announcement
Returns Promise<Announcement>
- Defined in lib/routes/Channels.ts:203

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: {
  content: string;
  }
  Comment creation options.
  - content: string
    Content Format: long-form markdown
    
    Description
    The content of the announcement comment
Returns Promise<AnnouncementComment>
- Defined in lib/routes/Channels.ts:218

createCalendarComment

createCalendarComment(channelID, eventID, options): Promise<CalendarComment>
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<CalendarComment>
- Defined in lib/routes/Channels.ts:236

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.
- 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/routes/Channels.ts:255

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

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

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

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

createForumThread

createForumThread<T>(channelID, options): Promise<ForumThread<T>>
Create a forum thread in a specified forum channel.
Type Parameters
- T extends ForumChannel = 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, content, note?): Promise<ListItem>
Create a new item in a list channel.
Parameters
- channelID: string
  ID of a "Lists" channel.
- content: string | Record<string, never>
  String content of the new item.
- Optionalnote: {
  content: string | Record<string, never>;
  }
  Add a note to the new item.
  - content: string | Record<string, never>
    Note
    
    Description
    The note of the list item
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:367

createMessage

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

createPermission

createPermission(guildID, channelID, targetID, options): Promise<Permission>
Add a new user permission to a channel.
Parameters
- guildID: string
  ID of the guild the channel is in
- channelID: string
  ID of the channel
- targetID: string | number
  ID of the user or role to assign the permission to
- options: {
  permissions: Record<string, never>;
  } | {
  permissions: Record<string, never>;
  }
  Create options
  
  Warning: targetID must have the correct type (number=role, string=user).
Returns Promise<Permission>
- Defined in lib/routes/Channels.ts:420

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

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

delete

delete(channelID): Promise<void>
Delete a channel.
Parameters
- channelID: string
  ID of the channel to delete.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:518

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

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

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

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

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

deleteCalendarRSVP

deleteCalendarRSVP(channelID, eventID, memberID): Promise<void>
Delete an 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:595

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

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

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

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

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

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

deletePermission

deletePermission(guildID, channelID, targetID): Promise<void>
Delete a channel permission.
Parameters
- guildID: string
  ID of the guild where the channel is in
- channelID: string
  ID of the channel
- targetID: string | number
  ID of the target user (string) or role (number)
  
  Warning: targetID must have the correct type (number=role, string=user).
Returns Promise<void>
- Defined in lib/routes/Channels.ts:679

deleteReaction

deleteReaction(channelID, channelType, targetID, reaction, targetUserID?): 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.
- OptionaltargetUserID: string
  ID of the user to remove reaction from. (works only on Channel Messages | default: @me)
Returns Promise<void>
- Defined in lib/routes/Channels.ts:696

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

edit

edit<T>(channelID, options): Promise<T>
Edit a channel.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- channelID: string
  ID of the channel to edit.
- options: EditChannelOptions
  Channel edit options.
Returns Promise<T>
- Defined in lib/routes/Channels.ts:777

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: {
  content?: string | Record<string, never>;
  title?: string;
  }
  Edit options
  - Optionalcontent?: string | Record<string, never>
    Content
    
    Description
    The content of the announcement
  - Optionaltitle?: string
    Title
    
    Description
    The title of the announcement
Returns Promise<Announcement>
- Defined in lib/routes/Channels.ts:795

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: {
  content: string;
  }
  Edit options.
  - content: string
    Content Format: long-form markdown
    
    Description
    The content of the announcement comment
Returns Promise<AnnouncementComment>
- Defined in lib/routes/Channels.ts:815

editCalendarComment

editCalendarComment(channelID, eventID, commentID, options): Promise<CalendarComment>
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<CalendarComment>
- Defined in lib/routes/Channels.ts:839

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

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: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval;
      };
      on?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[];
      type: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoType;
  }
  Edit repetition options.
Returns Promise<void>
- Defined in lib/routes/Channels.ts:897

editCalendarRSVP

editCalendarRSVP(channelID, eventID, memberID, options): Promise<CalendarEventRSVP>
Add/Edit an 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:915

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

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

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.
- Optionaloptions: EditForumCommentOptions
  Edit options.
Returns Promise<ForumThreadComment>
- Defined in lib/routes/Channels.ts:968

editForumThread

editForumThread<T>(channelID, threadID, options): Promise<ForumThread<T>>
Edit a forum thread from a specified forum channel.
Type Parameters
- T extends ForumChannel = 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:990

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.
- Optionaloptions: {
      content?: string;
      note?: null | {
          content: string;
      };
  }
  Edit options.
  - Optionalcontent?: string
  - Optionalnote?: null | {
    content: string;
    }
Returns Promise<ListItem>
- Defined in lib/routes/Channels.ts:1009

editMessage

editMessage<T>(channelID, messageID, newMessage, params?): Promise<Message<T>>
Edit a specific message coming from a specified channel.
Type Parameters
- T extends TextChannel = 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.
- Optionalparams: MessageConstructorParams
  Optional parameters.
Returns Promise<Message<T>>
- Defined in lib/routes/Channels.ts:1026

editPermission

editPermission(guildID, channelID, targetID, options): Promise<Permission>
Update a channel permission.
Parameters
- guildID: string
  ID of the guild the channel is in
- channelID: string
  ID of the channel
- targetID: string | number
  ID of the target user (string) or role (number)
- options: {
  permissions: Record<string, never>;
  }
  Edit options
  
  Warning: targetID must have the correct type (number=role, string=user).
  - permissions: Record<string, never>
    Description
    A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type
Returns Promise<Permission>
- Defined in lib/routes/Channels.ts:1065

get

get(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:1087

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

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

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

getAnnouncements

getAnnouncements(channelID, filter?): Promise<Announcement[]>
Get a list of announcements from a channel.
Parameters
- channelID: string
  ID of an Announcement channel.
- Optionalfilter: {
  before?: string;
  limit?: number;
  }
  Filter to apply.
  - Optionalbefore?: string
    Example
    2021-06-15T20:15:00.706Z
  - Optionallimit?: number
    Example
    25
Returns Promise<Announcement[]>
- Defined in lib/routes/Channels.ts:1151

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

getCalendarEventComment

getCalendarEventComment(channelID, eventID, commentID): Promise<CalendarComment>
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<CalendarComment>
- Defined in lib/routes/Channels.ts:1190

getCalendarEventComments

getCalendarEventComments(channelID, eventID): Promise<CalendarComment[]>
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<CalendarComment[]>
- Defined in lib/routes/Channels.ts:1205

getCalendarEvents

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

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

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

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

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

getDocComments

getDocComments(channelID, docID): Promise<DocComment[]>
Get every comment 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:1316

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.
- Optionalfilter: {
  before?: string;
  limit?: number;
  }
  Object to filter the output.
  - Optionalbefore?: string
  - Optionallimit?: number
Returns Promise<Doc[]>
- Defined in lib/routes/Channels.ts:1329

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

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

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 specific Forum channel.
- threadID: number
  ID of the specific Forum Thread.
Returns Promise<ForumThread<ForumChannel>>
- Defined in lib/routes/Channels.ts:1379

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.
- Optionalfilter: GetForumThreadsFilter
  Object to filter the output.
Returns Promise<ForumThread<ForumChannel>[]>
- Defined in lib/routes/Channels.ts:1389

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

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

getMessage

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

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.
- Optionalfilter: GetChannelMessagesFilter
  Object to filter the output.
Returns Promise<Message<TextChannel>[]>
- Defined in lib/routes/Channels.ts:1453

getPermission

getPermission(guildID, channelID, targetID): Promise<Permission>
Get the permissions of a user or role for a specified channel.
Parameters
- guildID: string
  ID of the guild the channel is in
- channelID: string
  ID of the channel
- targetID: string | number
  ID of the user or role to get the permission
  
  Warning: targetID must have the correct type (number=role, string=user).
Returns Promise<Permission>
- Defined in lib/routes/Channels.ts:1490

getPermissions

getPermissions(guildID, channelID): Promise<Permission[]>
Parameters
- guildID: string
- channelID: string
Returns Promise<Permission[]>
- Defined in lib/routes/Channels.ts:1501

getRolePermissions

getRolePermissions(guildID, channelID): Promise<Permission[]>
Get existing channel permissions for a specified role.
Parameters
- guildID: string
  ID of the guild where the channel is in
- channelID: string
  ID of the channel
Returns Promise<Permission[]>
- Defined in lib/routes/Channels.ts:1517

getUserPermissions

getUserPermissions(guildID, channelID): Promise<Permission[]>
Get the permissions of every user in the guild for a specified channel.
Parameters
- guildID: string
  ID of the guild where the channel is in
- channelID: string
  ID of the channel
Returns Promise<Permission[]>
- Defined in lib/routes/Channels.ts:1530

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

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

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

restore

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

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

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

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

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

Class Channels

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Channels

Methods

archive

Parameters

Returns Promise<void>

bulkCalendarRSVPUpdate

Parameters

Returns Promise<void>

bulkDeleteReactions

Parameters

OptionalemoteId?: number

Example

Returns Promise<void>

completeListItem

Parameters

Returns Promise<void>

createAnnouncement

Parameters

content: string | Record<string, never>

Description

title: string

Description

Returns Promise<Announcement>

createAnnouncementComment

Parameters

content: string

Description

Returns Promise<AnnouncementComment>

createCalendarComment

Parameters

Returns Promise<CalendarComment>

createCalendarEvent

Parameters

OptionalendDate?: string

Description

OptionalendsAfterOccurrences?: number

Description

Optionalevery?: { count: number; interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval; }

Description

count: number

Description

interval: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoEveryInterval

Description

Optionalon?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[]

Description

type: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoType

Description

Default

Returns Promise<CalendarEvent>

createCalendarEventSeries

Returns Error

createDoc

Parameters

Returns Promise<Doc>

createDocComment

Parameters

Returns Promise<DocComment>

createForumComment

Parameters

Returns Promise<ForumThreadComment>

createForumThread

Type Parameters

Parameters

Returns Promise<ForumThread<T>>

createListItem

Parameters

content: string | Record<string, never>

Description

Returns Promise<ListItem>

createMessage

Type Parameters

Parameters

Returns Promise<Message<T>>

`Optional`emoteId?: number

`Optional`endDate?: string

`Optional`endsAfterOccurrences?: number

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

`Optional`on?: PathsChannelsChannelIdEventsPostRequestBodyApplicationJsonRepeatInfoOn[]

`Optional`content?: string | Record<string, never>

`Optional`title?: string