Class VoiceState

Hierarchy

Base
ObjectToLower<Omit<VoiceStateResource, "member">>
- VoiceState

Index

Constructors

Properties

channelId client deaf guildId mute requestToSpeakTimestamp selfDeaf selfMute selfStream? selfVideo sessionId suppress userId withMember?

Accessors

Methods

channel disconnect fetch guild member requestSpeak setChannel setDeaf setMute setSuppress user

Constructors

constructor

new VoiceState(client: UsingClient, data: APIVoiceState): VoiceState
Parameters
- client: UsingClient
- data: APIVoiceState
Returns VoiceState
Inherited from Base.constructor
- Defined in src/structures/VoiceState.ts:19

Properties

channelId

channelId: null | string

`Readonly`client

client: UsingClient

deaf

deaf: boolean

guildId

guildId: string

mute

mute: boolean

requestToSpeakTimestamp

requestToSpeakTimestamp: null | string

selfDeaf

selfDeaf: boolean

selfMute

selfMute: boolean

`Optional`selfStream

selfStream?: boolean

selfVideo

selfVideo: boolean

sessionId

sessionId: string

suppress

suppress: boolean

userId

userId: string

`Protected` `Optional`withMember

withMember?: GuildMember

Accessors

isMuted

get isMuted(): boolean
Returns boolean
- Defined in src/structures/VoiceState.ts:27

Methods

channel

channel(mode?: "rest" | "flow"): Promise<undefined | AllGuildVoiceChannels>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<undefined | AllGuildVoiceChannels>
- Defined in src/structures/VoiceState.ts:39
channel(mode: "cache"): ReturnCache<undefined | AllGuildVoiceChannels>
Parameters
- mode: "cache"
Returns ReturnCache<undefined | AllGuildVoiceChannels>
- Defined in src/structures/VoiceState.ts:40

disconnect

disconnect(reason?: string): Promise<GuildMember>
Parameters
- Optionalreason: string
Returns Promise<GuildMember>
- Defined in src/structures/VoiceState.ts:80

fetch

fetch(force?: boolean): Promise<VoiceState>
Parameters
- force: boolean = false
Returns Promise<VoiceState>
- Defined in src/structures/VoiceState.ts:84

guild

guild(mode?: "rest" | "flow"): Promise<Guild<"cached" | "api">>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<Guild<"cached" | "api">>
- Defined in src/structures/VoiceState.ts:95
guild(mode: "cache"): ReturnCache<undefined | Guild<"cached">>
Parameters
- mode: "cache"
Returns ReturnCache<undefined | Guild<"cached">>
- Defined in src/structures/VoiceState.ts:96

member

member(force?: boolean): Promise<GuildMember>
Parameters
- Optionalforce: boolean
Returns Promise<GuildMember>
- Defined in src/structures/VoiceState.ts:31

requestSpeak

requestSpeak(date?: string | Date): Promise<undefined>
Parameters
- date: string | Date = ...
Returns Promise<undefined>
- Defined in src/structures/VoiceState.ts:72

setChannel

setChannel(channel_id: null | string, reason?: string): Promise<GuildMember>
Parameters
- channel_id: null | string
- Optionalreason: string
Returns Promise<GuildMember>
- Defined in src/structures/VoiceState.ts:89

setDeaf

setDeaf(deaf?: boolean, reason?: string): Promise<GuildMember>
Parameters
- deaf: boolean = ...
- Optionalreason: string
Returns Promise<GuildMember>
- Defined in src/structures/VoiceState.ts:61

setMute

setMute(mute?: boolean, reason?: string): Promise<GuildMember>
Parameters
- mute: boolean = ...
- Optionalreason: string
Returns Promise<GuildMember>
- Defined in src/structures/VoiceState.ts:55

setSuppress

setSuppress(suppress?: boolean): Promise<void>
Parameters
- suppress: boolean = ...
Returns Promise<void>
- Defined in src/structures/VoiceState.ts:67

user

user(force?: boolean): Promise<User>
Parameters
- Optionalforce: boolean
Returns Promise<User>
- Defined in src/structures/VoiceState.ts:35