Skip to content

Latest commit

 

History

History
346 lines (192 loc) · 12.4 KB

LobbyApi.md

File metadata and controls

346 lines (192 loc) · 12.4 KB

\LobbyApi

All URIs are relative to https://api.beamable.com

Method HTTP request Description
api_lobbies_get GET /api/lobbies
api_lobbies_id_delete DELETE /api/lobbies/{id}
api_lobbies_id_get GET /api/lobbies/{id}
api_lobbies_id_metadata_put PUT /api/lobbies/{id}/metadata
api_lobbies_id_put PUT /api/lobbies/{id}
api_lobbies_id_server_post POST /api/lobbies/{id}/server
api_lobbies_id_tags_delete DELETE /api/lobbies/{id}/tags
api_lobbies_id_tags_put PUT /api/lobbies/{id}/tags
api_lobbies_passcode_put PUT /api/lobbies/passcode
api_lobbies_post POST /api/lobbies

api_lobbies_get

models::LobbyQueryResponse api_lobbies_get(x_beam_scope, x_beam_gamertag, skip, limit, match_type)

Query for active lobbies

Parameters

Name Type Description Required Notes
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
skip Option<i32>
limit Option<i32>
match_type Option<String>

Return type

models::LobbyQueryResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_delete

serde_json::Value api_lobbies_id_delete(id, x_beam_scope, x_beam_gamertag, remove_from_lobby)

Remove the requested player from the lobby. The host is able to remove anyone. Others may only remove themselves without error.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the lobby [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
remove_from_lobby Option<RemoveFromLobby> Request including the player requested to remove

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_get

models::Lobby api_lobbies_id_get(id, x_beam_scope, x_beam_gamertag)

Get the current status of a lobby by id.

Parameters

Name Type Description Required Notes
id uuid::Uuid The lobby id. [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_metadata_put

models::Lobby api_lobbies_id_metadata_put(id, x_beam_scope, x_beam_gamertag, update_lobby)

Update the properties of a lobby

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the lobby [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
update_lobby Option<UpdateLobby> The update lobby request.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_put

models::Lobby api_lobbies_id_put(id, x_beam_scope, x_beam_gamertag, join_lobby)

Join a lobby

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the lobby [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
join_lobby Option<JoinLobby> The join lobby request. Includes tags.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_server_post

serde_json::Value api_lobbies_id_server_post(id, x_beam_scope, x_beam_gamertag, create_federated_game_server)

Invoke the Lobby actor to make the federated game server request.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the lobby [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
create_federated_game_server Option<CreateFederatedGameServer> Includes an optional matchtype

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_tags_delete

models::Lobby api_lobbies_id_tags_delete(id, x_beam_scope, x_beam_gamertag, remove_tags)

Remove the request tags from the requested player.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the lobby [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
remove_tags Option<RemoveTags> Includes the player ID and the tags to remove.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_id_tags_put

models::Lobby api_lobbies_id_tags_put(id, x_beam_scope, x_beam_gamertag, add_tags)

Add the request tags to the requested player.

Parameters

Name Type Description Required Notes
id uuid::Uuid Id of the lobby [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
add_tags Option<AddTags> Includes the player ID and tags to add.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_passcode_put

models::Lobby api_lobbies_passcode_put(x_beam_scope, x_beam_gamertag, join_lobby)

Join a lobby by passcode.

Parameters

Name Type Description Required Notes
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
join_lobby Option<JoinLobby> The join lobby request. Includes tags.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_lobbies_post

models::Lobby api_lobbies_post(x_beam_scope, x_beam_gamertag, create_lobby)

Create a lobby. A leader is not necessary to create a lobby.

Parameters

Name Type Description Required Notes
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
create_lobby Option<CreateLobby> The Create request.

Return type

models::Lobby

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]