Class QueryRequest
The body of a Query request which defines how to sort and filter results, how many results to return, etc.
Inherited Members
Namespace: Unity.Services.Apis.Lobbies
Assembly: Unity.Services.Apis.dll
Syntax
[DataContract(Name = "QueryRequest")]
[Preserve]
public class QueryRequest
Constructors
QueryRequest(int?, int?, bool, List<QueryFilter>, List<QueryOrder>, string)
Initializes a new instance of the Query
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. (default to 10). |
int? | skip | The number of results to skip before selecting results to return. (default to 0). |
bool | sampleResults | Whether a random sample of results that match the search filter should be returned. (default to false). |
List<Query |
filter | A list of filters which can be used to narrow down which lobbies to return.. |
List<Query |
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
[DataMember(Name = "continuationToken", EmitDefaultValue = true)]
[Preserve]
public string ContinuationToken { get; set; }
Property Value
Type | Description |
---|---|
string | A continuation token that can be passed to subsequent query requests to fetch the next page of results. |
Count
The number of results to return.
Declaration
[DataMember(Name = "count", EmitDefaultValue = true)]
[Preserve]
public int? Count { get; set; }
Property Value
Type | Description |
---|---|
int? | The number of results to return. |
Filter
A list of filters which can be used to narrow down which lobbies to return.
Declaration
[DataMember(Name = "filter", EmitDefaultValue = false)]
[Preserve]
public List<QueryFilter> Filter { get; set; }
Property Value
Type | Description |
---|---|
List<Query |
A list of filters which can be used to narrow down which lobbies to return. |
Order
A list of orders which define how the results should be ordered in the response.
Declaration
[DataMember(Name = "order", EmitDefaultValue = false)]
[Preserve]
public List<QueryOrder> Order { get; set; }
Property Value
Type | Description |
---|---|
List<Query |
A list of orders which define how the results should be ordered in the response. |
SampleResults
Whether a random sample of results that match the search filter should be returned.
Declaration
[DataMember(Name = "sampleResults", EmitDefaultValue = true)]
[Preserve]
public bool SampleResults { get; set; }
Property Value
Type | Description |
---|---|
bool | Whether a random sample of results that match the search filter should be returned. |
Skip
The number of results to skip before selecting results to return.
Declaration
[DataMember(Name = "skip", EmitDefaultValue = true)]
[Preserve]
public int? Skip { get; set; }
Property Value
Type | Description |
---|---|
int? | The number of results to skip before selecting results to return. |