AerisApiCollection
Summary
A data collection which creates Model objects from Aeris API response data.
See http://www.hamweather.com/support/documentation/aeris/ for Aeris API documentation.
Constructor
aeris.api.collections.AerisApiCollection
Syntax
aeris.api.collections.AerisApiCollection
-
opt_models
-
opt_options
Summary
Item Index
Methods
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:
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
parse
()
Summary
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.
serializeParams_
Syntax
Summary
Convert the model's Params object into a JSON data object.
Parameters:
-
params
Params
Returns:
setParams
Syntax
setParams
-
key
-
value
Summary
Updates the requests params included with API requests.
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
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_.
Events
'request'
Syntax
'request'
Summary
A request has been made to fetch data from the Aeris API.
Event Payload:
-
object
aeris.api.mixins.AerisApiBehaviorData object making the request.
-
promise
aeris.PromisePromise to fetch data. Resolves with raw data.
-
requestOptions
Object
'sync'
Syntax
'sync'
Summary
The AerisAPI has responsed to a request, and the data object has updated with fetched data.
Event Payload:
-
object
aeris.api.mixins.AerisApiBehaviorData object which made the request.
-
resp
ObjectRaw response data from the AerisAPI.
-
requestOptions
Object