playfab_ex v0.2.2 PlayfabEx.Server.AccountManagement

Link to this section Summary

Functions

Bans users by PlayFab ID with optional IP address, or MAC address for the provided game

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

Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls

Retrieves the player’s profile

Retrieves the relevant details for a specified user

Gets all bans for a user

Revoke all active bans for a user

Revoke all active bans specified with BanId

Forces an email to be sent to the registered contact email address for the user’s account based on an account recovery email template

Sends an email based on an email template to a player’s contact email

Sends an iOS/Android Push Notification to a specific user, if that user’s device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified

Update the avatar URL of the specified player

Updates information of a list of existing bans specified with Ban Ids

Link to this section Functions

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

Bans users by PlayFab ID with optional IP address, or MAC address for the provided game.

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_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 Steam identifiers. The Steam identifiers are the profile IDs for the user accounts, available as SteamId in the Steamworks Community API calls.

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 get_user_account_info(params)
get_user_account_info(map()) :: {:ok, map()} | {:error, String.t()}

Retrieves the relevant details for a specified user

online docs

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

Gets all bans for a user.

online docs

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

Revoke all active bans for a user.

online docs

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

Revoke all active bans specified with BanId.

online docs

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

Forces an email to be sent to the registered contact email address for the user’s account based on an account recovery email template

online docs

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

Sends an email based on an email template to a player’s contact email

online docs

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

Sends an iOS/Android Push Notification to a specific user, if that user’s device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.

online docs

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

Update the avatar URL of the specified player

online docs

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

Updates information of a list of existing bans specified with Ban Ids.

online docs