Join Lobby As Server
Preview: Join a lobby as a server entity. This is restricted to client lobbies which are using connections.
Allowed entity token types: game_server
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| LobbyBadRequest | 13007 |
| LobbyDifferentServerAlreadyJoined | 13014 |
| LobbyDoesNotExist | 13000 |
| LobbyDoesNotUseConnections | 13017 |
| LobbyIsNotClientOwned | 13016 |
| LobbyRateLimitExceeded | 13001 |
| LobbyServerAlreadyJoined | 13015 |
Authorizations
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Body
Preview: Request to join a lobby as a server. Only callable by a game_server entity and this is restricted to client owned lobbies which are using connections.
Preview: Request to join a lobby as a server. Only callable by a game_server entity and this is restricted to client owned lobbies which are using connections.
A field which indicates which lobby the game_server will be joining. This field is opaque to everyone except the Lobby service.
The game_server entity which is joining the Lobby. If a different game_server entity has already joined the request will fail unless the joined entity is disconnected, in which case the incoming game_server entity will replace the disconnected entity.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
The private key-value pairs which are visible to all entities in the lobby but can only be modified by the joined server.At most 30 key - value pairs may be stored here, keys are limited to 30 characters and values to 1000.The total size of all serverData values may not exceed 4096 bytes.
