Beamable SDK
Classes | Enumerations
Beamable.Experimental.Api.Lobbies Namespace Reference

Classes

class  AddTagsRequest
 Request payload to add tags to a player in a Lobby. More...
 
class  CreateLobbyRequest
 Request payload to create a new Lobby More...
 
interface  ILobbyApi
 
class  JoinByPasscodeRequest
 Request payload for joining a Lobby by passcode. More...
 
class  JoinLobbyRequest
 Request payload for joining a Lobby by id. More...
 
class  Lobby
 A Lobby is a grouping of online players for use in multiplayer gaming. State about the lobby will be shared amongst the players in it. More...
 
class  LobbyNotification
 Currently an empty payload notifying the client that the lobby should be re-fetched. More...
 
class  LobbyPlayer
 Represents a player as seen from the Lobby structure. More...
 
class  LobbyQueryResponse
 Response payload including a list of Lobby. More...
 
class  LobbyService
 
class  NotInLobby
 Exception thrown when making requests to Beamable.Player.PlayerLobby when a player is not in a Lobby. More...
 
class  RemoveFromLobbyRequest
 Request payload to be used whenever removing a player from the Lobby. This includes leaving the Lobby as well as kicking a player out of the Lobby. More...
 
class  RemoveTagsRequest
 Request payload to remove Lobby Tags from the requested player. More...
 
class  Tag
 An arbitrary name/value pair associated with a LobbyPlayer. More...
 

Enumerations

enum  LobbyRestriction { Open , Closed }
 Value used to determine behavior around who is able to join a Lobby. More...
 

Enumeration Type Documentation

◆ LobbyRestriction

Value used to determine behavior around who is able to join a Lobby.

Enumerator
Open 

Open lobbies allow any player to join as well as show up in queries for lobbies.

Closed 

Closed lobbies are hidden from lobby queries and require knowledge of a passcode to join.