com.amazonaws.mobileconnectors.cognito

Class CognitoSyncManager

java.lang.Object

com.amazonaws.mobileconnectors.cognito.CognitoSyncManager

public class CognitoSyncManager
extends Object

This saves Dataset in SQLite database. Here is a sample usage:

 CognitoCachingCredentialsProvider provider = new CognitoCachingCredentialsProvider(context,
         awsAccountId, identityPoolId, unauthRoleArn, authRoleArn, Regions.US_EAST_1);
 CognitoClientManager client = new CognitoClientManager(context, Regions.US_EAST_1, provider);

 Dataset dataset = client.openOrCreateDataset("default_dataset");
 dataset.put("high_score", "100");
 dataset.synchronize(new SyncCallback() {
     // override callbacks
 });
 

Constructor Summary

Constructors

Constructor and Description
CognitoSyncManager(android.content.Context context, CognitoCachingCredentialsProvider provider, AWSConfiguration awsConfig) Constructs a CognitoSyncManager object.
CognitoSyncManager(android.content.Context context, Regions region, CognitoCachingCredentialsProvider provider) Constructs a CognitoSyncManager object.
CognitoSyncManager(android.content.Context context, Regions region, CognitoCachingCredentialsProvider provider, ClientConfiguration clientConfiguration) Constructs a CognitoSyncManager object.
CognitoSyncManager(android.content.Context context, String identityPoolId, Regions region, CognitoCachingCredentialsProvider provider) Deprecated. Please use the constructor without an identityPoolId

Method Summary

Modifier and Type	Method and Description
String	getDeviceId() Gets the push sync device id of the device in use.
PushSyncUpdate	getPushSyncUpdate(android.content.Intent intent) Converts the notification from Cognito push sync to an object that has easy access to all of the relevant information.
boolean	isDeviceRegistered() Checks the cache to see if the registration information from a registration with push synchronization is saved to the device for the current identity.
List<DatasetMetadata>	listDatasets() Retrieves a list of datasets from local storage.
Dataset	openOrCreateDataset(String datasetName) Opens or creates a dataset.
void	refreshDatasetMetadata() Refreshes dataset metadata.
void	registerDevice(String platform, String token) Register device for push sync for the specified platform.
void	subscribe(List<String> datasetNames) Subscribes the user to some set of datasets from the total list that the device knows of, giving the user push sync notifications for all in that set
void	subscribeAll() Subscribes the user to all datasets that the local device knows of for push sync notifications, so that any changes to any of these datasets will result in notifications to this device.
void	unregisterDevice() Unregisters the device for push sync for the current identity.
void	unsubscribe(List<String> datasetNames) Unsubscribes the user to some set of datasets from the total list that the device knows of, ending any reception of push sync notifications
void	unsubscribeAll() Unsubscribes the user to all datasets that the local device knows of from push sync notifications, so that no changes to any of these datasets will result in notifications to this device.
void	wipeData() Wipes all user data cached locally, including identity id, session credentials, dataset metadata, and all records.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CognitoSyncManager

@Deprecated
public CognitoSyncManager(android.content.Context context,
                                      String identityPoolId,
                                      Regions region,
                                      CognitoCachingCredentialsProvider provider)

Deprecated. Please use the constructor without an identityPoolId

Constructs a CognitoSyncManager object.

Parameters:

context - a context of the app

identityPoolId - Cognito identity pool id

region - Cognito sync region

provider - a credentials provider

CognitoSyncManager

public CognitoSyncManager(android.content.Context context,
                          CognitoCachingCredentialsProvider provider,
                          AWSConfiguration awsConfig)

Constructs a CognitoSyncManager object.

Parameters:

context - a context of the app

provider - a credentials provider

awsConfig - holds the region of the client

CognitoSyncManager

public CognitoSyncManager(android.content.Context context,
                          Regions region,
                          CognitoCachingCredentialsProvider provider)

Constructs a CognitoSyncManager object.

Parameters:

context - a context of the app

region - Cognito sync region

provider - a credentials provider

CognitoSyncManager

public CognitoSyncManager(android.content.Context context,
                          Regions region,
                          CognitoCachingCredentialsProvider provider,
                          ClientConfiguration clientConfiguration)

Constructs a CognitoSyncManager object.

Parameters:

context - a context of the app

region - Cognito sync region

provider - a credentials provider

clientConfiguration - client configuration for underlying AWS client

Method Detail

openOrCreateDataset

public Dataset openOrCreateDataset(String datasetName)

Opens or creates a dataset. If the dataset doesn't exist, an empty one with the given name will be created. Otherwise, dataset is loaded from local storage. If a dataset is marked as deleted but hasn't been deleted on remote via refreshDatasetMetadata(), it will throw IllegalStateException.

Parameters:

datasetName - dataset name, must be [a-zA-Z0=9_.:-]+

Returns:

dataset loaded from local storage

listDatasets

public List<DatasetMetadata> listDatasets()

Retrieves a list of datasets from local storage. It may not reflects latest dataset on the remote storage until refreshDatasetMetadata is called.

Returns:

list of datasets

refreshDatasetMetadata

public void refreshDatasetMetadata()

Refreshes dataset metadata. Dataset metadata is pulled from remote storage and stored in local storage. Their record data isn't pulled down until you sync each dataset. Note: this is a network request, so calling this method in the main thread will result in NetworkOnMainThreadException.

wipeData

public void wipeData()

Wipes all user data cached locally, including identity id, session credentials, dataset metadata, and all records. Any data that hasn't been synced will be lost. This method should be called after logging out a customer.

registerDevice

public void registerDevice(String platform,
                           String token)

Register device for push sync for the specified platform. Once this device is registered and you have subscribed to a dataset, this device will receive a push notification if the dataset subscribed to is changed by any other device.

Parameters:

platform - Platform of the device, GCM or ADM

token - Device token of the device, gotten when registered for the platform in question.

getDeviceId

public String getDeviceId()

Gets the push sync device id of the device in use. This device id is unique per identity id, and helps identify the endpoint when Cognito is sending push updates.

Returns:

the device id of the current user's device

isDeviceRegistered

public boolean isDeviceRegistered()

Checks the cache to see if the registration information from a registration with push synchronization is saved to the device for the current identity. Device registrations are unique on a per identity/platform basis.

Returns:

true if it has, false if it hasn't

unregisterDevice

public void unregisterDevice()

Unregisters the device for push sync for the current identity. This will clear the local cache that blocks the device from registering, but not clearing the information from outside the device.

subscribeAll

public void subscribeAll()

Subscribes the user to all datasets that the local device knows of for push sync notifications, so that any changes to any of these datasets will result in notifications to this device.

subscribe

public void subscribe(List<String> datasetNames)

Subscribes the user to some set of datasets from the total list that the device knows of, giving the user push sync notifications for all in that set

Parameters:

datasetNames - The list of names of datasets to subscribe to

unsubscribeAll

public void unsubscribeAll()

Unsubscribes the user to all datasets that the local device knows of from push sync notifications, so that no changes to any of these datasets will result in notifications to this device.

unsubscribe

public void unsubscribe(List<String> datasetNames)

Unsubscribes the user to some set of datasets from the total list that the device knows of, ending any reception of push sync notifications

Parameters:

datasetNames - The list of names of datasets to unsubscribe from

getPushSyncUpdate

public PushSyncUpdate getPushSyncUpdate(android.content.Intent intent)

Converts the notification from Cognito push sync to an object that has easy access to all of the relevant information. This should be called only using a Cognito push synchronization message, anything else will return an empty object. PushSyncUpdate.isPushSyncUpdate(Intent intent) can be used to confirm.

Parameters:

intent - for extra the bundle returned from the intent.getExtras() call

Returns:

the PushSyncUpdate that bundle is converted to