Lobby - Unsubscribe From Lobby Resource
Unsubscribe from lobby notifications.
POST https://titleId.playfabapi.com/Lobby/UnsubscribeFromLobbyResourceRequest 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 | Required | Type | Description |
|---|---|---|---|
| EntityKey | True |
The entity which performed the subscription. |
|
| PubSubConnectionHandle | True |
string |
Opaque string, given to a client upon creating a connection with PubSub. |
| ResourceId | True |
string |
The name of the resource to unsubscribe from. |
| SubscriptionVersion | True |
number |
Version number passed for the subscription of this resource. |
| Type | True |
Subscription type. |
|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
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 |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Entity |
Combined entity type and ID structure which uniquely identifies a single entity. |
|
Lobby |
|
|
Subscription |
|
|
Unsubscribe |
Request to unsubscribe from lobby notifications. |
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 |
LobbyEmptyResult
SubscriptionType
| Name | Type | Description |
|---|---|---|
| LobbyChange |
string |
|
| LobbyInvite |
string |
UnsubscribeFromLobbyResourceRequest
Request to unsubscribe from lobby notifications.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| EntityKey |
The entity which performed the subscription. |
|
| PubSubConnectionHandle |
string |
Opaque string, given to a client upon creating a connection with PubSub. |
| ResourceId |
string |
The name of the resource to unsubscribe from. |
| SubscriptionVersion |
number |
Version number passed for the subscription of this resource. |
| Type |
Subscription type. |
Error Codes
| Name | Code |
|---|---|
| LobbyBadRequest | 13007 |
| LobbyDoesNotExist | 13000 |
| LobbyRateLimitExceeded | 13001 |
| PubSubConnectionHandleInvalid | 2503 |
| PubSubConnectionNotFoundForEntity | 2502 |