Syncano

Class: Syncano

Syncano

new Syncano(options)

Main Syncano object.

Parameters:
Name Type Description
options Object

All configuration options

Properties
Name Type Argument Default Description
baseUrl Object <optional>
 'https://api.syncano.io'

Base URL for all api calls.
accountKey Object <optional>
 null

Your Syncano account key.
userKey Object <optional>
 null

Instance user api key.
socialToken Object <optional>
 null

Instance social authentication token.
defaults Object <optional>
 {}

Object with default properties for api calls.
Source:
Returns:
Type
Syncano
Example
var connection = Syncano({accountKey: '123'});
var connection = Syncano({userKey: '123'});
var connection = Syncano({socialToken: '123'});
var connection = Syncano({ defaults: { instanceName: 'my-instance' }});

Methods

getAccountKey()

Gets accountKey.

Source:
Returns:
Type
String
Example
var connection = Syncano({accountKey: '123'});
var accountKey = connection.getAccountKey();

getApiKey()

Gets apiKey.

Source:
Returns:
Type
String
Example
var connection = Syncano({apiKey: '123'});
var apiKey = connection.getApiKey();

getBaseUrl()

Gets baseUrl.

Source:
Returns:
Type
String
Example
var connection = Syncano({accountKey: '123'});
var baseUrl = connection.getBaseUrl();

getInstanceName()

Gets instanceName.

Source:
Returns:
Type
String
Example
var connection = Syncano({accountKey: '123'});
var instanceName = connection.getInstanceName();

getSocialToken()

Gets socialToken.

Source:
Returns:
Type
String
Example
var connection = Syncano({socialToken: '123'});
var socialToken = connection.getSocialToken();

getUserKey()

Gets userKey.

Source:
Returns:
Type
String
Example
var connection = Syncano({userKey: '123'});
var userKey = connection.getUserKey();

onProgress(callback)

Sets progressCallback

Parameters:
Name Type Description
callback function

Function to be called on 'progress' event
Source:
Returns:
Type
Syncano

setAccountKey(accountKey)

Sets accountKey.

Parameters:
Name Type Description
accountKey String

Your Syncano account key
Source:
Returns:
Type
Syncano
Example
var connection = Syncano({accountKey: '123'});
connection.setAccountKey('abcd');

setApiKey(apiKey)

Sets apiKey.

Parameters:
Name Type Description
apiKey String

Instance user api key
Source:
Returns:
Type
Syncano
Example
var connection = Syncano({apiKey: '123'});
connection.setApiKey('abcd');

setBaseUrl(baseUrl)

Sets baseUrl.

Parameters:
Name Type Description
baseUrl String

Base URL for all api calls
Source:
Throws:

Base URL is required.

Type
Error
Returns:
Type
Syncano
Example
var connection = Syncano({accountKey: '123'});
connection.setBaseUrl('https://dummy.com/');

setInstanceName(instanceName)

Sets instanceName.

Parameters:
Name Type Description
instanceName String

Instance name for all api calls
Source:
Throws:

Instance name must be a string.

Type
Error
Returns:
Type
Syncano
Example
var connection = Syncano({accountKey: '123'});
connection.setInstanceName('my-instance');

setSocialToken(socialToken)

Sets socialToken.

Parameters:
Name Type Description
socialToken String

Instance social authentication token
Source:
Returns:
Type
Syncano
Example
var connection = Syncano({socialToken: '123'});
connection.setSocialToken('abcd');

setUserKey(userKey)

Sets userKey.

Parameters:
Name Type Description
userKey String

Instance user api key
Source:
Returns:
Type
Syncano
Example
var connection = Syncano({userKey: '123'});
connection.setUserKey('abcd');