Global

Type Definitions

ApiCaller

Object from proxyClient which allows direct API calls
Type:
Source:

ApiCallerFunction(paramsopt, filtersopt) → {Promise.<QueryResult>}

Parameters:
Name Type Attributes Default Description
params Object.<String, *> <optional>
 {} Call params
filters APIFilter <optional>
 {} All filters you want on your query result
Properties
Name Type Attributes Default Description
itemsFilter Array.<String> <optional>
 [] Filter on items sent by the server
contextFilter Array.<String> <optional>
 [] Filter on context sent by the server
Source:
Returns:
The query result
Type
Promise.<QueryResult>

APIFilter

API Filters
Type:
  • Object
Properties:
Name Type Description
itemsFilter Array.<String> Filter on items sent by the server
contextFilter Array.<String> Filter on context sent by the server
Source:

QueryResult

Query result
Type:
  • Object
Properties:
Name Type Attributes Description
context Object.<String, *> reply context
items Object.<String, *> <optional>
 reply items
Source:

Token

Token info
Type:
  • Object
Properties:
Name Type Description
token string Token public
secret string Token secret
Source:

UROAuthProxyClient

This object allows to call API with javascript functions instead of passing call name as string. For example, instead of doing `urOAuth.query('collections.getCollectionPage', { deckOnly: true })`, you can do `urOAuth.proxyClient.collections.getCollectionPage({ deckOnly: true })` The parameters are the same as query parameters following the call name since the function uses proxies and bind. The function still returns a promise. Please note as well that since proxies are used, you need to have an environment which supports it. For node.js, you need node.js 6+. If you use it with a previous version, even with babel, it will likely fail.
Type:
  • Object
Properties:
Name Type Description
characters ApiCaller Characters API
collections ApiCaller Collections API
forums ApiCaller Forums API
general ApiCaller General API
guilds ApiCaller Guilds API
market ApiCaller Market API
missions ApiCaller Missions API
players ApiCaller Players API
Source: