Skip to main content

Type Alias: NablaConnectState

NablaConnectState = object

An immutable snapshot of the encounter, as stateChanged and getCurrentState() give it.

Properties​

availableActions​

readonly availableActions: readonly AvailableAction[]

The commands the iframe accepts right now.

canBeClosed​

readonly canBeClosed: boolean

true when closing or navigating away loses nothing.

Remarks​

It does not depend on state: it is false while audio is recorded or uploaded, and while note edits are not saved. Read it here, or wait with NablaConnectClient.waitUntilClosable.

failureReason​

readonly failureReason: NoteGenerationFailureReason | null

Set when reason is NOTE_GENERATION_FAILED, null otherwise.

reason​

readonly reason: NablaConnectStateReason | null

Why this state was published, null when the change came from the iframe or the provider.

state​

readonly state: EncounterState

Where the encounter is.