discord.js | BaseGuildVoiceChannel

Search...

BaseGuildVoiceChannel

export class BaseGuildVoiceChannel extends TextBasedChannelMixin(GuildChannel, true, [ 'lastPinTimestamp', 'lastPinAt',])

export class BaseGuildVoiceChannel extends TextBasedChannelMixin(GuildChannel, true, [ 'lastPinTimestamp', 'lastPinAt',])

Represents a voice-based guild channel on Discord.

Extends

TextBasedChannelMixin(GuildChannel, true, [ 'lastPinTimestamp', 'lastPinAt',])

constructor(guild, data?)

Constructs a new instance of the BaseGuildVoiceChannel class

Name	Type	Optional	Description
guild	Guild	No	None
data	RawGuildChannelData	Yes	None

bitrate:number

The bitrate of this voice-based channel

Readonly

client:Client

The client that instantiated this

Readonly

createdAt:Date

The time the channel was created at

Readonly

createdTimestamp:number

The timestamp the channel was created at

Readonly

deletable:boolean

Whether the channel is deletable by the client user

flags?:Readonly<ChannelFlagsBitField>

The flags that are applied to the channel. This is only null in a PartialGroupDMChannel. In all other cases, it is not null.

Readonly

full:boolean

Checks if the voice-based channel is full

guild:Guild

The guild the channel is in

guildId:Snowflake

The id of the guild the channel is in

id:Snowflake

The channel's id

Readonly

joinable:boolean

Whether the channel is joinable by the client user

Readonly

lastMessage?:Message

The Message object of the last message in the channel, if one was sent

lastMessageId?:Snowflake

The last message id sent in the channel, if one was sent

Readonly

manageable:boolean

Whether the channel is manageable by the client user

Readonly

members:Collection<Snowflake, GuildMember>

The members in this voice-based channel

messages:GuildMessageManager

A manager of the messages sent to this channel

name:string

The name of the guild channel

nsfw:boolean

If the guild considers this channel NSFW

Readonly

parent?:CategoryChannel

The category parent of this channel

parentId?:Snowflake

The id of the category parent of this channel

Readonly

partial:boolean

Whether this Channel is a partial This is always false outside of DM channels.

permissionOverwrites:PermissionOverwriteManager

A manager of permission overwrites that belong to this channel

Readonly

permissionsLocked?:boolean

If the permissionOverwrites match the parent channel, null if no parent

Readonly

position:number

The position of the channel

rateLimitPerUser:number | null

The rate limit per user (slowmode) for this channel in seconds

rawPosition:number

The raw position of the channel from Discord

rtcRegion:string | null

The RTC region for this voice-based channel. This region is automatically selected if null.

type:ChannelType

The type of the channel

Readonly

url:string

The URL to the channel

userLimit:number

The maximum amount of users allowed in this channel.

videoQualityMode:VideoQualityMode | null

The camera video quality mode of the channel.

Readonly

viewable:boolean

Whether the channel is viewable by the client user

awaitMessageComponent(options?):Promise<MessageComponentInteraction>

Collects a single component interaction that passes the filter. The Promise will reject if the time expires.

Example

// Collect a message component interaction
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
channel.awaitMessageComponent({ filter, time: 15_000 })
  .then(interaction => console.log(`${interaction.customId} was clicked!`))
  .catch(console.error);

// Collect a message component interaction
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
channel.awaitMessageComponent({ filter, time: 15_000 })
  .then(interaction => console.log(`${interaction.customId} was clicked!`))
  .catch(console.error);

Name	Type	Optional	Description
options	AwaitMessageComponentOptions	Yes	Options to pass to the internal collector

awaitMessages(options?):Promise<Collection<Snowflake, Message>>

Similar to createMessageCollector but in promise form. Resolves with a collection of messages that pass the specified filter.

Example

// Await !vote messages
const filter = m => m.content.startsWith('!vote');
// Errors: ['time'] treats ending because of the time limit as an error
channel.awaitMessages({ filter, max: 4, time: 60_000, errors: ['time'] })
  .then(collected => console.log(collected.size))
  .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));

// Await !vote messages
const filter = m => m.content.startsWith('!vote');
// Errors: ['time'] treats ending because of the time limit as an error
channel.awaitMessages({ filter, max: 4, time: 60_000, errors: ['time'] })
  .then(collected => console.log(collected.size))
  .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));

Name	Type	Optional	Description
options	AwaitMessagesOptions	Yes	Optional options to pass to the internal collector

bulkDelete(messages, filterOld?):Promise<Collection<Snowflake, (Message|undefined)>>

Bulk deletes given messages that are newer than two weeks.

Returns

Returns the deleted messages *

Example

// Bulk delete messages
channel.bulkDelete(5)
  .then(messages => console.log(`Bulk deleted ${messages.size} messages`))
  .catch(console.error);

// Bulk delete messages
channel.bulkDelete(5)
  .then(messages => console.log(`Bulk deleted ${messages.size} messages`))
  .catch(console.error);

Name	Type	Optional	Description
messages	Collection<Snowflake, Message> \| Array<MessageResolvable> \| number	No	Messages or number of messages to delete
filterOld	boolean	Yes	Filter messages to remove those which are older than two weeks automatically

createInvite(options?):Promise<Invite>

Creates an invite to this guild channel.

Example

// Create an invite to a channel
channel.createInvite()
  .then(invite => console.log(`Created an invite with a code of ${invite.code}`))
  .catch(console.error);

// Create an invite to a channel
channel.createInvite()
  .then(invite => console.log(`Created an invite with a code of ${invite.code}`))
  .catch(console.error);

Name	Type	Optional	Description
options	InviteCreateOptions	Yes	The options for creating the invite

createMessageCollector(options?):MessageCollector

Creates a Message Collector.

Example

// Create a message collector
const filter = message => message.content.includes('discord');
const collector = channel.createMessageCollector({ filter, time: 15_000 });
collector.on('collect', message => console.log(`Collected ${message.content}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));

// Create a message collector
const filter = message => message.content.includes('discord');
const collector = channel.createMessageCollector({ filter, time: 15_000 });
collector.on('collect', message => console.log(`Collected ${message.content}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));

Name	Type	Optional	Description
options	MessageCollectorOptions	Yes	The options to pass to the collector

createMessageComponentCollector(options?):InteractionCollector

Creates a component interaction collector.

Example

// Create a button interaction collector
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
const collector = channel.createMessageComponentCollector({ filter, time: 15_000 });
collector.on('collect', interaction => console.log(`Collected ${interaction.customId}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));

// Create a button interaction collector
const filter = (interaction) => interaction.customId === 'button' && interaction.user.id === 'someId';
const collector = channel.createMessageComponentCollector({ filter, time: 15_000 });
collector.on('collect', interaction => console.log(`Collected ${interaction.customId}`));
collector.on('end', collected => console.log(`Collected ${collected.size} items`));

Name	Type	Optional	Description
options	MessageComponentCollectorOptions	Yes	Options to send to the collector

createWebhook(options?):Promise<Webhook>

Creates a webhook for the channel.

Returns

Returns the created Webhook *

Example

// Create a webhook for the current channel
channel.createWebhook({
  name: 'Snek',
  avatar: 'https://i.imgur.com/mI8XcpG.jpg',
  reason: 'Needed a cool new Webhook'
})
  .then(console.log)
  .catch(console.error)

// Create a webhook for the current channel
channel.createWebhook({
  name: 'Snek',
  avatar: 'https://i.imgur.com/mI8XcpG.jpg',
  reason: 'Needed a cool new Webhook'
})
  .then(console.log)
  .catch(console.error)

Name	Type	Optional	Description
options	ChannelWebhookCreateOptions	Yes	Options for creating the webhook

fetchInvites(cache?):Promise<Collection<string, Invite>>

Fetches a collection of invites to this guild channel.

Name	Type	Optional	Description
cache	boolean	Yes	Whether to cache the fetched invites

fetchWebhooks():Promise<Collection<Snowflake, Webhook>>

Fetches all webhooks for the channel.

Example

// Fetch webhooks
channel.fetchWebhooks()
  .then(hooks => console.log(`This channel has ${hooks.size} hooks`))
  .catch(console.error);

// Fetch webhooks
channel.fetchWebhooks()
  .then(hooks => console.log(`This channel has ${hooks.size} hooks`))
  .catch(console.error);

send(options):Promise<Message>

Sends a message to this channel.

Example

// Send a basic message
channel.send('hello!')
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

// Send a basic message
channel.send('hello!')
  .then(message => console.log(`Sent message: ${message.content}`))
  .catch(console.error);

Example

// Send a remote file
channel.send({
  files: ['https://cdn.discordapp.com/icons/222078108977594368/6e1019b3179d71046e463a75915e7244.png?size=2048']
})
  .then(console.log)
  .catch(console.error);

// Send a remote file
channel.send({
  files: ['https://cdn.discordapp.com/icons/222078108977594368/6e1019b3179d71046e463a75915e7244.png?size=2048']
})
  .then(console.log)
  .catch(console.error);

Example

// Send a local file
channel.send({
  files: [{
    attachment: 'entire/path/to/file.jpg',
    name: 'file.jpg',
    description: 'A description of the file'
  }]
})
  .then(console.log)
  .catch(console.error);

// Send a local file
channel.send({
  files: [{
    attachment: 'entire/path/to/file.jpg',
    name: 'file.jpg',
    description: 'A description of the file'
  }]
})
  .then(console.log)
  .catch(console.error);

Name	Type	Optional	Description
options	string \| MessagePayload \| MessageCreateOptions	No	The options to provide

sendTyping():Promise<void>

Sends a typing indicator in the channel.

Returns

Resolves upon the typing status being sent *

Example

// Start typing in a channel
channel.sendTyping();

// Start typing in a channel
channel.sendTyping();

setBitrate(bitrate, reason?):Promise<this>

Sets the bitrate of the channel.

Example

// Set the bitrate of a voice channel
channel.setBitrate(48_000)
  .then(channel => console.log(`Set bitrate to ${channel.bitrate}bps for ${channel.name}`))
  .catch(console.error);

// Set the bitrate of a voice channel
channel.setBitrate(48_000)
  .then(channel => console.log(`Set bitrate to ${channel.bitrate}bps for ${channel.name}`))
  .catch(console.error);

Name	Type	Optional	Description
bitrate	number	No	The new bitrate
reason	string	Yes	Reason for changing the channel's bitrate

setNSFW(nsfw?, reason?):Promise<this>

Sets whether this channel is flagged as NSFW.

Name	Type	Optional	Description
nsfw	boolean	Yes	Whether the channel should be considered NSFW
reason	string	Yes	Reason for changing the channel's NSFW flag

setRateLimitPerUser(rateLimitPerUser, reason?):Promise<this>

Sets the rate limit per user (slowmode) for this channel.

Name	Type	Optional	Description
rateLimitPerUser	number	No	The new rate limit in seconds
reason	string	Yes	Reason for changing the channel's rate limit

setRTCRegion(rtcRegion, reason?):Promise<this>

Sets the RTC region of the channel.

Example

// Set the RTC region to sydney
channel.setRTCRegion('sydney');

// Set the RTC region to sydney
channel.setRTCRegion('sydney');

Example

// Remove a fixed region for this channel - let Discord decide automatically
channel.setRTCRegion(null, 'We want to let Discord decide.');

// Remove a fixed region for this channel - let Discord decide automatically
channel.setRTCRegion(null, 'We want to let Discord decide.');

Name	Type	Optional	Description
rtcRegion	string \| null	No	The new region of the channel. Set to `null` to remove a specific region for the channel
reason	string	Yes	The reason for modifying this region.

setUserLimit(userLimit, reason?):Promise<this>

Sets the user limit of the channel.

Example

// Set the user limit of a voice channel
channel.setUserLimit(42)
  .then(channel => console.log(`Set user limit to ${channel.userLimit} for ${channel.name}`))
  .catch(console.error);

// Set the user limit of a voice channel
channel.setUserLimit(42)
  .then(channel => console.log(`Set user limit to ${channel.userLimit} for ${channel.name}`))
  .catch(console.error);

Name	Type	Optional	Description
userLimit	number	No	The new user limit
reason	string	Yes	Reason for changing the user limit

setVideoQualityMode(videoQualityMode, reason?):Promise<this>

Sets the camera video quality mode of the channel.

Name	Type	Optional	Description
videoQualityMode	VideoQualityMode	No	The new camera video quality mode.
reason	string	Yes	Reason for changing the camera video quality mode.