Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]
public interface

# Event

implements Freezable<Event> Parcelable

com.google.android.gms.games.event.Event

Known Indirect Subclasses EventEntity
EventEntity | Data object representing the data for a event.

## Class Overview

Data interface for retrieving event information.

## Summary

[Expand] Inherited Constants
From interface android.os.Parcelable
int | CONTENTS_FILE_DESCRIPTOR |
int | PARCELABLE_WRITE_RETURN_VALUE |

Public Methods
abstract String | getDescription() Retrieves the description for this event.
abstract void | getDescription(CharArrayBuffer dataOut) Loads the event description into the given `CharArrayBuffer`.
abstract String | getEventId() Retrieves the ID of this event.
abstract String | 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).
abstract Uri | getIconImageUri() Retrieves a URI that can be used to load the event's image icon.
abstract String | getName() Retrieves the name of this event.
abstract void | getName(CharArrayBuffer dataOut) Loads the event name into the given `CharArrayBuffer`.
abstract Player | 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.

[Expand] Inherited Methods
From interface com.google.android.gms.common.data.Freezable
abstract Event | freeze() Freeze a volatile representation into an immutable representation.
abstract boolean | isDataValid() Check to see if this object is valid for use.
From interface android.os.Parcelable
abstract int | describeContents()
abstract void | writeToParcel(Parcel arg0, int arg1)

## Public Methods

#### public abstract String getDescription ()

Retrieves the description for this event.

##### Returns

- The event description.

#### public abstract void getDescription (CharArrayBuffer dataOut)

Loads the event description into the given `CharArrayBuffer`.

##### Parameters

dataOut | The buffer to load the data into.

#### public abstract String getEventId ()

Retrieves the ID of this event.

##### Returns

- The event ID.

#### public abstract String getFormattedValue ()

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 void getFormattedValue (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 abstract Uri getIconImageUri ()

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 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 abstract String getName ()

Retrieves the name of this event.

##### Returns

- The event name.

#### public abstract void getName (CharArrayBuffer dataOut)

Loads the event name into the given `CharArrayBuffer`.

##### Parameters

dataOut | The buffer to load the data into.

#### public abstract Player 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 of `freeze()`.

##### Returns

- The player associated with this event.

#### public abstract long getValue ()

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.