Class LobbyOwnerSession

Namespace

Coherence.Cloud

Assembly

Coherence.Runtime.dll

public class LobbyOwnerSession

Inheritance

object

LobbyOwnerSession

Constructors

LobbyOwnerSession(LobbyData, IAuthClient, IRequestFactory)

public LobbyOwnerSession(LobbyData lobbyData, IAuthClient authClient, IRequestFactory requestFactory)

Parameters

lobbyData LobbyData

authClient IAuthClient

requestFactory IRequestFactory

Methods

AddOrUpdateLobbyAttributes(List<CloudAttribute>, Action<RequestResponse<bool>>)

Through this method you will be able to add new Attributes or update existing Attributes. Deleting existing Attributes is not supported, the list supplied as parameter will be merged with your current Attributes if the request succeeds with the backend.

public void AddOrUpdateLobbyAttributes(List<CloudAttribute> attributes, Action<RequestResponse<bool>> onRequestFinished)

Parameters

attributes List<CloudAttribute>

List of Attributes to be added or updated from the current Lobby.

onRequestFinished Action<RequestResponse<bool>>

Callback that will be invoked when the request finished.

AddOrUpdateLobbyAttributesAsync(List<CloudAttribute>)

Through this method you will be able to add new Attributes or update existing Attributes. Deleting existing Attributes is not supported, the list supplied as parameter will be merged with your current Attributes if the request succeeds with the backend.

public Task<bool> AddOrUpdateLobbyAttributesAsync(List<CloudAttribute> attributes)

Parameters

attributes List<CloudAttribute>

List of Attributes to be added or updated from the current Lobby.

Returns

Task<bool>

GetAddOrUpdateLobbyAttributesCooldown()

public TimeSpan GetAddOrUpdateLobbyAttributesCooldown()

Returns

TimeSpan

Returns the internal cooldown for the Add Or Update Lobby Attributes endpoint.

KickPlayer(Player, Action<RequestResponse<bool>>)

Kick a Player from the active Lobby.

public void KickPlayer(Player player, Action<RequestResponse<bool>> onRequestFinished)

Parameters

player Player

Player that will be kicked from the Lobby.

onRequestFinished Action<RequestResponse<bool>>

Callback that will be invoked when the request finished.

KickPlayerAsync(Player)

Kick a Player from the active Lobby.

public Task<bool> KickPlayerAsync(Player player)

Parameters

player Player

Player that will be kicked from the Lobby.

Returns

Task<bool>

StartGameSession(Action<RequestResponse<bool>>, int?, bool, bool)

Starts a game session for the current Lobby. A room will be created by coherence and supplied through the LobbiesService.OnPlaySessionStarted Callback.

public void StartGameSession(Action<RequestResponse<bool>> onRequestFinished, int? maxPlayers = null, bool unlistLobby = true, bool closeLobby = false)

Parameters

onRequestFinished Action<RequestResponse<bool>>

Callback that will be invoked when the request finished.

maxPlayers int?

Optional parameter to specify the max amount of Players allowed in the Room. If not supplied, the max amount of Players of the Lobby will be used.

unlistLobby bool

Optional parameter to unlist the Lobby. Unlisting the Lobby means that no other Player will be able to find the Lobby through matchmaking. True by default.

closeLobby bool

Optional parameter to close the Lobby. Closing the Lobby means that no other Player will be able to join the Lobby. False by default.

StartGameSessionAsync(int?, bool, bool)

Starts a game session for the current Lobby. A room will be created by coherence and supplied through the LobbiesService.OnPlaySessionStarted Callback.

public Task<bool> StartGameSessionAsync(int? maxPlayers = null, bool unlistLobby = true, bool closeLobby = false)

Parameters

maxPlayers int?

Optional parameter to specify the max amount of Players allowed in the Room. If not supplied, the max amount of Players of the Lobby will be used.

unlistLobby bool

Optional parameter to unlist the Lobby. Unlisting the Lobby means that no other Player will be able to find the Lobby through matchmaking. True by default.

closeLobby bool

Optional parameter to close the Lobby. Closing the Lobby means that no other Player will be able to join the Lobby. False by default.

Returns

Task<bool>