AerisBatchModel
Summary
Represents data from multiple Aeris API endpoints combined into a single model.
Note that AerisBatchModel does not currently support per-model actions or queries.
Constructor
Item Index
Methods
- addFilter
- addQuery
- createErrorFromResponse_
- createParams_
- encodeModelParams_
- encodeParamsString_
- fetch
- getAction
- getApiKeyParams_
- getEncodedEndpoints_
- getEndpoint
- getEndpointUrl_
- getNestedModels_
- getParams
- getQuery
- isModel_
- isSuccessResponse_
- parse
- removeApiKeysFromParams_
- removeFilter
- removeQuery
- resetFilter
- resetQuery
- serializeParams_
- setAction
- setBounds
- setFrom
- setLimit
- setParams
- setTo
- sync
- testFilter
- testFilterCollection
- toJSON
- updateModelWithResponseData_
Methods
addFilter
Syntax
addFilter
-
filter -
opt_options
Summary
Add a filter to the Aeris API request.
addQuery
Syntax
addQuery
-
query -
opt_options
Summary
Add a query term to Aeris API request.
createParams_
Syntax
Summary
Returns:
encodeModelParams_
Syntax
Summary
Parameters:
-
modelAerisApiModel
Returns:
Encoded model params.
encodeParamsString_
Syntax
encodeParamsString_
()
private
Summary
getApiKeyParams_
Syntax
Summary
Find the Aeris client_id and client_secret params by searching through component models.
Returns:
getNestedModels_
Syntax
Summary
Return component models, which are attributes of the batch model.
Returns:
getParams
Syntax
Summary
Returns the params object used to fetch collection data.
Returns:
getQuery
Syntax
Summary
Returns the query for the Aeris API request.
Returns:
parse
Syntax
Summary
Sets batch response data onto nested models
Parameters:
-
rawObjectRaw response data.
Returns:
removeApiKeysFromParams_
Syntax
removeApiKeysFromParams_
-
serializedParams
Summary
It is likely that each model contains idential client_id/client_secret params. This will result in the params being serialized into the query string for every model.
For batch queries with many model, this could potentially exceed the url limit.
Parameters:
-
serializedParamsObject
removeFilter
Syntax
removeFilter
-
filter -
opt_options
Summary
Remove a filter from the Aeris API request.
removeQuery
Syntax
removeQuery
-
query -
opt_options
Summary
Remove a query from the Aeris API request
resetFilter
Syntax
resetFilter
-
opt_filter -
opt_options
Summary
Reset a filter from the Aeris API request.
resetQuery
Syntax
resetQuery
-
opt_query -
opt_options
Summary
Resets the query for the Aeris API request.
setParams
Syntax
setParams
-
key -
value
Summary
Updates the requests params included with API requests.
sync
Syntax
Summary
Overrides Backbone.sync to introduce logic for fetching data from the Aeris API
Note that the AerisAPI is read-only.
Returns:
Resolves with response data.
testFilter
Syntax
Summary
Tests whether a model is passing an Aeris API filter.
Parameters:
-
filterString
Returns:
testFilterCollection
Syntax
Summary
Tests whether a model is passing a set of Aeris API filters.
Parameters:
-
filtersFilterCollection
Returns:
updateModelWithResponseData_
Syntax
updateModelWithResponseData_
-
model -
data
Summary
Parameters:
-
modelAerisApiModel -
dataObjectResponse data
Properties
action_
Syntax
endpoint_
Syntax
Summary
Aeris API Endpoints from which to request data.
See http://www.hamweather.com/support/documentation/aeris/endpoints/ for available endpoints, actions, and parameters.
jsonp_
Syntax
jsonp_
aeris.JSONP
private
Summary
The JSONP utility for fetching AerisApi data.
modelsInOrder_
Syntax
modelsInOrder_
Array.Summary
A list of nested models, in the order of the last API requests.
params_
Syntax
params_
aeris.api.params.models.Params | Object
Will be converted to Params instance, if passed in as a plain object.
protected
Summary
Parameters to include with the batch request.
Note that parameters can also be attached to individual endpoints defined in this.endpoints_.
server_
Syntax
Summary
The locatin of the aeris API server.
Default: 'http://api.aerisapi.com'
Events
'request'
Syntax
'request'
Summary
A request has been made to fetch data from the Aeris API.
Event Payload:
-
objectaeris.api.mixins.AerisApiBehaviorData object making the request.
-
promiseaeris.PromisePromise to fetch data. Resolves with raw data.
-
requestOptionsObject
'sync'
Syntax
'sync'
Summary
The AerisAPI has responsed to a request, and the data object has updated with fetched data.
Event Payload:
-
objectaeris.api.mixins.AerisApiBehaviorData object which made the request.
-
respObjectRaw response data from the AerisAPI.
-
requestOptionsObject