Interface IHostSession

A host's mutable handle on a session.

Inherited Members

ISession.Changed

ISession.StateChanged

ISession.PlayerJoined

ISession.PlayerLeft

ISession.PlayerLeaving

ISession.PlayerHasLeft

ISession.SessionPropertiesChanged

ISession.PlayerPropertiesChanged

ISession.RemovedFromSession

ISession.Deleted

ISession.Type

ISession.Id

ISession.Code

ISession.IsHost

ISession.HasPassword

ISession.AvailableSlots

ISession.MaxPlayers

ISession.PlayerCount

ISession.Properties

ISession.State

ISession.CurrentPlayer

ISession.SaveCurrentPlayerDataAsync()

ISession.LeaveAsync()

ISession.RefreshAsync()

ISession.ReconnectAsync()

ISession.AsHost()

Namespace: Unity.Services.Multiplayer

Assembly: Unity.Services.Multiplayer.dll

Syntax

public interface IHostSession : ISession

Properties

Host

Session host player ID.

Declaration

string Host { get; set; }

Property Value

Type	Description
string

Remarks

Can be changed to the ID of any player that is already a member of the session. Host migration is NOT supported on Multiplay Game Server Hosting server builds.

Exceptions

Type	Condition
SessionException	Thrown when attempting to change the value on a Multiplay Game Server Hosting server build. The Error property will be set to InvalidPlatformOperation.

See Also

AsHost()

IsLocked

Whether the session is locked

Declaration

bool IsLocked { get; set; }

Property Value

Type	Description
bool

See Also

AsHost()

IsPrivate

Whether the session is private

Declaration

bool IsPrivate { get; set; }

Property Value

Type	Description
bool

See Also

AsHost()

Name

The Name of the session.

Declaration

string Name { get; set; }

Property Value

Type	Description
string

See Also

AsHost()

Password

The password used to connect to the Session.

Declaration

string Password { set; }

Property Value

Type	Description
string

See Also

AsHost()

Players

The list of players in the session

Declaration

IReadOnlyList<IPlayer> Players { get; }

Property Value

Type	Description
IReadOnlyList<IPlayer>

See Also

AsHost()

Methods

DeleteAsync()

Delete the session.

Declaration

Task DeleteAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

See Also

AsHost()

GetHostMigrationDataAsync(TimeSpan)

Get the host migration data from the session. SetHostMigrationDataAsync(byte[], TimeSpan)

Declaration

Task<MigrationData> GetHostMigrationDataAsync(TimeSpan timeout)

Parameters

Type	Name	Description
TimeSpan	timeout	The timeout for the request.

Returns

Type	Description
Task<MigrationData>	Task for MigrationData. MigrationData.Data null if not present.

Remarks

This task is not cancellable; use timeout parameter to limit execution time.

Exceptions

Type	Condition
SessionException	Thrown when a session related error occurs. The Error property reflects the error. Possible errors include: MigrationDataRequestTimeout NotAuthorized NotInLobby RateLimitExceeded SessionNotFound Unknown

See Also

AsHost()

RemovePlayerAsync(string)

Removes a player from the session.

Declaration

Task RemovePlayerAsync(string playerId)

Parameters

Type	Name	Description
string	playerId	Identifier for the player to remove.

Returns

Type	Description
Task	A task for the operation.

See Also

AsHost()

SavePlayerDataAsync(string)

Save the updated properties of a player.

Declaration

Task SavePlayerDataAsync(string playerId)

Parameters

Type	Name	Description
string	playerId	The ID of the player whose data will be saved.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Exceptions

Type	Condition
SessionException	Thrown when the player does is not found. The Error property will be set to InvalidOperation.

See Also

AsHost()

SavePropertiesAsync()

Saves the property changes of the session.

Declaration

Task SavePropertiesAsync()

Returns

Type	Description
Task	A task for the operation.

See Also

AsHost()

SetHostMigrationDataAsync(byte[], TimeSpan)

Set the host migration data on the session. GetHostMigrationDataAsync(TimeSpan)

Declaration

Task SetHostMigrationDataAsync(byte[] data, TimeSpan timeout)

Parameters

Type	Name	Description
byte[]	data	The host migration data byte array to set.
TimeSpan	timeout	The timeout for the request.

Returns

Type	Description
Task	A task for the operation.

Remarks

This task is not cancellable; use timeout parameter to limit execution time.

Exceptions

Type	Condition
SessionException	Thrown when a session related error occurs. The Error property reflect the error. Possible errors include: MigrationDataRequestTimeout MigrationDataUploadVersionConflict NotAuthorized NotInLobby RateLimitExceeded SessionNotFound Unknown
ArgumentOutOfRangeException	Thrown when the data to set exceeds the maximum migration data size limit returned by the server.

See Also

AsHost()

SetProperties(Dictionary<string, SessionProperty>)

Set properties.

Declaration

void SetProperties(Dictionary<string, SessionProperty> properties)

Parameters

Type	Name	Description
Dictionary<string, SessionProperty>	properties	The properties to be set on the session.

Remarks

Passing null to SetProperty removes the property from the session.
However passing a SessionProperty with a null value (new SessionProperty(null)) keeps the session property and sets its value to null.

See Also

AsHost()

SetProperty(string, SessionProperty)

Set a property.

Declaration

void SetProperty(string key, SessionProperty property)

Parameters

Type	Name	Description
string	key	The property's key to bet set on the session.
SessionProperty	property	The property's value.

Remarks

Passing null to SetProperty removes the property from the session.
However passing a SessionProperty with a null value (new SessionProperty(null)) keeps the session property and sets its value to null.

See Also

AsHost()

Extension Methods

MatchmakerExtensions.GetMatchmakingResults(ISession)

See Also

AsHost()