playfab_ex v0.2.0 PlayfabEx.Client.PlayerDataManagement

Link to this section Summary

Functions

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

Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user

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 requested player. If PlayFabId is empty or null will return currently logged in user

Retrieves the information on the available versions of the specified statistic

Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player

Retrieves the title-specific custom data for the user which is readable and writable 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 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. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features

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

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

Link to this section Functions

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 current player for the given statistic, starting from the indicated point in the leaderboard

online docs

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

Retrieves a list of ranked friends of the current player for the given statistic, centered on the requested PlayFab user. If PlayFabId is empty or null will return currently logged in user.

online docs

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

online docs

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

Retrieves a list of ranked users for the given statistic, centered on the requested player. If PlayFabId is empty or null will return currently logged in user.

online docs

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.

online docs

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

Retrieves the indicated statistics (current version and values for all statistics, if none are specified), for the local player.

online docs

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

online docs

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

online docs

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

online docs

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

online docs

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. By default, clients are not permitted to update statistics. Developers may override this setting in the Game Manager > Settings > API Features.

online docs

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

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

online docs

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

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

online docs