GuildMemberManager

Manager

On this page

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

manager Module 1.2.4 Source

Constructor

GuildMemberManager.new(client, guild)

The class table is callable, so GuildMemberManager(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.GuildMemberManager({}, {})

Properties

GuildMemberManager.guild

# readonly

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

Methods

GuildMemberManager:add()

Add an item to this GuildMemberManager.

Signature

GuildMemberManager:add(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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:addRole()

Add Role to this GuildMemberManager.

Signature

GuildMemberManager:addRole(userId, roleId, reason, callback)

Parameters

Name	Type	Required	Behavior
`userId`	`string`	required	Snowflake id string.
`roleId`	`string`	required	Snowflake id string.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:addRole("123", "123", reason, function(err, result)
    if err then error(err) end
end)

GuildMemberManager:ban()

Performs ban on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:ban(id, options, callback)

Parameters

Name	Type	Required	Behavior
`id`	`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:bulkBan()

Performs bulk ban on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:bulkBan(options, callback)

Parameters

Name	Type	Required	Behavior
`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:edit()

Apply a REST update to this resource.

Signature

GuildMemberManager:edit(id, options, callback)

Parameters

Name	Type	Required	Behavior
`id`	`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:editMe()

Apply a REST update to Me and refresh the local object when the request succeeds.

Signature

GuildMemberManager:editMe(options, callback)

Parameters

Name	Type	Required	Behavior
`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:fetch()

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

Signature

GuildMemberManager:fetch(id, callback)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:fetchMe()

Fetch Me from REST and update the local cache when the request succeeds.

Signature

GuildMemberManager:fetchMe(callback)

Parameters

Name	Type	Required	Behavior
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:fetchMe(function(err, result)
    if err then error(err) end
end)

GuildMemberManager:kick()

Performs kick on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:kick(id, reason, callback)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:kick("123", reason, function(err, result)
    if err then error(err) end
end)

GuildMemberManager:list()

Performs list on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:list(options, callback)

Parameters

Name	Type	Required	Behavior
`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:me()

Performs me on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:me()

Parameters

No parameters.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:me()

GuildMemberManager:prune()

Performs prune on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:prune(options, callback)

Parameters

Name	Type	Required	Behavior
`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:removeRole()

Remove Role from this GuildMemberManager.

Signature

GuildMemberManager:removeRole(userId, roleId, reason, callback)

Parameters

Name	Type	Required	Behavior
`userId`	`string`	required	Snowflake id string.
`roleId`	`string`	required	Snowflake id string.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:removeRole("123", "123", reason, function(err, result)
    if err then error(err) end
end)

GuildMemberManager:removeTimeout()

Remove Timeout from this GuildMemberManager.

Signature

GuildMemberManager:removeTimeout(id, reason, callback)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:removeTimeout("123", reason, function(err, result)
    if err then error(err) end
end)

GuildMemberManager:search()

Performs search on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:search(options, callback)

Parameters

Name	Type	Required	Behavior
`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

GuildMemberManager — the same instance, for chaining.

Example

lua

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

GuildMemberManager:setNickname()

Set the Nickname field. Builders return this GuildMemberManager so setters can be chained.

Signature

GuildMemberManager:setNickname(id, nick, reason, callback)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.
`nick`	`any`	required	Passed through to the implementation as written.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:setNickname("123", nick, reason, function(err, result)
    if err then error(err) end
end)

GuildMemberManager:timeout()

Performs timeout on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:timeout(id, duration, reason, callback)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.
`duration`	`any`	required	Passed through to the implementation as written.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — 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 GuildMemberManager
object:timeout("123", duration, reason, function(err, result)
    if err then error(err) end
end)

GuildMemberManager:unban()

Performs unban on this GuildMemberManager. Call it from bot code when you need that operation on the current object.

Signature

GuildMemberManager:unban(id, reason, callback)

Parameters

Name	Type	Required	Behavior
`id`	`string`	required	Snowflake id string.
`reason`	`string`	optional	Audit-log reason sent as `X-Audit-Log-Reason` on REST mutations.
`callback`	`function`	optional	Optional completion callback `function(err, result)`. If omitted, failures raise a DiscordLua error.

Returns

GuildMemberManager — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a GuildMemberManager
object:unban("123", reason, function(err, result)
    if err then error(err) end
end)

Static members

GuildMemberManager.GuildMemberEditMeOptions

Examples

lua

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

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

Version: discord 1.2.4 · runtime 1.0.0