Client Framework API

Namespace: OrionAPI

OrionAPI

Functions used by starlets to use the API.

Source:

Methods

<static> getURL(objectName, callbackName, baseURL, parameters)

Returns the fully hashed API URL to your callback for you to use.

Parameters:
Name Type Argument Default Description
objectName String <optional>
 'window'

Namespace containing method.
callbackName String

Name of method.
baseURL String

Remote path to API method of choice.
parameters Object

Index of variables to include in query string.
Source:
Fires:
Example
var params = {};

params.foo  = 'bar';
params.spam = false;

OrionAPI.getURL('', 'apiURLCallback', '/api-v4/some_api_call', params);

function apiURLCallback(url)
{
   // url contains the fully hashed API URL ready to call.
}