GuildVoiceStateManager
GuildVoiceStateManager ⇐ VoiceStateManager
Section titled “GuildVoiceStateManager ⇐ VoiceStateManager”Represents a voice state manager for a specific guild.
Kind: global class
Extends: VoiceStateManager
- GuildVoiceStateManager ⇐
VoiceStateManager- new GuildVoiceStateManager(guildId, client)
- .cache ⇒
Array - .edit(user, [options]) ⇒
Promise.<void>
new GuildVoiceStateManager(guildId, client)
Section titled “new GuildVoiceStateManager(guildId, client)”Constructs a new instance of the class.
| Param | Type | Description |
|---|---|---|
| guildId | string | The ID of the guild. |
| client | Client | The client instance. |
guildVoiceStateManager.cache ⇒ Array
Section titled “guildVoiceStateManager.cache ⇒ Array”Retrieves the cache for the current guild.
Kind: instance property of GuildVoiceStateManager
Returns: Array - An array of objects from the cache that belong to the current guild.
guildVoiceStateManager.edit(user, [options]) ⇒ Promise.<void>
Section titled “guildVoiceStateManager.edit(user, [options]) ⇒ Promise.<void>”Edits the voice state of a user in a guild.
Kind: instance method of GuildVoiceStateManager
Returns: Promise.<void> - A promise that resolves when the voice state is successfully edited.
| Param | Type | Description |
|---|---|---|
| user | string | User | The user or user ID to edit the voice state for. |
| [options] | Object | The options for editing the voice state. |
| [options.channel] | string | Channel | The channel or channel ID to move the user to. |
| [options.suppress] | boolean | Whether to suppress the user’s audio. |
| [options.requestToSpeak] | Date | The timestamp for the user’s request to speak. |