Filter class sealed

A Filter represents a restriction on one or more field values and can be used to refine the results of a Query. Filterss are created by invoking Filter.where, Filter.or, or Filter.and and can then be passed to Query.where. to create a new Query instance that also contains this Filter.

Annotations

• @immutable

Constructors

Filter.and(List<Filter> filters)

Creates and returns a new Filter that is a conjunction of the given Filters. A conjunction filter includes a document if it satisfies all of the given Filters.

factory

Filter.or(List<Filter> filters)

Creates and returns a new Filter that is a disjunction of the given Filters. A disjunction filter includes a document if it satisfies any of the given Filters.

factory

Filter.where(Object fieldPath, WhereFilter op, Object? value)

Creates and returns a new Filter, which can be applied to Query.where, Filter.or or Filter.and. When applied to a Query it requires that documents must contain the specified field and that its value should satisfy the relation constraint provided.

factory

Filter.whereFieldPath(FieldPath fieldPath, WhereFilter op, Object? value)

Creates and returns a new Filter, which can be applied to Query.where, Filter.or or Filter.and. When applied to a Query it requires that documents must contain the specified field and that its value should satisfy the relation constraint provided.

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited