class XIVAPI::Dataclasses::Exception

Overview

Dataclass for Exceptions returned from the API. This class will be used to generate custom exception instances.

#debug : JSON::Any
Extra arbitrary data that helps the API devs understand bugs.
#debug=(_debug : JSON::Any)
#error : Bool
A flag stating if the exception was an error or not.
#error=(_error : Bool)
#exception_type : String
The name of the exception that was thrown.
#exception_type=(_exception_type : String)
#hash : String
A sha1 trackable hash of the exception.
#hash=(_hash : String)
#message : String
The exception message from the API.
#message=(_message : String)
#subject : String
String indicating the type of exception that was received.
#subject=(_subject : String)
#to_json(json : JSON::Builder)

def self.new(__temp_27 : JSON::PullParser) #

def debug : JSON::Any #

Extra arbitrary data that helps the API devs understand bugs. Do not code against this classure as it can change at any time.

[View source]

def debug=(_debug : JSON::Any) #

def error : Bool #

A flag stating if the exception was an error or not.

[View source]

def error=(_error : Bool) #

def exception_type : String #

The name of the exception that was thrown.

[View source]

def exception_type=(_exception_type : String) #

def hash : String #

A sha1 trackable hash of the exception.

[View source]

def hash=(_hash : String) #

def message : String #

The exception message from the API.

[View source]

def message=(_message : String) #

def subject : String #

String indicating the type of exception that was received.

[View source]

def subject=(_subject : String) #

def to_json(json : JSON::Builder) #