blinkcard-ux/com.microblink.blinkcard.ux.state

Package-level declarations

Types

data class BlinkCardUiState(val blinkCardScanningResult: BlinkCardScanningResult? = null, val reticleState: ReticleState = ReticleState.Hidden, val processingState: ProcessingState = ProcessingState.Sensing, val cardAnimationState: CardAnimationState = CardAnimationState.Hidden, val statusMessage: StatusMessage = CommonStatusMessage.ScanFirstSide, val currentSide: UiScanningSide = UiScanningSide.First, val torchState: MbTorchState = MbTorchState.Off, val cancelRequestState: CancelRequestState = CancelRequestState.CancelNotRequested, val helpButtonDisplayed: Boolean = DefaultShowHelpButton, val helpDisplayed: Boolean = false, val helpTooltipDisplayed: Boolean = false, val onboardingDialogDisplayed: Boolean = DefaultShowOnboardingDialog, val errorState: ErrorState = ErrorState.NoError, val hapticFeedbackState: HapticFeedbackState = HapticFeedbackState.VibrationOff) : BaseUiState

CancelRequestState

enum CancelRequestState : Enum<CancelRequestState>

Represents the reason of the cancel request. Currently not used.

CardAnimationState

fun interface CardAnimationState

Current state of the flip-card animation shown after the first side has been successfully scanned.

CommonStatusMessage

enum CommonStatusMessage : Enum<CommonStatusMessage> , StatusMessage

Represents all the instruction messages that may be shown during the scanning session.

ErrorState

enum ErrorState : Enum<ErrorState>

Represents the state of the error.

HapticFeedbackState

enum HapticFeedbackState : Enum<HapticFeedbackState>

Current state of the haptic (vibration) feedback that activates during the scanning session.

MbTorchState

enum MbTorchState : Enum<MbTorchState>

Current state of the torch (flashlight) as shown by the icon on the UI.

ProcessingState

sealed class ProcessingState

Represents the different states of the reticle and UI elements during the scanning process.

ReticleState

enum ReticleState : Enum<ReticleState>

Represents the different states of the reticle elements during the scanning process.

StatusMessage

interface StatusMessage

Interface that represents the status messages that may be shown during the scanning session.

StatusMessageCounter

class StatusMessageCounter

A class responsible for counting the occurrences of different CommonStatusMessage types.

UiScanningSide

enum UiScanningSide : Enum<UiScanningSide>

Specifies the current scanning side.