VoiceStateManager

Manager

On this page

VoiceStateManager is the cache and REST facade for VoiceState objects owned by the parent. Typical calls are fetch, create, edit, delete, resolve, and resolveId.

manager Module 1.2.4 Source

Constructor

VoiceStateManager.new(client, guild)

The class table is callable, so VoiceStateManager(client, guild) is the same as .new.

Name	Type	Required	Behavior
`client`	`any`	required	Passed through to the implementation as written.
`guild`	`any`	required	Passed through to the implementation as written.

lua

local discord = require("discord")
local object = discord.VoiceStateManager({}, {})

Properties

VoiceStateManager.guild

# readonly

Name: guild
Type: any
Access: readonly
Description: Guild this VoiceStateManager belongs to, when the payload included a guild id.
Availability: Populated from the Gateway/REST payload or constructor for this VoiceStateManager.

Methods

VoiceStateManager:fetch()

Request a fresh copy of this resource from REST and update the cache.

Signature

VoiceStateManager:fetch(userId, options, callback)

Parameters

Name	Type	Required	Behavior
`userId`	`string`	required	Snowflake id string.
`options`	`table`	optional	Lua option table. Field names match the corresponding DiscordLua option type when one exists.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

VoiceStateManager — the same instance, for chaining.

Throws

A DiscordLua error when arguments are invalid or the request fails without a callback.

Example

lua

local discord = require("discord")
-- object is a VoiceStateManager
object:fetch("123", {}, function(err, result)
    if err then error(err) end
end)

Examples

lua

local discord = require("discord")
local object = discord.VoiceStateManager({})

ApplicationCommandManager · ApplicationCommandPermissionsManager · ApplicationEmojiManager · AutoModerationRuleManager · BaseGuildEmojiManager · BaseManager · CachedManager · CategoryChannelChildManager

Version: discord 1.2.4 · runtime 1.0.0