RemoteDocumentState

Type: Object

The remote document state for a document. Remote document state gives you information on whether the document is dirty, saved or locked correctly or has save or lock errors. Can be retrieved by the useRemoteDocumentState hook.

Properties

Name Type Description
state RemoteDocumentStateProperties

This is the raw data corresponding to the remote document state. Use this to get more details based on the type.

type DocumentStateType

This is a summary for the remote document state. This property is used by the default sheetframe header as well as the default document state popover. The value of this property is determined by Fonto and may not describe all document state information. For example, this will be set to a save error (if that occurs) instead of "lock acquired" which could also be true at that moment. If you require the full data, use the state property.

Was this page helpful?