Class StageChannel

constructor

• new StageChannel(guild, data?): StageChannel

• Parameters

  • guild: Guild

  • Optional data: RawGuildChannelData

  Returns StageChannel

bitrate

Readonly client

flags

guild

guildId

id

lastMessage

lastMessageId

messages

name

nsfw

parentId

permissionOverwrites

rateLimitPerUser

rawPosition

rtcRegion

userLimit

videoQualityMode

createdAt

• get createdAt(): Date

• Returns Date

createdTimestamp

• get createdTimestamp(): number

• Returns number

deletable

• get deletable(): boolean

• Returns boolean

full

• get full(): boolean

• Returns boolean

joinable

• get joinable(): boolean

• Returns boolean

manageable

• get manageable(): boolean

• Returns boolean

members

• get members(): Collection<string, GuildMember>

• Returns Collection<string, GuildMember>

parent

• get parent(): null | CategoryChannel

• Returns null | CategoryChannel

partial

• get partial(): false

• Returns false

permissionsLocked

• get permissionsLocked(): null | boolean

• Returns null | boolean

position

• get position(): number

• Returns number

url

• get url(): string

• Returns string

viewable

• get viewable(): boolean

• Returns boolean

awaitMessageComponent

• awaitMessageComponent<ComponentType>(options?): Promise<MappedInteractionTypes<boolean>[ComponentType]>

• Type Parameters

  • ComponentType extends MessageComponentType

  Parameters

  • Optional options: AwaitMessageCollectorOptionsParams<ComponentType, true>

  Returns Promise<MappedInteractionTypes<boolean>[ComponentType]>

awaitMessages

• awaitMessages(options?): Promise<Collection<string, Message<boolean>>>

• Parameters

  • Optional options: AwaitMessagesOptions

  Returns Promise<Collection<string, Message<boolean>>>

bulkDelete

• bulkDelete(messages, filterOld?): Promise<Collection<string, undefined | Message<boolean> | PartialMessage>>

• Parameters

  • messages: number | Collection<string, Message<boolean>> | readonly MessageResolvable[]

  • Optional filterOld: boolean

  Returns Promise<Collection<string, undefined | Message<boolean> | PartialMessage>>

clone

• clone(options?): Promise<StageChannel>

• Parameters

  • Optional options: GuildChannelCloneOptions

  Returns Promise<StageChannel>

createInvite

• createInvite(options?): Promise<Invite>

• Parameters

  • Optional options: InviteCreateOptions

  Returns Promise<Invite>

createMessageCollector

• createMessageCollector(options?): MessageCollector

• Parameters

  • Optional options: MessageCollectorOptions

  Returns MessageCollector

createMessageComponentCollector

• createMessageComponentCollector<ComponentType>(options?): InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>

• Type Parameters

  • ComponentType extends MessageComponentType

  Parameters

  • Optional options: MessageChannelCollectorOptionsParams<ComponentType, true>

  Returns InteractionCollector<MappedInteractionTypes<boolean>[ComponentType]>

createWebhook

• createWebhook(options): Promise<Webhook<Incoming>>

• Parameters

  • options: ChannelWebhookCreateOptions

  Returns Promise<Webhook<Incoming>>

delete

• delete(reason?): Promise<StageChannel>

• Parameters

  • Optional reason: string

  Returns Promise<StageChannel>

edit

• edit(options): Promise<StageChannel>

• Parameters

  • options: GuildChannelEditOptions

  Returns Promise<StageChannel>

equals

• equals(channel): boolean

• Parameters

  • channel: GuildChannel

  Returns boolean

fetch

• fetch(force?): Promise<StageChannel>

• Parameters

  • Optional force: boolean

  Returns Promise<StageChannel>

fetchInvites

• fetchInvites(cache?): Promise<Collection<string, Invite>>

• Parameters

  • Optional cache: boolean

  Returns Promise<Collection<string, Invite>>

fetchWebhooks

• fetchWebhooks(): Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>

• Returns Promise<Collection<string, Webhook<Incoming | ChannelFollower>>>

isDMBased

• isDMBased(): this is DMChannel | PartialDMChannel | PartialGroupDMChannel

• Returns this is DMChannel | PartialDMChannel | PartialGroupDMChannel

isTextBased

• isTextBased(): this is GuildBasedChannel & TextBasedChannel

• Returns this is GuildBasedChannel & TextBasedChannel

isThread

• isThread(): this is AnyThreadChannel

• Returns this is AnyThreadChannel

isThreadOnly

• isThreadOnly(): this is ThreadOnlyChannel

• Returns this is ThreadOnlyChannel

isVoiceBased

• isVoiceBased(): this is VoiceBasedChannel

• Returns this is VoiceBasedChannel

lockPermissions

• lockPermissions(): Promise<StageChannel>

• Returns Promise<StageChannel>

permissionsFor

• permissionsFor(memberOrRole, checkAdmin?): Readonly<PermissionsBitField>

• Parameters

  • memberOrRole: GuildMember | Role

  • Optional checkAdmin: boolean

  Returns Readonly<PermissionsBitField>

• permissionsFor(memberOrRole, checkAdmin?): null | Readonly<PermissionsBitField>

• Parameters

  • memberOrRole: string | GuildMember | Role | User | Message<boolean> | ThreadMember<boolean>

  • Optional checkAdmin: boolean

  Returns null | Readonly<PermissionsBitField>

send

• send(options): Promise<Message<true>>

• Parameters

  • options: string | MessagePayload | MessageCreateOptions

  Returns Promise<Message<true>>

sendTyping

• sendTyping(): Promise<void>

• Returns Promise<void>

setBitrate

• setBitrate(bitrate, reason?): Promise<StageChannel>

• Parameters

  • bitrate: number

  • Optional reason: string

  Returns Promise<StageChannel>

setNSFW

• setNSFW(nsfw?, reason?): Promise<TextBasedChannelFields<true>>

• Parameters

  • Optional nsfw: boolean

  • Optional reason: string

  Returns Promise<TextBasedChannelFields<true>>

setName

• setName(name, reason?): Promise<StageChannel>

• Parameters

  • name: string

  • Optional reason: string

  Returns Promise<StageChannel>

setParent

• setParent(channel, options?): Promise<StageChannel>

• Parameters

  • channel: null | CategoryChannelResolvable

  • Optional options: SetParentOptions

  Returns Promise<StageChannel>

setPosition

• setPosition(position, options?): Promise<StageChannel>

• Parameters

  • position: number

  • Optional options: SetChannelPositionOptions

  Returns Promise<StageChannel>

setRTCRegion

• setRTCRegion(rtcRegion, reason?): Promise<StageChannel>

• Parameters

  • rtcRegion: null | string

  • Optional reason: string

  Returns Promise<StageChannel>

setRateLimitPerUser

• setRateLimitPerUser(rateLimitPerUser, reason?): Promise<TextBasedChannelFields<true>>

• Parameters

  • rateLimitPerUser: number

  • Optional reason: string

  Returns Promise<TextBasedChannelFields<true>>

setUserLimit

• setUserLimit(userLimit, reason?): Promise<StageChannel>

• Parameters

  • userLimit: number

  • Optional reason: string

  Returns Promise<StageChannel>

setVideoQualityMode

• setVideoQualityMode(videoQualityMode, reason?): Promise<StageChannel>

• Parameters

  • videoQualityMode: VideoQualityMode

  • Optional reason: string

  Returns Promise<StageChannel>

toJSON

• toJSON(...props): unknown

• Parameters

  • Rest ...props: Record<string, string | boolean>[]

  Returns unknown

toString

• toString(): `<#${string}>`

• Returns `<#${string}>`

valueOf

• valueOf(): string

• Returns string