Class StageChannel

Represents a guild stage channel.

Hierarchy

GuildChannel
- StageChannel

Index

Constructors

constructor

new StageChannel(data: RawStageChannel, client: Client<ClientEvents>): StageChannel
Parameters
- data: RawStageChannel
- client: Client<ClientEvents>
Returns StageChannel
Overrides GuildChannel.constructor
- Defined in lib/structures/StageChannel.ts:41

Properties

bitrate

bitrate: number

The bitrate of the stage channel.

client

client: Client<ClientEvents>

guildID

guildID: string

The id of the guild this channel is in.

id

id: string

name

name: string

The name of this channel.

parentID

parentID: null | string

The ID of the parent of this channel, if applicable.

permissionOverwrites

permissionOverwrites: TypedCollection<string, RawOverwrite, PermissionOverwrite, []>

The permission overwrites of this channel.

position

position: number

The position of this channel on the sidebar.

rtcRegion

rtcRegion: null | string

The id of the voice region of the channel, null is automatic.

topic

topic: null | string

The topic of the channel.

type

type: GUILD_STAGE_VOICE

The type of this channel.

voiceMembers

voiceMembers: TypedCollection<string, RawMember, Member, [guildID: string]>

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from GuildChannel.createdAt
- Defined in lib/structures/Base.ts:31

guild

get guild(): Guild
The guild associated with this channel. This will throw an error if the guild is not cached.

Returns Guild
Inherited from GuildChannel.guild
- Defined in lib/structures/GuildChannel.ts:45

mention

get mention(): string
A string that will mention this channel.

Returns string
Inherited from GuildChannel.mention
- Defined in lib/structures/Channel.ts:73

parent

get parent(): undefined | null | CategoryChannel
The parent of this channel, if applicable. This will be a text/announcement/forum channel if we're in a thread, category otherwise.

Returns undefined | null | CategoryChannel
Overrides GuildChannel.parent
- Defined in lib/structures/StageChannel.ts:77

Methods

createInvite

createInvite(options: CreateInviteOptions): Promise<Invite<InviteInfoTypes, StageChannel>>
Create an invite for this channel.
Parameters
- options: CreateInviteOptions
  
  The options to create an invite with.
Returns Promise<Invite<InviteInfoTypes, StageChannel>>
- Defined in lib/structures/StageChannel.ts:86

createStageInstance

createStageInstance(options: CreateStageInstanceOptions): Promise<StageInstance>
Create a stage instance on this channel.
Parameters
- options: CreateStageInstanceOptions
  
  The options for creating the stage instance.
Returns Promise<StageInstance>
- Defined in lib/structures/StageChannel.ts:94

delete

delete(): Promise<void>
Close a direct message, leave a group channel, or delete a guild channel.

Returns Promise<void>
Inherited from GuildChannel.delete
- Defined in lib/structures/Channel.ts:80

deletePermission

deletePermission(overwriteID: string, reason?: string): Promise<void>
Delete a permission overwrite on this channel.
Parameters
- overwriteID: string
  
  The ID of the permission overwrite to delete.
- Optional reason: string
  
  The reason for deleting the permission overwrite.
Returns Promise<void>
- Defined in lib/structures/StageChannel.ts:103

deleteStageInstance

deleteStageInstance(reason?: string): Promise<void>
Delete the stage instance on this channel.
Parameters
- Optional reason: string
  
  The reason for deleting the stage instance.
Returns Promise<void>
- Defined in lib/structures/StageChannel.ts:111

edit

edit(options: EditStageChannelOptions): Promise<StageChannel>
Edit this channel.
Parameters
- options: EditStageChannelOptions
  
  The options for editing the channel.
Returns Promise<StageChannel>
Overrides GuildChannel.edit
- Defined in lib/structures/StageChannel.ts:119

editPermission

editPermission(overwriteID: string, options: EditPermissionOptions): Promise<void>
Edit a permission overwrite on this channel.
Parameters
- overwriteID: string
  
  The ID of the permission overwrite to edit.
- options: EditPermissionOptions
  
  The options for editing the permission overwrite.
Returns Promise<void>
- Defined in lib/structures/StageChannel.ts:128

editStageInstance

editStageInstance(options: EditStageInstanceOptions): Promise<StageInstance>
Edit the stage instance on this channel.
Parameters
- options: EditStageInstanceOptions
  
  The options for editing the stage instance.
Returns Promise<StageInstance>
- Defined in lib/structures/StageChannel.ts:136

getStageInstance

getStageInstance(): Promise<StageInstance>
Get the stage instance associated with this channel.

Returns Promise<StageInstance>
- Defined in lib/structures/StageChannel.ts:143

join

join(options: Omit<JoinVoiceChannelOptions, "channelID" | "guildID" | "voiceAdapterCreator">): VoiceConnection
Join this stage channel.
Parameters
- options: Omit<JoinVoiceChannelOptions, "channelID" | "guildID" | "voiceAdapterCreator">
  
  The options to join the channel with.
Returns VoiceConnection
- Defined in lib/structures/StageChannel.ts:151

leave

leave(): void
Leave this stage channel.

Returns void
- Defined in lib/structures/StageChannel.ts:163

permissionsOf

permissionsOf(member: string | Member): Permission
Get the permissions of a member. If providing an id, the member must be cached.
Parameters
- member: string | Member
  
  The member to get the permissions of.
Returns Permission
- Defined in lib/structures/StageChannel.ts:171

toJSON

toJSON(): JSONStageChannel
Returns JSONStageChannel
Overrides GuildChannel.toJSON
- Defined in lib/structures/StageChannel.ts:203

toString

toString(): string
Returns string
Inherited from GuildChannel.toString
- Defined in lib/structures/Base.ts:56

`Static` from

from<T>(data: RawChannel, client: Client<ClientEvents>): T
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- data: RawChannel
- client: Client<ClientEvents>
Returns T
Inherited from GuildChannel.from
- Defined in lib/structures/Channel.ts:31

`Static` getCreatedAt

getCreatedAt(id: string): Date
Parameters
- id: string
Returns Date
Inherited from GuildChannel.getCreatedAt
- Defined in lib/structures/Base.ts:20

`Static` getDiscordEpoch

getDiscordEpoch(id: string): number
Parameters
- id: string
Returns number
Inherited from GuildChannel.getDiscordEpoch
- Defined in lib/structures/Base.ts:24

Class StageChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

data: RawStageChannel

client: Client<ClientEvents>

Returns StageChannel

Properties

bitrate

client

guildID

id

name

parentID

permissionOverwrites

position

rtcRegion

topic

type

voiceMembers

Accessors

createdAt

Returns Date

guild

Returns Guild

mention

Returns string

parent

Returns undefined | null | CategoryChannel

Methods

createInvite

Parameters

options: CreateInviteOptions

Returns Promise<Invite<InviteInfoTypes, StageChannel>>

createStageInstance

Parameters

options: CreateStageInstanceOptions

Returns Promise<StageInstance>

delete

Returns Promise<void>

deletePermission

Parameters

overwriteID: string

Optional reason: string

Returns Promise<void>

deleteStageInstance

Parameters

Optional reason: string

Returns Promise<void>

edit

Parameters

options: EditStageChannelOptions

Returns Promise<StageChannel>

editPermission

Parameters

overwriteID: string

options: EditPermissionOptions

Returns Promise<void>

editStageInstance

Parameters

options: EditStageInstanceOptions

Returns Promise<StageInstance>

getStageInstance

Returns Promise<StageInstance>

join

Parameters

options: Omit<JoinVoiceChannelOptions, "channelID" | "guildID" | "voiceAdapterCreator">

Returns VoiceConnection

leave

Returns void

permissionsOf

Parameters

member: string | Member

Returns Permission

`Optional` reason: string

`Optional` reason: string

`Static` from

`Static` getCreatedAt

`Static` getDiscordEpoch