Class QuerySessionsResults

Results from a session query.

Inheritance

object

QuerySessionsResults

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Multiplayer

Assembly: Unity.Services.Multiplayer.dll

Syntax

public class QuerySessionsResults

Properties

ContinuationToken

ContinuationToken used for pagination.

Declaration

public string ContinuationToken { get; }

Property Value

Type	Description
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
IList<ISessionInfo>

Remarks

To join one of the sessions, use its Id and JoinByIdAsync(string, JoinSessionOptions).

Methods

StartPolling(int)

Starts background polling for new query results, re-using the same options.

Declaration

public void StartPolling(int pollingDelaySeconds = 5)

Parameters

Type	Name	Description
int	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()