blinkid-verify-ux/com.microblink.blinkidverify.ux.result.contract/BlinkIdVerifyActivitySettings

BlinkIdVerifyActivitySettings

data class BlinkIdVerifyActivitySettings @JvmOverloads constructor(val blinkIdVerifySdkSettings: BlinkIdVerifySdkSettings, val cameraSettings: CameraSettings = CameraSettings(), val captureSessionSettings: VerifyCaptureSessionSettings = VerifyCaptureSessionSettings(), val uxSettings: VerifyUxSettings = VerifyUxSettings(), val verifyActivityUiColors: BlinkIdVerifyActivityColors? = null, val verifyActivityUiStrings: SdkStrings = SdkStrings.Default, val verifyActivityTypography: ParcelableUiTypography = ParcelableUiTypography.Default(null), val showOnboardingDialog: Boolean = DefaultShowOnboardingDialog, val showHelpButton: Boolean = DefaultShowHelpButton, val enableEdgeToEdge: Boolean = true, val deleteCachedAssetsAfterUse: Boolean = false) : Parcelable

Configuration settings for the BlinkIdVerifyCaptureActivity.

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

Constructors

Link copied to clipboard
@JvmOverloads
constructor(blinkIdVerifySdkSettings: BlinkIdVerifySdkSettings, cameraSettings: CameraSettings = CameraSettings(), captureSessionSettings: VerifyCaptureSessionSettings = VerifyCaptureSessionSettings(), uxSettings: VerifyUxSettings = VerifyUxSettings(), verifyActivityUiColors: BlinkIdVerifyActivityColors? = null, verifyActivityUiStrings: SdkStrings = SdkStrings.Default, verifyActivityTypography: ParcelableUiTypography = ParcelableUiTypography.Default(null), showOnboardingDialog: Boolean = DefaultShowOnboardingDialog, showHelpButton: Boolean = DefaultShowHelpButton, enableEdgeToEdge: Boolean = true, deleteCachedAssetsAfterUse: Boolean = false)

Properties

Link copied to clipboard
val blinkIdVerifySdkSettings: BlinkIdVerifySdkSettings

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

Link copied to clipboard
val cameraSettings: CameraSettings

The CameraSettings used for document scanning. Defaults to CameraSettings with default values.

Link copied to clipboard
val captureSessionSettings: VerifyCaptureSessionSettings

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
val showOnboardingDialog: Boolean

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

Link copied to clipboard
Link copied to clipboard
val verifyActivityTypography: ParcelableUiTypography

Custom typography for the BlinkIdVerifyActivity user interface. Due to a limitation of Typography class, ParcelableUiTypography mimics com.microblink.ux.theme.UiTypography by allowing the customization of all the elements to a lesser extent. The most important TextStyle and Font customizations are still available through this class. Defaults to ParcelableUiTypography.Default.

Link copied to clipboard
val verifyActivityUiColors: BlinkIdVerifyActivityColors? = null

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

Link copied to clipboard
val verifyActivityUiStrings: SdkStrings

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

Functions

Link copied to clipboard
open override fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)