Events | Android Developers

Quicknav Quicknav
Links

- Google Play Developer Console
- Android Developers Blog
- About Android

Android Sites

- Android.com
- Android Developers
- Android Open Source Project

Language
close

- - About
  - Wear
  - TV
  - Auto
- - Get Started
  - Devices
  - Style
  - Patterns
  - Building Blocks
  - Downloads
  - Videos
- - Training
  - API Guides
  - Reference
  - Tools
  - Google Services
  - Samples
- - Google Play
  - Essentials
  - Get Users
  - Engage & Retain
  - Monetize
  - Tools & Reference
  - Developer Stories

## Results

Loading...
public interface

# Events

com.google.android.gms.games.event.Events

## Class Overview

Entry point for events functionality.

## Summary

Nested Classes
interface | Events.LoadEventsResult | Result delivered when event data has been loaded.

Public Methods
abstract void | increment(GoogleApiClient apiClient, String eventId, int incrementAmount) Increments an event by the given number of steps.
abstract PendingResult<Events.LoadEventsResult> | load(GoogleApiClient apiClient, boolean forceReload) Asynchronously load event data for the currently signed in player.
abstract PendingResult<Events.LoadEventsResult> | loadByIds(GoogleApiClient apiClient, boolean forceReload, String... eventIds) Asynchronously load event data for specified event IDs.

## Public Methods

#### public abstract void increment (GoogleApiClient apiClient, String eventId, int incrementAmount)

Increments an event by the given number of steps.

This is the fire-and-forget API. Event increments are cached locally and flushed to the server in batches.

Required API: `API`
Required Scopes: `SCOPE_GAMES`

##### Parameters

apiClient | The `GoogleApiClient` to service the call.
eventId | The event ID to increment.
incrementAmount | The amount increment by. Must be greater than or equal to 0.

#### public abstract PendingResult<Events.LoadEventsResult> load (GoogleApiClient apiClient, boolean forceReload)

Asynchronously load event data for the currently signed in player.

Required API: `API`
Required Scopes: `SCOPE_GAMES`

##### Parameters

apiClient | The `GoogleApiClient` to service the call.
forceReload | If true, this call will clear any locally cached data and attempt to fetch the latest data from the server. This would commonly be used for something like a user-initiated refresh. Normally, this should be set to false to gain advantages of data caching.

##### Returns

- `PendingResult` to access the data when available.

#### public abstract PendingResult<Events.LoadEventsResult> loadByIds (GoogleApiClient apiClient, boolean forceReload, String... eventIds)

Asynchronously load event data for specified event IDs.

Required API: `API`
Required Scopes: `SCOPE_GAMES`

##### Parameters

apiClient | The `GoogleApiClient` to service the call.
forceReload | If true, this call will clear any locally cached data and attempt to fetch the latest data from the server. This would commonly be used for something like a user-initiated refresh. Normally, this should be set to false to gain advantages of data caching.
eventIds | The IDs of the events to load.

##### Returns

- `PendingResult` to access the data when available.