class XIVAPI::Dataclasses::FreeCompanyResponse
- XIVAPI::Dataclasses::FreeCompanyResponse
 - Reference
 - Object
 
Overview
A class used to map out the response from the Free Company endpoint.
Defined in:
dataclasses/free_company/free_company_response.crConstructors
Instance Method Summary
- 
        #free_company : XIVAPI::Dataclasses::FreeCompany
        
          
A
FreeCompanyclass containing the information about the Free Company. - #free_company=(_free_company : FreeCompany)
 - 
        #free_company_members : Array(XIVAPI::Dataclasses::CharacterSummary)?
        
          
An Array of
CharacterSummaryclasss representing the Characters in the Free Company. - #free_company_members=(_free_company_members : ::Union(Array(CharacterSummary), Nil))
 - #to_json(json : JSON::Builder)
 
Constructor Detail
Instance Method Detail
        
        def free_company : XIVAPI::Dataclasses::FreeCompany
        #
      
      
        A FreeCompany class containing the information about the Free Company.
        
        def free_company_members : Array(XIVAPI::Dataclasses::CharacterSummary)?
        #
      
      
        An Array of CharacterSummary classs representing the Characters in the Free Company.
Will be nil unless the Free Company Members data (FCM) is requested, or if it is not yet in the system.