RemoteDocumentStateProperties

Type: Object

The remote document state properties for a document. Part of RemoteDocumentState.

Properties

documentId

The document identifier of the document that this remote state applies to.

hasLockError

Type: Boolean

Indicates whether an error occurred during the lock process. Fonto will automatically try again.

hasPermanentSaveError

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.

hasSaveError

Type: Boolean

Indicates whether an error occurred during the save process. Fonto will automatically try again.

hasUnsaveableContent

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.

isDirty

Type: Boolean

Indicates whether the document currently has unsaved changes.

isInSync

Type: Boolean

False when the version of the document in the CMS has changed outside of the current Fonto session.

isModifyingLock

Type: Boolean

Indicates whether a lock or unlock is currently being executed.

isSaving

Type: Boolean

Indicates whether a save is currently being executed.

lastSavedDate

Type: Date | NULL

A date indicating when the last save occurred. Is set to null if no save has been done yet.

lockErrorMessage

Type: String | NULL

The error message for the lock error. Only filled when hasLockError is true.

lockReason

Type: String | NULL

The value of the reason property in Lock entities from the CMS Connectors API.

lockState

Type: String

Either "acquired", "available" or "unavailable".

outOfSyncReason

Type: OutOfSyncReasons | NULL

Indicates the reason why the document is not in sync, or null if isInSync is true.

permanentSaveErrorMessage

Type: String | NULL

The error message for the permanent save error. Only filled when hasPermanentSaveError is true.

saveErrorMessage

Type: String | NULL

The error message for the save error. Only filled when hasSaveError is true.