module XIVAPI::Client::Other

Direct including types

• XIVAPI::Client

Defined in:

Constant Summary

SEARCH_ALGORITHMS = Set {"custom", "wildcard", "wildcard_plus", "fuzzy", "term", "prefix", "match", "match_phrase", "match_phrase_prefix", "multi_match"}

A Set of Strings representing the allowed values for string_algo for the Search endpoint. The default is wildcard, and providing an invalid value to the search method will revert back to this value.

SEARCH_INDEXES = Set {"achievement", "title", "action", "craftaction", "trait", "pvpaction", "pvptrait", "status", "bnpcname", "enpcresident", "companion", "mount", "leve", "emote", "instancecontent", "item", "recipe", "fate", "quest", "balloon", "buddyequip", "orchestrion", "placename", "weather", "world", "lore_finder"}

A Set of Strings representing the allowed values for indexes for the Search endpoint. These are not case sensitive as far as I am aware.

SEARCH_SORT_ORDERS = Set {"asc", "desc"}

A Set of Strings representing the allowed values for sort_order for the Search endpoint. The default is asc, and providing an invalid value to the search method will revert back to this value.

Instance Method Summary

• #content : Array(String)

  Retrieve an Array of all of the available content that is accessible in the API.

• #list_game_data(index : String, page : Int32 = 1, limit : Int32 = 100, ids : Array(Int32) = [] of Int32) : XIVAPI::Dataclasses::Page(Dataclasses::IDIconNameUrl)

  List ids of game data of a specific category

• #lore(string : String = "", string_algo : String = "wildcard", string_column : String = "", filters : Array(String) = [] of String, indexes : Array(String) = [] of String, sort_field : String = "", sort_order : String = "asc", page : Int32 = 1, limit : Int32 = 50, include_data : Bool = false) : XIVAPI::Dataclasses::Page(Dataclasses::Lore)

  Search the API for Lore entries.

• #patch_list : Array(Dataclasses::Patch)

  Retrieve an Array of Patch structs, providing data on each game patch XIV has had.

• #read_game_data(index : String, id : Int32) : JSON::Any

  Retrieve a JSON::Any object of the game data with the given ID

• #search(string : String = "", string_algo : String = "wildcard", string_column : String = "", filters : Array(String) = [] of String, indexes : Array(String) = [] of String, sort_field : String = "", sort_order : String = "asc", page : Int32 = 1, limit : Int32 = 50) : XIVAPI::Dataclasses::Page(Dataclasses::SearchResult)

  Search the API for anything you need.

Instance Method Detail