Interface IVoiceChannel

Hierarchy

IVoiceChannel

Index

Methods

Methods

canJoin

canJoin(): boolean

- Defined in IVoiceChannel.ts:40
Whether the client can join the channel

Returns boolean

True if the client can join the channel, else false

getConnection

getConnection(): IVoiceConnection

- Defined in IVoiceChannel.ts:63
Gets the voice connection, if there is one.

Returns IVoiceConnection

The active voice connection

getId

getId(): number

- Defined in IVoiceChannel.ts:34
The id of the channel

Returns number

The id of the channel

getMembers

getMembers(): IUser[]

- Defined in IVoiceChannel.ts:46
Get the members in the voice channel

Returns IUser[]

The members in the voice channel

getName

getName(): boolean

- Defined in IVoiceChannel.ts:51
Get the name of the voice channel

Returns boolean

getServer

getServer(): IServer

- Defined in IVoiceChannel.ts:28
Get the server the channel is located on

Returns IServer

The server the channel is on

getUserLimit

getUserLimit(): number

- Defined in IVoiceChannel.ts:57
The maximum amount of users allowed in this channel - 0 means unlimited.

Returns number

The max. amount of users allowed

isDeletable

isDeletable(): boolean

- Defined in IVoiceChannel.ts:10
Whether the channel is deletable

Returns boolean

True if the channel is deletable, else false

isFull

isFull(): boolean

- Defined in IVoiceChannel.ts:22
Whether the channel is full

Returns boolean

True if the channel is full, else false

join

join(): Promise<IVoiceConnection>

- Defined in IVoiceChannel.ts:68
Joins the voice channel

Returns Promise<IVoiceConnection>

leave

leave(): void

- Defined in IVoiceChannel.ts:73
Leaves the voice channel

Returns void

wasDeleted

wasDeleted(): boolean

- Defined in IVoiceChannel.ts:16
Whether the channel has been deleted

Returns boolean

True if the channel was deleted, else false

Generated using TypeDoc