StatusData¶
-
class
StatusData
(type=success, message, details)¶ A StatusData instance must be used as return value by
Base.syncFolderList()
andBase.syncFolder()
.StatusData also defines the possible StatusDataTypes used by the TbSync Event Log.
Arguments: - type (StatusDataType) – Status type (see const definitions below)
- message (string) –
Optional
A message, which will be used as sync status. If this is not a success, it will be used also in the TbSync Event Log as well. - details (string) –
Optional
If this is not a success, it will be used as description in the TbSync Event Log.
-
StatusData.
ACCOUNT_RERUN
¶ Sync of the entire account will be aborted and restarted completely.
-
StatusData.
ERROR
¶ Sync of the entire account will be aborted.
-
StatusData.
FOLDER_RERUN
¶ Sync of the current folder/resource will be restarted.
-
StatusData.
INFO
¶ Successfull sync, but message and details provided will be added to the event log.
-
StatusData.
SUCCESS
¶ Successfull sync.
-
StatusData.
WARNING
¶ Sync of this resource will be aborted and continued with next resource.
Example usage:
let status = TbSync.StatusData.INFO;
return new TbSync.StatusData(status, "Have a nice day!", "Everything is fine.");