Class QueryRequest#

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

Namespace: Unity.Services.Lobbies.Models#

Syntax#

[Preserve]
public class QueryRequest

Constructors#

QueryRequest(Nullable<Int32>, Nullable<Int32>, Boolean, 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#

Properties#

ContinuationToken#

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

Declaration#

[Preserve]
public string ContinuationToken { get; }

Property Value#

Count#

The number of results to return.

Declaration#

[Preserve]
public int? Count { get; }

Property Value#

Filter#

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

Declaration#

[Preserve]
public List<QueryFilter> Filter { get; }

Property Value#

Order#

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

Declaration#

[Preserve]
public List<QueryOrder> Order { get; }

Property Value#

SampleResults#

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

Declaration#

[Preserve]
public bool SampleResults { get; }

Property Value#

Skip#

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

Declaration#

[Preserve]
public int? Skip { get; }

Property Value#