Class FieldFilter

A field filter for querying an index

Inheritance

object

FieldFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.CloudSave.Models

Assembly: Unity.Services.CloudSave.dll

Syntax

[Preserve]
[DataContract(Name = "FieldFilter")]
public class FieldFilter

Constructors

FieldFilter(string, object, OpOptions, bool)

A field filter for querying an index

Declaration

[Preserve]
public FieldFilter(string key, object value, FieldFilter.OpOptions op, bool asc)

Parameters

Type	Name	Description
string	key	Item key
object	value	The indexed Cloud Save value
FieldFilter.OpOptions	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
bool	asc	Whether the field is sorted in ascending order

Properties

Asc

Whether the field is sorted in ascending order

Declaration

[Preserve]
[DataMember(Name = "asc", IsRequired = true, EmitDefaultValue = true)]
public bool Asc { get; }

Property Value

Type	Description
bool

Key

Item key

Declaration

[Preserve]
[DataMember(Name = "key", IsRequired = true, EmitDefaultValue = true)]
public string Key { get; }

Property Value

Type	Description
string

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

[Preserve]
[JsonConverter(typeof(StringEnumConverter))]
[DataMember(Name = "op", IsRequired = true, EmitDefaultValue = true)]
public FieldFilter.OpOptions Op { get; }

Property Value

Type	Description
FieldFilter.OpOptions

Value

The indexed Cloud Save value

Declaration

[Preserve]
[JsonConverter(typeof(JsonObjectConverter))]
[DataMember(Name = "value", IsRequired = true, EmitDefaultValue = true)]
public IDeserializable Value { get; }

Property Value

Type	Description
IDeserializable