A lobby object allows you to store and manage metadata for your rooms.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
appId |
String | ✔️ | System generated unique identifier for an application. | app-af469a92-5b45-4565-b3c4-b79878de67d2 |
createdAt |
OffsetDateTime | ✔️ | When the lobby was created. | |
createdBy |
CreatedBy | ✔️ | UserId or email address for the user that created the lobby. | google-oauth2|107030234048588177467 |
initialConfig |
Object | ✔️ | User input to initialize the game state. Object must be smaller than 64KB. | |
local |
boolean | ✔️ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
region |
Region | ✔️ | N/A | |
roomId |
String | ✔️ | Unique identifier to a game session or match. Use the default system generated ID or overwrite it with your own. Note: error will be returned if roomId is not globally unique. |
2swovpy1fnunu |
shortCode |
Optional<String> | ✔️ | N/A | LFG4 |
state |
JsonNullable<Object> | ➖ | JSON blob to store metadata for a room. Must be smaller than 1MB. | |
visibility |
LobbyVisibility | ✔️ | Types of lobbies a player can create.private: the player who created the room must share the roomId with their friendspublic: visible in the public lobby list, anyone can joinlocal: for testing with a server running locally |
private |