Advisories
Summary
Constructor
aeris.api.collections.Advisories
Syntax
aeris.api.collections.Advisories
()
Summary
Item Index
Methods
Methods
addFilter
Syntax
addFilter
-
filter
-
opt_options
Summary
Add a filter to the Aeris API request. Filters will also be applied client-side, if possible.
addQuery
Syntax
addQuery
-
query
-
opt_options
Summary
Add a query term to Aeris API request.
applyClientFilters_
Syntax
applyClientFilters_
-
filterCollection
Summary
Parameters:
-
filterCollection
FilterCollection
bindClientFilters_
Syntax
bindClientFilters_
()
private
Summary
createSourceCollection_
Syntax
createSourceCollection_
-
opt_models
-
options
Summary
Parameters:
-
opt_models
Array.<Model> -
options
Object=Options to pass to the source collection.
-
SourceCollectionType
function():AerisApiCollectionsource collection constructor.
-
getApiFilters_
Syntax
Summary
Get the filters used to query the AerisAPI
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:
removeClientFilter
Syntax
removeClientFilter
()
Summary
Remove all client-side filters from the collection.
removeClientLimit
Syntax
removeClientLimit
()
Summary
removeFilter
Syntax
removeFilter
-
filter
-
opt_options
Summary
Remove a filter from the Aeris API request. Filters will also be applied client-side, if possible.
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. Filters will also be applied client-side, if possible.
resetQuery
Syntax
resetQuery
-
opt_query
-
opt_options
Summary
Resets the query for the Aeris API request.
setClientFilter
Syntax
setClientFilter
-
filter
-
opt_ctx
Summary
Apply a client-side filter to the collection.
setParams
Syntax
setParams
-
key
-
value
Summary
Updates the requests params included with API requests.
updateClientFilters_
Syntax
updateClientFilters_
()
private
Summary
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