Fork me on GitHub
Show:

Params

Extends aeris.Model

Summary

Represents parameters to be included with a request to the Aeris API.

Constructor

aeris.api.params.models.Params

Syntax

aeris.api.params.models.Params

(
  • opt_options
)

Summary

Parameters:

Methods

addFilter

Syntax

addFilter

()

Summary

Add a filter Delegates to aeris.api.params.collections.FilterCollection#add

addQuery

Syntax

addQuery

(
  • query
  • opt_options
)

Summary

Add a query term to Aeris API request.

Parameters:

bindToApiKeys_

Syntax

bindToApiKeys_

() private

Summary

Bind client_id/secret params to global apiKey config.

getQuery

Syntax

getQuery

() ChainedQueries

Summary

Returns the query for the Aeris API request.

Returns:

proxyEventsForAttr_

Syntax

proxyEventsForAttr_

(
  • attr
)
private

Summary

Proxy events for a nested {aeris.Model|aeris.Collection} object.

Parameters:

  • attr String

    Attribute name of the nested object.

removeFilter

Syntax

removeFilter

()

Summary

Remove a filter.

Delegates to aeris.api.params.collections.FilterCollection#remove

removeQuery

Syntax

removeQuery

(
  • query
  • opt_options
)

Summary

Remove a query from the Aeris API request

Parameters:

resetFilter

Syntax

resetFilter

()

Summary

Resets the filters.

Delegates to aeris.api.params.collections.FilterCollection#reset

resetQuery

Syntax

resetQuery

(
  • opt_query
  • opt_options
)

Summary

Resets the query for the Aeris API request.

Parameters:

setBounds

Syntax

setBounds

(
  • bounds
)

Summary

Sets the bound limits within which to search for.

If null is passed, will remove the bounds limit parameter altogether.

Parameters:

toJSON

Syntax

toJSON

()

Summary

validate

Syntax

validate

()

Summary

Properties

FilterCollectionType_

Syntax

FilterCollectionType_

function():aeris.api.params.collections.FilterCollection private

Summary

QueryType_

Syntax

QueryType_

function():aeris.api.params.collections.ChainedQuery Constructor for query attribute object. private

Summary