ResourceSyncState Property

The sync state of the folder resource.

Syntax

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

Possible Values

  0 (ssUndefined), 
  1 (ssSynced), 
  2 (ssNotSynced), 
  3 (ssPartiallySynced)

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

The sync state of the folder resource.

This property specifies the sync state of the folder resource. Not applicable for file resources. Possible values are:


0 (ssUndefined - default)	The sync state is undefined. This is the only valid value for file resources, and is also used if a folder resource's sync state is unknown.
1 (ssSynced)	The folder resource is fully synced.
2 (ssNotSynced)	The folder resource is not synced.
3 (ssPartiallySynced)	Only parts of the folder resource's contents are synced.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

This property is not available at design time.

Data Type

Integer