Fork me on GitHub
Show:

Filter

Extends aeris.Model
Defined in: ../src/api/params/models/filter.js:7

Summary

Represents a single filter applied to a request to the Aeris API.

Constructor

aeris.api.params.models.Filter

Defined in ../src/api/params/models/filter.js:7

Syntax

aeris.api.params.models.Filter

(
  • opt_options
)

Summary

Parameters:

Item Index

Methods

Attributes

Methods

isAnd

Defined in ../src/api/params/models/filter.js:70

Syntax

isAnd

() Boolean

Summary

Returns:

Boolean:

Filter's operator is 'AND'.

isOr

Defined in ../src/api/params/models/filter.js:61

Syntax

isOr

() Boolean

Summary

Returns:

Boolean:

Filter's operator is 'OR'.

validate

Defined in ../src/api/params/models/filter.js:50

Syntax

validate

()

Summary

Attributes

name

Defined in ../src/api/params/models/filter.js:18

The name of the filter.

operator

Operator

Defined in ../src/api/params/models/filter.js:23

Operator to use when querying with multiple filters.

Note that the filter operator will be used before the filter name. Advanced order-of-operations in filter operators is not currently supported.

Default: {aeris.api.Operator.AND}