class

XIVAPI::Dataclasses::CharacterResponse

Inherits JSON::Serializable < Reference < Object

A class used to map out the response from the Character endpoint. Currently, this class contains the entire data using the extended=1 flag, but columns are still specifiable for the requests.

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

achievements

An Achievements class containing all of the Character's Achievements data. Will be nil unless the Achievements data (AC) is requested.

Source

character

A CharacterData class containing the actual data about the Character.

Source

free_company

A FreeCompany class representing the Character's Free Company. Will be nil unless the Free Company data (FC) is requested, or if it is not yet in the system.

Source

free_company_members

An Array of CharacterSummary classs with details about the members of the Character's Free Company. Will be nil unless the Free Company Members data (FCM) is requested, or if it is not yet in the system.

Source

friends

An Array of CharacterSummary classs with details about the Character's friends. Will be nil unless the Friends List data (FR) is requested.

Source

minions

An array of MinionMount classes representing minions owned Will be nil unless the Minion & Mount data (MIMO) is requested.

Source

mounts

An array of MinionMount classes representing mounts owned Will be nil unless the Minion & Mount data (MIMO) is requested.

Source

pvp_team

A PvpTeam class representing the Character's PVP Team. Will be nil unless the PVP Team data (PVP) is requested, or if it is not yet in the system.

Source