v1.0.0
Latest
2022.3+
Class QueryLobbiesOptions
Query parameters for Lobby service requests.
Inheritance
System.Object
QueryLobbiesOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Unity.Services.Lobbies
Syntax
public class QueryLobbiesOptions
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; set; }
Property Value
Type | Description |
---|---|
System.String |
Count
The number of results to return. Minimum: 1. Maximum: 100. Default: 10.
Declaration
public int Count { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Filters
A list of filters which can be used to narrow down which lobbies to return.
Declaration
public List<QueryFilter> Filters { get; set; }
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; set; }
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; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Skip
The number of results to skip before selecting results to return. Maximum: 1000. Default: 0.
Declaration
public int Skip { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |