blinkid-ux/com.microblink.blinkid.ux.settings/BlinkIdUxSettings/BlinkIdUxSettings

BlinkIdUxSettings

constructor(stepTimeoutDuration: Duration = 60000.milliseconds, inactivityTimeoutDuration: Duration = 10000.milliseconds, allowHapticFeedback: Boolean = true, allowScanSound: Boolean = true, classFilter: ClassFilter? = null, redactionSettingsResolver: RedactionSettingsResolver? = null, passportOnly: Boolean = false, helpTooltipShowDelay: Duration = needHelpTooltipDefaultTimeToAppearMs.milliseconds, helpTooltipHideDelay: Duration = needHelpTooltipDefaultDurationMs.milliseconds)

Parameters

stepTimeoutDuration

Duration of the scanning session step before a timeout is triggered. Resets on side changes, pauses when onboarding and help screen dialogs appear. If set to Duration.ZERO, the scanning will not time out.

inactivityTimeoutDuration

Duration of the current UI state in a scanning session before a timeout is triggered. Resets every time the UI state changes (reticle type or message). If set to Duration.ZERO, the scanning will not time out.

allowHapticFeedback

Whether haptic feedback is allowed during the scanning process. Defaults to true.

allowScanSound

Whether scan success sounds are allowed during the scanning process. Defaults to true.

classFilter

Defines which specific document classes are allowed during scanning. Each document class is defined by the trio of CountryId, RegionId, and DocumentTypeId. Defaults to null, meaning all classes are allowed.

redactionSettingsResolver

Defines how to resolve RedactionSettings for a given document class.

passportOnly

Enables the passport-only scanning flow, with passport specific instructions, onboarding and help screens. Only passport documents are allowed. If classFilter is also set, documents must pass both filters. Defaults to false.

helpTooltipShowDelay

Duration before the help tooltip is shown. If less than or equal to Duration.ZERO, the help tooltip won't be shown automatically.

helpTooltipHideDelay

Duration before the help tooltip is hidden. If less than or equal to Duration.ZERO, the help tooltip won't be hidden automatically. Defaults to 5 seconds.

@JvmOverloads

constructor(stepTimeoutDurationMs: Int, inactivityTimeoutDuration: Int, allowHapticFeedback: Boolean = true, allowScanSound: Boolean = true, classFilter: ClassFilter? = null, redactionSettingsResolver: RedactionSettingsResolver? = null, passportOnly: Boolean = false, helpTooltipShowDelayMs: Int = needHelpTooltipDefaultTimeToAppearMs.toInt(), helpTooltipHideDelayMs: Int = needHelpTooltipDefaultDurationMs.toInt())

Constructor for easier Java implementation.

This secondary constructor allows Java developers to create a BlinkIdUxSettings instance by providing the stepTimeoutDuration as an Int in milliseconds.

Parameters

stepTimeoutDurationMs

Duration of the scanning session step before a timeout is triggered in milliseconds. Resets on side changes, pauses when onboarding and help screen dialogs appear. If set to 0, the scanning will not time out.

inactivityTimeoutDuration

Duration of the current UI state in a scanning session before a timeout is triggered in milliseconds. Resets every time the UI state changes (reticle type or message). If set to 0, the scanning will not time out.

allowHapticFeedback

Whether haptic feedback is allowed during the scanning process. Defaults to true.

allowScanSound

Whether scan success sounds are allowed during the scanning process. Defaults to true.

classFilter

redactionSettingsResolver

Defines how to resolve RedactionSettings for a given document class.

passportOnly

helpTooltipShowDelayMs

Duration before the help tooltip is shown in milliseconds. If less than or equal to 0, the help tooltip won't be shown automatically.

helpTooltipHideDelayMs

Duration before the help tooltip is hidden in milliseconds. If less than or equal to 0, the help tooltip won't be hidden automatically. Defaults to 5000.