Class StageChannel

bitrate

client

guildID

id

Optional lastMessage

lastMessageID

messages

name

nsfw

parentID

permissionOverwrites

position

rateLimitPerUser

rtcRegion

topic

userLimit

videoQualityMode

voiceMembers

createdAt

• get createdAt(): Date

• Returns Date

guild

• get guild(): Guild

• The guild associated with this channel. This will throw an error if the guild is not cached.

  Returns Guild

mention

• get mention(): string

• A string that will mention this channel.

  Returns string

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

voiceStates

• get voiceStates(): VoiceState<T>[]

• The voice states related to this channel.

  Returns VoiceState<T>[]

createInvite

• createInvite(options): Promise<Invite<"withMetadata", StageChannel>>

• Create an invite for this channel. If the guild is not a COMMUNITY server, invites can only be made to last 30 days.

  Parameters

  • options: CreateInviteOptions

    The options for the invite.

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

createMessage

• createMessage(options): Promise<Message<StageChannel>>

• Create a message in this channel.

  Parameters

  • options: CreateMessageOptions

    The options for the message.

  Returns Promise<Message<StageChannel>>

createReaction

• createReaction(messageID, emoji): 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>

createWebhook

• createWebhook(options): Promise<Webhook>

• Create a webhook in this channel.

  Parameters

  • options: CreateWebhookOptions

    The options to create the webhook with.

  Returns Promise<Webhook>

delete

• delete(): Promise<void>

• Close a direct message, leave a group channel, or delete a guild channel.

  Returns Promise<void>

deleteMessage

• deleteMessage(messageID, reason?): 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>

deleteMessages

• deleteMessages(messageIDs, reason?): 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>

deletePermission

• deletePermission(overwriteID, reason?): 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>

deleteReaction

• deleteReaction(messageID, emoji, user?): 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>

deleteReactions

• deleteReactions(messageID, emoji?): 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>

edit

• edit(options): Promise<StageChannel>

• Edit this channel.

  Parameters

  • options: EditStageChannelOptions

    The options for editing the channel.

  Returns Promise<StageChannel>

editMessage

• editMessage(messageID, options): 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>>

editPermission

• editPermission(overwriteID, options): 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>

getInvites

• getInvites(): Promise<Invite<"withMetadata", StageChannel>[]>

• Get the invites of this channel.

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

getMessage

• getMessage(messageID): Promise<Message<StageChannel>>

• Get a message in this channel.

  Parameters

  • messageID: string

    The ID of the message to get.

  Returns Promise<Message<StageChannel>>

getMessages

• getMessages(options?): Promise<Message<StageChannel>[]>

• Get messages in this channel.

  Parameters

  • Optional options: GetChannelMessagesOptions<Uncached | AnyTextableChannel>

    The options for getting the messages. before, after, and around All are mutually exclusive.

  Returns Promise<Message<StageChannel>[]>

getPinnedMessages

• getPinnedMessages(): Promise<Message<StageChannel>[]>

• Get the pinned messages in this channel.

  Returns Promise<Message<StageChannel>[]>

getReactions

• getReactions(messageID, emoji, options?): 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[]>

getWebhooks

• getWebhooks(): Promise<Webhook[]>

• Get the webhooks in this channel.

  Returns Promise<Webhook[]>

join

• join(options): VoiceConnection

• Join this stage channel.

  Parameters

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

    The options to join the channel with.

  Returns VoiceConnection

leave

• leave(): void

• Leave this stage channel.

  Returns void

permissionsOf

• permissionsOf(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

pinMessage

• pinMessage(messageID, reason?): 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>

purge

• purge(options): 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>

sendTyping

• sendTyping(): Promise<void>

• Show a typing indicator in this channel. How long users see this varies from client to client.

  Returns Promise<void>

toString

• toString(): string

• Returns string

unpinMessage

• unpinMessage(messageID, reason?): 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>

Static from

• from<T>(data, client): T

• Type Parameters

  • T extends AnyChannel = AnyChannel

  Parameters

  • data: RawChannel
  • client: Client<ClientEvents>

  Returns T

Static generateID

• generateID(timestamp?): string

• Parameters

  • timestamp: number | Date = ...

  Returns string

Static getCreatedAt

• getCreatedAt(id): Date

• Parameters

  • id: string

  Returns Date

Static getDiscordEpoch

• getDiscordEpoch(id): number

• Parameters

  • id: string

  Returns number