Class FieldFilter
A field filter for querying an index
Inherited Members
Namespace: Unity.Services.Apis.CloudSave
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "FieldFilter")]
[Preserve]
public class FieldFilter
Constructors
FieldFilter(string, object, OpEnum, bool)
Initializes a new instance of the Field
Declaration
[Preserve]
public FieldFilter(string key = null, object value = null, FieldFilter.OpEnum op = (FieldFilter.OpEnum)0, bool asc = false)
Parameters
Type | Name | Description |
---|---|---|
string | key | Item key (required). |
object | value | The indexed Cloud Save value (required). |
Field |
op | The comparison operator to use for the filter. The specified value is compared to the indexed value (lexicographically for string data, numerically for numerical data) using one of the following operators: * |
bool | asc | Whether the field is sorted in ascending order (required). |
Properties
Asc
Whether the field is sorted in ascending order
Declaration
[DataMember(Name = "asc", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public bool Asc { get; set; }
Property Value
Type | Description |
---|---|
bool | Whether the field is sorted in ascending order |
Key
Item key
Declaration
[DataMember(Name = "key", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string Key { get; set; }
Property Value
Type | Description |
---|---|
string | Item key |
Op
The comparison operator to use for the filter. The specified value is compared to the indexed value (lexicographically for string data, numerically for numerical data) using one of the following operators: * EQ
- Equal * NE
- Not Equal * LT
- Less Than * LE
- Less Than or Equal * GT
- Greater Than * GE
- Greater Than or Equal
Declaration
[DataMember(Name = "op", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public FieldFilter.OpEnum Op { get; set; }
Property Value
Type | Description |
---|---|
Field |
The comparison operator to use for the filter. The specified value is compared to the indexed value (lexicographically for string data, numerically for numerical data) using one of the following operators: * |
Value
The indexed Cloud Save value
Declaration
[DataMember(Name = "value", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public object Value { get; set; }
Property Value
Type | Description |
---|---|
object | The indexed Cloud Save value |