Class PrivateThreadChannel

client

flags

guildID

id

Optional lastMessage

lastMessageID

memberCount

members

messageCount

messages

name

Optional owner

ownerID

parentID

rateLimitPerUser

totalMessageSent

createdAt

• get createdAt(): Date

• Returns Date

guild

• get guild(): Guild

• The guild associated with this channel. This will throw an error if the guild is not cached.

  Returns Guild

mention

• get mention(): string

• A string that will mention this channel.

  Returns string

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

addMember

• addMember(userID): Promise<void>

• Add a member to this thread.

  Parameters

  • userID: string

    The ID of the user to add to the thread.

  Returns Promise<void>

createMessage

• createMessage(options): Promise<Message<PrivateThreadChannel>>

• Create a message in this thread.

  Parameters

  • options: CreateMessageOptions

    The options for creating the message.

  Returns Promise<Message<PrivateThreadChannel>>

createReaction

• createReaction(messageID, emoji): 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>

delete

• delete(): Promise<void>

• Close a direct message, leave a group channel, or delete a guild channel.

  Returns Promise<void>

deleteMessage

• deleteMessage(messageID, reason?): 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>

deleteMessages

• deleteMessages(messageIDs, reason?): 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>

deleteReaction

• deleteReaction(messageID, emoji, user?): 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>

deleteReactions

• deleteReactions(messageID, emoji?): 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>

edit

• edit(options): Promise<PrivateThreadChannel>

• Edit this channel.

  Parameters

  • options: EditPrivateThreadChannelOptions

    The options for editing the channel.

  Returns Promise<PrivateThreadChannel>

editMessage

• editMessage(messageID, options): Promise<Message<PrivateThreadChannel>>

• 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<PrivateThreadChannel>>

getMember

• getMember(userID): 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>

getMembers

• getMembers(): Promise<ThreadMember[]>

• Get the members of this thread.

  Returns Promise<ThreadMember[]>

getMessage

• getMessage(messageID): Promise<Message<PrivateThreadChannel>>

• Get a message in this thread.

  Parameters

  • messageID: string

    The ID of the message to get.

  Returns Promise<Message<PrivateThreadChannel>>

getMessages

• getMessages(options?): Promise<Message<PrivateThreadChannel>[]>

• 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<PrivateThreadChannel>[]>

getPinnedMessages

• getPinnedMessages(): Promise<Message<PrivateThreadChannel>[]>

• Get the pinned messages in this thread.

  Returns Promise<Message<PrivateThreadChannel>[]>

getReactions

• getReactions(messageID, emoji, options?): 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[]>

join

• join(): Promise<void>

• Join this thread.

  Returns Promise<void>

leave

• leave(): Promise<void>

• Leave this thread.

  Returns Promise<void>

permissionsOf

• permissionsOf(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

pinMessage

• pinMessage(messageID, reason?): 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>

purge

• purge(options): Promise<number>

• Purge an amount of messages from this channel.

  Parameters

  • options: PurgeOptions<PrivateThreadChannel>

    The options to purge. before, after, and around All are mutually exclusive.

  Returns Promise<number>

removeMember

• removeMember(userID): Promise<void>

• Remove a member from this thread.

  Parameters

  • userID: string

    The ID of the user to remove from the thread.

  Returns Promise<void>

sendTyping

• sendTyping(): Promise<void>

• Show a typing indicator in this thread.

  Returns Promise<void>

toString

• toString(): string

• Returns string

unpinMessage

• unpinMessage(messageID, reason?): 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>

Static from

• from<T>(data, client): T

• Type Parameters

  • T extends AnyChannel = AnyChannel

  Parameters

  • data: RawChannel
  • client: Client<ClientEvents>

  Returns T

Static generateID

• generateID(timestamp?): string

• Parameters

  • timestamp: number | Date = ...

  Returns string

Static getCreatedAt

• getCreatedAt(id): Date

• Parameters

  • id: string

  Returns Date

Static getDiscordEpoch

• getDiscordEpoch(id): number

• Parameters

  • id: string

  Returns number