API Reference PlanetSide 2 API v1.0.0

View Source

Modules

PS2

Base module for :planetside_api. Provides convenience functions for world/server IDs and event names.

Functions for querying the Census API.

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

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

A data structure representing a tree on an API query. Create a tree using PS2.API.Query.Tree.new/1 functions.

A module for creating Census API queries in a clean manner via pipelines.

An Event Streaming Service (ESS) client behaviour.