Skip to content
Discord Luau

BaseGuildThread

A base discord Thread channel, all discord threads extend from.

Properties

ownerId

BaseGuildThread.ownerId  :: string

messageCount

BaseGuildThread.messageCount  :: number

memberCount

BaseGuildThread.memberCount  :: number

totalMessageSent

BaseGuildThread.totalMessageSent  :: number

threadMetadata

BaseGuildThread.threadMetadata  :: {
       archived: boolean,
       autoArchiveDuration: number,
       archiveTimestamp: string,
       locked: boolean,
       invitable: boolean?,
       createTimestamp: string?,
    }

availableTags

BaseGuildThread.availableTags  :: {
       { id: string,
       name: string,
       moderated: boolean,
       emojiId: string?,
       emojiName: string?,
    }

appliedTags

BaseGuildThread.appliedTags  :: { string }

defaultReactionEmoji

BaseGuildThread.defaultReactionEmoji  :: Objects.DiscordEmoji

lastPinTimestamp

BaseGuildThread.lastPinTimestamp  :: string

This property was inherited from Objects.BaseGuildTextChannel

lastMessageId

BaseGuildThread.lastMessageId  :: string?

This property was inherited from Objects.BaseGuildTextChannel

Methods

joinThreadAsync

BaseGuildThread : joinThreadAsync ()  -> Vendor.Future<unknown>

Joins the current discord bot into the thread

addMemberToThreadAsync

BaseGuildThread : addMemberToThreadAsync (

     userId: string
)  -> Vendor.Future<unknown>

Adds the passed member to the thread channel

leaveThreadAsync

BaseGuildThread : leaveThreadAsync ()  -> Vendor.Future<unknown>

Leaves the thread channel if the discord bot is in the channel.

removeMemberFromThreadAsync

BaseGuildThread : removeMemberFromThreadAsync (

     userId: string
)  -> Vendor.Future<unknown>

Removes the passed user id from the current thread channel

getThreadMemberAsync

BaseGuildThread : getThreadMemberAsync (

     userId: string
)  -> Vendor.Future<{ DiscordGuildMember }>

Returns a list of members that are active in the current thread channel

removeMemberFromThreadAsync

BaseGuildThread : removeMemberFromThreadAsync (

     userId: string
)  -> Vendor.Future<{ DiscordGuildMember }>

Returns a list of members that are active in the current thread channel

triggerTypingIndicator

BaseGuildThread : triggerTypingIndicator ()  -> Vendor.Future

Triggers the typing indicator in the channel.

This function was inherited from Objects.BaseGuildTextChannel

getMessagesAsync

BaseGuildThread : getMessagesAsync (

     limit: number?
)  -> Vendor.Future

Gets messages from the channel asynchronously.

This function was inherited from Objects.BaseGuildTextChannel

getMessageAsync

BaseGuildThread : getMessageAsync (

     messageId: string
)  -> Vendor.Future

Gets a specific message from the channel asynchronously.

This function was inherited from Objects.BaseGuildTextChannel

bulkDeleteMessagesAsync

BaseGuildThread : bulkDeleteMessagesAsync (

     messageIds: {string}
)  -> Vendor.Future

Deletes multiple messages from the channel asynchronously.

This function was inherited from Objects.BaseGuildTextChannel

sendMessageAsync

BaseGuildThread : sendMessageAsync (

     messageBuilder: MessageBuilder
)  -> Vendor.Future

Sends a message to the channel asynchronously.

This function was inherited from Objects.BaseGuildTextChannel

getPinnedMessagesAsync

BaseGuildThread : getPinnedMessagesAsync ()  -> Vendor.Future<{[number]: DiscordMessage}>

Retrieves the pinned messages in the text channel asynchronously.

This function was inherited from Objects.BaseGuildTextChannel

Functions

The BaseGuildThread instance has no set functions!