playfab_ex v0.2.0 PlayfabEx.Server.Default.Characters

Link to this section Summary

Functions

Deletes the specific character ID from the specified user

Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness

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

Retrieves the details of all title-specific statistics for the specific character

Retrieves a list of ranked characters for the given statistic, centered on the requested user

Retrieves a list of all of the user’s characters for the given statistic

Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness

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

Link to this section Functions

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

Deletes the specific character ID from the specified user.

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

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

Lists all of the characters that belong to a specific user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.

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

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

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

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

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

Retrieves the details of all title-specific statistics for the specific character

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

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

Retrieves a list of ranked characters for the given statistic, centered on the requested user

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

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

Retrieves a list of all of the user’s characters for the given statistic.

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

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

Grants the specified character type to the user. CharacterIds are not globally unique; characterId must be evaluated with the parent PlayFabId to guarantee uniqueness.

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

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

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

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