Interface IHostSession
A host's mutable handle on a session.
Inherited Members
Namespace: Unity.Services.Multiplayer
Assembly: Unity.Services.Multiplayer.dll
Syntax
public interface IHostSession : ISessionProperties
Host
ID of the session host.
Declaration
string Host { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Remarks
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
IsLocked
Whether the session is locked
Declaration
bool IsLocked { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
IsPrivate
Whether the session is private
Declaration
bool IsPrivate { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
See Also
Name
The Name of the session.
Declaration
string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Password
The password used to connect to the Session.
Declaration
string Password { set; }Property Value
| Type | Description |
|---|---|
| string |
See Also
Players
The list of players in the session
Declaration
IReadOnlyList<IPlayer> Players { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<IPlayer> |
See Also
Methods
DeleteAsync()
Delete the session.
Declaration
Task DeleteAsync()Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |
See Also
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
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
SavePropertiesAsync()
Saves the property changes of the session.
Declaration
Task SavePropertiesAsync()Returns
| Type | Description |
|---|---|
| Task | A task for the operation. |
See Also
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
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.