Class QueryRequest
The body of a Query request which defines how to sort and filter results, how many results to return, etc.
Inheritance
Inherited Members
Namespace: Unity.Services.Lobbies.Models
Syntax
public class QueryRequestConstructors
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
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 |
|---|---|---|
| System.Nullable<System.Int32> | count | The number of results to return. |
| System.Nullable<System.Int32> | skip | The number of results to skip before selecting results to return. |
| System.Boolean | sampleResults | Whether a random sample of results that match the search filter should be returned. |
| System.Collections.Generic.List<QueryFilter> | filter | A list of filters which can be used to narrow down which lobbies to return. |
| System.Collections.Generic.List<QueryOrder> | order | A list of orders which define how the results should be ordered in the response. |
| System.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
public string ContinuationToken { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Count
The number of results to return.
Declaration
public int? Count { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Filter
A list of filters which can be used to narrow down which lobbies to return.
Declaration
public List<QueryFilter> Filter { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<QueryFilter> |
Order
A list of orders which define how the results should be ordered in the response.
Declaration
public List<QueryOrder> Order { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<QueryOrder> |
SampleResults
Whether a random sample of results that match the search filter should be returned.
Declaration
public bool SampleResults { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Skip
The number of results to skip before selecting results to return.
Declaration
public int? Skip { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |