Skip to content
Discord Luau

GuildPrivateThreadChannel

Represents the implementation of a Discord Private Thread channel.

Properties

ownerId

GuildPrivateThreadChannel.ownerId  :: string

This property was inherited from Objects.BaseGuildThread

messageCount

GuildPrivateThreadChannel.messageCount  :: number

This property was inherited from Objects.BaseGuildThread

memberCount

GuildPrivateThreadChannel.memberCount  :: number

This property was inherited from Objects.BaseGuildThread

totalMessageSent

GuildPrivateThreadChannel.totalMessageSent  :: number

This property was inherited from Objects.BaseGuildThread

threadMetadata

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

This property was inherited from Objects.BaseGuildThread

availableTags

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

This property was inherited from Objects.BaseGuildThread

appliedTags

GuildPrivateThreadChannel.appliedTags  :: { string }

This property was inherited from Objects.BaseGuildThread

defaultReactionEmoji

GuildPrivateThreadChannel.defaultReactionEmoji  :: Objects.DiscordEmoji

This property was inherited from Objects.BaseGuildThread

Methods

joinThreadAsync

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

Joins the current discord bot into the thread

This function was inherited from Objects.BaseGuildThread

addMemberToThreadAsync

GuildPrivateThreadChannel : addMemberToThreadAsync (

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

Adds the passed member to the thread channel

This function was inherited from Objects.BaseGuildThread

leaveThreadAsync

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

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

This function was inherited from Objects.BaseGuildThread

removeMemberFromThreadAsync

GuildPrivateThreadChannel : removeMemberFromThreadAsync (

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

Removes the passed user id from the current thread channel

This function was inherited from Objects.BaseGuildThread

getThreadMemberAsync

GuildPrivateThreadChannel : getThreadMemberAsync (

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

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

This function was inherited from Objects.BaseGuildThread

removeMemberFromThreadAsync

GuildPrivateThreadChannel : removeMemberFromThreadAsync (

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

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

This function was inherited from Objects.BaseGuildThread

Functions

The GuildPrivateThreadChannel instance has no set functions!