GatewayRateLimitError

Error

On this page

GatewayRateLimitError is raised or passed to a REST callback when an operation fails. Read name and message; REST errors may also expose HTTP status and Discord error codes.

error Module 1.2.9 Source

Constructor

GatewayRateLimitError.new(message, extra)

The class table is callable, so GatewayRateLimitError(message, extra) is the same as .new.

Name	Type	Required	Behavior
`message`	`any`	required	Passed through to the implementation as written.
`extra`	`any`	optional	Passed through to the implementation as written.

lua

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

Properties

GatewayRateLimitError.data

# readonly

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

GatewayRateLimitError.payload

# readonly

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

Examples

lua

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

AuthenticationError · DiscordAPIError · DiscordjsError · DiscordjsRangeError · DiscordjsTypeError · DiscordLuaError · GatewayError · HTTPError

Version: discord 1.2.9 · runtime 1.0.0