PlanetSide 2 API

View Source PS2.API.Join (PlanetSide 2 API v0.3.5)

A data structure representing a join on an API query. Create a join using %PS2.API.Join{} or the new/0 or new/1 functions.

Link to this section Summary

Types

opts()
t()

Functions

new()
new(opts)

Link to this section Types

Link to this type

opts()

View Source

Specs

opts() :: [
  collection: String.t(),
  on: String.t(),
  to: String.t(),
  list: boolean(),
  show: [term()],
  hide: [term()],
  inject_at: String.t(),
  outer: boolean()
]
Link to this type

t()

View Source

Specs

t() :: %PS2.API.Join{collection: String.t() | nil, joins: [t()], params: map()}

Link to this section Functions

Link to this function

new()

View Source

Specs

new() :: t()
Link to this function

new(opts)

View Source

Specs

new(opts()) :: t()