blinkid-ux/com.microblink.blinkid.ux.contract/BlinkIdScanActivitySettings

BlinkIdScanActivitySettings

data class BlinkIdScanActivitySettings(val sdkSettings: BlinkIdSdkSettings, val scanningSessionSettings: BlinkIdSessionSettings = BlinkIdSessionSettings(), val uxSettings: BlinkIdUxSettings = BlinkIdUxSettings(), val scanActivityUiColors: BlinkIdScanActivityColors? = null, val scanActivityUiStrings: SdkStrings = SdkStrings.Default, val showOnboardingDialog: Boolean = DefaultShowOnboardingDialog, val showHelpButton: Boolean = DefaultShowHelpButton, val enableEdgeToEdge: Boolean = true, val deleteCachedAssetsAfterUse: Boolean = false) : Parcelable

Configuration settings for the BlinkIdScanActivity.

This data class encapsulates the various settings that control the behavior and appearance of the BlinkIdScanActivity, including the SDK settings, scanning session configurations, UI customization options, and other miscellaneous preferences.

Constructors

constructor(sdkSettings: BlinkIdSdkSettings, scanningSessionSettings: BlinkIdSessionSettings = BlinkIdSessionSettings(), uxSettings: BlinkIdUxSettings = BlinkIdUxSettings(), scanActivityUiColors: BlinkIdScanActivityColors? = null, scanActivityUiStrings: SdkStrings = SdkStrings.Default, showOnboardingDialog: Boolean = DefaultShowOnboardingDialog, showHelpButton: Boolean = DefaultShowHelpButton, enableEdgeToEdge: Boolean = true, deleteCachedAssetsAfterUse: Boolean = false)

Properties

deleteCachedAssetsAfterUse

val deleteCachedAssetsAfterUse: Boolean = false

Indicates whether cached SDK assets should be deleted after they are used. If the scanning session is used only once (e.g. for user onboarding), the setting should be set to true. Otherwise, the setting should be set to true to avoid assets being re-downloaded. This only applies if DOWNLOAD_RESOURCES variant of the SDK is used. Defaults to false.

enableEdgeToEdge

val enableEdgeToEdge: Boolean = true

Enables edge-to-edge display for the activity. This is the default behavior for all Android 15 devices (and above) and cannot be changed by this setting. In order to have this behavior on older OS versions, this setting should be set to true. Padding and window insets are handled automatically. Defaults to true.

scanActivityUiColors

val scanActivityUiColors: BlinkIdScanActivityColors? = null

Custom colors for the BlinkIdScanActivity user interface. If set to null, the default colors will be used. Defaults to null.

scanActivityUiStrings

val scanActivityUiStrings: SdkStrings

Custom strings for the BlinkIdScanActivity user interface. Defaults to SdkStrings.Default.

scanningSessionSettings

val scanningSessionSettings: BlinkIdSessionSettings

Configuration options for the document scanning session. This allows you to customize aspects of the scanning process, such as certain visual check strictness and timeout duration. Defaults to BlinkIdSessionSettings().

sdkSettings

val sdkSettings: BlinkIdSdkSettings

The core SDK settings required for initializing and running the BlinkID SDK. This is a mandatory parameter.

showHelpButton

val showHelpButton: Boolean

Determines whether a help button should be displayed in the activity. The button allows the user to open help screens during scanning. Defaults to DefaultShowHelpButton.

showOnboardingDialog

val showOnboardingDialog: Boolean

Determines whether an onboarding dialog should be displayed to the user when the activity is first launched. Defaults to DefaultShowOnboardingDialog.

uxSettings

val uxSettings: BlinkIdUxSettings

The BlinkIdUxSettings used to customize the UX.

Functions

describeContents

open override fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)