Fork me on GitHub
Show:

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

Parameters:

  • opt_models Object=
  • opt_options Object=
    • endpoint String=

      Aeris API endpoint.

    • params Object|Model=

      Parameters with which to query the Aeris API.

    • server String=

      The Aeris API server location.

    • JSONP JSONP=

      object used for fetching batch data.

Methods

addFilter

Syntax

addFilter

(
  • filter
  • opt_options
)

Summary

Add a filter to the Aeris API request.

Parameters:

addQuery

Syntax

addQuery

(
  • query
  • opt_options
)

Summary

Add a query term to Aeris API request.

Parameters:

createErrorFromResponse_

Syntax

createErrorFromResponse_

(
  • response
)
Error protected

Summary

Parameters:

Returns:

createParams_

Syntax

createParams_

(
  • opt_params
)
Params protected

Summary

Parameters:

Returns:

fetch

Syntax

fetch

() Promise

Summary

Fetch data from the Aeris API.

Returns:

Promise:

Resolves with API response.

getAction

Syntax

getAction

() String

Summary

Returns:

getEndpoint

Syntax

getEndpoint

() String

Summary

Returns:

getEndpointUrl_

Syntax

getEndpointUrl_

() String protected

Summary

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:

parse

Syntax

parse

()

Summary

removeFilter

Syntax

removeFilter

(
  • filter
  • opt_options
)

Summary

Remove a filter from the Aeris API request.

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.

Parameters:

resetQuery

Syntax

resetQuery

(
  • opt_query
  • opt_options
)

Summary

Resets the query for the Aeris API request.

Parameters:

serializeParams_

Syntax

serializeParams_

(
  • params
)
Object protected

Summary

Convert the model's Params object into a JSON data object.

Parameters:

Returns:

setAction

Syntax

setAction

(
  • action
)

Summary

Parameters:

setBounds

Syntax

setBounds

(
  • bounds
)

Summary

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.

setTo

Syntax

setTo

(
  • to
)

Summary

Parameters:

sync

Syntax

sync

() Promise protected

Summary

Overrides Backbone.sync to introduce logic for fetching data from the Aeris API

Note that the AerisAPI is read-only.

Returns:

Promise:

Resolves with response data.

Properties

endpoint_

Syntax

endpoint_

String private

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_.

server_

Syntax

server_

String private

Summary

Location of the Aeris API server.

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: