Class QuerySessionsResults
Results from a session query.
Inheritance
Inherited Members
Namespace: Unity.Services.Multiplayer
Syntax
public class QuerySessionsResultsProperties
ContinuationToken
ContinuationToken used for pagination.
Declaration
public string ContinuationToken { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
The continuation token is an opaque string that includes all the necessary information to obtain the next page of results. It is used by ContinuationToken.
Sessions
Public information for each session returned by the query.
Declaration
public IList<ISessionInfo> Sessions { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IList<ISessionInfo> |
Remarks
To join one of the sessions, use its Id and Unity.Services.Multiplayer.ISessionManager.JoinByIdAsync(System.String,Unity.Services.Multiplayer.JoinSessionOptions).
Methods
StartPolling(Int32)
Starts background polling for new query results, re-using the same options.
Declaration
public void StartPolling(int pollingDelaySeconds = 5)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | pollingDelaySeconds | The interval at which we should poll the query results |
Remarks
Useful for live-updating UIs as session results can change frequently as they fill up or new ones get created. The polling delay should be of at least 1 second to avoid rate limiting by the service.
StopPolling()
Stops background polling for new query results.
Declaration
public void StopPolling()