ExOsrsApi.PlayerHighscores (ExOsrsApi v0.1.0) View Source

Link to this section Summary

Link to this section Types

Specs

t() :: %ExOsrsApi.PlayerHighscores{
  activities: ExOsrsApi.Models.Activities.t() | nil,
  empty: term(),
  skills: ExOsrsApi.Models.Skills.t() | nil,
  type: atom(),
  username: term()
}

Link to this section Functions

Link to this function

get_activities(player_highscores)

View Source

Specs

get_activities(t()) :: ExOsrsApi.Models.Activities.t() | nil
Link to this function

get_activity_data(player_highscores, activity)

View Source

Specs

get_activity_data(t(), binary()) ::
  {:error, ExOsrsApi.Errors.Error.t()}
  | {:ok, ExOsrsApi.Models.ActivityEntry.t()}
Link to this function

get_non_null_activities(player_highscores)

View Source

Specs

get_non_null_activities(t()) :: [ExOsrsApi.Models.ActivityEntry.t()]
Link to this function

get_non_null_skills(player_highscores)

View Source

Specs

get_non_null_skills(t()) :: [ExOsrsApi.Models.SkillEntry.t()]
Link to this function

get_skill_data(player_highscores, skill)

View Source

Specs

get_skill_data(t(), atom()) ::
  {:error, ExOsrsApi.Errors.Error.t()} | {:ok, ExOsrsApi.Models.SkillEntry.t()}
Link to this function

get_skills(player_highscores)

View Source

Specs

get_skills(t()) :: ExOsrsApi.Models.Skills.t() | nil
Link to this function

is_empty?(player_highscores)

View Source

Specs

is_empty?(t()) :: boolean()
Link to this function

new_empty(username, type)

View Source

Specs

new_empty(String.t(), atom()) :: {:ok, t()}
Link to this function

new_from_bitstring(username, type, data)

View Source

Specs

new_from_bitstring(String.t(), atom(), String.t()) ::
  {:error, ExOsrsApi.Errors.Error.t()} | {:ok, t()}