Fork me on GitHub
Show:

Filter

Extends aeris.Model

Summary

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

Constructor

aeris.api.params.models.Filter

Syntax

aeris.api.params.models.Filter

(
  • opt_options
)

Summary

Parameters:

Item Index

Methods

Attributes

Methods

isAnd

Syntax

isAnd

() Boolean

Summary

Returns:

Boolean:

Filter's operator is 'AND'.

isOr

Syntax

isOr

() Boolean

Summary

Returns:

Boolean:

Filter's operator is 'OR'.

validate

Syntax

validate

()

Summary

Attributes

name

The name of the filter.

operator

Operator

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}