Twilio Sync client library
npm install twilio-syncTwilio Sync is Twilio's state synchronization service, offering two-way real-time communication between browsers, mobiles, and the cloud.
Visit our official site for more details: https://www.twilio.com/sync
``
npm install --save twilio-sync
Using this method, you can require twilio-sync.js like so:
`
const { SyncClient } = require('twilio-sync');
const syncClient = new SyncClient(token);
Releases of twilio-sync.js are hosted on a CDN, and you can include these
directly in your web app using a <script> tag.
`
Using this method, twilio-sync.js will set a browser global:
`
const syncClient = new Twilio.Sync.Client(token);
To use the library, you need to generate an Access Token and pass it to the Sync Client constructor.
The Twilio SDK Starter applications for Node.js, Java, PHP, Ruby, Python, C# provide an easy way to set up a token generator locally.
Alternatively, you can set up a Twilio Function based on the _Sync Access Token_ template.
`
// Obtain a JWT access token: https://www.twilio.com/docs/sync/identity-and-access-tokens
const token = '
const syncClient = new Twilio.Sync.Client(token);
// Open a Document by unique name and update its data
syncClient.document('MyDocument')
.then(function(document) {
// Listen to updates on the Document
document.on('updated', function(event) {
console.log('Received Document update event. New data:', event.data);
});
// Update the Document data
const newData = { temperature: 23 };
return document.set(newData);
})
.then(function(updateResult) {
console.log('The Document was successfully updated', updateResult)
})
.catch(function(error) {
console.error('Unexpected error', error)
});
``
For more code examples for Documents and other Sync objects, refer to the SDK API Docs.
See this link.