Lobby - Get Lobby
Get a lobby.
POST https://titleId.playfabapi.com/Lobby/GetLobbyRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| LobbyId |
string |
The id of the lobby. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Access |
|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Get |
Request to get a lobby. |
|
Get |
|
| Lobby | |
|
Lobby |
|
| Member | |
|
Membership |
|
|
Owner |
AccessPolicy
| Name | Type | Description |
|---|---|---|
| Friends |
string |
|
| Private |
string |
|
| Public |
string |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
EntityKey
Combined entity type and ID structure which uniquely identifies a single entity.
| Name | Type | Description |
|---|---|---|
| Id |
string |
Unique ID of the entity. |
| Type |
string |
Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types |
GetLobbyRequest
Request to get a lobby.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| LobbyId |
string |
The id of the lobby. |
GetLobbyResult
| Name | Type | Description |
|---|---|---|
| Lobby |
The information pertaining to the requested lobby. |
Lobby
| Name | Type | Description |
|---|---|---|
| AccessPolicy |
A setting indicating who is allowed to join this lobby, as well as see it in queries. |
|
| ChangeNumber |
number |
A number that increments once for each request that modifies the lobby. |
| ConnectionString |
string |
A string used to join the lobby. This field is populated by the Lobby service. Invites are performed by communicating this connectionString to other players. |
| LobbyData |
object |
Lobby data. |
| LobbyId |
string |
Id to uniquely identify a lobby. |
| MaxPlayers |
number |
The maximum number of players allowed in the lobby. |
| Members |
Member[] |
Array of all lobby members. |
| MembershipLock |
A setting indicating whether members are allowed to join this lobby. When Locked new members are prevented from joining. |
|
| Owner |
The client or server entity which owns this lobby. |
|
| OwnerMigrationPolicy |
A setting indicating the owner migration policy. If server owned, this field is not present. |
|
| PubSubConnectionHandle |
string |
An opaque string stored on a SubscribeToLobbyResource call, which indicates the connection an owner or member has with PubSub. |
| SearchData |
object |
Search data. |
| Server |
Preview: Lobby joined server. This is not the server owner, rather the server that has joined a client owned lobby. |
|
| UseConnections |
boolean |
A flag which determines if connections are used. Defaults to true. Only set on create. |
LobbyServer
| Name | Type | Description |
|---|---|---|
| PubSubConnectionHandle |
string |
Opaque string, stored on a Subscribe call, which indicates the connection a joined server has with PubSub. |
| ServerData |
object |
Key-value pairs specific to the joined server. |
| ServerEntity |
The server entity key. |
Member
| Name | Type | Description |
|---|---|---|
| MemberData |
object |
Key-value pairs specific to member. |
| MemberEntity |
The member entity key. |
|
| PubSubConnectionHandle |
string |
Opaque string, stored on a Subscribe call, which indicates the connection an owner or member has with PubSub. |
MembershipLock
| Name | Type | Description |
|---|---|---|
| Locked |
string |
|
| Unlocked |
string |
OwnerMigrationPolicy
| Name | Type | Description |
|---|---|---|
| Automatic |
string |
|
| Manual |
string |
|
| None |
string |
|
| Server |
string |
Error Codes
| Name | Code |
|---|---|
| LobbyBadRequest | 13007 |
| LobbyDoesNotExist | 13000 |
| LobbyRateLimitExceeded | 13001 |