IJourneyState – GBG IDscan Documentation

IJourneyState

The current state of the journey.

Signature:

export interface IJourneyState 

Properties

PropertyTypeDescription
actionFlowStateThe current capture state of the journey. The value of this is dictated by the server.
actionAttemptnumberThe number of times the request has been attempted
inputProviderInputProviderThe current input provider in use
journeyIIdScanDataThe current state of the DataStore for this journey
pageTemplatesThe current page/step of the journey being shown to the user

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

The number of times the request has been attempted

Signature:

readonly actionAttempt: number;

IJourneyState.inputProvider property

The current input provider in use

Signature:

readonly inputProvider: InputProvider;

IJourneyState.journey property

The current state of the DataStore for this journey

Signature:

readonly journey: IIdScanData;

IJourneyState.page property

The current page/step of the journey being shown to the user

Signature:

readonly page: Templates;

Was this page helpful?