Hide

AppStateManager

public final class AppStateManager extends Object
java.lang.Object
   ↳ com.google.android.gms.appstate.AppStateManager

This class is deprecated.
App State APIs are now deprecated. Please use Saved Games instead (https://developers.google.com/games/services/common/concepts/savedgames).

Main public API entry point for the AppState APIs.

Nested Class Summary

interface AppStateManager.StateConflictResult Result retrieved from AppStateManager.StateResult when a conflict is detected while loading app state. 
interface AppStateManager.StateDeletedResult Result delivered when app state data has been deleted. 
interface AppStateManager.StateListResult Result delivered when app state data has been loaded. 
interface AppStateManager.StateLoadedResult Result retrieved from AppStateManager.StateResult when app state data has been loaded successfully. 
interface AppStateManager.StateResult Result of an operation that could potentially generate a state conflict. 

Field Summary

public static final Api<Api.ApiOptions.NoOptions> API Token to pass to addApi(Api) to enable AppState features.
public static final Scope SCOPE_APP_STATE Scope for using the App State service.

Public Method Summary

static PendingResult<AppStateManager.StateDeletedResult>
delete(GoogleApiClient googleApiClient, int stateKey)
static int
getMaxNumKeys(GoogleApiClient googleApiClient)
static int
getMaxStateSize(GoogleApiClient googleApiClient)
static PendingResult<AppStateManager.StateListResult>
list(GoogleApiClient googleApiClient)
static PendingResult<AppStateManager.StateResult>
load(GoogleApiClient googleApiClient, int stateKey)
static PendingResult<AppStateManager.StateResult>
resolve(GoogleApiClient googleApiClient, int stateKey, String resolvedVersion, byte[] resolvedData)
static PendingResult<Status>
signOut(GoogleApiClient googleApiClient)
static void
update(GoogleApiClient googleApiClient, int stateKey, byte[] data)
static PendingResult<AppStateManager.StateResult>
updateImmediate(GoogleApiClient googleApiClient, int stateKey, byte[] data)

Fields

public static final Api<Api.ApiOptions.NoOptions> API

Token to pass to addApi(Api) to enable AppState features.

public static final Scope SCOPE_APP_STATE

Scope for using the App State service.

Public Methods

public static PendingResult<AppStateManager.StateDeletedResult> delete (GoogleApiClient googleApiClient, int stateKey)

Delete the state data for the current app. This method will delete all data associated with the provided key, as well as removing the key itself.

Note that this API is not version safe. This means that it is possible to accidentally delete a user's data using this API. For a version safe alternative, consider using update(GoogleApiClient, int, byte[]) with null data instead.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
stateKey The key to clear data for. Must be a non-negative integer less than getMaxNumKeys(GoogleApiClient).
Returns

public static int getMaxNumKeys (GoogleApiClient googleApiClient)

Gets the maximum number of keys that an app can store data in simultaneously.

If the service cannot be reached for some reason, this will return STATUS_CLIENT_RECONNECT_REQUIRED. In this case, no further operations should be attempted until after the client has reconnected.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
Returns
  • The maximum number of keys that an app can use for data.

public static int getMaxStateSize (GoogleApiClient googleApiClient)

Gets the maximum app state size per state key in bytes. Guaranteed to be at least 256 KB. May increase in the future.

If the service cannot be reached for some reason, this will return STATUS_CLIENT_RECONNECT_REQUIRED. In this case, no further operations should be attempted until after the client has reconnected.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
Returns
  • The maximum state size that can be stored with a given state key in bytes.

public static PendingResult<AppStateManager.StateListResult> list (GoogleApiClient googleApiClient)

Asynchronously lists all the saved states for the current app.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
Returns

public static PendingResult<AppStateManager.StateResult> load (GoogleApiClient googleApiClient, int stateKey)

Asynchronously loads saved state for the current app.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
stateKey The key to load data for. Must be a non-negative integer less than getMaxNumKeys(GoogleApiClient).
Returns

public static PendingResult<AppStateManager.StateResult> resolve (GoogleApiClient googleApiClient, int stateKey, String resolvedVersion, byte[] resolvedData)

Resolve a previously detected conflict in app state data. Note that it is still possible to receive a conflict callback after this call. This will occur if data on the server continues to change. In this case, resolution should be retried until a successful status is returned.

The value of resolvedVersion passed here must correspond to the value returned from getResolvedVersion().

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
stateKey The key to resolve data for. Must be a non-negative integer less than getMaxNumKeys(GoogleApiClient).
resolvedVersion Version code from previous onStateConflict call.
resolvedData Data to submit as the current data. null is a valid value here. May be a maximum of getMaxStateSize(GoogleApiClient) bytes.
Returns

public static PendingResult<Status> signOut (GoogleApiClient googleApiClient)

Asynchronously signs the current user out.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
Returns

public static void update (GoogleApiClient googleApiClient, int stateKey, byte[] data)

Updates app state for the current app. The data provided here is developer-specified and can be in any format appropriate for the app. This method updates the local copy of the app state and syncs the changes to the server. If the local data conflicts with the data on the server, this will be indicated the next time you call load(GoogleApiClient, int).

This is the fire-and-forget form of the API. Use this form if you don't need to know the results of the operation immediately. For most applications, this will be the preferred API to use. See updateImmediate(GoogleApiClient, int, byte[]) if you need the results delivered to your application.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
stateKey The key to update data for. Must be a non-negative integer less than getMaxNumKeys(GoogleApiClient).
data The data to store. May be a maximum of getMaxStateSize(GoogleApiClient) bytes.

public static PendingResult<AppStateManager.StateResult> updateImmediate (GoogleApiClient googleApiClient, int stateKey, byte[] data)

Updates app state for the current app. The data provided here is developer-specified and can be in any format appropriate for the app. This method will attempt to update the data on the server immediately. The results of this operation will be returned via a PendingResult.

Required API: API
Required Scopes: SCOPE_APP_STATE

Parameters
googleApiClient The GoogleApiClient to service the call.
stateKey The key to update data for. Must be a non-negative integer less than getMaxNumKeys(GoogleApiClient).
data The data to store. May be a maximum of getMaxStateSize(GoogleApiClient) bytes.
Returns