IJourneyState
The current state of the journey.
Signature:
export interface IJourneyStateProperties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
| action | FlowState |
The current capture state of the journey. The value of this is dictated by the server. |
| actionAttempt | number |
The number of times the request has been attempted |
| inputProvider | InputProvider |
The current input provider in use |
| journey | IIdScanData |
The current state of the DataStore for this journey |
| page | Templates |
The current page/step of the journey being shown to the user |
IJourneyState.action property
Section titled “IJourneyState.action property”The current capture state of the journey. The value of this is dictated by the server.
Signature:
readonly action: FlowState;IJourneyState.actionAttempt property
Section titled “IJourneyState.actionAttempt property”The number of times the request has been attempted
Signature:
readonly actionAttempt: number;IJourneyState.inputProvider property
Section titled “IJourneyState.inputProvider property”The current input provider in use
Signature:
readonly inputProvider: InputProvider;IJourneyState.journey property
Section titled “IJourneyState.journey property”The current state of the DataStore for this journey
Signature:
readonly journey: IIdScanData;IJourneyState.page property
Section titled “IJourneyState.page property”The current page/step of the journey being shown to the user
Signature:
readonly page: Templates;