Class ThreadChannel<T>

Represents a guild thread channel.

Type Parameters

T extends AnyThreadChannel = AnyThreadChannel

Hierarchy

GuildChannel
- ThreadChannel

Constructors

constructor

new ThreadChannel<T>(data: RawThreadChannel, client: Client<ClientEvents>): ThreadChannel<T>
Type Parameters
- T extends AnyThreadChannel = AnyThreadChannel
Parameters
- data: RawThreadChannel
- client: Client<ClientEvents>
Returns ThreadChannel<T>
Overrides GuildChannel.constructor
- Defined in lib/structures/ThreadChannel.ts:56

Properties

client

client: Client<ClientEvents>

flags

flags: number

The flags for this thread channel.

guildID

guildID: string

The id of the guild this channel is in.

id

id: string

`Optional` lastMessage

lastMessage?: null | Message<T>

The last message sent in this channel. This will only be present if a message has been sent within the current session.

lastMessageID

lastMessageID: null | string

The ID of last message sent in this channel.

memberCount

memberCount: number

The approximate number of members in this thread. Stops counting after 50.

members

members: ThreadMember[]

The members of this thread.

messageCount

messageCount: number

The number of messages (not including the initial message or deleted messages) in the thread. Stops counting after 50.

messages

messages: TypedCollection<string, RawMessage, Message<T>, []>

The cached messages in this channel.

name

name: string

The name of this channel.

`Optional` owner

owner?: User

The owner of this thread.

ownerID

ownerID: string

The ID of the owner of this thread.

parentID

parentID: string

The ID of the parent of this channel, if applicable.

rateLimitPerUser

rateLimitPerUser: number

The amount of seconds between non-moderators sending messages.

threadMetadata

threadMetadata: ThreadMetadata | PrivateThreadMetadata

The thread metadata associated with this thread.

totalMessageSent

totalMessageSent: number

The total number of messages ever sent in the thread. Includes deleted messages.

type

type: ANNOUNCEMENT_THREAD | PUBLIC_THREAD | PRIVATE_THREAD

The type of this channel.

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from GuildChannel.createdAt
- Defined in lib/structures/Base.ts:39

guild

get guild(): Guild
The guild associated with this channel. This will throw an error if the guild is not cached.

Returns Guild
Inherited from GuildChannel.guild
- Defined in lib/structures/GuildChannel.ts:46

mention

get mention(): string
A string that will mention this channel.

Returns string
Inherited from GuildChannel.mention
- Defined in lib/structures/Channel.ts:73

parent

get parent(): undefined | ThreadParentChannel
The parent of this channel, if applicable. This will be a text/announcement/forum channel if we're in a thread, category otherwise.

Returns undefined | ThreadParentChannel
Overrides GuildChannel.parent
- Defined in lib/structures/ThreadChannel.ts:135

Methods

addMember

addMember(userID: string): Promise<void>
Add a member to this thread.
Parameters
- userID: string
  
  The ID of the user to add to the thread.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:143

createMessage

createMessage(options: CreateMessageOptions): Promise<Message<T>>
Create a message in this thread.
Parameters
- options: CreateMessageOptions
  
  The options for creating the message.
Returns Promise<Message<T>>
- Defined in lib/structures/ThreadChannel.ts:151

createReaction

createReaction(messageID: string, emoji: string): Promise<void>
Add a reaction to a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to add a reaction to.
- emoji: string
  
  The reaction to add to the message. name:id for custom emojis, and the unicode codepoint for default emojis.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:160

delete

delete(): Promise<void>
Close a direct message, leave a group channel, or delete a guild channel.

Returns Promise<void>
Inherited from GuildChannel.delete
- Defined in lib/structures/Channel.ts:80

deleteMessage

deleteMessage(messageID: string, reason?: string): Promise<void>
Delete a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to delete.
- Optional reason: string
  
  The reason for deleting the message.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:169

deleteMessages

deleteMessages(messageIDs: string[], reason?: string): Promise<number>
Bulk delete messages in this thread.
Parameters
- messageIDs: string[]
  
  The IDs of the messages to delete. Any duplicates or messages older than two weeks will cause an error.
- Optional reason: string
  
  The reason for deleting the messages.
Returns Promise<number>
- Defined in lib/structures/ThreadChannel.ts:178

deleteReaction

deleteReaction(messageID: string, emoji: string, user?: string): Promise<void>
Remove a reaction from a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to remove a reaction from.
- emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- user: string = "@me"
  
  The user to remove the reaction from, @me for the current user (default).
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:188

deleteReactions

deleteReactions(messageID: string, emoji?: string): Promise<void>
Remove all, or a specific emoji's reactions from a message.
Parameters
- messageID: string
  
  The ID of the message to remove reactions from.
- Optional emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:197

edit

edit(options: EditPublicThreadChannelOptions | EditPrivateThreadChannelOptions): Promise<ThreadChannel<T>>
Edit this channel.
Parameters
- options: EditPublicThreadChannelOptions | EditPrivateThreadChannelOptions
  
  The options for editing the channel.
Returns Promise<ThreadChannel<T>>
Inherited from GuildChannel.edit
- Defined in lib/structures/GuildChannel.ts:76

editMessage

editMessage(messageID: string, options: EditMessageOptions): Promise<Message<T>>
Edit a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to edit.
- options: EditMessageOptions
  
  The options for editing the message.
Returns Promise<Message<T>>
- Defined in lib/structures/ThreadChannel.ts:206

getMember

getMember(userID: string): Promise<ThreadMember>
Get a thread member in this thread.
Parameters
- userID: string
  
  The ID of the user to get the thread member of.
Returns Promise<ThreadMember>
- Defined in lib/structures/ThreadChannel.ts:214

getMembers

getMembers(): Promise<ThreadMember[]>
Get the members of this thread.

Returns Promise<ThreadMember[]>
- Defined in lib/structures/ThreadChannel.ts:221

getMessage

getMessage(messageID: string): Promise<Message<T>>
Get a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to get.
Returns Promise<Message<T>>
- Defined in lib/structures/ThreadChannel.ts:229

getMessages

getMessages(options?: GetChannelMessagesOptions<Uncached | AnyTextableChannel>): Promise<Message<T>[]>
Get messages in this thread.
Parameters
- Optional options: GetChannelMessagesOptions<Uncached | AnyTextableChannel>
  
  The options for getting the messages. before, after, and around All are mutually exclusive.
Returns Promise<Message<T>[]>
- Defined in lib/structures/ThreadChannel.ts:237

getPinnedMessages

getPinnedMessages(): Promise<Message<T>[]>
Get the pinned messages in this thread.

Returns Promise<Message<T>[]>
- Defined in lib/structures/ThreadChannel.ts:244

getReactions

getReactions(messageID: string, emoji: string, options?: GetReactionsOptions): Promise<User[]>
Get the users who reacted with a specific emoji on a message.
Parameters
- messageID: string
  
  The ID of the message to get reactions from.
- emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- Optional options: GetReactionsOptions
  
  The options for getting the reactions.
Returns Promise<User[]>
- Defined in lib/structures/ThreadChannel.ts:254

join

join(): Promise<void>
Join this thread.

Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:261

leave

leave(): Promise<void>
Leave this thread.

Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:268

permissionsOf

permissionsOf(member: string | Member): Permission
Get the permissions of a member. If providing an id, the member must be cached. The parent channel must be cached as threads themselves do not have permissions.
Parameters
- member: string | Member
  
  The member to get the permissions of.
Returns Permission
- Defined in lib/structures/ThreadChannel.ts:276

pinMessage

pinMessage(messageID: string, reason?: string): Promise<void>
Pin a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to pin.
- Optional reason: string
  
  The reason for pinning the message.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:288

purge

purge(options: PurgeOptions<T>): Promise<number>
Purge an amount of messages from this channel.
Parameters
- options: PurgeOptions<T>
  
  The options to purge. before, after, and around All are mutually exclusive.
Returns Promise<number>
- Defined in lib/structures/ThreadChannel.ts:296

removeMember

removeMember(userID: string): Promise<void>
Remove a member from this thread.
Parameters
- userID: string
  
  The ID of the user to remove from the thread.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:304

sendTyping

sendTyping(): Promise<void>
Show a typing indicator in this thread.

Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:311

toJSON

toJSON(): JSONThreadChannel
Returns JSONThreadChannel
Overrides GuildChannel.toJSON
- Defined in lib/structures/ThreadChannel.ts:315

toString

toString(): string
Returns string
Inherited from GuildChannel.toString
- Defined in lib/structures/Base.ts:64

unpinMessage

unpinMessage(messageID: string, reason?: string): Promise<void>
Unpin a message in this thread.
Parameters
- messageID: string
  
  The ID of the message to unpin.
- Optional reason: string
  
  The reason for unpinning the message.
Returns Promise<void>
- Defined in lib/structures/ThreadChannel.ts:336

`Static` from

from<T>(data: RawChannel, client: Client<ClientEvents>): T
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- data: RawChannel
- client: Client<ClientEvents>
Returns T
Inherited from GuildChannel.from
- Defined in lib/structures/Channel.ts:31

`Static` generateID

generateID(timestamp?: number | Date): string
Parameters
- timestamp: number | Date = ...
Returns string
Inherited from GuildChannel.generateID
- Defined in lib/structures/Base.ts:21

`Static` getCreatedAt

getCreatedAt(id: string): Date
Parameters
- id: string
Returns Date
Inherited from GuildChannel.getCreatedAt
- Defined in lib/structures/Base.ts:28

`Static` getDiscordEpoch

getDiscordEpoch(id: string): number
Parameters
- id: string
Returns number
Inherited from GuildChannel.getDiscordEpoch
- Defined in lib/structures/Base.ts:32

Class ThreadChannel<T>

Type Parameters

T extends AnyThreadChannel = AnyThreadChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends AnyThreadChannel = AnyThreadChannel

Parameters

data: RawThreadChannel

client: Client<ClientEvents>

Returns ThreadChannel<T>

Properties

client

flags

guildID

id

Optional lastMessage

lastMessageID

memberCount

members

messageCount

messages

name

Optional owner

ownerID

parentID

rateLimitPerUser

threadMetadata

totalMessageSent

type

Accessors

createdAt

Returns Date

guild

Returns Guild

mention

Returns string

parent

Returns undefined | ThreadParentChannel

Methods

addMember

Parameters

userID: string

Returns Promise<void>

createMessage

Parameters

options: CreateMessageOptions

Returns Promise<Message<T>>

createReaction

Parameters

messageID: string

emoji: string

Returns Promise<void>

delete

Returns Promise<void>

deleteMessage

Parameters

messageID: string

Optional reason: string

Returns Promise<void>

deleteMessages

Parameters

messageIDs: string[]

Optional reason: string

Returns Promise<number>

deleteReaction

Parameters

messageID: string

emoji: string

user: string = "@me"

Returns Promise<void>

deleteReactions

Parameters

messageID: string

`Optional` lastMessage

`Optional` owner

`Optional` reason: string

`Optional` reason: string

`Optional` emoji: string

`Optional` options: GetChannelMessagesOptions<Uncached | AnyTextableChannel>

`Optional` options: GetReactionsOptions

`Optional` reason: string

`Optional` reason: string

`Static` from