Data object representing the data for a event. This is immutable, and therefore safe to cache or store. Note, however, that the data it represents may grow stale.
Inherited Constant Summary
Field Summary
| public static finalCreator<EventEntity> | CREATOR |
Public Constructor Summary
|
EventEntity(Event
event)
|
Public Method Summary
| boolean | |
| Event |
freeze()
|
| String |
getDescription()
Retrieves the description for this event.
|
| void | |
| String |
getEventId()
Retrieves the ID of this event.
|
| void |
getFormattedValue(CharArrayBuffer
dataOut)
Retrieves the sum of increments have been made to this event (formatted for the
user's locale).
|
| String |
getFormattedValue()
Retrieves the sum of increments have been made to this event (formatted for the
user's locale).
|
| Uri |
getIconImageUri()
Retrieves a URI that can be used to load the event's image icon.
|
| String | |
| void | |
| String |
getName()
Retrieves the name of this event.
|
| Player |
getPlayer()
Retrieves the player information associated with this event.
|
| long |
getValue()
Retrieves the number of increments this user has made to this event.
|
| int |
hashCode()
|
| boolean | |
| boolean |
isVisible()
Retrieves whether the event should be displayed to the user in any event
related UIs.
|
| String |
toString()
|
| void |
writeToParcel(Parcelout, int
flags)
|
Inherited Method Summary
Fields
public static finalCreator<EventEntity> CREATOR
Public Constructors
publicEventEntity(Event event)
Public Methods
public booleanequals(Objectobj)
publicEvent freeze()
publicStringgetDescription()
Retrieves the description for this event.
Returns
- The event description.
public voidgetDescription(CharArrayBuffer dataOut)
Loads the event description into the givenCharArrayBuffer.
Parameters
| dataOut | The buffer to load the data into. |
|---|
publicStringgetEventId()
Retrieves the ID of this event.
Returns
- The event ID.
public voidgetFormattedValue(CharArrayBuffer dataOut)
Retrieves the sum of increments have been made to this event (formatted for the user's locale).
Parameters
| dataOut | The buffer to load the data into. |
|---|
publicStringgetFormattedValue()
Retrieves the sum of increments have been made to this event (formatted for the user's locale).
Returns
- The formatted number of increments this user has made to this event.
publicUrigetIconImageUri()
Retrieves a URI that can be used to load the event's image icon. Returns null if the event has no image.
To retrieve the Image from theUri,use
ImageManager.
Returns
- The image URI for the achievement's unlocked image icon, or null if the achievement has no unlocked image.
publicStringgetIconImageUrl()
public voidgetName(CharArrayBuffer dataOut)
Loads the event name into the givenCharArrayBuffer.
Parameters
| dataOut | The buffer to load the data into. |
|---|
publicStringgetName()
Retrieves the name of this event.
Returns
- The event name.
publicPlayer getPlayer()
Retrieves the player information associated with this event.
Note that this object is a volatile representation, so it is not safe to cache the
output of this directly. Instead, cache the result ofFreezable.freeze().
Returns
- The player associated with this event.
public longgetValue()
Retrieves the number of increments this user has made to this event.
Returns
- The number of increments this user has made to this event.
public inthashCode()
public booleanisDataValid()
public booleanisVisible()
Retrieves whether the event should be displayed to the user in any event related UIs.
Returns
- Whether to display the event to the user.