Interface IHostSession

An interface that can be used by the host to manage a session and access more privileged operations.

Inherited Members
ISession.Changed
ISession.StateChanged
ISession.PlayerJoined
ISession.PlayerLeft
ISession.SessionPropertiesChanged
Namespace: Unity.Services.Multiplayer
Assembly: Unity.Services.Multiplayer.dll
Syntax
public interface IHostSession : ISession

Properties

Host

ID of the session host. Note host migration is NOT supported on Multiplay Game Server Hosting server builds.

Declaration
string Host { get; set; }
Property Value
Type Description
string

IsLocked

Whether the session is locked

Declaration
bool IsLocked { get; set; }
Property Value
Type Description
bool

IsPrivate

Whether the session is private

Declaration
bool IsPrivate { get; set; }
Property Value
Type Description
bool

Name

The Name of the session.

Declaration
string Name { get; set; }
Property Value
Type Description
string

Password

The password used to connect to the Session

Declaration
string Password { set; }
Property Value
Type Description
string

Players

Declaration
IReadOnlyList<IPlayer> Players { get; }
Property Value
Type Description
IReadOnlyList<IPlayer>

Methods

DeleteAsync()

Delete the session.

Declaration
Task DeleteAsync()
Returns
Type Description
Task

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.

SavePlayerDataAsync(string)

Save the updated properties of a player

Declaration
Task SavePlayerDataAsync(string playerId)
Parameters
Type Name Description
string playerId
Returns
Type Description
Task

SavePropertiesAsync()

Saves the property changes of the session.

Declaration
Task SavePropertiesAsync()
Returns
Type Description
Task

A task for the operation.

SetProperties(Dictionary<string, SessionProperty>)

Set properties. Set a value to null to remove.

Declaration
void SetProperties(Dictionary<string, SessionProperty> properties)
Parameters
Type Name Description
Dictionary<string, SessionProperty> properties

SetProperty(string, SessionProperty)

Set a property. Set a value to null to remove.

Declaration
void SetProperty(string key, SessionProperty property)
Parameters
Type Name Description
string key
SessionProperty property

Extension Methods