playfab_ex v0.2.0 PlayfabEx.Server.Default.Matchmaking

Link to this section Summary

Functions

Inform the matchmaker that a Game Server Instance is removed

Informs the PlayFab match-making service that the user specified has left the Game Server Instance

Validates a Game Server session ticket and returns details about the user

Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance

Inform the matchmaker that a new Game Server Instance is added

Sets the custom data of the indicated Game Server Instance

Set the state of the indicated Game Server Instance

Set custom tags for the specified Game Server Instance

Link to this section Functions

Link to this function deregister_game(params)
deregister_game(map()) :: {:ok, map()} | {:error, String.t()}

Inform the matchmaker that a Game Server Instance is removed.

@link https://api.playfab.com/documentation/server/method/DeregisterGame

Link to this function notify_matchmaker_player_left(params)
notify_matchmaker_player_left(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Informs the PlayFab match-making service that the user specified has left the Game Server Instance

@link https://api.playfab.com/documentation/server/method/NotifyMatchmakerPlayerLeft

Link to this function redeem_matchmaker_ticket(params)
redeem_matchmaker_ticket(map()) :: {:ok, map()} | {:error, String.t()}

Validates a Game Server session ticket and returns details about the user

@link https://api.playfab.com/documentation/server/method/RedeemMatchmakerTicket

Link to this function refresh_game_server_instance_heartbeat(params)
refresh_game_server_instance_heartbeat(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Set the state of the indicated Game Server Instance. Also update the heartbeat for the instance.

@link https://api.playfab.com/documentation/server/method/RefreshGameServerInstanceHeartbeat

Link to this function register_game(params)
register_game(map()) :: {:ok, map()} | {:error, String.t()}

Inform the matchmaker that a new Game Server Instance is added.

@link https://api.playfab.com/documentation/server/method/RegisterGame

Link to this function set_game_server_instance_data(params)
set_game_server_instance_data(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Sets the custom data of the indicated Game Server Instance

@link https://api.playfab.com/documentation/server/method/SetGameServerInstanceData

Link to this function set_game_server_instance_state(params)
set_game_server_instance_state(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Set the state of the indicated Game Server Instance.

@link https://api.playfab.com/documentation/server/method/SetGameServerInstanceState

Link to this function set_game_server_instance_tags(params)
set_game_server_instance_tags(map()) ::
  {:ok, map()} |
  {:error, String.t()}

Set custom tags for the specified Game Server Instance

@link https://api.playfab.com/documentation/server/method/SetGameServerInstanceTags