Inheritance diagram for Beamable.Experimental.Api.Lobbies.ILobbyApi:

Public Member Functions
Promise< LobbyQueryResponse >	FindLobbies ()
	Find lobbies for the player to join. More...

Promise< Lobby >	CreateLobby (string name, LobbyRestriction restriction, SimGameTypeRef gameTypeRef=null, string description=null, List< Tag > playerTags=null, int? maxPlayers=null, int? passcodeLength=null, List< string > statsToInclude=null)
	Create a new Lobby with the current player as the host. More...

Promise< Lobby >	JoinLobby (string lobbyId, List< Tag > playerTags=null)
	Join a Lobby given its id. More...

Promise< Lobby >	JoinLobbyByPasscode (string passcode, List< Tag > playerTags=null)
	Join a Lobby given its passcode. More...

Promise< Lobby >	GetLobby (string lobbyId)
	Fetch the current status of a Lobby. More...

Promise	LeaveLobby (string lobbyId)
	Notify the given lobby that the player intends to leave. More...

Promise< Lobby >	AddPlayerTags (string lobbyId, List< Tag > tags, string playerId=null, bool replace=false)
	Add a list of Tag to the given player in the given lobby. More...

Promise< Lobby >	RemovePlayerTags (string lobbyId, List< string > tags, string playerId=null)
	Remove a list of tags from the given player in the given Lobby. More...

Promise	KickPlayer (string lobbyId, string playerId)
	Send a request to the given Lobby to remove the player with the given playerId. If the requesting player doesn't have the capability to boot players, this will throw an exception. More...

Member Function Documentation

◆ AddPlayerTags()

Promise< Lobby > Beamable.Experimental.Api.Lobbies.ILobbyApi.AddPlayerTags	(	string	lobbyId,
		List< Tag >	tags,
		string	playerId = `null`,
		bool	replace = `false`
	)

Add a list of Tag to the given player in the given lobby.

Parameters

lobbyId	The id of the Lobby.
tags	List of Tag to associate with the player.
playerId	The id of the player.

Returns: A Promise<Lobby> representing the modified lobby.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ CreateLobby()

Promise< Lobby > Beamable.Experimental.Api.Lobbies.ILobbyApi.CreateLobby	(	string	name,
		LobbyRestriction	restriction,
		SimGameTypeRef	gameTypeRef = `null`,
		string	description = `null`,
		List< Tag >	playerTags = `null`,
		int?	maxPlayers = `null`,
		int?	passcodeLength = `null`,
		List< string >	statsToInclude = `null`
	)

Create a new Lobby with the current player as the host.

Parameters

name	Name of the lobby
restriction	The privacy value for the created lobby.
gameTypeRef	If this lobby should be subject to matchmaking, a gametype ref should be provided
description	Short optional description of what the lobby is for.
playerTags	Arbitrary list of tags to include on the creating player.
passcodeLength	Configurable value for how long the generated passcode should be.
maxPlayers	Configurable value for the maximum number of players this lobby can have.
statsToInclude	Stat keys to include with Lobby requests.

Returns: A Promise<Lobby> representing the created lobby.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ FindLobbies()

Promise< LobbyQueryResponse > Beamable.Experimental.Api.Lobbies.ILobbyApi.FindLobbies ( )

Find lobbies for the player to join.

Returns: A Promise<LobbyQueryResponse> representing a list of public lobbies.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ GetLobby()

Promise< Lobby > Beamable.Experimental.Api.Lobbies.ILobbyApi.GetLobby ( string lobbyId )

Fetch the current status of a Lobby.

Parameters

lobbyId The id of the Lobby.

Returns: A Promise<Lobby> representing the modified lobby.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ JoinLobby()

Promise< Lobby > Beamable.Experimental.Api.Lobbies.ILobbyApi.JoinLobby	(	string	lobbyId,
		List< Tag >	playerTags = `null`
	)

Join a Lobby given its id.

Parameters

lobbyId	The id of the Lobby to join.
playerTags	List of Tag to associate with the joining player.

Returns: A Promise<Lobby> representing the modified lobby.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ JoinLobbyByPasscode()

Promise< Lobby > Beamable.Experimental.Api.Lobbies.ILobbyApi.JoinLobbyByPasscode	(	string	passcode,
		List< Tag >	playerTags = `null`
	)

Join a Lobby given its passcode.

Parameters

passcode	The passcode of the Lobby to join.
playerTags	List of Tag to associate with the joining player.

Returns: A Promise<Lobby> representing the modified lobby.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ KickPlayer()

Promise Beamable.Experimental.Api.Lobbies.ILobbyApi.KickPlayer	(	string	lobbyId,
		string	playerId
	)

Send a request to the given Lobby to remove the player with the given playerId. If the requesting player doesn't have the capability to boot players, this will throw an exception.

Parameters

lobbyId	The id of the Lobby.
playerId	The id of the player to remove.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ LeaveLobby()

Promise Beamable.Experimental.Api.Lobbies.ILobbyApi.LeaveLobby ( string lobbyId )

Notify the given lobby that the player intends to leave.

Parameters

lobbyId The id of the Lobby to leave.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

◆ RemovePlayerTags()

Promise< Lobby > Beamable.Experimental.Api.Lobbies.ILobbyApi.RemovePlayerTags	(	string	lobbyId,
		List< string >	tags,
		string	playerId = `null`
	)

Remove a list of tags from the given player in the given Lobby.

Parameters

lobbyId	The id of the Lobby.
tags	List of Tag to remove from the player.
playerId	The id of the player.

Returns: A Promise<Lobby> representing the modified lobby.

Implemented in Beamable.Experimental.Api.Lobbies.LobbyService.

The documentation for this interface was generated from the following file:

com.beamable/Common/Runtime/Api/Lobbies/ILobbyApi.cs

Public Member Functions

Member Function Documentation

◆ AddPlayerTags()

◆ CreateLobby()

◆ FindLobbies()

◆ GetLobby()

◆ JoinLobby()

◆ JoinLobbyByPasscode()

◆ KickPlayer()

◆ LeaveLobby()

◆ RemovePlayerTags()