Data object representing a set of Achievement data. This is immutable, and therefore safe to cache or store. Note, however, that the data it represents may grow stale.
This class exists solely to support parceling these objects and should not be used directly.
Inherited Constant Summary
int | CONTENTS_FILE_DESCRIPTOR | |
int | PARCELABLE_WRITE_RETURN_VALUE |
int | STATE_HIDDEN | Constant returned by
getState() indicating a hidden achievement. |
int | STATE_REVEALED | Constant returned by
getState() indicating a revealed achievement. |
int | STATE_UNLOCKED | Constant returned by
getState() indicating an unlocked achievement. |
int | TYPE_INCREMENTAL | Constant returned by
getType() indicating an incremental achievement. |
int | TYPE_STANDARD | Constant returned by
getType() indicating a standard achievement. |
Field Summary
public static final Creator<AchievementEntity> | CREATOR |
Public Method Summary
boolean | |
Achievement |
freeze()
|
String |
getAchievementId()
Retrieves the ID of this achievement.
|
int |
getCurrentSteps()
Retrieves the number of steps this user has gone toward unlocking this
achievement; only applicable for
TYPE_INCREMENTAL achievement types.
|
String |
getDescription()
Retrieves the description for this achievement.
|
void |
getDescription(CharArrayBuffer
dataOut)
Loads the achievement description into the given
CharArrayBuffer .
|
String |
getFormattedCurrentSteps()
Retrieves the number of steps this user has gone toward unlocking this
achievement (formatted for the user's locale); only applicable for
TYPE_INCREMENTAL achievement types.
|
void |
getFormattedCurrentSteps(CharArrayBuffer
dataOut)
Retrieves the number of steps this user has gone toward unlocking this
achievement (formatted for the user's locale) into the given
CharArrayBuffer .
|
void |
getFormattedTotalSteps(CharArrayBuffer
dataOut)
Loads the total number of steps necessary to unlock this achievement (formatted
for the user's locale) into the given
CharArrayBuffer ;
only applicable for
TYPE_INCREMENTAL achievement types.
|
String |
getFormattedTotalSteps()
Retrieves the total number of steps necessary to unlock this achievement,
formatted for the user's locale; only applicable for
TYPE_INCREMENTAL achievement types.
|
long |
getLastUpdatedTimestamp()
Retrieves the timestamp (in millseconds since epoch) at which this achievement
was last updated.
|
void | |
String |
getName()
Retrieves the name of this achievement.
|
Player |
getPlayer()
Retrieves the player information associated with this achievement.
|
Uri |
getRevealedImageUri()
Retrieves a URI that can be used to load the achievement's revealed image icon.
|
String | |
int |
getState()
Returns the
Achievement.AchievementState of the achievement.
|
int |
getTotalSteps()
Retrieves the total number of steps necessary to unlock this achievement; only
applicable for
TYPE_INCREMENTAL achievement types.
|
int |
getType()
Returns the
Achievement.AchievementType of this achievement.
|
Uri |
getUnlockedImageUri()
Retrieves a URI that can be used to load the achievement's unlocked image icon.
|
String | |
long |
getXpValue()
Retrieves the XP value of this achievement.
|
int |
hashCode()
|
boolean | |
String |
toString()
|
void |
writeToParcel(Parcel dest, int
flags)
|
Inherited Method Summary
abstract int |
describeContents()
|
abstract void |
writeToParcel(Parcel arg0,
int arg1)
|
abstract String |
getAchievementId()
Retrieves the ID of this achievement.
|
abstract int |
getCurrentSteps()
Retrieves the number of steps this user has gone toward unlocking this
achievement; only applicable for
TYPE_INCREMENTAL achievement types.
|
abstract String |
getDescription()
Retrieves the description for this achievement.
|
abstract void |
getDescription(CharArrayBuffer
dataOut)
Loads the achievement description into the given
CharArrayBuffer .
|
abstract void |
getFormattedCurrentSteps(CharArrayBuffer
dataOut)
Retrieves the number of steps this user has gone toward unlocking this
achievement (formatted for the user's locale) into the given
CharArrayBuffer .
|
abstract String |
getFormattedCurrentSteps()
Retrieves the number of steps this user has gone toward unlocking this
achievement (formatted for the user's locale); only applicable for
TYPE_INCREMENTAL achievement types.
|
abstract void |
getFormattedTotalSteps(CharArrayBuffer
dataOut)
Loads the total number of steps necessary to unlock this achievement
(formatted for the user's locale) into the given
CharArrayBuffer ; only applicable for
TYPE_INCREMENTAL achievement types.
|
abstract String |
getFormattedTotalSteps()
Retrieves the total number of steps necessary to unlock this achievement,
formatted for the user's locale; only applicable for
TYPE_INCREMENTAL achievement types.
|
abstract long |
getLastUpdatedTimestamp()
Retrieves the timestamp (in millseconds since epoch) at which this
achievement was last updated.
|
abstract void | |
abstract String |
getName()
Retrieves the name of this achievement.
|
abstract Player |
getPlayer()
Retrieves the player information associated with this achievement.
|
abstract Uri |
getRevealedImageUri()
Retrieves a URI that can be used to load the achievement's revealed image
icon.
|
abstract int |
getState()
Returns the
Achievement.AchievementState of the achievement.
|
abstract int |
getTotalSteps()
Retrieves the total number of steps necessary to unlock this achievement;
only applicable for
TYPE_INCREMENTAL achievement types.
|
abstract int |
getType()
Returns the
Achievement.AchievementType of this achievement.
|
abstract Uri |
getUnlockedImageUri()
Retrieves a URI that can be used to load the achievement's unlocked image
icon.
|
abstract long |
getXpValue()
Retrieves the XP value of this achievement.
|
abstract Achievement |
freeze()
|
abstract boolean |
isDataValid()
|
Fields
public static final Creator<AchievementEntity> CREATOR
Public Methods
public boolean equals (Object obj)
public Achievement freeze ()
public String getAchievementId ()
Retrieves the ID of this achievement.
Returns
- The achievement ID.
public int getCurrentSteps ()
Retrieves the number of steps this user has gone toward unlocking this achievement;
only applicable for
TYPE_INCREMENTAL
achievement types.
Returns
- The number of steps this user has gone toward unlocking this achievement.
public String getDescription ()
Retrieves the description for this achievement.
Returns
- The achievement description.
public void getDescription (CharArrayBuffer dataOut)
Loads the achievement description into the given CharArrayBuffer
.
Parameters
dataOut | The buffer to load the data into. |
---|
public String getFormattedCurrentSteps ()
Retrieves the number of steps this user has gone toward unlocking this achievement
(formatted for the user's locale); only applicable for
TYPE_INCREMENTAL
achievement types.
Returns
- The formatted number of steps this user has gone toward unlocking this
achievement or
null
if this information is unavailable.
public void getFormattedCurrentSteps (CharArrayBuffer dataOut)
Retrieves the number of steps this user has gone toward unlocking this achievement
(formatted for the user's locale) into the given CharArrayBuffer
.
Parameters
dataOut | The buffer to load the data into. |
---|
public void getFormattedTotalSteps (CharArrayBuffer dataOut)
Loads the total number of steps necessary to unlock this achievement (formatted for
the user's locale) into the given CharArrayBuffer
;
only applicable for
TYPE_INCREMENTAL
achievement types.
Parameters
dataOut | The buffer to load the data into. |
---|
public String getFormattedTotalSteps ()
Retrieves the total number of steps necessary to unlock this achievement, formatted
for the user's locale; only applicable for
TYPE_INCREMENTAL
achievement types.
Returns
- The total number of steps necessary to unlock this achievement or
null
if this information is unavailable.
public long getLastUpdatedTimestamp ()
Retrieves the timestamp (in millseconds since epoch) at which this achievement was last updated. If the achievement has never been updated, this will return -1.
Returns
- Timestamp at which this achievement was last updated.
public void getName (CharArrayBuffer dataOut)
Loads the achievement name into the given CharArrayBuffer
.
Parameters
dataOut | The buffer to load the data into. |
---|
public String getName ()
Retrieves the name of this achievement.
Returns
- The achievement name.
public Player getPlayer ()
Retrieves the player information associated with this achievement.
Note that this object is a volatile representation, so it is not safe to cache the
output of this directly. Instead, cache the result of Freezable.freeze()
.
Returns
- The player associated with this achievement.
public Uri getRevealedImageUri ()
Retrieves a URI that can be used to load the achievement's revealed image icon. Returns null if the achievement has no revealed image.
To retrieve the Image from the Uri
, use
ImageManager
.
Returns
- The image URI for the achievement's revealed image icon, or null if the achievement has no revealed image.
public String getRevealedImageUrl ()
public int getState ()
Returns the
Achievement.AchievementState
of the achievement.
public int getTotalSteps ()
Retrieves the total number of steps necessary to unlock this achievement; only
applicable for
TYPE_INCREMENTAL
achievement types.
Returns
- The total number of steps necessary to unlock this achievement.
public int getType ()
Returns the
Achievement.AchievementType
of this achievement.
public Uri getUnlockedImageUri ()
Retrieves a URI that can be used to load the achievement's unlocked image icon. Returns null if the achievement has no unlocked image.
To retrieve the Image from the Uri
, use
ImageManager
.
Returns
- The image URI for the achievement's unlocked image icon, or null if the achievement has no unlocked image.
public String getUnlockedImageUrl ()
public long getXpValue ()
Retrieves the XP value of this achievement.
Returns
- XP value given to players for unlocking this achievement.