RuntimeError
ErrorOn this page
RuntimeError 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
RuntimeError.new(message, extra) The class table is callable, so RuntimeError(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.RuntimeError({}, {})Properties
- Name
code- Type
number- Access
- readonly
- Description
- Instance field
RuntimeError.code. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RuntimeError.
- Name
extra- Type
table- Access
- readonly
- Description
- Instance field
RuntimeError.extra. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RuntimeError.
- Name
message- Type
string- Access
- readonly
- Description
- Instance field
RuntimeError.message. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RuntimeError.
- Name
method- Type
string- Access
- readonly
- Description
- Instance field
RuntimeError.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 RuntimeError.
- Name
name- Type
string- Access
- readonly
- Description
- Display name of this RuntimeError.
- Availability
- Populated from the Gateway/REST payload or constructor for this RuntimeError.
- Name
path- Type
string- Access
- readonly
- Description
- Instance field
RuntimeError.path. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RuntimeError.
- Name
retryAfter- Type
number- Access
- readonly
- Description
- Instance field
RuntimeError.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 RuntimeError.
- Name
status- Type
number- Access
- readonly
- Description
- Instance field
RuntimeError.status. Read it after the object is constructed or wrapped from Gateway/REST data. - Availability
- Populated from the Gateway/REST payload or constructor for this RuntimeError.
Methods
Performs new on this RuntimeError. Call it from bot code when you need that operation on the current object.
Signature
RuntimeError.new(message, extra) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
message |
any |
required | Passed through to the implementation as written. |
extra |
any |
optional | Passed through to the implementation as written. |
Returns
any.
Example
local discord = require("discord")
-- object is a RuntimeError
RuntimeError.new(message, extra)RuntimeError:raise()
#Performs raise on this RuntimeError. Call it from bot code when you need that operation on the current object.
Signature
RuntimeError:raise(level) Parameters
| Name | Type | Required | Behavior |
|---|---|---|---|
level |
any |
required | Passed through to the implementation as written. |
Returns
any.
Throws
A DiscordLua error when arguments are invalid or the request fails without a callback.
Example
local discord = require("discord")
-- object is a RuntimeError
object:raise(level)Examples
local discord = require("discord")
local object = discord.RuntimeError({})Related APIs
APIError · AuthenticationError · DiscordLuaError · GatewayError · HTTPError · PermissionError · RateLimitError · ValidationError
Version: discord 1.2.4 · runtime 1.0.0