Represents a guild voice channel on Discord.
Extends
BaseGuildVoiceChannelThe bitrate of this voice-based channel
Inherited from BaseGuildVoiceChannelChecks if the voice-based channel is full
Inherited from BaseGuildVoiceChannelWhether the channel is joinable by the client user
Inherited from BaseGuildVoiceChannelThe Message object of the last message in the channel, if one was sent
Inherited from BaseGuildVoiceChannelThe last message id sent in the channel, if one was sent
Inherited from BaseGuildVoiceChannelThe members in this voice-based channel
Inherited from BaseGuildVoiceChannelA manager of the messages sent to this channel
Inherited from BaseGuildVoiceChannelIf the guild considers this channel NSFW
Inherited from BaseGuildVoiceChannelThe rate limit per user (slowmode) for this channel in seconds
Inherited from BaseGuildVoiceChannelThe RTC region for this voice-based channel. This region is automatically selected if
Inherited from BaseGuildVoiceChannelnull
.The type of the channel
The maximum amount of users allowed in this channel.
Inherited from BaseGuildVoiceChannelThe camera video quality mode of the channel.
Inherited from BaseGuildVoiceChannelCollects a single component interaction that passes the filter. The Promise will reject if the time expires.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | AwaitMessageComponentOptions | Yes | Options to pass to the internal collector |
Similar to createMessageCollector but in promise form. Resolves with a collection of messages that pass the specified filter.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | AwaitMessagesOptions | Yes | Optional options to pass to the internal collector |
Bulk deletes given messages that are newer than two weeks.
Returns
Returns the deleted messages *Example
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 |
Creates an invite to this guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | InviteCreateOptions | Yes | The options for creating the invite |
Creates a Message Collector.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | MessageCollectorOptions | Yes | The options to pass to the collector |
Creates a component interaction collector.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | MessageComponentCollectorOptions | Yes | Options to send to the collector |
Creates a webhook for the channel.
Returns
Returns the created Webhook *Example
Name | Type | Optional | Description |
---|---|---|---|
options | ChannelWebhookCreateOptions | Yes | Options for creating the webhook |
Fetches a collection of invites to this guild channel.
Name | Type | Optional | Description |
---|---|---|---|
cache | boolean | Yes | Whether to cache the fetched invites |
Fetches all webhooks for the channel.
Inherited from BaseGuildVoiceChannelExample
Sends a message to this channel.
Example
Example
Example
Name | Type | Optional | Description |
---|---|---|---|
options | string | MessagePayload | MessageCreateOptions | No | The options to provide |
Sends a typing indicator in the channel.
Inherited from BaseGuildVoiceChannelReturns
Resolves upon the typing status being sent *Example
Sets the bitrate of the channel.
Example
Sets the RTC region of the channel.
Example
Example
Sets the user limit of the channel.
Example
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. |