Firestore API - Class Filter (3.7.0)

public abstract class Filter : IEquatable<Filter>

Reference documentation and code samples for the Firestore API class Filter.

A holder for any type of filter.

Inheritance

object > Filter

Implements

IEquatable Filter

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Methods

And(params Filter[])

public static Filter And(params Filter[] filters)

Creates a composite filter which is the logical "AND" of all the specified filters.

Parameter
Name	Description
`filters`	`Filter` Set of filters to combine. Must not be null or empty, or contain null references.

Returns
Type	Description
`Filter`	A filter representing the logical "AND" of all the elements in `filters`.

And(IEnumerable<Filter>)

public static Filter And(IEnumerable<Filter> filters)

Creates a composite filter which is the logical "AND" of all the specified filters.

Parameter
Name	Description
`filters`	`IEnumerableFilter` Set of filters to combine. Must not be null or empty, or contain null references.

Returns
Type	Description
`Filter`	A filter representing the logical "AND" of all the elements in `filters`.

ArrayContains(FieldPath, object)

public static Filter ArrayContains(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be an array containing value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

ArrayContains(string, object)

public static Filter ArrayContains(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be an array containing value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

ArrayContainsAny(FieldPath, IEnumerable)

public static Filter ArrayContainsAny(FieldPath fieldPath, IEnumerable values)

Returns a filter specifying that fieldPath must be a field present in the document, with a value which is an array containing at least one value in values.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`values`	`IEnumerable`

Returns
Type	Description
`Filter`

ArrayContainsAny(string, IEnumerable)

public static Filter ArrayContainsAny(string fieldPath, IEnumerable values)

Returns a filter specifying that fieldPath must be a field present in the document, with a value which is an array containing at least one value in values.

Parameters
Name	Description
`fieldPath`	`string`
`values`	`IEnumerable`

Returns
Type	Description
`Filter`

EqualTo(FieldPath, object)

public static Filter EqualTo(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be equal to value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

EqualTo(string, object)

public static Filter EqualTo(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be equal to value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

GreaterThan(FieldPath, object)

public static Filter GreaterThan(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be greater than value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

GreaterThan(string, object)

public static Filter GreaterThan(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be greater than value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

GreaterThanOrEqualTo(FieldPath, object)

public static Filter GreaterThanOrEqualTo(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be greater than or equal to value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

GreaterThanOrEqualTo(string, object)

public static Filter GreaterThanOrEqualTo(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be greater than or equal to value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

InArray(FieldPath, IEnumerable)

public static Filter InArray(FieldPath fieldPath, IEnumerable values)

Returns a filter specifying that fieldPath must be a field present in the document, with a value which is one of the values in values.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`values`	`IEnumerable`

Returns
Type	Description
`Filter`

InArray(string, IEnumerable)

public static Filter InArray(string fieldPath, IEnumerable values)

Returns a filter specifying that fieldPath must be a field present in the document, with a value which is one of the values in values.

Parameters
Name	Description
`fieldPath`	`string`
`values`	`IEnumerable`

Returns
Type	Description
`Filter`

LessThan(FieldPath, object)

public static Filter LessThan(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be less than value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

LessThan(string, object)

public static Filter LessThan(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be less than value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

LessThanOrEqualTo(FieldPath, object)

public static Filter LessThanOrEqualTo(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be less than or equal to value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

LessThanOrEqualTo(string, object)

public static Filter LessThanOrEqualTo(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must be less than or equal to value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

NotEqualTo(FieldPath, object)

public static Filter NotEqualTo(FieldPath fieldPath, object value)

Returns a filter specifying that the value in fieldPath must not be equal to value.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`value`	`object`

Returns
Type	Description
`Filter`

NotEqualTo(string, object)

public static Filter NotEqualTo(string fieldPath, object value)

Returns a filter specifying that the value in fieldPath must not be equal to value.

Parameters
Name	Description
`fieldPath`	`string`
`value`	`object`

Returns
Type	Description
`Filter`

NotInArray(FieldPath, IEnumerable)

public static Filter NotInArray(FieldPath fieldPath, IEnumerable values)

Returns a filter specifying that fieldPath must be a field present in the document, with a value which is not one of the values in values.

Parameters
Name	Description
`fieldPath`	`FieldPath`
`values`	`IEnumerable`

Returns
Type	Description
`Filter`

NotInArray(string, IEnumerable)

public static Filter NotInArray(string fieldPath, IEnumerable values)

Returns a filter specifying that fieldPath must be a field present in the document, with a value which is not one of the values in values.

Parameters
Name	Description
`fieldPath`	`string`
`values`	`IEnumerable`

Returns
Type	Description
`Filter`

Or(params Filter[])

public static Filter Or(params Filter[] filters)

Creates a composite filter which is the logical "OR" of all the specified filters.

Parameter
Name	Description
`filters`	`Filter` Set of filters to combine. Must not be null or empty, or contain null references.

Returns
Type	Description
`Filter`	A filter representing the logical "OR" of all the elements in `filters`.

Or(IEnumerable<Filter>)

public static Filter Or(IEnumerable<Filter> filters)

Creates a composite filter which is the logical "OR" of all the specified filters.

Parameter
Name	Description
`filters`	`IEnumerableFilter` Set of filters to combine. Must not be null or empty, or contain null references.

Returns
Type	Description
`Filter`	A filter representing the logical "OR" of all the elements in `filters`.