blinkid-verify-core/com.microblink.blinkidverify.core.capture.session/BlinkIdVerifySessionSettings

BlinkIdVerifySessionSettings

@Serializable

data class BlinkIdVerifySessionSettings @JvmOverloads constructor(val inputImageSource: InputImageSource = InputImageSource.Video, val scanningSettings: BlinkIdVerifyScanningSettings = BlinkIdVerifyScanningSettings(), val consent: ExternalConsentObject? = null, val traceId: String? = null) : Parcelable

Represents the configuration settings for a session.

Constructors

@JvmOverloads

constructor(inputImageSource: InputImageSource = InputImageSource.Video, scanningSettings: BlinkIdVerifyScanningSettings = BlinkIdVerifyScanningSettings(), consent: ExternalConsentObject? = null, traceId: String? = null)

Properties

consent

val consent: ExternalConsentObject?

End-user consent for cloud processing. When set, it is passed into native native getResult so the generated request payload contains the consent object. Set it only when consent is already available before the session starts (client-managed consent flow). Sessions launched through the scanning screen receive consent from BlinkIdVerifyConsentUxConfig instead, via com.microblink.blinkidverify.core.capture.session.BlinkIdVerifyScanningSession.setConsent or com.microblink.blinkidverify.core.capture.session.BlinkIdVerifyScanningSession.setConsent.

inputImageSource

val inputImageSource: InputImageSource

The type of image source for the session. Defines whether the images are sourced from a video stream or a single photo, as defined by InputImageSource. The default is set to Video.

scanningSettings

val scanningSettings: BlinkIdVerifyScanningSettings

The specific scanning settings for the session. Defines various parameters that control the scanning process.

traceId

val traceId: String?

Optional caller-supplied trace ID included in the native session result payload. This is not part of the serialized v3 configuration.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

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