playfab_ex v0.2.0 PlayfabEx.Client.AccountManagement

Link to this section Summary

Functions

Adds the specified generic service identifier to the player’s PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players

Adds or updates a contact email to the player’s profile

Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login

Retrieves the user’s PlayFab account details

Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers

Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier)

Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account

Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as “id” in the Google+ People API calls

Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as “user_id” from the Kongregate API methods(ex: )

Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as “_id” from the Twitch API methods (ex: )

Links the Android device identifier to the user’s PlayFab account

Retrieves all of the user’s different kinds of info

Retrieves the player’s profile

Links the Facebook account associated with the provided Facebook access token to the user’s PlayFab account

Links the Game Center account associated with the provided Game Center ID to the user’s PlayFab account

Links the currently signed-in user account to their Google account, using their Google account credentials

Links the vendor-specific iOS device identifier to the user’s PlayFab account

Links the Kongregate identifier to the user’s PlayFab account

Links the Steam account associated with the provided Steam authentication ticket to the user’s PlayFab account

Links the Twitch account associated with the token to the user’s PlayFab account

Link Windows Hello authentication to the current PlayFab Account

Removes a contact email from the player’s profile

Removes the specified generic service identifier from the player’s PlayFab account

Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players

Forces an email to be sent to the registered email address for the user’s account, with a link allowing the user to change the password

Unlinks the related Android device identifier from the user’s PlayFab account

Unlinks the related custom identifier from the user’s PlayFab account

Unlinks the related Facebook account from the user’s PlayFab account

Unlinks the related Game Center account from the user’s PlayFab account

Unlinks the related Google account from the user’s PlayFab account ( )

Unlinks the related iOS device identifier from the user’s PlayFab account

Unlinks the related Kongregate identifier from the user’s PlayFab account

Unlinks the related Twitch account from the user’s PlayFab account

Unlink Windows Hello authentication from the current PlayFab Account

Update the avatar URL of the player

Updates the title specific display name for the user

Link to this section Functions

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

Adds the specified generic service identifier to the player’s PlayFab account. This is designed to allow for a PlayFab ID lookup of any arbitrary service identifier a title wants to add. This identifier should never be used as authentication credentials, as the intent is that it is easily accessible by other players.

online docs

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

Adds or updates a contact email to the player’s profile.

online docs

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

Adds playfab username/password auth to an existing account created via an anonymous auth method, e.g. automatic device ID login.

online docs

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

Retrieves the user’s PlayFab account details

online docs

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

Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers.

online docs

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

Retrieves the unique PlayFab identifiers for the given set of Game Center identifiers (referenced in the Game Center Programming Guide as the Player Identifier).

online docs

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

Retrieves the unique PlayFab identifiers for the given set of generic service identifiers. A generic identifier is the service name plus the service-specific ID for the player, as specified by the title when the generic identifier was added to the player account.

online docs

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

Retrieves the unique PlayFab identifiers for the given set of Google identifiers. The Google identifiers are the IDs for the user accounts, available as “id” in the Google+ People API calls.

online docs

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

Retrieves the unique PlayFab identifiers for the given set of Kongregate identifiers. The Kongregate identifiers are the IDs for the user accounts, available as “user_id” from the Kongregate API methods(ex: ).

online docs

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

Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for the user accounts, available as “_id” from the Twitch API methods (ex: ).

online docs

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

Links the Android device identifier to the user’s PlayFab account

online docs

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

Retrieves all of the user’s different kinds of info.

online docs

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

Retrieves the player’s profile

online docs

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

Submit a report for another player (due to bad bahavior, etc.), so that customer service representatives for the title can take action concerning potentially toxic players.

online docs

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

Forces an email to be sent to the registered email address for the user’s account, with a link allowing the user to change the password

online docs

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

Unlinks the related Android device identifier from the user’s PlayFab account

online docs

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

Unlinks the related custom identifier from the user’s PlayFab account

online docs

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

online docs

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

online docs