discord.js | StageChannel

Search...

StageChannel

export class StageChannel extends BaseGuildVoiceChannel

export class StageChannel extends BaseGuildVoiceChannel

Represents a guild stage channel on Discord.

Extends

BaseGuildVoiceChannel

bitrate:number

The bitrate of this voice-based channel

Inherited from BaseGuildVoiceChannel

Readonly

full:boolean

Checks if the voice-based channel is full

Inherited from BaseGuildVoiceChannel

Readonly

joinable:boolean

Whether the channel is joinable by the client user

Inherited from BaseGuildVoiceChannel

Readonly

members:Collection<Snowflake, GuildMember>

The members in this voice-based channel

Inherited from BaseGuildVoiceChannel

nsfw:boolean

If the guild considers this channel NSFW

Inherited from BaseGuildVoiceChannel

rateLimitPerUser:number | null

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

Inherited from BaseGuildVoiceChannel

rtcRegion:string | null

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

Inherited from BaseGuildVoiceChannel

Readonly

stageInstance:StageInstance | null

The stage instance of this stage channel, if it exists

topic:string | null

The topic of the stage channel

type:ChannelType.GuildStageVoice

The type of the channel

userLimit:number

The maximum amount of users allowed in this channel.

Inherited from BaseGuildVoiceChannel

videoQualityMode:VideoQualityMode | null

The camera video quality mode of the channel.

Inherited from BaseGuildVoiceChannel

createInvite(options?):Promise<Invite>

Creates an invite to this guild channel.

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

Inherited from BaseGuildVoiceChannel

createStageInstance(options):Promise<StageInstance>

Creates a stage instance associated with this stage channel.

Name	Type	Optional	Description
options	StageInstanceCreateOptions	No	The options to create the stage instance

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

Inherited from BaseGuildVoiceChannel

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

Sets the bitrate of the channel.

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

Inherited from BaseGuildVoiceChannel

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

Sets the RTC region of the channel.

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.

Inherited from BaseGuildVoiceChannel

setTopic(topic):Promise<StageChannel>

Sets a new topic for the guild channel.

Name	Type	Optional	Description
topic	string	No	The new topic for the guild channel

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

Sets the user limit of the channel.

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

Inherited from BaseGuildVoiceChannel

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.

Inherited from BaseGuildVoiceChannel