ResourceSyncState Property

The sync state of the folder.

Syntax

 box.getResourceSyncState([callback])
 box.setResourceSyncState( resourceSyncState, [callback])

Possible Values

  0 (rsSynced), 
  1 (rsNotSynced), 
  2 (rsPartiallySynced), 
  3 (rsUnknown)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getResourceSyncState([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setResourceSyncState([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies whether a folder is synced. Possible values are:

0 (rsSynced - defalut)
1 (rsNotSynced)
2 (rsPartiallySynced)
3 (rsUnknown)

The value 3 (rsUnknown) is used when populating this property after calling ListResources when full details about the folder are not known.

When calling UpdateResource value of 0 (rsSynced) and 1 (rsNotSynced) are applicable.

Data Type

Integer