Interface ILobbyService
Service for Lobbies. Provides user the ability to create, delete, update, and query Lobbies. Includes operations for interacting with given players in a Lobby context.
Namespace: Unity.Services.Lobbies
Assembly: solution.dll
Syntax
public interface ILobbyServiceMethods
| Name | Description |
|---|---|
| CreateLobbyAsync(string, int, CreateLobbyOptions) | Create a Lobby with a given name and specified player limit. Async operation. |
| CreateOrJoinLobbyAsync(string, string, int, CreateLobbyOptions) | Create or join a Lobby with a given name and ID and specified player limit. Async operation. |
| DeleteLobbyAsync(string) | Delete a Lobby by specifying a Lobby ID. Async operation. |
| GetJoinedLobbiesAsync() | Async Operation. Get currently joined lobbies. |
| GetLobbyAsync(string) | Retrieve data for a Lobby by specifying a Lobby ID. Async operation. |
| JoinLobbyByCodeAsync(string, JoinLobbyByCodeOptions) | Join a Lobby using a given Lobby Invite Code. Async operation. |
| JoinLobbyByIdAsync(string, JoinLobbyByIdOptions) | Join a Lobby by specifying the Lobby ID. Async operation. |
| QueryLobbiesAsync(QueryLobbiesOptions) | Query and retrieve a list of lobbies that meet specified query parameters. Async operation. |
| QuickJoinLobbyAsync(QuickJoinLobbyOptions) | Query available lobbies and join a randomly selected instance. Async operation. |
| ReconnectToLobbyAsync(string) | Reconnects to the lobby. |
| RemovePlayerAsync(string, string) | Remove a player from a specified Lobby. Async operation. |
| SendHeartbeatPingAsync(string) | Send a heartbeat ping to keep the Lobby active. Async operation. |
| SubscribeToLobbyEventsAsync(string, LobbyEventCallbacks) | A subscription to the given lobby is created and the given callbacks are associated with it. The return ILobbyEvents interface can be used to unsubscribe and re-subscribe to the connection. The callbacks object provided will be used to provide the notifications from the subscription. |
| UpdateLobbyAsync(string, UpdateLobbyOptions) | Update the specified Lobby with the given option parameters. Async operation. |
| UpdatePlayerAsync(string, string, UpdatePlayerOptions) | Update player lobby associated data with the given option parameters. Async operation. |