Class: SyncEvent

iotcs.device.StorageObject.SyncEvent(storageObject, nameopt, virtualDeviceopt)

new SyncEvent(storageObject, nameopt, virtualDeviceopt)

An event passed to the onSync callback when content referred to by an attribute value has been successfully synchronized, or has failed to be synchronized.
Parameters:
Name Type Attributes Description
storageObject iotcs.device.StorageObject The storage object to synchronize.
name string <optional>
The name of the storage object.
virtualDevice iotcs.device.VirtualDevice <optional>

Methods

(static) getName() → {string}

Get the name of the attribute, action, or format that this event is associated with.
Returns:
The name, or null if sync was called independently.
Type
string

(static) getSource() → {iotcs.device.StorageObject}

Get the StorageObject that is the source of this event.
Returns:
The storage object.
Type
iotcs.device.StorageObject

(static) getVirtualDevice() → {iotcs.device.VirtualDevice}

Get the virtual device that is the source of the event.
Returns:
the virtual device, or null if sync was called independently.
Type
iotcs.device.VirtualDevice

Home