types
Microblink Platform SDK / components/types
components/types
Enumerations
CustomScreenAction
Enumeration Members
| Enumeration Member | Value |
|---|---|
CANCEL | "cancel" |
CONTINUE_FLOW | "continueFlow" |
FINISH | "finish" |
START | "start" |
Type Aliases
CustomScreenProps
CustomScreenProps = {
actions:StartScreenActions;contentFn?: (args) =>JSX.Element|HTMLElement|string|null|undefined;fallback:JSX.Element;state:StartScreenState;type:"start"; } | {actions:ProgressScreenActions;contentFn?: (args) =>JSX.Element|HTMLElement|string;fallback:JSX.Element;state:ProgressScreenState;type:"progress"; } | {actions:EndScreenActions;contentFn?: (args) =>JSX.Element|HTMLElement|string|null|undefined;fallback:JSX.Element;state:EndScreenState;type:"end"; }
EndScreenActions
EndScreenActions =
object
Properties
finish()
finish: () =>
void
Returns
void
EndScreenState
EndScreenState =
object
Properties
status
status:
VerificationStatus|undefined
transactionId
transactionId:
string|undefined
ProgressScreenActions
ProgressScreenActions =
object
Properties
cancel()
cancel: () =>
void
Returns
void
continueFlow()
continueFlow: () =>
void
Triggers the continuation of the flow, allowing users to move from the progress screen to the next step in the verification process.
IMPORTANT: Do NOT immediately invoke this action within progressScreen callback, as it may cause unintended side effects such as inability for user to exit step execution.
Returns
void
ProgressScreenState
ProgressScreenState =
object
Properties
steps
steps:
CustomScreenStep[]
StartScreenActions
StartScreenActions =
object
Properties
cancel()
cancel: () =>
void
Returns
void
start()
start: () =>
void
Returns
void
StartScreenState
StartScreenState =
object
Properties
steps
steps:
CustomScreenStep[]
Functions
getStepsForCustomScreen()
getStepsForCustomScreen(
workflowInfo):object[]
Parameters
| Parameter | Type |
|---|---|
workflowInfo | TransactionWorkflowInfo |
Returns
object[]