Fork me on GitHub
Show:

Advisories

Summary

Constructor

aeris.api.collections.Advisories

Syntax

aeris.api.collections.Advisories

()

Summary

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.

Parameters:

addQuery

Syntax

addQuery

(
  • query
  • opt_options
)

Summary

Add a query term to Aeris API request.

Parameters:

applyClientFilters_

Syntax

applyClientFilters_

(
  • filterCollection
)
private

Summary

Parameters:

bindClientFilters_

Syntax

bindClientFilters_

() private

Summary

createSourceCollection_

Syntax

createSourceCollection_

(
  • opt_models
  • options
)
private

Summary

Parameters:

fetch

Syntax

fetch

() Promise

Summary

Fetch data from the Aeris API.

Returns:

Promise:

Resolves with API response.

getApiFilters_

Syntax

getApiFilters_

() FilterCollection private

Summary

Get the filters used to query the AerisAPI

Returns:

getParams

Syntax

getParams

() Params

Summary

Returns the params object used to fetch collection data.

Returns:

getQuery

Syntax

getQuery

() ChainedQueries

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.

Parameters:

removeQuery

Syntax

removeQuery

(
  • query
  • opt_options
)

Summary

Remove a query from the Aeris API request

Parameters:

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.

Parameters:

resetQuery

Syntax

resetQuery

(
  • opt_query
  • opt_options
)

Summary

Resets the query for the Aeris API request.

Parameters:

setBounds

Syntax

setBounds

(
  • bounds
)

Summary

Parameters:

setClientFilter

Syntax

setClientFilter

(
  • filter
  • opt_ctx
)

Summary

Apply a client-side filter to the collection.

Parameters:

setFrom

Syntax

setFrom

(
  • from
)

Summary

Parameters:

setLimit

Syntax

setLimit

(
  • limit
)

Summary

Parameters:

setParams

Syntax

setParams

(
  • key
  • value
)

Summary

Updates the requests params included with API requests.

Parameters:

  • key String|Object

    Param name. First argument can also. be a key: value hash.

  • value *

    Param value.

updateClientFilters_

Syntax

updateClientFilters_

() private

Summary

Events

'request'

Syntax

'request'

Summary

A request has been made to fetch data from the Aeris API.

Event Payload:

'sync'

Syntax

'sync'

Summary

The AerisAPI has responsed to a request, and the data object has updated with fetched data.

Event Payload: