Delete a lobby
Permanently delete a lobby to remove it from the system and disconnect all players.
Read time 1 minuteLast updated 3 months ago
Lobby hosts can delete their lobbies. Deleted lobbies are no longer accessible; deleted lobbies do not appear in queries and all APIs targeting a deleted lobby (for example, Get and Update) fail.
Note
The lobby is automatically deleted when the last player leaves the lobby.
Best practices
Clients should expect that they can be removed from a lobby at any time. This could be due to the lobby being deleted, the player being removed from a lobby by the host, the player being removed from the lobby due to a relay disconnect (see Relay integration), or a service outage. Clients should expect that all API calls targeting a specific lobby can fail, and should handle them accordingly. C#try{ await LobbyService.Instance.DeleteLobbyAsync("lobbyId");}catch (LobbyServiceException e){ Debug.Log(e);}