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

Syntax

public abstract class Filter : IEquatable<Filter>

Methods

And(params Filter[])

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

Declaration

public static Filter And(params Filter[] filters)

Parameters

Type	Name	Description
Filter[]	filters	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>)

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

Declaration

public static Filter And(IEnumerable<Filter> filters)

Parameters

Type	Name	Description
IEnumerable<Filter>	filters	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)

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

Declaration

public static Filter ArrayContains(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

ArrayContains(string, object)

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

Declaration

public static Filter ArrayContains(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

ArrayContainsAny(FieldPath, IEnumerable)

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.

Declaration

public static Filter ArrayContainsAny(FieldPath fieldPath, IEnumerable values)

Parameters

Type	Name	Description
FieldPath	fieldPath
IEnumerable	values

Returns

Type	Description
Filter

ArrayContainsAny(string, IEnumerable)

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.

Declaration

public static Filter ArrayContainsAny(string fieldPath, IEnumerable values)

Parameters

Type	Name	Description
string	fieldPath
IEnumerable	values

Returns

Type	Description
Filter

EqualTo(FieldPath, object)

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

Declaration

public static Filter EqualTo(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

EqualTo(string, object)

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

Declaration

public static Filter EqualTo(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

GreaterThan(FieldPath, object)

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

Declaration

public static Filter GreaterThan(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

GreaterThan(string, object)

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

Declaration

public static Filter GreaterThan(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

GreaterThanOrEqualTo(FieldPath, object)

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

Declaration

public static Filter GreaterThanOrEqualTo(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

GreaterThanOrEqualTo(string, object)

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

Declaration

public static Filter GreaterThanOrEqualTo(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

InArray(FieldPath, IEnumerable)

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.

Declaration

public static Filter InArray(FieldPath fieldPath, IEnumerable values)

Parameters

Type	Name	Description
FieldPath	fieldPath
IEnumerable	values

Returns

Type	Description
Filter

InArray(string, IEnumerable)

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.

Declaration

public static Filter InArray(string fieldPath, IEnumerable values)

Parameters

Type	Name	Description
string	fieldPath
IEnumerable	values

Returns

Type	Description
Filter

LessThan(FieldPath, object)

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

Declaration

public static Filter LessThan(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

LessThan(string, object)

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

Declaration

public static Filter LessThan(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

LessThanOrEqualTo(FieldPath, object)

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

Declaration

public static Filter LessThanOrEqualTo(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

LessThanOrEqualTo(string, object)

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

Declaration

public static Filter LessThanOrEqualTo(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

NotEqualTo(FieldPath, object)

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

Declaration

public static Filter NotEqualTo(FieldPath fieldPath, object value)

Parameters

Type	Name	Description
FieldPath	fieldPath
object	value

Returns

Type	Description
Filter

NotEqualTo(string, object)

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

Declaration

public static Filter NotEqualTo(string fieldPath, object value)

Parameters

Type	Name	Description
string	fieldPath
object	value

Returns

Type	Description
Filter

NotInArray(FieldPath, IEnumerable)

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.

Declaration

public static Filter NotInArray(FieldPath fieldPath, IEnumerable values)

Parameters

Type	Name	Description
FieldPath	fieldPath
IEnumerable	values

Returns

Type	Description
Filter

NotInArray(string, IEnumerable)

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.

Declaration

public static Filter NotInArray(string fieldPath, IEnumerable values)

Parameters

Type	Name	Description
string	fieldPath
IEnumerable	values

Returns

Type	Description
Filter

Or(params Filter[])

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

Declaration

public static Filter Or(params Filter[] filters)

Parameters

Type	Name	Description
Filter[]	filters	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>)

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

Declaration

public static Filter Or(IEnumerable<Filter> filters)

Parameters

Type	Name	Description
IEnumerable<Filter>	filters	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.