Class QueryRequest

The body of a Query request which defines how to sort and filter results, how many results to return, etc.

Inheritance

object

QueryRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Lobbies.Models

Assembly: Unity.Services.Multiplayer.dll

Syntax

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

Constructors

QueryRequest(int?, int?, bool, List<QueryFilter>, List<QueryOrder>, string)

The body of a Query request which defines how to sort and filter results, how many results to return, etc.

Declaration

[Preserve]
public QueryRequest(int? count = 10, int? skip = 0, bool sampleResults = false, List<QueryFilter> filter = null, List<QueryOrder> order = null, string continuationToken = null)

Parameters

Type	Name	Description
int?	count	The number of results to return.
int?	skip	The number of results to skip before selecting results to return.
bool	sampleResults	Whether a random sample of results that match the search filter should be returned.
List<QueryFilter>	filter	A list of filters which can be used to narrow down which lobbies to return.
List<QueryOrder>	order	A list of orders which define how the results should be ordered in the response.
string	continuationToken	A continuation token that can be passed to subsequent query requests to fetch the next page of results.

Properties

ContinuationToken

A continuation token that can be passed to subsequent query requests to fetch the next page of results.

Declaration

[Preserve]
[DataMember(Name = "continuationToken", EmitDefaultValue = false)]
public string ContinuationToken { get; }

Property Value

Type	Description
string

Count

The number of results to return.

Declaration

[Preserve]
[DataMember(Name = "count", EmitDefaultValue = false)]
public int? Count { get; }

Property Value

Type	Description
int?

Filter

A list of filters which can be used to narrow down which lobbies to return.

Declaration

[Preserve]
[DataMember(Name = "filter", EmitDefaultValue = false)]
public List<QueryFilter> Filter { get; }

Property Value

Type	Description
List<QueryFilter>

Order

A list of orders which define how the results should be ordered in the response.

Declaration

[Preserve]
[DataMember(Name = "order", EmitDefaultValue = false)]
public List<QueryOrder> Order { get; }

Property Value

Type	Description
List<QueryOrder>

SampleResults

Whether a random sample of results that match the search filter should be returned.

Declaration

[Preserve]
[DataMember(Name = "sampleResults", EmitDefaultValue = true)]
public bool SampleResults { get; }

Property Value

Type	Description
bool

Skip

The number of results to skip before selecting results to return.

Declaration

[Preserve]
[DataMember(Name = "skip", EmitDefaultValue = false)]
public int? Skip { get; }

Property Value

Type	Description
int?