Represents a guild stage channel on Discord.
Extends
BaseGuildVoiceChannelThe bitrate of this voice-based channel
Inherited from BaseGuildVoiceChannelThe time the channel was created at
Inherited from GuildChannelThe timestamp the channel was created at
Inherited from GuildChannelWhether the channel is deletable by the client user
Inherited from GuildChannelThe flags that are applied to the channel. This is only
Inherited from GuildChannelnull
in a PartialGroupDMChannel. In all other cases, it is not null
.Checks if the voice-based channel is full
Inherited from BaseGuildVoiceChannelThe guild the channel is in
Inherited from GuildChannelThe id of the guild the channel is in
Inherited from GuildChannelThe channel's id
Inherited from BaseChannelWhether 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 BaseGuildVoiceChannelWhether the channel is manageable by the client user
Inherited from GuildChannelThe members in this voice-based channel
Inherited from BaseGuildVoiceChannelA manager of the messages sent to this channel
Inherited from BaseGuildVoiceChannelThe name of the guild channel
Inherited from GuildChannelIf the guild considers this channel NSFW
Inherited from BaseGuildVoiceChannelThe category parent of this channel
Inherited from GuildChannelThe id of the category parent of this channel
Inherited from GuildChannelWhether this Channel is a partial This is always false outside of DM channels.
Inherited from BaseChannelA manager of permission overwrites that belong to this channel
Inherited from GuildChannelIf the permissionOverwrites match the parent channel, null if no parent
Inherited from GuildChannelThe position of the channel
Inherited from GuildChannelThe rate limit per user (slowmode) for this channel in seconds
Inherited from BaseGuildVoiceChannelThe raw position of the channel from Discord
Inherited from GuildChannelThe RTC region for this voice-based channel. This region is automatically selected if
Inherited from BaseGuildVoiceChannelnull
.The type of the channel
The URL to the channel
Inherited from BaseChannelThe maximum amount of users allowed in this channel.
Inherited from BaseGuildVoiceChannelThe camera video quality mode of the channel.
Inherited from BaseGuildVoiceChannelWhether the channel is viewable by the client user
Inherited from GuildChannelCollects 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 |
Clones this channel.
Name | Type | Optional | Description |
---|---|---|---|
options | GuildChannelCloneOptions | Yes | The options for cloning this channel |
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 stage instance associated with this stage channel.
Name | Type | Optional | Description |
---|---|---|---|
options | StageInstanceCreateOptions | No | The options to create the stage instance |
Creates a webhook for the channel.
Returns
Returns the created Webhook *Example
Name | Type | Optional | Description |
---|---|---|---|
options | ChannelWebhookCreateOptions | Yes | Options for creating the webhook |
Deletes this channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
reason | string | Yes | Reason for deleting this channel |
Edits the channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
options | GuildChannelEditOptions | No | The options to provide |
Checks if this channel has the same type, topic, position, name, overwrites, and id as another channel. In most cases, a simple
channel.id === channel2.id
will do, and is much faster too.Name | Type | Optional | Description |
---|---|---|---|
channel | GuildChannel | No | Channel to compare with |
Fetches this channel.
Name | Type | Optional | Description |
---|---|---|---|
force | boolean | Yes | Whether to skip the cache check and request the API |
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
Indicates whether this channel is DM-based (either a or a PartialGroupDMChannel).
Inherited from BaseChannelIndicates whether this channel is sendable.
Inherited from BaseChannelIndicates whether this channel is text-based.
Inherited from GuildChannelIndicates whether this channel is a .
Inherited from BaseChannelIndicates whether this channel is .
Inherited from BaseChannelIndicates whether this channel is .
Inherited from BaseChannelLocks in the permission overwrites from the parent channel.
Inherited from GuildChannelGets the overall set of permissions for a member or role in this channel, taking into account channel overwrites.
Returns
Name | Type | Optional | Description |
---|---|---|---|
memberOrRole | GuildMember | Role | No | The member or role to obtain the overall permissions for |
checkAdmin | boolean | Yes | Whether having the PermissionFlagsBits.Administrator permission will return all permissions |
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 a new name for the guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
name | string | No | The new name for the guild channel |
reason | string | Yes | Reason for changing the guild channel's name |
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 |
Sets the parent of this channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
channel | CategoryChannelResolvable | null | No | The category channel to set as the parent |
options | SetParentOptions | Yes | The options for setting the parent |
Sets a new position for the guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
position | number | No | The new position for the guild channel |
options | SetChannelPositionOptions | Yes | Options for setting position |
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 |
Sets the RTC region of the channel.
Example
Example
Sets a new topic for the guild channel.
Example
Name | Type | Optional | Description |
---|---|---|---|
topic | string | No | The new topic for the guild channel |
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. |
When concatenated with a string, this automatically returns the channel's mention instead of the Channel object.
Inherited from GuildChannel