VoiceState

Extends

Base.ObjectToLower<VoiceStateResource>

Constructors

new VoiceState(client, data, withMember)

1
new VoiceState(
2
   client: UsingClient,
3
   data: VoiceStateResource,
4
   withMember?: GuildMember): VoiceState

Parameters

Parameter	Type
`client`	`UsingClient`
`data`	`VoiceStateResource`
`withMember`?	`GuildMember`

Returns

VoiceState

Inherited from

Base.constructor

Source

seyfert/src/structures/VoiceState.ts:9

Properties

Property	Modifier	Type	Inherited from
`channelId`	`public`	`null` \| `string`	`ObjectToLower.channelId`
`client`	`readonly`	`UsingClient`	`Base.client`
`deaf`	`public`	`boolean`	`ObjectToLower.deaf`
`guildId`	`public`	`string`	`ObjectToLower.guildId`
`mute`	`public`	`boolean`	`ObjectToLower.mute`
`requestToSpeakTimestamp`	`public`	`null` \| `string`	`ObjectToLower.requestToSpeakTimestamp`
`selfDeaf`	`public`	`boolean`	`ObjectToLower.selfDeaf`
`selfMute`	`public`	`boolean`	`ObjectToLower.selfMute`
`selfStream`	`public`	`undefined` \| `boolean`	`ObjectToLower.selfStream`
`selfVideo`	`public`	`boolean`	`ObjectToLower.selfVideo`
`sessionId`	`public`	`string`	`ObjectToLower.sessionId`
`suppress`	`public`	`boolean`	`ObjectToLower.suppress`
`userId`	`public`	`string`	`ObjectToLower.userId`

Methods

channel()

1
channel(force?: boolean): Promise<undefined | BaseChannel<ChannelType> | DMChannel | CategoryChannel>

Parameters

Parameter	Type
`force`?	`boolean`

Returns

Promise<undefined | BaseChannel<ChannelType> | DMChannel | CategoryChannel>

Source

seyfert/src/structures/VoiceState.ts:30

disconnect()

1
disconnect(reason?: string): Promise<GuildMember>

Parameters

Parameter	Type
`reason`?	`string`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/VoiceState.ts:49

isMuted()

1
isMuted(): boolean

Returns

boolean

Source

seyfert/src/structures/VoiceState.ts:18

member()

1
member(force?: boolean): Promise<GuildMember>

Parameters

Parameter	Type
`force`?	`boolean`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/VoiceState.ts:22

setChannel()

1
setChannel(channel_id: null | string, reason?: string): Promise<GuildMember>

Parameters

Parameter	Type
`channel_id`	`null` \| `string`
`reason`?	`string`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/VoiceState.ts:53

setDeaf()

1
setDeaf(deaf: boolean, reason?: string): Promise<GuildMember>

Parameters

Parameter	Type	Default value
`deaf`	`boolean`	`!this.deaf`
`reason`?	`string`	`undefined`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/VoiceState.ts:42

setMute()

1
setMute(mute: boolean, reason?: string): Promise<GuildMember>

Parameters

Parameter	Type	Default value
`mute`	`boolean`	`!this.mute`
`reason`?	`string`	`undefined`

Returns

Promise<GuildMember>

Source

seyfert/src/structures/VoiceState.ts:35

user()

1
user(force?: boolean): Promise<User>

Parameters

Parameter	Type
`force`?	`boolean`

Returns

Promise<User>

Source

seyfert/src/structures/VoiceState.ts:26