resourceSyncState (property)
The sync state of the folder resource.
Syntax
- (int)resourceSyncState:(int)resourceIndex; - (void)setResourceSyncState:(int)resourceIndex:(int)newResourceSyncState;
/* Possible Values */
SS_UNDEFINED(0),
SS_SYNCED(1),
SS_NOT_SYNCED(2),
SS_PARTIALLY_SYNCED(3)
public func resourceSyncState(resourceIndex: Int32) throws -> BoxResourceSyncStates
public func setResourceSyncState(resourceIndex: Int32, newResourceSyncState: BoxResourceSyncStates) throws -> Void
public enum BoxResourceSyncStates : Int32 { case ssUndefined = 0 case ssSynced = 1 case ssNotSynced = 2 case ssPartiallySynced = 3 }
Default Value
0
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 ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.