SimpleIdentifyThrottler

Class

On this page

SimpleIdentifyThrottler is a DiscordLua class representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

class Module 1.2.9 Source

Constructor

SimpleIdentifyThrottler.new(maxConcurrency)

The class table is callable, so SimpleIdentifyThrottler(maxConcurrency) is the same as .new.

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

lua

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

Properties

SimpleIdentifyThrottler.maxConcurrency

# readonly

Name: maxConcurrency
Type: any
Access: readonly
Description: Instance field SimpleIdentifyThrottler.maxConcurrency. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this SimpleIdentifyThrottler.

SimpleIdentifyThrottler.states

# readonly

Name: states
Type: Collection
Access: readonly
Description: Instance field SimpleIdentifyThrottler.states. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this SimpleIdentifyThrottler.
Related: Collection

Methods

SimpleIdentifyThrottler:waitForIdentify()

Performs wait for identify on this SimpleIdentifyThrottler. Call it from bot code when you need that operation on the current object.

Signature

SimpleIdentifyThrottler:waitForIdentify(shardId, signal)

Parameters

Name	Type	Required	Behavior
`shardId`	`string`	required	Snowflake id string.
`signal`	`any`	required	Passed through to the implementation as written.

Returns

SimpleIdentifyThrottler — 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 SimpleIdentifyThrottler
object:waitForIdentify("123", signal)

Examples

lua

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

ActionRow · Activity · ActivityInstance · ActivityLocation · AnonymousGuild · ApplicationCommand · ApplicationCommandNumericOptionMinMaxValueMixin · ApplicationCommandOptionBase

Version: discord 1.2.9 · runtime 1.0.0