Mobile Document Scanner API Reference / ScannerEvents
Interface: ScannerEvents
Defined in: src/flow/events.ts:12
The events of the document scanner, by name, with the payload of each. Listen with on().
Properties
documentChange
documentChange:
DocumentChange
Defined in: src/flow/events.ts:18
A change to the document: pages came in, went out, or moved, a page changed, or what undo and redo can do changed. Each change carries the state of the document after it.
done
done:
SuccessfulScan
Defined in: src/flow/events.ts:26
The success of a session. The document scanner waits for the listeners before it closes its screens and before scan() resolves. Thus the host application can act on the result while the screens still show. The event fires once in each session, and not for a cancel or a failure.
error
error:
ScannerError
Defined in: src/flow/events.ts:31
The failure of a session, with its reason. The event fires once, before scan() resolves.
navigate
navigate:
Navigation
Defined in: src/flow/events.ts:36
A move of the user to another screen or mode, or an overlay that opened or closed.