Class StageChannel

Represents a guild stage channel.

Hierarchy

TextableChannel<StageChannel>
- StageChannel

Constructors

constructor

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

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

`Optional` lastMessage

lastMessage?: null | Message<StageChannel>

The last message sent in this channel. This will only be present if a message has been sent within the current session.

lastMessageID

lastMessageID: null | string

The ID of last message sent in this channel.

messages

messages: TypedCollection<string, RawMessage, Message<StageChannel>, []>

The cached messages in this channel.

name

name: string

The name of this channel.

nsfw

nsfw: boolean

If this channel is age gated.

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.

rateLimitPerUser

rateLimitPerUser: number

The amount of seconds between non-moderators sending messages.

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.

userLimit

userLimit: number

The maximum number of members in this voice channel. 0 is unlimited.

videoQualityMode

videoQualityMode: VideoQualityModes

The video quality mode of this channel.

voiceMembers

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

Accessors

createdAt

get createdAt(): Date
Returns Date
Inherited from TextableChannel.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 TextableChannel.guild
- Defined in lib/structures/GuildChannel.ts:45

mention

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

Returns string
Inherited from TextableChannel.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 TextableChannel.parent
- Defined in lib/structures/StageChannel.ts:55

Methods

createInvite

createInvite(options: CreateInviteOptions): Promise<Invite<"withMetadata", StageChannel>>
Create an invite for this channel.
Parameters
- options: CreateInviteOptions
  
  The options for the invite.
Returns Promise<Invite<"withMetadata", StageChannel>>
Inherited from TextableChannel.createInvite
- Defined in lib/structures/TextableChannel.ts:109

createMessage

createMessage(options: CreateMessageOptions): Promise<Message<StageChannel>>
Create a message in this channel.
Parameters
- options: CreateMessageOptions
  
  The options for the message.
Returns Promise<Message<StageChannel>>
Inherited from TextableChannel.createMessage
- Defined in lib/structures/TextableChannel.ts:117

createReaction

createReaction(messageID: string, emoji: string): Promise<void>
Add a reaction to a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to add a reaction to.
- emoji: string
  
  The reaction to add to the message. name:id for custom emojis, and the unicode codepoint for default emojis.
Returns Promise<void>
Inherited from TextableChannel.createReaction
- Defined in lib/structures/TextableChannel.ts:126

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:63

createWebhook

createWebhook(options: CreateWebhookOptions): Promise<Webhook>
Create a webhook in this channel.
Parameters
- options: CreateWebhookOptions
  
  The options to create the webhook with.
Returns Promise<Webhook>
Inherited from TextableChannel.createWebhook
- Defined in lib/structures/TextableChannel.ts:134

delete

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

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

deleteMessage

deleteMessage(messageID: string, reason?: string): Promise<void>
Delete a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to delete.
- Optional reason: string
  
  The reason for deleting the message.
Returns Promise<void>
Inherited from TextableChannel.deleteMessage
- Defined in lib/structures/TextableChannel.ts:143

deleteMessages

deleteMessages(messageIDs: string[], reason?: string): Promise<number>
Bulk delete messages in this channel.
Parameters
- messageIDs: string[]
  
  The IDs of the messages to delete. Any duplicates or messages older than two weeks will cause an error.
- Optional reason: string
  
  The reason for deleting the messages.
Returns Promise<number>
Inherited from TextableChannel.deleteMessages
- Defined in lib/structures/TextableChannel.ts:152

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>
Inherited from TextableChannel.deletePermission
- Defined in lib/structures/TextableChannel.ts:161

deleteReaction

deleteReaction(messageID: string, emoji: string, user?: string): Promise<void>
Remove a reaction from a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to remove a reaction from.
- emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- user: string = "@me"
  
  The user to remove the reaction from, @me for the current user (default).
Returns Promise<void>
Inherited from TextableChannel.deleteReaction
- Defined in lib/structures/TextableChannel.ts:171

deleteReactions

deleteReactions(messageID: string, emoji?: string): Promise<void>
Remove all, or a specific emoji's reactions from a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to remove reactions from.
- Optional emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis. Omit to remove all reactions.
Returns Promise<void>
Inherited from TextableChannel.deleteReactions
- Defined in lib/structures/TextableChannel.ts:180

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:71

edit

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

editMessage

editMessage(messageID: string, options: EditMessageOptions): Promise<Message<StageChannel>>
Edit a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to edit.
- options: EditMessageOptions
  
  The options for editing the message.
Returns Promise<Message<StageChannel>>
Inherited from TextableChannel.editMessage
- Defined in lib/structures/TextableChannel.ts:197

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>
Inherited from TextableChannel.editPermission
- Defined in lib/structures/TextableChannel.ts:206

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:87

getInvites

getInvites(): Promise<Invite<"withMetadata", StageChannel>[]>
Get the invites of this channel.

Returns Promise<Invite<"withMetadata", StageChannel>[]>
Inherited from TextableChannel.getInvites
- Defined in lib/structures/TextableChannel.ts:213

getMessage

getMessage(messageID: string): Promise<Message<StageChannel>>
Get a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to get.
Returns Promise<Message<StageChannel>>
Inherited from TextableChannel.getMessage
- Defined in lib/structures/TextableChannel.ts:221

getMessages

getMessages(options?: GetChannelMessagesOptions): Promise<Message<StageChannel>[]>
Get messages in this channel.
Parameters
- Optional options: GetChannelMessagesOptions
  
  The options for getting the messages. before, after, and around All are mutually exclusive.
Returns Promise<Message<StageChannel>[]>
Inherited from TextableChannel.getMessages
- Defined in lib/structures/TextableChannel.ts:229

getPinnedMessages

getPinnedMessages(): Promise<Message<StageChannel>[]>
Get the pinned messages in this channel.

Returns Promise<Message<StageChannel>[]>
Inherited from TextableChannel.getPinnedMessages
- Defined in lib/structures/TextableChannel.ts:236

getPublicArchivedThreads

getPublicArchivedThreads(options?: GetArchivedThreadsOptions): Promise<ArchivedThreads<AnnouncementThreadChannel>>
Get the public archived threads in this channel.
Parameters
- Optional options: GetArchivedThreadsOptions
  
  The options for getting the public archived threads.
Returns Promise<ArchivedThreads<AnnouncementThreadChannel>>
Inherited from TextableChannel.getPublicArchivedThreads
- Defined in lib/structures/TextableChannel.ts:244

getReactions

getReactions(messageID: string, emoji: string, options?: GetReactionsOptions): Promise<User[]>
Get the users who reacted with a specific emoji on a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to get reactions from.
- emoji: string
  
  The reaction to remove from the message. name:id for custom emojis, and the unicode codepoint for default emojis.
- Optional options: GetReactionsOptions
  
  The options for getting the reactions.
Returns Promise<User[]>
Inherited from TextableChannel.getReactions
- Defined in lib/structures/TextableChannel.ts:254

getStageInstance

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

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

getWebhooks

getWebhooks(): Promise<Webhook[]>
Get the webhooks in this channel.

Returns Promise<Webhook[]>
Inherited from TextableChannel.getWebhooks
- Defined in lib/structures/TextableChannel.ts:261

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:102

leave

leave(): void
Leave this stage channel.

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

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
Inherited from TextableChannel.permissionsOf
- Defined in lib/structures/TextableChannel.ts:269

pinMessage

pinMessage(messageID: string, reason?: string): Promise<void>
Pin a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to pin.
- Optional reason: string
  
  The reason for pinning the message.
Returns Promise<void>
Inherited from TextableChannel.pinMessage
- Defined in lib/structures/TextableChannel.ts:306

purge

purge(options: PurgeOptions<StageChannel>): Promise<number>
Purge an amount of messages from this channel.
Parameters
- options: PurgeOptions<StageChannel>
  
  The options to purge. before, after, and around All are mutually exclusive.
Returns Promise<number>
Inherited from TextableChannel.purge
- Defined in lib/structures/TextableChannel.ts:314

sendTyping

sendTyping(): Promise<void>
Show a typing indicator in this channel. How long users see this varies from client to client.

Returns Promise<void>
Inherited from TextableChannel.sendTyping
- Defined in lib/structures/TextableChannel.ts:321

startThreadFromMessage

startThreadFromMessage(messageID: string, options: StartThreadFromMessageOptions): Promise<PublicThreadChannel>
Create a thread from an existing message in this channel.
Parameters
- messageID: string
  
  The ID of the message to create a thread from.
- options: StartThreadFromMessageOptions
  
  The options for creating the thread.
Returns Promise<PublicThreadChannel>
Inherited from TextableChannel.startThreadFromMessage
- Defined in lib/structures/TextableChannel.ts:330

startThreadWithoutMessage

startThreadWithoutMessage(options: StartThreadWithoutMessageOptions): Promise<PublicThreadChannel>
Create a thread without an existing message in this channel.
Parameters
- options: StartThreadWithoutMessageOptions
  
  The options for creating the thread.
Returns Promise<PublicThreadChannel>
Inherited from TextableChannel.startThreadWithoutMessage
- Defined in lib/structures/TextableChannel.ts:338

toJSON

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

toString

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

unpinMessage

unpinMessage(messageID: string, reason?: string): Promise<void>
Unpin a message in this channel.
Parameters
- messageID: string
  
  The ID of the message to unpin.
- Optional reason: string
  
  The reason for unpinning the message.
Returns Promise<void>
Inherited from TextableChannel.unpinMessage
- Defined in lib/structures/TextableChannel.ts:361

`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 TextableChannel.from
- Defined in lib/structures/Channel.ts:31

`Static` getCreatedAt

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

`Static` getDiscordEpoch

getDiscordEpoch(id: string): number
Parameters
- id: string
Returns number
Inherited from TextableChannel.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

Optional lastMessage

lastMessageID

messages

name

nsfw

parentID

permissionOverwrites

position

rateLimitPerUser

rtcRegion

topic

type

userLimit

videoQualityMode

voiceMembers

Accessors

createdAt

Returns Date

guild

Returns Guild

mention

Returns string

parent

Returns undefined | null | CategoryChannel

Methods

createInvite

Parameters

options: CreateInviteOptions

Returns Promise<Invite<"withMetadata", StageChannel>>

createMessage

Parameters

options: CreateMessageOptions

Returns Promise<Message<StageChannel>>

createReaction

Parameters

messageID: string

emoji: string

Returns Promise<void>

createStageInstance

Parameters

options: CreateStageInstanceOptions

Returns Promise<StageInstance>

createWebhook

Parameters

options: CreateWebhookOptions

Returns Promise<Webhook>

delete

Returns Promise<void>

deleteMessage

Parameters

messageID: string

Optional reason: string

Returns Promise<void>

deleteMessages

Parameters

messageIDs: string[]

Optional reason: string

Returns Promise<number>

deletePermission

Parameters

overwriteID: string

Optional reason: string

`Optional` lastMessage

`Optional` reason: string

`Optional` reason: string

`Optional` reason: string

`Optional` emoji: string

`Optional` reason: string

`Optional` options: GetChannelMessagesOptions

`Optional` options: GetArchivedThreadsOptions

`Optional` options: GetReactionsOptions