View Source PS2.API.Query (PlanetSide 2 API v0.3.1)
A data structure representing an API query. Create a struct using %PS2.API.Query{} or the new/0 or new/1 functions.
Link to this section Summary
Types
The key of a term is the field name, and the value is the sort direction. Set the value to nil
for the default sort direction.
Link to this section Types
Specs
opts() :: [{:collection, String.t()}]
Specs
The key of a term is the field name, and the value is the sort direction. Set the value to nil
for the default sort direction.
Specs
t() :: %PS2.API.Query{ collection: String.t() | nil, joins: [PS2.API.Join.t()], params: map(), sort: sort_terms() | nil, tree: PS2.API.Tree.t() | nil }
Link to this section Functions
Specs
new() :: t()