Class ChannelManager

Hierarchy

ChannelManager

Methods

addThreadMember

addThreadMember(channelID: string, userID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:953
Add someone to a thread

Parameters
- channelID: string
  
  Channel Identifiant
- userID: string
  
  User Identifiant
Returns Promise<void>

bulkDeleteMessages

bulkDeleteMessages(channelID: string, options: number | BulkDeleteMessagesOptions, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:556
Delete a group of messages

Parameters
- channelID: string
  
  Channel Identifiant
- options: number | BulkDeleteMessagesOptions
  
  Options for deleting a group of messages
- Optional reason: string
  
  Reason
Returns Promise<void>

createChannelInvite

createChannelInvite(channelID: string, options?: CreateChannelInviteOptions, reason?: string): Promise<Invite>

- Defined in client/managers/ChannelManager.ts:638
Create an invitation

Parameters
- channelID: string
  
  Channel Invitation
- options: CreateChannelInviteOptions = {}
  
  Options to create an invitation
- Optional reason: string
  
  Reason
Returns Promise<Invite>
- Invitation Object

createMessage

createMessage(channelID: string, options: CreateMessageOptions): Promise<Message>

- Defined in client/managers/ChannelManager.ts:293
Send a message in a Channel

Parameters
- channelID: string
  
  Channel Identifiant
- options: CreateMessageOptions
  
  Options for the message sending
Returns Promise<Message>
- Message Object

createReaction

createReaction(channelID: string, messageID: string, emoji: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:342
Create a reaction to a message

Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message you want to react to.
- emoji: string
  
  The emoji to react with.
Returns Promise<void>

crosspostMessage

crosspostMessage(channelID: string, messageID: string): Promise<Message>

- Defined in client/managers/ChannelManager.ts:318
Crosspost a message during the channels who follow the channel

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
Returns Promise<Message>
- Message Object

deleteAllReactions

deleteAllReactions(channelID: string, messageID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:457
Delete all reactions from a message

Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message you want to delete all reactions from.
Returns Promise<void>

deleteAllReactionsForEmoji

deleteAllReactionsForEmoji(channelID: string, messageID: string, emoji: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:480
Delete all reactions for a specific emoji

Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message you want to delete all reactions from.
- emoji: string
  
  The emoji you want to delete all reactions for.
Returns Promise<void>

deleteChannel

deleteChannel(channelID: string, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:219
Delete a channel

Parameters
- channelID: string
  
  Channel Identifiant
- Optional reason: string
  
  Reason for the deletion
Returns Promise<void>

deleteChannelPermission

deleteChannelPermission(channelID: string, overwriteID: string, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:666
Delete a permission

Parameters
- channelID: string
  
  Channel Identification
- overwriteID: string
  
  User or Role Identification
- Optional reason: string
  
  Reason
Returns Promise<void>

deleteMessage

deleteMessage(channelID: string, messageID: string, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:531
Delete a message

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
- Optional reason: string
  
  Reason
Returns Promise<void>

deleteOwnReaction

deleteOwnReaction(channelID: string, messageID: string, emoji: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:371
Delete your own reaction

Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message you want to delete a reaction from.
- emoji: string
  
  The emoji to delete.
Returns Promise<void>

deleteUserReaction

deleteUserReaction(channelID: string, messageID: string, userID: string, emoji: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:400
Delete a user's reaction from a message

Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message you want to delete a reaction from.
- userID: string
  
  The ID of the user who reacted to the message.
- emoji: string
  
  The emoji to delete.
Returns Promise<void>

editChannelPermissions

editChannelPermissions(channelID: string, overwriteID: string, options: EditChannelPermissionsOptions, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:590
Edit a permission

Parameters
- channelID: string
  
  Channel Identifiant
- overwriteID: string
  
  Role or User Identifiant
- options: EditChannelPermissionsOptions
  
  Options to edit a permission
- Optional reason: string
  
  Reason
Returns Promise<void>

editMessage

editMessage(channelID: string, messageID: string, options: CreateMessageOptions): Promise<Message>

- Defined in client/managers/ChannelManager.ts:505
Edit a specific message in a channel

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
- options: CreateMessageOptions
  
  Options for the message edition
Returns Promise<Message>
- Message Object

followNewsChannel

followNewsChannel(channelID: string, options: FollowNewsChannelOptions): Promise<FollowedChannel>

- Defined in client/managers/ChannelManager.ts:691
Follow a news channel

Parameters
- channelID: string
  
  Channel Identifiant
- options: FollowNewsChannelOptions
  
  Options to follow a news channel
Returns Promise<FollowedChannel>
- Followed Channel Object

getChannel

getChannel(channelID: string): Promise<Channel>

- Defined in client/managers/ChannelManager.ts:165
Get a channel

Parameters
- channelID: string
  
  Channel identifiant
Returns Promise<Channel>
Channel Object

getChannelInvites

getChannelInvites(channelID: string): Promise<Invite[]>

- Defined in client/managers/ChannelManager.ts:616
Get all channel invitations

Parameters
- channelID: string
  
  Channel Identifiant
Returns Promise<Invite[]>
- List of Invitation Object

getChannelMessage

getChannelMessage(channelID: string, messageID: string): Promise<Message>

- Defined in client/managers/ChannelManager.ts:269
Get a single message from a channel

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
Returns Promise<Message>
- Message Object

getChannelMessages

getChannelMessages(channelID: string, options?: GetMessagesOptions): Promise<Message[]>

- Defined in client/managers/ChannelManager.ts:244
Get messages from a Channel

Parameters
- channelID: string
  
  Channel Identifiant
- options: GetMessagesOptions = {}
  
  Options for the query search
Returns Promise<Message[]>
Array of messages

getPinnedMessages

getPinnedMessages(channelID: string): Promise<Message[]>

- Defined in client/managers/ChannelManager.ts:733
Get the list of pinned messages

Parameters
- channelID: string
  
  Channel Identifiant
Returns Promise<Message[]>
- List of messages object

getReactions

getReactions(channelID: string, messageID: string, emoji: string, options?: GetReactionsOptions): Promise<User[]>

- Defined in client/managers/ChannelManager.ts:431
Get all users who reacted to a message with a certain emoji

Parameters
- channelID: string
  
  The ID of the channel the message is in.
- messageID: string
  
  The ID of the message you want to get reactions for.
- emoji: string
  
  The emoji you want to get the users for.
- options: GetReactionsOptions = {}
Returns Promise<User[]>

getThreadMember

getThreadMember(channelID: string, userID: string): Promise<ThreadMember>

- Defined in client/managers/ChannelManager.ts:1017
Get the thread of a member

Parameters
- channelID: string
  
  Channel Identifiant
- userID: string
  
  User Identifiant
Returns Promise<ThreadMember>
- Thread Member Object

groupDMAddRecipient

groupDMAddRecipient(channelID: string, userID: string, options: GroupDMAddRecipientOptions): Promise<void>

- Defined in client/managers/ChannelManager.ts:805
Add someone to a DM group

Parameters
- channelID: string
  
  Channel Identifiant
- userID: string
  
  User Identifiant
- options: GroupDMAddRecipientOptions
  
  Options to add someone to a DM group
Returns Promise<void>

groupDMRemoveRecipient

groupDMRemoveRecipient(channelID: string, userID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:829
Remove someone to a DM group

Parameters
- channelID: string
  
  Channel Identifiant
- userID: string
  
  User Identifiant
Returns Promise<void>

joinThread

joinThread(channelID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:933
Join a thread

Parameters
- channelID: string
  
  Channel Identifiant
Returns Promise<void>

leaveThread

leaveThread(channelID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:975
Leave a thread

Parameters
- channelID: string
  
  Channel Identifiant
Returns Promise<void>

listJoinedPrivateArchivedThreads

listJoinedPrivateArchivedThreads(channelID: string, options: ListArchivedThreadsOptions): Promise<ListArchivedThreadsResponse>

- Defined in client/managers/ChannelManager.ts:1111
List all public the archived private joined thread

Parameters
- channelID: string
  
  Channel Identifiant
- options: ListArchivedThreadsOptions
  
  Option to list all the archived private joined thread
Returns Promise<ListArchivedThreadsResponse>
- List of Thread Channels

listPrivateArchivedThreads

listPrivateArchivedThreads(channelID: string, options: ListArchivedThreadsOptions): Promise<ListArchivedThreadsResponse>

- Defined in client/managers/ChannelManager.ts:1086
List all public the archived private thread

Parameters
- channelID: string
  
  Channel Identifiant
- options: ListArchivedThreadsOptions
  
  Option to list all the archived private thread
Returns Promise<ListArchivedThreadsResponse>
- List of Thread Channels

listPublicArchivedThreads

listPublicArchivedThreads(channelID: string, options: ListArchivedThreadsOptions): Promise<ListArchivedThreadsResponse>

- Defined in client/managers/ChannelManager.ts:1061
List all public the archived public thread

Parameters
- channelID: string
  
  Channel Identifiant
- options: ListArchivedThreadsOptions
  
  Option to list all the archived public thread
Returns Promise<ListArchivedThreadsResponse>
- List of Thread Channels

listThreadMembers

listThreadMembers(channelID: string): Promise<ThreadMember[]>

- Defined in client/managers/ChannelManager.ts:1040
List all the members of a thread

Parameters
- channelID: string
  
  Channel Identifiant
Returns Promise<ThreadMember[]>
- List of Thread Member Object

modifyChannel

modifyChannel(channelID: string, options: ModifyDMChannelOptions | ModifyGuildChannelOptions, reason?: string): Promise<Channel>

- Defined in client/managers/ChannelManager.ts:191
Modify a channel

Parameters
- channelID: string
  
  Channel identifiant
- options: ModifyDMChannelOptions | ModifyGuildChannelOptions
  
  Option object
- Optional reason: string
  
  Reason for the modification
Returns Promise<Channel>
- New Channel Object

pinMessage

pinMessage(channelID: string, messageID: string, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:754
Pin a message

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
- Optional reason: string
  
  Reason
Returns Promise<void>

removeThreadMember

removeThreadMember(channelID: string, userID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:994
Remove someone to a thread

Parameters
- channelID: string
  
  Channel Identifiant
- userID: string
  
  User Identifant
Returns Promise<void>

startThreadWithMessages

startThreadWithMessages(channelID: string, messageID: string, options: StartThreadFromMessageOptions, reason?: string): Promise<Channel>

- Defined in client/managers/ChannelManager.ts:854
Create a thread with a message

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
- options: StartThreadFromMessageOptions
  
  Options to create a thread
- Optional reason: string
  
  Reason
Returns Promise<Channel>
- ThreadChannel Object

startThreadWithoutMessages

startThreadWithoutMessages(channelID: string, options: StartThreadWithoutMessageOptions, reason?: string): Promise<Channel>

- Defined in client/managers/ChannelManager.ts:883
Create a thread

Parameters
- channelID: string
  
  Channel Identifiant
- options: StartThreadWithoutMessageOptions
  
  Option to create a thread
- Optional reason: string
  
  Reason
Returns Promise<Channel>
- ThreadChannel Object

startThreadinForumChannel

startThreadinForumChannel(channelID: string, options: StartThreadFromMessageOptions & CreateMessageOptions, reason?: string): Promise<Channel>

- Defined in client/managers/ChannelManager.ts:908
Create a forum thread

Parameters
- channelID: string
  
  Channel Identifiant
- options: StartThreadFromMessageOptions & CreateMessageOptions
- Optional reason: string
Returns Promise<Channel>

triggerTypingIndicator

triggerTypingIndicator(channelID: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:714
Trigger typing indicator in a channel

Parameters
- channelID: string
  
  Channel Identifiant
Returns Promise<void>

unpinMessage

unpinMessage(channelID: string, messageID: string, reason?: string): Promise<void>

- Defined in client/managers/ChannelManager.ts:780
Unpin a message

Parameters
- channelID: string
  
  Channel Identifiant
- messageID: string
  
  Message Identifiant
- Optional reason: string
  
  Reason
Returns Promise<void>

Constructors

constructor

new ChannelManager(token: string, tokenType: string, cache: CacheManager, version: APIVersions): ChannelManager

- Defined in client/managers/ChannelManager.ts:148
Parameters
- token: string
  
  Bot's token
- tokenType: string
- cache: CacheManager
  
  Application's cache
- version: APIVersions
  
  API Version
Returns ChannelManager

Properties

Readonly version

version: APIVersions

API Version

Private #cache

#cache: CacheManager

Application's cache

Private #token

#token: string

Bot's token

Private Readonly #tokenType

#tokenType: string

Token type

Generated using TypeDoc