class

XIVAPI::Client

Inherits XIVAPI::Client::Servers < XIVAPI::Client::PvpTeam < XIVAPI::Client::Other < XIVAPI::Client::Linkshell < XIVAPI::Client::FreeCompany < XIVAPI::Client::Character < Reference < Object

When this file is required, include the Servers module to have access to the commands

Constructors

new(api_key : String = "", language : String = "en", staging : Bool = false)
Source

Instance methods

api_key

The api key for the client, can be changed while in use

Source
api_key=(api_key : String)

The api key for the client, can be changed while in use

Source
default_params

Return a Hash of the default parameters that should be added in every request. These are currently; api_key, language

Source
language

The current language being used as the default for the requests

Source
language=(language : String)

Set the language of the client by ensuring it's in the array of allowed languages

Source
staging

A flag stating whether or not requests should use the stage version of the API

Source
staging=(staging : Bool)

Set the staging value of the client. This method automatically updates the API url to the appropriate value

Source

Nested types