Menu

Expand
Rate this page:

Twilio Sync Client SDKs

Twilio provides client-side Sync SDKs for browser-based web applications as well as native iOS and Android applications.

JavaScript SDK

The latest version of the JavaScript SDK for Sync is made available on Twilio’s CDN. Find the latest release in the Sync JavaScript Changelog. To include it on your web page, simply add the following <script> tag:

<script src="https://media.twiliocdn.com/sdk/js/sync/v1.0/twilio-sync.min.js"></script>

The Twilio.Sync namespace will then be available in the window scope of your JavaScript application.

You’ll need to provision a token to your application to get started. See our guide Securing your Sync App for more information on token management, or look at one of our Quickstarts to get started from a basic example.

Supported browsers

We support the latest major versions of:

  • Chrome
  • Firefox
  • Internet Explorer
  • Microsoft Edge
  • Safari

Android SDK

The Twilio Sync Android SDK is distributed as a direct download from Twilio’s CDN. It can also be referenced in your Gradle build file. The project is deployed on Bintray.

Direct download

Download the Sync Android SDK from the Twilio CDN.

Bintray

Twilio Sync is available from Bintray.

Gradle

To install via Gradle, include the following in your Gradle build file:

allprojects {
  repositories {
    maven {
      url "https://twilio.bintray.com/releases"
    }
  }
}

dependencies {
  implementation 'com.twilio:sync-android:1.0.0'
}

iOS SDK

The iOS SDK is available through the CocoaPods and Swift Package Manager dependency managers, or by direct download.

We do not currently support the Carthage dependency manager because it does not support binary XCFrameworks.

CocoaPods

To install the SDK using CocoaPods, add the following to your Podfile, changing MyTarget to the name of your target:

use_frameworks!
platform :iOS, '11.0'

target 'MyTarget' do
  pod 'TwilioSyncClient', '~> 1.1'
end

Swift Package Manager

To install the SDK with Swift Package Manager, add the following dependency to your project:

https://github.com/twilio/twilio-sync-ios
  1. Open your project in Xcode.
  2. Select File > Swift Packages > Add Package Dependency....
  3. Enter https://github.com/twilio/twilio-sync-ios into the search field in the Choose Package Repository dialog, then click Next.
  4. Make your versioning choice and click Next.
  5. Add the package to one of your targets and click Finish.

Direct Download

We also offer the frameworks for direct download. There are several steps you’ll need to complete to successfully add Sync to your project:

  1. Download the Sync Client framework from the Twilio CDN.
  2. Expand the downloaded .zip file and locate the .xcframework file(s) inside the directory created.
  3. Drag the .xcframework file(s) into your Xcode project, making sure they are dropped in the Embedded Binaries section of your project target’s settings. Make sure you select Copy items if needed when prompted. If the framework file(s) do not appear under Embedded Binaries for your target, you will receive a Reason: image not found error during compilation.
  4. Add libc++.tbd as a dependency to your target in the Linked Frameworks section of the build settings if it is not already there.
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting our Twilio Community forums or browsing the Twilio tag on Stack Overflow.

        
        
        

        Thank you for your feedback!

        We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

        Sending your feedback...
        🎉 Thank you for your feedback!
        Something went wrong. Please try again.

        Thanks for your feedback!

        Refer us and get $10 in 3 simple steps!

        Step 1

        Get link

        Get a free personal referral link here

        Step 2

        Give $10

        Your user signs up and upgrade using link

        Step 3

        Get $10

        1,250 free SMSes
        OR 1,000 free voice mins
        OR 12,000 chats
        OR more