Remote Document State Properties
Type: Object
The remote document state properties for a document. Part of RemoteDocumentState.
Properties
document Id
Type: DocumentId
The document identifier of the document that this remote state applies to.
has Lock Error
Type: Boolean
Indicates whether an error occurred during the lock process. Fonto will automatically try again.
has Permanent Save Error
Type: Boolean
Indicates whether a permanent save error occurred. Errors are considered permanent when the status code returned from the CMS is 403 or 404. This will also set isInSync
to false with an outOfSyncReason
corresponding to the 403 or 404 response.
has Save Error
Type: Boolean
Indicates whether an error occurred during the save process. Fonto will automatically try again.
has Unsaveable Content
Type: Boolean
Indicates whether saving the document resulted in a 400 response from the CMS. This response indicates a problem with the content or metadata that has to be resolved for saving to be successful.
is Dirty
Type: Boolean
Indicates whether the document currently has unsaved changes.
is In Sync
Type: Boolean
False when the version of the document in the CMS has changed outside of the current Fonto session.
is Modifying Lock
Type: Boolean
Indicates whether a lock or unlock is currently being executed.
is Saving
Type: Boolean
Indicates whether a save is currently being executed.
last Saved Date
Type: Date | NULL
A date indicating when the last save occurred. Is set to null if no save has been done yet.
lock Error Message
Type: String | NULL
The error message for the lock error. Only filled when hasLockError
is true.
lock Reason
Type: String | NULL
The value of the reason property in Lock entities from the CMS Connectors API.
lock State
Type: String
Either "acquired", "available" or "unavailable".
out Of Sync Reason
Type: OutOfSyncReasons | NULL
Indicates the reason why the document is not in sync, or null if isInSync
is true
.
permanent Save Error Message
Type: String | NULL
The error message for the permanent save error. Only filled when hasPermanentSaveError
is true.
save Error Message
Type: String | NULL
The error message for the save error. Only filled when hasSaveError
is true.