nutrient/com.pspdfkit.instant.document/InstantDocumentState

InstantDocumentState

enum InstantDocumentState : Enum<InstantDocumentState>

Lists the observable states of an Instant document and its sync cycle.

The term “sync cycle” refers to the repetitive transitions between the states “receiving changes” and “sending changes” until there are no unsynced local changes remaining. If you are using automatic sync, a sync cycle will begin delayed after the last change to an annotation of the document. New sync cycle can also be triggered by changes coming in from the server when listening for server changes.

When not listening for server changes and with automatic sync of local changes disabled, a sync cycle starts whenever you call InstantPdfDocument.syncAnnotations.

Entries

UNKNOWN

Document is in an unknown state. This goes away by the time you access a downloaded document for the first time.

NEEDS_RESET_FOR_DATABASE_MIGRATION

The current database version does not include required metadata on at least some records.

RESETTING_FOR_DATABASE_MIGRATION

The layer's record store is being updated with the latest server version.

CLEAN

The document is valid and has no local changes.

DIRTY

The document is valid but has local changes that have not been synced to the server.

SENDING_CHANGES

The document is busy syncing — currently sending its local changes to the server.

RECEIVING_CHANGES

The document is busy syncing — currently receiving changes from the server.

INVALID

The document is invalid and cannot be used any longer.

Properties

entries

val entries: EnumEntries<InstantDocumentState>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

valueOf

fun valueOf(value: String): InstantDocumentState

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<InstantDocumentState>

Returns an array containing the constants of this enum type, in the order they're declared.