public abstract class Filter : IEquatable<Filter>
Reference documentation and code samples for the Firestore API class Filter.
A holder for any type of filter.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
|
