Members
SETTINGS
settings for the SDK. Defaults can be found in the config.json file in root of repo.
- Source:
Type Definitions
collectionCallback(error, items, meta, response)
A callback passed a collection of items such as traffic updates
Parameters:
| Name |
Type |
Description |
error |
Error
|
error object |
items |
Array
|
an array of targetted items |
meta |
Object
|
meta data concerning the data |
response |
Object
|
the original response object |
- Source:
Endpoint
Type:
- Source:
itemCallback(error, item, meta, response)
A callack passed a single items
Parameters:
| Name |
Type |
Description |
error |
Error
|
|
item |
Object
|
|
meta |
Object
|
|
response |
Object
|
|
- Source:
itemsGetOneRequest(identifier, paramsopt, callback)
Parameters:
| Name |
Type |
Attributes |
Description |
identifier |
Number
|
Object
|
|
|
params |
Object
|
<optional>
|
|
callback |
itemCallback
|
|
|
- Source:
itemsGetRequest(paramsopt, callback)
Parameters:
- Source:
itemsPostOneRequest(body, callback)
Parameters:
- Source:
SSEClientFactory(initDict) → {EventSource}
Parameters:
| Name |
Type |
Description |
initDict |
Object
|
|
- Source:
Returns:
-
Type
-
EventSource
successCallback(error, indicator, meta, response)
A callack passed a success indicator
Parameters:
| Name |
Type |
Description |
error |
Error
|
|
indicator |
Object
|
|
meta |
Object
|
|
response |
Object
|
|
- Source: