You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 16, 2020. It is now read-only.
Developer Preview: We welcome developer feedback on this project. You can reach us by creating an issue on the GitHub repository or post to the Amazon Cognito forums:
The Cognito Sync Manager for JavaScript allows your web application to store data in the cloud for your users and
synchronize across other devices. The library uses the browser's local storage API to create a local cache for the
data, similar to our mobile SDK. This allows your web application to access stored data even when there is no
connectivity.
Note: This library is designed to run in the browser. It has not been tested for use in other environments.
For NPM usage refer to the following issue: NPM usage.
Usage
Step 1. Log into Amazon Cognito management console and create a new identity pool. Be sure to enable the "unauthenticated
identities" option. On the last step of the wizard, make a note of your Account ID, Identity Pool ID, and
Unauthenticated Role ARN.
Step 2. Instantiate the AWS JavaScript SDK using the AWS.CognitoIdentityCredentials class, using the information you
gathered from the previous step.
AWS.config.region='us-east-1';AWS.config.credentials=newAWS.CognitoIdentityCredentials({IdentityPoolId: 'YOUR IDENTITY POOL ID',});
Step 3. Make the call to obtain the credentials you configured, and in the callback, instantiate the CognitoSyncManager
class. It will assume the credentials from the AWS SDK.
AWS.config.credentials.get(function(){client=newAWS.CognitoSyncManager();// YOUR CODE HERE});
Step 4. Now you need to open or create a new dataset to start saving data to. Call .openOrCreateDataset() and pass in the
desired dataset name.
client.openOrCreateDataset('myDatasetName',function(err,dataset){// Do something with the dataset here.});
Step 5. Once you have the dataset object, you can write, read, and delete records to that dataset. It is also possible to get all the records from a given dataset, get the amount of data used by a dataset, and more.
<!-- Read Records -->
dataset.get('myRecord',function(err,value){console.log('myRecord: '+value);});
<!-- Write Records -->
dataset.put('newRecord','newValue',function(err,record){console.log(record);});
<!-- Delete Records -->
dataset.remove('oldKey',function(err,record){if(!err){console.log('success');}});
Step 6. Finally, synchronize the data to Cognito. You pass the synchronize function an object with callbacks to handle the
various outcomes: onSuccess, onFailure, onConflict, onDatasetsMerged, onDatasetDeleted.
<!-- Synchronize -->
dataset.synchronize({onSuccess: function(dataset,newRecords){//...},onFailure: function(err){//...},onConflict: function(dataset,conflicts,callback){varresolved=[];for(vari=0;i<conflicts.length;i++){// Take remote version.resolved.push(conflicts[i].resolveWithRemoteRecord());// Or... take local version.// resolved.push(conflicts[i].resolveWithLocalRecord());// Or... use custom logic.// var newValue = conflicts[i].getRemoteRecord().getValue() + conflicts[i].getLocalRecord().getValue();// resolved.push(conflicts[i].resolveWithValue(newValue);}dataset.resolve(resolved,function(){returncallback(true);});// Or... callback false to stop the synchronization process.// return callback(false);},onDatasetDeleted: function(dataset,datasetName,callback){// Return true to delete the local copy of the dataset.// Return false to handle deleted datasets outsid ethe synchronization callback.returncallback(true);},onDatasetsMerged: function(dataset,datasetNames,callback){// Return true to continue the synchronization process.// Return false to handle dataset merges outside the synchroniziation callback.returncallback(false);}});
