Class FilterOption

A Generic class for creating option for querying sessions.

Inheritance
object
FilterOption
Inherited Members
Namespace: Unity.Services.Multiplayer
Assembly: Unity.Services.Multiplayer.dll
Syntax
public class FilterOption

Constructors

FilterOption(FilterField, string, FilterOperation)

A filter for an individual field that is applied to a query.

Declaration
public FilterOption(FilterField field, string value, FilterOperation operation)
Parameters
Type Name Description
FilterField field

The name of the field to filter on. For custom data fields, the name of the index must be used instead of the field name.
string value

The value to compare to the field being filtered. This value must be a string and it must be parsable as the same type as field (e.g. integer for MaxPlayers, datetime for Created, etc.). The value for datetime fields (Created, LastUpdated) must be in RFC3339 format. For example, in C# this can be achieved using the "o" format specifier: return dateTime.ToString(\"o\", DateTimeFormatInfo.InvariantInfo);. Refer to your language documentation for other methods to generate RFC3339-compatible datetime strings.
FilterOperation operation

The operation used to compare the field to the filter value.

Properties

Field

The name of the field to filter on. For custom data fields, the name of the index must be used instead of the field name.

Declaration
public FilterField Field { get; }
Property Value
Type Description
FilterField

Operation

The operation used to compare the field to the filter value. Supports CONTAINS (only on the Name field), EQ (Equal), NE (Not Equal), LT (Less Than), LE (Less Than or Equal), GT (Greater Than), and GE (Greater Than or Equal).

Declaration
public FilterOperation Operation { get; }
Property Value
Type Description
FilterOperation

Value

The value to compare to the field being filtered. This value must be a string and it must be parsable as the same type as field (e.g. integer for MaxPlayers, datetime for Created, etc.). The value for datetime fields (Created, LastUpdated) must be in RFC3339 format. For example, in C# this can be achieved using the "o" format specifier: return dateTime.ToString(\"o\", DateTimeFormatInfo.InvariantInfo);. Refer to your language documentation for other methods to generate RFC3339-compatible datetime strings.

Declaration
public string Value { get; }
Property Value
Type Description
string