RateLimitError
ErrorOn this page
RateLimitError 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.
Constructor
RateLimitError.new(message, extra) The class table is callable, so RateLimitError(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. |
local discord = require("discord")
local object = discord.RateLimitError({}, {})Properties
- Name
global- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.global. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
hash- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.hash. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
limit- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.limit. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
majorParameter- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.majorParameter. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
method- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.method. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
retryAfter- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.retryAfter. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
route- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.route. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
scope- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.scope. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
sublimitTimeout- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.sublimitTimeout. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
timeToReset- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.timeToReset. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
- Name
url- Type
any- Access
- readonly
- Description
- Instance field
RateLimitError.url. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RateLimitError.
Examples
local discord = require("discord")
local object = discord.RateLimitError({})Related APIs
AuthenticationError · DiscordAPIError · DiscordjsError · DiscordjsRangeError · DiscordjsTypeError · DiscordLuaError · GatewayError · GatewayRateLimitError
Version: discord 1.2.9 · runtime 1.0.0