Class StageChannel

Hierarchy

VoiceChannel
- StageChannel

Index

Constructors

constructor

Properties

Constructors

constructor

new StageChannel(data: BaseData, client: Client): StageChannel

Inherited from VoiceChannel.constructor
- Defined in node_modules/eris/index.d.ts:2836
Parameters
- data: BaseData
- client: Client
Returns StageChannel

Properties

bitrate

bitrate: number

client

client: Client

createdAt

createdAt: number

guild

guild: Guild

id

id: string

mention

mention: string

name

name: string

nsfw

nsfw: boolean

parentID

parentID: null | string

permissionOverwrites

permissionOverwrites: Collection<PermissionOverwrite>

position

position: number

rtcRegion

rtcRegion: null | string

Optional topic

topic: string

type

type: 13

userLimit

userLimit: number

videoQualityMode

videoQualityMode: VideoQualityMode

voiceMembers

voiceMembers: Collection<Member>

Methods

createInstance

createInstance(options: StageInstanceOptions): Promise<StageInstance>

- Defined in node_modules/eris/index.d.ts:3450
Parameters
- options: StageInstanceOptions
Returns Promise<StageInstance>

createInvite

createInvite(options?: CreateInviteOptions, reason?: string): Promise<Invite<"withMetadata", VoiceChannel>>

Inherited from VoiceChannel.createInvite
- Defined in node_modules/eris/index.d.ts:3615
Parameters
- Optional options: CreateInviteOptions
- Optional reason: string
Returns Promise<Invite<"withMetadata", VoiceChannel>>

delete

delete(reason?: string): Promise<void>

Inherited from VoiceChannel.delete
- Defined in node_modules/eris/index.d.ts:2837
Parameters
- Optional reason: string
Returns Promise<void>

deleteInstance

deleteInstance(): Promise<void>

- Defined in node_modules/eris/index.d.ts:3451
Returns Promise<void>

deletePermission

deletePermission(overwriteID: string, reason?: string): Promise<void>

Inherited from VoiceChannel.deletePermission
- Defined in node_modules/eris/index.d.ts:2838
Parameters
- overwriteID: string
- Optional reason: string
Returns Promise<void>

edit

edit(options: Omit<EditChannelOptions, "icon" | "ownerID">, reason?: string): Promise<StageChannel>

Inherited from VoiceChannel.edit
- Defined in node_modules/eris/index.d.ts:2839
Parameters
- options: Omit<EditChannelOptions, "icon" | "ownerID">
- Optional reason: string
Returns Promise<StageChannel>

editInstance

editInstance(options: StageInstanceOptions): Promise<StageInstance>

- Defined in node_modules/eris/index.d.ts:3452
Parameters
- options: StageInstanceOptions
Returns Promise<StageInstance>

editPermission

editPermission(overwriteID: string, allow: number | bigint, deny: number | bigint, type: PermissionType, reason?: string): Promise<PermissionOverwrite>

Inherited from VoiceChannel.editPermission
- Defined in node_modules/eris/index.d.ts:2840
Parameters
- overwriteID: string
- allow: number | bigint
- deny: number | bigint
- type: PermissionType
- Optional reason: string
Returns Promise<PermissionOverwrite>

editPosition

editPosition(position: number, options?: EditChannelPositionOptions): Promise<void>

Inherited from VoiceChannel.editPosition
- Defined in node_modules/eris/index.d.ts:2847
Parameters
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

getInstance

getInstance(): Promise<StageInstance>

- Defined in node_modules/eris/index.d.ts:3453
Returns Promise<StageInstance>

getInvites

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

Inherited from VoiceChannel.getInvites
- Defined in node_modules/eris/index.d.ts:3616
Returns Promise<Invite<"withMetadata", VoiceChannel>[]>

inspect

inspect(): StageChannel

Inherited from VoiceChannel.inspect
- Defined in node_modules/eris/index.d.ts:2038
Returns StageChannel

join

join(options?: JoinVoiceChannelOptions): Promise<VoiceConnection>

Inherited from VoiceChannel.join
- Defined in node_modules/eris/index.d.ts:3617
Parameters
- Optional options: JoinVoiceChannelOptions
Returns Promise<VoiceConnection>

leave

leave(): void

Inherited from VoiceChannel.leave
- Defined in node_modules/eris/index.d.ts:3618
Returns void

permissionsOf

permissionsOf(memberID: string | Member | MemberRoles): Permission

Inherited from VoiceChannel.permissionsOf
- Defined in node_modules/eris/index.d.ts:2849
Parameters
- memberID: string | Member | MemberRoles
Returns Permission

toJSON

toJSON(props?: string[]): JSONCache

Inherited from VoiceChannel.toJSON
- Defined in node_modules/eris/index.d.ts:2040
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

Inherited from VoiceChannel.toString
- Defined in node_modules/eris/index.d.ts:2039
Returns string

Static from

from(data: BaseData, client: Client): AnyChannel

Inherited from VoiceChannel.from
- Defined in node_modules/eris/index.d.ts:2101
Parameters
- data: BaseData
- client: Client
Returns AnyChannel

Static getCreatedAt

getCreatedAt(id: string): number

Inherited from VoiceChannel.getCreatedAt
- Defined in node_modules/eris/index.d.ts:2036
Parameters
- id: string
Returns number

Static getDiscordEpoch

getDiscordEpoch(id: string): number

Inherited from VoiceChannel.getDiscordEpoch
- Defined in node_modules/eris/index.d.ts:2037
Parameters
- id: string
Returns number

Generated using TypeDoc