Interface ISession#

An interface that can be used by a client to access the information of a session.

Namespace: Unity.Services.Multiplayer#

Syntax#

public interface ISession

Properties#

AvailableSlots#

Available slots in the session

Declaration#

int AvailableSlots { get; }

Property Value#

Code#

The join code of the session.

Declaration#

string Code { get; }

Property Value#

Remarks#

Prefer this to ID when player-visible strings are needed. Unlike IDs, join codes are much shorter to type and avoid visually ambiguous characters.

CurrentPlayer#

The current player in the session.

Declaration#

IPlayer CurrentPlayer { get; }

Property Value#

HasPassword#

True if the session has a password, false otherwise

Declaration#

bool HasPassword { get; }

Property Value#

Host#

PlayerID of the session host.

Declaration#

string Host { get; }

Property Value#

Id#

The ID of the session.

Declaration#

string Id { get; }

Property Value#

Remarks#

Unique within a project and environment. Sessions can be joined by Id.

See Also#

IsHost#

Whether the current player is the host of the session.

Declaration#

bool IsHost { get; }

Property Value#

IsLocked#

Whether the session is locked.

Declaration#

bool IsLocked { get; }

Property Value#

Remarks#

Locked sessions cannot be joined by anyone.

See Also#

IsPrivate#

Whether the session is private.

Declaration#

bool IsPrivate { get; }

Property Value#

Remarks#

Private sessions or not visible in queries and cannot be joined with quick-join. They can still be joined by ID or by Code.

See Also#

MaxPlayers#

The total number of players allowed in the session, including the host.

Declaration#

int MaxPlayers { get; }

Property Value#

See Also#

Name#

The Name of the session.

Declaration#

string Name { get; }

Property Value#

Remarks#

Does not have to be unique. Sessions can be filtered by name in a query.

See Also#

PlayerCount#

The player count of the session

Declaration#

int PlayerCount { get; }

Property Value#

Players#

The list of players in the session

Declaration#

IReadOnlyList<IReadOnlyPlayer> Players { get; }

Property Value#

Properties#

The properties of the session.

Declaration#

IReadOnlyDictionary<string, SessionProperty> Properties { get; }

Property Value#

State#

The current state of the session.

Declaration#

SessionState State { get; }

Property Value#

Type#

The type is a client-side key used to uniquely identify a session.

Declaration#

string Type { get; }

Property Value#

Methods#

AsHost()#

Returns a read-write handle to the session with host privileges.

Declaration#

IHostSession AsHost()

Returns#

Exceptions#

LeaveAsync()#

Leaves the session.

Declaration#

Task LeaveAsync()

Returns#

Exceptions#

ReconnectAsync()#

Reconnects to the session.

Declaration#

Task ReconnectAsync()

Returns#

Remarks#

Reconnecting is necessary when a player has momentarily disconnected from the network but didn't gracefully leave the session.

Exceptions#

RefreshAsync()#

Refreshes the session data.

Declaration#

Task RefreshAsync()

Returns#

Exceptions#

SaveCurrentPlayerDataAsync()#

Save changes to the current player.

Declaration#

Task SaveCurrentPlayerDataAsync()

Returns#

Events#

Changed#

Event that is invoked when the session changes.

Declaration#

event Action Changed

Event Type#

Deleted#

Event that is invoked when the session is deleted.

Declaration#

event Action Deleted

Event Type#

PlayerJoined#

Event that is invoked when a player joins the session.

Declaration#

event Action<string> PlayerJoined

Event Type#

Remarks#

The System.String parameter represents the ID of the player who joined.

PlayerLeft#

Event that is invoked when a player leaves the session.

Declaration#

event Action<string> PlayerLeft

Event Type#

Remarks#

The System.String parameter represents the ID of the player who left.

PlayerPropertiesChanged#

Event that is invoked when player properties are changed.

Declaration#

event Action PlayerPropertiesChanged

Event Type#

RemovedFromSession#

Event that is invoked when the current player is removed from the session.

Declaration#

event Action RemovedFromSession

Event Type#

SessionPropertiesChanged#

Event that is invoked when session properties are changed.

Declaration#

event Action SessionPropertiesChanged

Event Type#

StateChanged#

Event that is invoked when the session state changes.

Declaration#

event Action<SessionState> StateChanged

Event Type#

Remarks#

The SessionState parameter represents the new state of the session.

Extension Methods#