class XIVAPI::Dataclasses::CharacterResponse

Overview

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.

Defined in:

dataclasses/character/character_response.cr

Constructors

Instance Method Summary

Constructor Detail

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

Instance Method Detail

def achievements : XIVAPI::Dataclasses::Achievements? #

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


[View source]
def achievements=(_achievements : ::Union(Achievements, Nil)) #

def character : XIVAPI::Dataclasses::Character #

A CharacterData class containing the actual data about the Character.


[View source]
def character=(_character : Character) #

def free_company : XIVAPI::Dataclasses::FreeCompany? #

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.


[View source]
def free_company=(_free_company : ::Union(FreeCompany, Nil)) #

def free_company_members : Array(XIVAPI::Dataclasses::CharacterSummary)? #

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.


[View source]
def free_company_members=(_free_company_members : ::Union(Array(CharacterSummary), Nil)) #

def friends : Array(XIVAPI::Dataclasses::CharacterSummary)? #

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


[View source]
def friends=(_friends : ::Union(Array(CharacterSummary), Nil)) #

def pvp_team : XIVAPI::Dataclasses::PvpTeam? #

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.


[View source]
def pvp_team=(_pvp_team : ::Union(PvpTeam, Nil)) #

def to_json(json : JSON::Builder) #