playfab_ex v0.2.0 PlayfabEx.Server.Default.PlayerDataManagement

Link to this section Summary

Functions

Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics

Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard

Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard

Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user

Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false

Retrieves the information on the available versions of the specified statistic

Retrieves the current version and values for the indicated statistics, for the local player

Retrieves the title-specific custom data for the user which is readable and writable by the client

Retrieves the title-specific custom data for the user which cannot be accessed by the client

Retrieves the publisher-specific custom data for the user which is readable and writable by the client

Retrieves the publisher-specific custom data for the user which cannot be accessed by the client

Retrieves the publisher-specific custom data for the user which can only be read by the client

Retrieves the title-specific custom data for the user which can only be read by the client

Updates the values of the specified title-specific statistics for the user

Updates the title-specific custom data for the user which is readable and writable by the client

Updates the title-specific custom data for the user which cannot be accessed by the client

Updates the publisher-specific custom data for the user which is readable and writable by the client

Updates the publisher-specific custom data for the user which cannot be accessed by the client

Updates the publisher-specific custom data for the user which can only be read by the client

Updates the title-specific custom data for the user which can only be read by the client

Link to this section Functions

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

Deletes the users for the provided game. Deletes custom data, all account linkages, and statistics.

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

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

Retrieves a list of ranked friends of the given player for the given statistic, starting from the indicated point in the leaderboard

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

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

Retrieves a list of ranked users for the given statistic, starting from the indicated point in the leaderboard

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

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

Retrieves a list of ranked users for the given statistic, centered on the currently signed-in user

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

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

Returns whatever info is requested in the response for the user. Note that PII (like email address, facebook id) may be returned. All parameters default to false.

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

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

Retrieves the information on the available versions of the specified statistic.

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

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

Retrieves the current version and values for the indicated statistics, for the local player.

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

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

Retrieves the title-specific custom data for the user which is readable and writable by the client

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

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

Retrieves the title-specific custom data for the user which cannot be accessed by the client

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

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

Retrieves the publisher-specific custom data for the user which is readable and writable by the client

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

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

Retrieves the publisher-specific custom data for the user which cannot be accessed by the client

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

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

Retrieves the publisher-specific custom data for the user which can only be read by the client

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

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

Retrieves the title-specific custom data for the user which can only be read by the client

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

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

Updates the values of the specified title-specific statistics for the user

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

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

Updates the title-specific custom data for the user which is readable and writable by the client

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

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

Updates the title-specific custom data for the user which cannot be accessed by the client

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

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

Updates the publisher-specific custom data for the user which is readable and writable by the client

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

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

Updates the publisher-specific custom data for the user which cannot be accessed by the client

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

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

Updates the publisher-specific custom data for the user which can only be read by the client

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

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

Updates the title-specific custom data for the user which can only be read by the client

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