View Source GoogleApi.Games.V1.Model.AchievementDefinition (google_api_games v0.26.1)

An achievement definition object.

Attributes

  • achievementType (type: String.t, default: nil) - The type of the achievement.
  • description (type: String.t, default: nil) - The description of the achievement.
  • experiencePoints (type: String.t, default: nil) - Experience points which will be earned when unlocking this achievement.
  • formattedTotalSteps (type: String.t, default: nil) - The total steps for an incremental achievement as a string.
  • id (type: String.t, default: nil) - The ID of the achievement.
  • initialState (type: String.t, default: nil) - The initial state of the achievement.
  • isRevealedIconUrlDefault (type: boolean(), default: nil) - Indicates whether the revealed icon image being returned is a default image, or is provided by the game.
  • isUnlockedIconUrlDefault (type: boolean(), default: nil) - Indicates whether the unlocked icon image being returned is a default image, or is game-provided.
  • kind (type: String.t, default: nil) - Uniquely identifies the type of this resource. Value is always the fixed string games#achievementDefinition.
  • name (type: String.t, default: nil) - The name of the achievement.
  • revealedIconUrl (type: String.t, default: nil) - The image URL for the revealed achievement icon.
  • totalSteps (type: integer(), default: nil) - The total steps for an incremental achievement.
  • unlockedIconUrl (type: String.t, default: nil) - The image URL for the unlocked achievement icon.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Games.V1.Model.AchievementDefinition{
  achievementType: String.t() | nil,
  description: String.t() | nil,
  experiencePoints: String.t() | nil,
  formattedTotalSteps: String.t() | nil,
  id: String.t() | nil,
  initialState: String.t() | nil,
  isRevealedIconUrlDefault: boolean() | nil,
  isUnlockedIconUrlDefault: boolean() | nil,
  kind: String.t() | nil,
  name: String.t() | nil,
  revealedIconUrl: String.t() | nil,
  totalSteps: integer() | nil,
  unlockedIconUrl: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.