types

Microblink Platform SDK

---

Microblink Platform SDK / state/types

state/types

Enumerations

MachineEventTypes

Defined in: orchestrator/src/state/types.ts:48

Enumeration Members

Enumeration Member	Value	Defined in
ABORT	"abort"	orchestrator/src/state/types.ts:55
COMPLETE	"complete"	orchestrator/src/state/types.ts:58
CONTINUE	"continue"	orchestrator/src/state/types.ts:50
ERROR	"error"	orchestrator/src/state/types.ts:54
RESET	"reset"	orchestrator/src/state/types.ts:57
RETRY	"retry"	orchestrator/src/state/types.ts:53
RUN_D2D	"run_d2d"	orchestrator/src/state/types.ts:51
SET_STATE	"set_state"	orchestrator/src/state/types.ts:56
START	"start"	orchestrator/src/state/types.ts:49
SUBMIT_FEEDBACK	"submit_feedback"	orchestrator/src/state/types.ts:52
UPDATE_TRANSACTION_STATE	"update_transaction_state"	orchestrator/src/state/types.ts:59
UPDATE_UPLOAD_PROGRESS_CONTEXT	"update_upload_progress_context"	orchestrator/src/state/types.ts:60

---

MachineStates

Defined in: orchestrator/src/state/types.ts:17

Enumeration Members

Enumeration Member	Value	Defined in
cameraPermissionError	"cameraPermissionError"	orchestrator/src/state/types.ts:35
cameraSelection	"cameraSelection"	orchestrator/src/state/types.ts:20
cameraSelectionError	"cameraSelectionError"	orchestrator/src/state/types.ts:40
capabilityError	"capabilityError"	orchestrator/src/state/types.ts:41
d2dAbort	"d2dAbort"	orchestrator/src/state/types.ts:45
d2dAddNewDevice	"d2dAddNewDevice"	orchestrator/src/state/types.ts:26
d2dConnect	"d2dConnect"	orchestrator/src/state/types.ts:23
d2dConnectError	"d2dConnectError"	orchestrator/src/state/types.ts:42
d2dFlowEnd	"d2dFlowEnd"	orchestrator/src/state/types.ts:25
d2dIdle	"d2dIdle"	orchestrator/src/state/types.ts:24
d2dInit	"d2dInit"	orchestrator/src/state/types.ts:22
d2dInitError	"d2dInitError"	orchestrator/src/state/types.ts:43
executeCapability	"executeCapability"	orchestrator/src/state/types.ts:30
executeCapabilityError	"executeCapabilityError"	orchestrator/src/state/types.ts:39
flowEnd	"flowEnd"	orchestrator/src/state/types.ts:33
gatherConsent	"gatherConsent"	orchestrator/src/state/types.ts:32
gatherConsentError	"gatherConsentError"	orchestrator/src/state/types.ts:44
idle	"idle"	orchestrator/src/state/types.ts:18
requestCameraPermissions	"requestCameraPermissions"	orchestrator/src/state/types.ts:28
resumeTransaction	"resumeTransaction"	orchestrator/src/state/types.ts:29
resumeTransactionError	"resumeTransactionError"	orchestrator/src/state/types.ts:37
retrySubmitFeedback	"retrySubmitFeedback"	orchestrator/src/state/types.ts:34
reviewProgress	"reviewProgress"	orchestrator/src/state/types.ts:19
startFlow	"start"	orchestrator/src/state/types.ts:27
startTransaction	"startTransaction"	orchestrator/src/state/types.ts:21
startTransactionError	"startTransactionError"	orchestrator/src/state/types.ts:36
submitFeedback	"submitFeedback"	orchestrator/src/state/types.ts:31
submitTransactionError	"submitTransactionError"	orchestrator/src/state/types.ts:38

Interfaces

MachineContext

Defined in: orchestrator/src/state/types.ts:106

Properties

apiConfig

apiConfig: ProxyConfig | TransactionConfig

Defined in: orchestrator/src/state/types.ts:117

apiManager

apiManager: ApiManager

Defined in: orchestrator/src/state/types.ts:119

backCameraId

backCameraId: string

Defined in: orchestrator/src/state/types.ts:121

consentData

consentData: ConsentData

Defined in: orchestrator/src/state/types.ts:118

currentInstruction

currentInstruction: InstructionParams

Defined in: orchestrator/src/state/types.ts:129

currentInstructionFeedback

currentInstructionFeedback: InstructionFeedback

Defined in: orchestrator/src/state/types.ts:130

d2dAbandoned

d2dAbandoned: boolean

Defined in: orchestrator/src/state/types.ts:112

d2dQrCodeAutogenCount

d2dQrCodeAutogenCount: number

Defined in: orchestrator/src/state/types.ts:110

d2dQrCodeExpiresAt

d2dQrCodeExpiresAt: Date

Defined in: orchestrator/src/state/types.ts:111

d2dUrl

d2dUrl: string

Defined in: orchestrator/src/state/types.ts:109

deviceId

deviceId: string

Defined in: orchestrator/src/state/types.ts:107

enableD2D

enableD2D: boolean

Defined in: orchestrator/src/state/types.ts:108

frontCameraId

frontCameraId: string

Defined in: orchestrator/src/state/types.ts:120

isCameraGoodEnough

isCameraGoodEnough: boolean

Defined in: orchestrator/src/state/types.ts:123

isCameraGranted

isCameraGranted: boolean

Defined in: orchestrator/src/state/types.ts:122

isPrefetching

isPrefetching: Promise<void>

Defined in: orchestrator/src/state/types.ts:131

mode

mode: WorkingMode

Defined in: orchestrator/src/state/types.ts:115

onResult()?

optional onResult: (result) => void

Defined in: orchestrator/src/state/types.ts:134

Parameters

Parameter	Type
result	InstructionFeedback

Returns

void

processingStatus

processingStatus: ProcessingStatus

Defined in: orchestrator/src/state/types.ts:126

reason?

optional reason: ERROR_SCAN_TIMEOUT

Defined in: orchestrator/src/state/types.ts:133

resourcesPath?

optional resourcesPath: string

Defined in: orchestrator/src/state/types.ts:116

retryDelay

retryDelay: string

Defined in: orchestrator/src/state/types.ts:124

shouldActivateCurrentDevice

shouldActivateCurrentDevice: boolean

Defined in: orchestrator/src/state/types.ts:113

showProgress

showProgress: boolean

Defined in: orchestrator/src/state/types.ts:114

statusSubcode

statusSubcode: StatusSubcode

Defined in: orchestrator/src/state/types.ts:125

uploadProgress

uploadProgress: number

Defined in: orchestrator/src/state/types.ts:132

verificationStatus

verificationStatus: VerificationStatus

Defined in: orchestrator/src/state/types.ts:127

workflowInfo

workflowInfo: TransactionWorkflowInfo

Defined in: orchestrator/src/state/types.ts:128

Type Aliases

MachineEvents

MachineEvents = { type: START; } | { shouldActivateCurrentDevice: boolean; showProgress: boolean; type: CONTINUE; } | { type: RUN_D2D; } | { result: InstructionFeedback; type: SUBMIT_FEEDBACK; } | { type: RETRY; } | { reason?: TransactionEventType; type: ERROR; } | { reason?: TransactionEventType; type: ABORT; } | { data: Partial<MachineContext>; type: SET_STATE; } | { type: RESET; } | { type: COMPLETE; verificationStatus: VerificationStatus; } | { data: { processingStatus: ProcessingStatus; verificationStatus: VerificationStatus; }; type: UPDATE_TRANSACTION_STATE; } | { progress: number; type: UPDATE_UPLOAD_PROGRESS_CONTEXT; }

Defined in: orchestrator/src/state/types.ts:63

---

MachineInputs

MachineInputs = object

Defined in: orchestrator/src/state/types.ts:98

Properties

apiConfig

apiConfig: IdvFlowProps["apiConfig"]

Defined in: orchestrator/src/state/types.ts:99

consentData

consentData: ConsentData

Defined in: orchestrator/src/state/types.ts:101

enableD2D?

optional enableD2D: boolean

Defined in: orchestrator/src/state/types.ts:103

mode

mode: WorkingMode

Defined in: orchestrator/src/state/types.ts:100

resourcesPath?

optional resourcesPath: string

Defined in: orchestrator/src/state/types.ts:102

---

WorkingMode

WorkingMode = "classic" | "d2d"

Defined in: orchestrator/src/state/types.ts:96