RemoteDocumentStateProperties

Type: Object

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

Properties

Name Type Description
documentId DocumentId

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

hasLockError Boolean

Indicates whether an error occurred during the lock process.

hasPermanentSaveError Boolean

Indicates whether a permanent save error occurred. Errors are considered permanent when the XML cannot be serialized or when the status code returned from the CMS is 403 or 404.

hasSaveError Boolean

Indicates whether an error occurred during the save process.

isDirty Boolean

Indicates whether the document currently has unsaved changes.

isInSync Boolean

Indicates whether the document revision identifier is equal to the one returned by the CMS.

isModifyingLock Boolean

Indicates whether a lock or unlock is currently being executed.

isSaving Boolean

Indicates whether a save is currently being executed.

lastSavedDate Date | Null

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

lockErrorMessage String | Null

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

lockReason String | Null

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

lockState String

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

permanentSaveErrorMessage String | Null

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

saveErrorMessage String | Null

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

Was this page helpful?