Skip to content
Discord Luau

BaseGuildVoiceChannel

A base discord voice channel, every Guild Voice channel extends from.

Properties

id

BaseGuildVoiceChannel.id  :: string

guildId

BaseGuildVoiceChannel.guildId  :: string

voiceConnection

BaseGuildVoiceChannel.voiceConnection  :: Network.DiscordVoiceConnection?

bitrate

BaseGuildVoiceChannel.bitrate  :: number

userLimit

BaseGuildVoiceChannel.userLimit  :: number

rtcRegion

BaseGuildVoiceChannel.rtcRegion  :: string

videoQualityMode

BaseGuildVoiceChannel.videoQualityMode  :: number

guildId

BaseGuildVoiceChannel.guildId  :: string

This property was inherited from Objects.BaseDiscordGuildChannel

topic

BaseGuildVoiceChannel.topic  :: string

This property was inherited from Objects.BaseDiscordGuildChannel

nsfw

BaseGuildVoiceChannel.nsfw  :: boolean

This property was inherited from Objects.BaseDiscordGuildChannel

rateLimitPerUser

BaseGuildVoiceChannel.rateLimitPerUser  :: number

This property was inherited from Objects.BaseDiscordGuildChannel

parentId

BaseGuildVoiceChannel.parentId  :: string

This property was inherited from Objects.BaseDiscordGuildChannel

flags

BaseGuildVoiceChannel.flags  :: number

This property was inherited from Objects.BaseDiscordGuildChannel

Methods

connectAsync

BaseGuildVoiceChannel : connectAsync ()  -> Vendor.Future<boolean>

Connects to the voice channel asynchronously.

disconnectAsync

BaseGuildVoiceChannel : disconnectAsync ()  -> Vendor.Future<unknown>

Disconnects from the voice channel asynchronously.

overwriteRolePermissionsAsync

BaseGuildVoiceChannel : 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

BaseGuildVoiceChannel : 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

BaseGuildVoiceChannel : 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

BaseGuildVoiceChannel : getInvitesAsync ()  -> Vendor.Future

Gets the invites for the channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

createInviteAsync

BaseGuildVoiceChannel : createInviteAsync (

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

Creates an invite for the channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

setPositionAsync

BaseGuildVoiceChannel : setPositionAsync (

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

Sets the position of the channel asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

modifyAsync

BaseGuildVoiceChannel : modifyAsync (

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

Modifies the thread channel settings asynchronously.

This function was inherited from Objects.BaseDiscordGuildChannel

getPublicArchivedThreadsAsync

BaseGuildVoiceChannel : 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

BaseGuildVoiceChannel : 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

BaseGuildVoiceChannel : 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 BaseGuildVoiceChannel instance has no set functions!