Known Indirect Subclasses |
Data interface for retrieving event information.
Inherited Constant Summary
Public Method Summary
abstractString |
getDescription()
Retrieves the description for this event.
|
abstract void | |
abstractString |
getEventId()
Retrieves the ID of this event.
|
abstractString |
getFormattedValue()
Retrieves the sum of increments have been made to this event (formatted for the
user's locale).
|
abstract void |
getFormattedValue(CharArrayBuffer
dataOut)
Retrieves the sum of increments have been made to this event (formatted for the
user's locale).
|
abstractUri |
getIconImageUri()
Retrieves a URI that can be used to load the event's image icon.
|
abstractString |
getName()
Retrieves the name of this event.
|
abstract void | |
abstractPlayer |
getPlayer()
Retrieves the player information associated with this event.
|
abstract long |
getValue()
Retrieves the number of increments this user has made to this event.
|
abstract boolean |
isVisible()
Retrieves whether the event should be displayed to the user in any event
related UIs.
|
Inherited Method Summary
Public Methods
public abstractStringgetDescription()
Retrieves the description for this event.
Returns
- The event description.
public abstract voidgetDescription(CharArrayBuffer dataOut)
Loads the event description into the givenCharArrayBuffer
.
Parameters
dataOut | The buffer to load the data into. |
---|
public abstractStringgetEventId()
Retrieves the ID of this event.
Returns
- The event ID.
public abstractStringgetFormattedValue()
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.
public abstract 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. |
---|
public abstractUrigetIconImageUri()
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.
public abstractStringgetName()
Retrieves the name of this event.
Returns
- The event name.
public abstract voidgetName(CharArrayBuffer dataOut)
Loads the event name into the givenCharArrayBuffer
.
Parameters
dataOut | The buffer to load the data into. |
---|
public abstractPlayer 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 abstract 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 abstract boolean isVisible()
Retrieves whether the event should be displayed to the user in any event related UIs.
Returns
- Whether to display the event to the user.