ApplicationCommandPermissionsManager
ManagerOn this page
ApplicationCommandPermissionsManager is the cache and REST facade for ApplicationCommandPermissions objects owned by the parent. Typical calls are fetch, create, edit, delete, resolve, and resolveId.
Constructor
ApplicationCommandPermissionsManager.new(client, guild, command) The class table is callable, so ApplicationCommandPermissionsManager(client, guild, command) 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. |
command |
any |
required | Passed through to the implementation as written. |
local discord = require("discord")
local object = discord.ApplicationCommandPermissionsManager({}, {}, {})Properties
- Name
client- Type
any- Access
- readonly
- Description
- Owning Client instance used for REST, cache, and event dispatch.
- Availability
- Populated from the Gateway/REST payload or constructor for this ApplicationCommandPermissionsManager.
- Name
command- Type
any- Access
- readonly
- Description
- Instance field
ApplicationCommandPermissionsManager.command. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this ApplicationCommandPermissionsManager.
- Name
commandId- Type
any- Access
- readonly
- Description
- Instance field
ApplicationCommandPermissionsManager.commandId. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this ApplicationCommandPermissionsManager.
- Name
guild- Type
any- Access
- readonly
- Description
- Guild this ApplicationCommandPermissionsManager belongs to, when the payload included a guild id.
- Availability
- Populated from the Gateway/REST payload or constructor for this ApplicationCommandPermissionsManager.
Methods
ApplicationCommandPermissionsManager:add()
#Add an item to this ApplicationCommandPermissionsManager.
Signature
ApplicationCommandPermissionsManager:add(permissions, callback) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
permissions |
any |
required | Passed through to the implementation as written. |
callback |
function |
optional | Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error. |
Returns
ApplicationCommandPermissionsManager — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:add(permissions, function(err, result)
if err then error(err) end
end)ApplicationCommandPermissionsManager:applicationId()
#Performs application id on this ApplicationCommandPermissionsManager. Call it from bot code when you need that operation on the current object.
Signature
ApplicationCommandPermissionsManager:applicationId() Parameters
No parameters.
Returns
ApplicationCommandPermissionsManager — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:applicationId()ApplicationCommandPermissionsManager:fetch()
#Request a fresh copy of this resource from REST and update the cache.
Signature
ApplicationCommandPermissionsManager:fetch(commandId, callback) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
commandId |
string |
required | Snowflake id string. |
callback |
function |
optional | Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error. |
Returns
ApplicationCommandPermissionsManager — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:fetch("123", function(err, result)
if err then error(err) end
end)ApplicationCommandPermissionsManager:guildId()
#Performs guild id on this ApplicationCommandPermissionsManager. Call it from bot code when you need that operation on the current object.
Signature
ApplicationCommandPermissionsManager:guildId() Parameters
No parameters.
Returns
ApplicationCommandPermissionsManager — the same instance, for chaining.
Throws
A DiscordLua error when arguments are invalid or the request fails without a callback.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:guildId()ApplicationCommandPermissionsManager:has()
#Performs has on this ApplicationCommandPermissionsManager. Call it from bot code when you need that operation on the current object.
Signature
ApplicationCommandPermissionsManager:has(permissionId, callback) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
permissionId |
string |
required | Snowflake id string. |
callback |
function |
optional | Optional completion callback function(err, result). If omitted, failures raise a DiscordLua error. |
Returns
ApplicationCommandPermissionsManager — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:has("123", function(err, result)
if err then error(err) end
end)ApplicationCommandPermissionsManager:path()
#Performs path on this ApplicationCommandPermissionsManager. Call it from bot code when you need that operation on the current object.
Signature
ApplicationCommandPermissionsManager:path(commandId) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
commandId |
string |
required | Snowflake id string. |
Returns
ApplicationCommandPermissionsManager — the same instance, for chaining.
Throws
A DiscordLua error when arguments are invalid or the request fails without a callback.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:path("123")ApplicationCommandPermissionsManager:remove()
#Remove an item from this ApplicationCommandPermissionsManager.
Signature
ApplicationCommandPermissionsManager:remove(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
ApplicationCommandPermissionsManager — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:remove({}, function(err, result)
if err then error(err) end
end)ApplicationCommandPermissionsManager:set()
#Performs set on this ApplicationCommandPermissionsManager. Call it from bot code when you need that operation on the current object.
Signature
ApplicationCommandPermissionsManager:set(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
ApplicationCommandPermissionsManager — the same instance, for chaining.
Example
local discord = require("discord")
-- object is a ApplicationCommandPermissionsManager
object:set({}, function(err, result)
if err then error(err) end
end)Examples
local discord = require("discord")
local object = discord.ApplicationCommandPermissionsManager({})Related APIs
ApplicationCommandManager · ApplicationEmojiManager · AutoModerationRuleManager · BaseGuildEmojiManager · BaseManager · CachedManager · CategoryChannelChildManager · ChannelManager
Version: discord 1.2.4 · runtime 1.0.0