Skip to content
Discord Luau

BaseGuildTextChannel

A base guild text channel, where any/all text channels extend from.

Properties

lastPinTimestamp

BaseGuildTextChannel.lastPinTimestamp  :: string

lastMessageId

BaseGuildTextChannel.lastMessageId  :: string?

guildId

BaseGuildTextChannel.guildId  :: string

This property was inherited from Objects.BaseDiscordGuildChannel

topic

BaseGuildTextChannel.topic  :: string

This property was inherited from Objects.BaseDiscordGuildChannel

nsfw

BaseGuildTextChannel.nsfw  :: boolean

This property was inherited from Objects.BaseDiscordGuildChannel

rateLimitPerUser

BaseGuildTextChannel.rateLimitPerUser  :: number

This property was inherited from Objects.BaseDiscordGuildChannel

parentId

BaseGuildTextChannel.parentId  :: string

This property was inherited from Objects.BaseDiscordGuildChannel

flags

BaseGuildTextChannel.flags  :: number

This property was inherited from Objects.BaseDiscordGuildChannel

Methods

triggerTypingIndicator

BaseGuildTextChannel : triggerTypingIndicator ()  -> Vendor.Future

Triggers the typing indicator in the channel.

getMessagesAsync

BaseGuildTextChannel : getMessagesAsync (

     limit: number?
)  -> Vendor.Future

Gets messages from the channel asynchronously.

getMessageAsync

BaseGuildTextChannel : getMessageAsync (

     messageId: string
)  -> Vendor.Future

Gets a specific message from the channel asynchronously.

bulkDeleteMessagesAsync

BaseGuildTextChannel : bulkDeleteMessagesAsync (

     messageIds: {string}
)  -> Vendor.Future

Deletes multiple messages from the channel asynchronously.

sendMessageAsync

BaseGuildTextChannel : sendMessageAsync (

     messageBuilder: MessageBuilder
)  -> Vendor.Future

Sends a message to the channel asynchronously.

getPinnedMessagesAsync

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

Retrieves the pinned messages in the text channel asynchronously.

overwriteRolePermissionsAsync

BaseGuildTextChannel : overwriteRolePermissionsAsync (

     roleId: string
     allowedPermissions: PermissionsBuilder.PermissionsBuilder
     disallowedPermissions: PermissionsBuilder.PermissionsBuilder
)  -> Vendor.Future

set overwrites for a specific role permissions for this channel in a discord guild.

This function was inherited from Objects.BaseDiscordGuildChannel

overwriteMemberPermissionssync

BaseGuildTextChannel : overwriteMemberPermissionssync (

     memberId: string
     allowedPermissions: PermissionsBuilder.PermissionsBuilder
     disallowedPermissions: PermissionsBuilder.PermissionsBuilder
)  -> Vendor.Future

set overwrites for a specific members permissions for this channel in a discord guild.

This function was inherited from Objects.BaseDiscordGuildChannel

overwriteMemberPermissionssync

BaseGuildTextChannel : overwriteMemberPermissionssync (

     roleIdOrUserId: string
)  -> Vendor.Future

deletes overwritten permissions for the given id, the given id must be either a role id or a user id

This function was inherited from Objects.BaseDiscordGuildChannel

getInvitesAsync

BaseGuildTextChannel : getInvitesAsync ()  -> Vendor.Future

Gets the invites for the channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

createInviteAsync

BaseGuildTextChannel : createInviteAsync (

     maxAge: number?
     maxUses: number?
     temporary: boolean?
)  -> Vendor.Future

Creates an invite for the channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

setPositionAsync

BaseGuildTextChannel : setPositionAsync (

     position: number
     parentId: string?
     syncPermissions: boolean?
)  -> Vendor.Future

Sets the position of the channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

modifyAsync

BaseGuildTextChannel : modifyAsync (

     channelBuilder: ChannelBuilder.ChannelBuilder
)  -> Vendor.Future<unknown>

Modifies the thread channel settings asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

getPublicArchivedThreadsAsync

BaseGuildTextChannel : getPublicArchivedThreadsAsync (

     epoch: number?
     limit: number?
)  -> Vendor.Future<{ number }>

Gets all archived public threads in the guild channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

getPrivateArchivedThreadsAsync

BaseGuildTextChannel : getPrivateArchivedThreadsAsync (

     epoch: number?
     limit: number?
)  -> Vendor.Future<{ number }>

Gets all archived private threads in the guild channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

getJoinedPrivateArchivedThreads

BaseGuildTextChannel : getJoinedPrivateArchivedThreads (

     epoch: number?
     limit: number?
)  -> Vendor.Future<{ number }>

Gets all archived private threads that the bot is a member of, in the guild channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

Functions

The BaseGuildTextChannel instance has no set functions!