Class VoiceChannel

Hierarchy

GuildChannel
- VoiceChannel
  - StageChannel

Implements

Invitable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new VoiceChannel(data: BaseData, guild: Guild): VoiceChannel

Inherited from GuildChannel.constructor
- Defined in node_modules/eris/index.d.ts:2084
Parameters
- data: BaseData
- guild: Guild
Returns VoiceChannel

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

type

type: 13 | 2

userLimit

userLimit: number

videoQualityMode

videoQualityMode: VideoQualityMode

voiceMembers

voiceMembers: Collection<Member>

Methods

createInvite

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

Implementation of Invitable.createInvite
- Defined in node_modules/eris/index.d.ts:2594
Parameters
- Optional options: CreateInviteOptions
- Optional reason: string
Returns Promise<Invite<"withMetadata", VoiceChannel>>

delete

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

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

deletePermission

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

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

edit

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

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

editPermission

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

Inherited from GuildChannel.editPermission
- Defined in node_modules/eris/index.d.ts:2088
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 GuildChannel.editPosition
- Defined in node_modules/eris/index.d.ts:2095
Parameters
- position: number
- Optional options: EditChannelPositionOptions
Returns Promise<void>

getInvites

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

Implementation of Invitable.getInvites

Overrides GuildChannel.getInvites
- Defined in node_modules/eris/index.d.ts:2595
Returns Promise<Invite<"withMetadata", VoiceChannel>[]>

inspect

inspect(): VoiceChannel

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

join

join(options: { opusOnly?: boolean; shared?: boolean }): Promise<VoiceConnection>

- Defined in node_modules/eris/index.d.ts:2596
Parameters
- options: { opusOnly?: boolean; shared?: boolean }
  - Optional opusOnly?: boolean
  - Optional shared?: boolean
Returns Promise<VoiceConnection>

leave

leave(): void

- Defined in node_modules/eris/index.d.ts:2597
Returns void

permissionsOf

permissionsOf(memberID: string | Member): Permission

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

toJSON

toJSON(props?: string[]): JSONCache

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

toString

toString(): string

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

Static from

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

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

Static getCreatedAt

getCreatedAt(id: string): number

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

Generated using TypeDoc