ContentSync Docs
  • Welcome
  • What is ContentSync?
    • Content Versions
    • Content Keys
  • Quick Start
  • Platform
    • ContentSync.com
      • Team Accounts
  • Spreadsheets
    • Google Spreadsheets
    • Microsoft Excel 365
  • Plugins
    • Adobe XD Plugin
      • Adobe XD - Getting Started
      • Features
        • Push Content
        • Pull Content
        • Image Syncing
    • Sketch Plugin
      • Sketch - Getting Started
      • Features
        • Image Syncing
        • Symbol Overrides
        • Symbol Swapping
        • Content Styles
        • Multiple Sheets
        • Saved Sync Defaults
        • ContentSync.API()
      • Troubleshooting
  • Troubleshooting
  • FAQ
  • Security & Data
  • Contact Us
Powered by GitBook
On this page
  • ContentSync.API().versions(callback(ok, data))
  • ContentSync.API().pull(versions, callback(ok, data))
  • ContentSync.API().syncSelection(version_name, data, selection, callback(ok, data))
  • Development

Was this helpful?

  1. Plugins
  2. Sketch Plugin
  3. Features

ContentSync.API()

ContentSync can also be used from other Sketch plugins too. Use ContentSync.API() within Sketch plugin code to integrate and extend ContentSync.

ContentSync.API().versions(callback(ok, data))

ContentSync.API().versions(...) will return a list of versions from your linked ContentSync project. Callback should be a function which takes two parameters, ok and data.

Function Definition

ok - true if successful, false if error

data- List of version objects if ok==true and error details if ok==false asasa

version - Object of the format:

{
    name: string,
    syncable: boolean
}

Example

An example Sketch script which would print out the versions looks like this:

function withV(v){
    console.log(v);
}

// Fetch ContentSync versions and print them out
ContentSync.API().versions((ok, data) => {
    if(ok) data.map(withV);
    if(!ok) console.log("Error: ", data);
});

ContentSync.API().pull(versions, callback(ok, data))

Coming soon.

ContentSync.API().syncSelection(version_name, data, selection, callback(ok, data))

Coming soon.

Development

PreviousSaved Sync DefaultsNextTroubleshooting

Last updated 3 years ago

Was this helpful?

ContentSync.API() is still in early development. Please contact us or create a issue to request additional features or report any problem.

Github