CaptureConfig

data class CaptureConfig(enableCaptureTips: Boolean, allowFlashToggling: Boolean, defaultFlashMode: FlashMode, enableAutoCapture: Boolean, initialAutoCaptureState: Boolean, enableLongReceiptPageToast: Boolean, enableGalleryImport: Boolean, @IntRange(from = 1.toLong(), to = 10.toLong()) maxImages: Int, enableLongCapture: Boolean, enableCrop: Boolean, enableSecureWindow: Boolean, attachLocationData: Boolean, compressForSensibillApi: Boolean, enableCaptureProgressFeedback: Boolean, documentTypeStrings: DocumentTypeStrings, documentType: CaptureDocumentType) : Serializable

Configuration class to be sent to CaptureStandaloneActivity. This class defines the configurable behaviour for CaptureStandaloneActivity

Constructors

CaptureConfig

fun CaptureConfig(enableCaptureTips: Boolean = true, allowFlashToggling: Boolean = true, defaultFlashMode: FlashMode = FlashMode.FLASH_MODE_AUTO, enableAutoCapture: Boolean = true, initialAutoCaptureState: Boolean = true, enableLongReceiptPageToast: Boolean = true, enableGalleryImport: Boolean = true, @IntRange(from = 1.toLong(), to = 10.toLong()) maxImages: Int = 1, enableLongCapture: Boolean = true, enableCrop: Boolean = true, enableSecureWindow: Boolean = false, attachLocationData: Boolean = false, compressForSensibillApi: Boolean = true, enableCaptureProgressFeedback: Boolean = true, documentTypeStrings: DocumentTypeStrings = DocumentTypeStrings.defaultReceiptStrings, documentType: CaptureDocumentType = CaptureDocumentType.RECEIPT)

Types

Companion

object Companion

Properties

allowFlashToggling

@SerializedName(value = allowFlashToggling)

val allowFlashToggling: Boolean = true

Allows the user to toggle the flash mode.

attachLocationData

@SerializedName(value = attachLocationData)

val attachLocationData: Boolean = false

Enables attaching GPS location data via EXIF to captured images.

compressForSensibillApi

@SerializedName(value = compressForSensibillApi)

val compressForSensibillApi: Boolean = true

Enables built-in compression for captured images in order to make them compatible with the Sensibill APIs.

defaultFlashMode

@SerializedName(value = defaultFlashMode)

val defaultFlashMode: FlashMode

Sets the default flash mode that will be used by the camera

documentType

@SerializedName(value = documentType)

val documentType: CaptureDocumentType

The CaptureDocumentType for which this configuration is intended.

documentTypeStrings

@SerializedName(value = documentTypeStrings)

val documentTypeStrings: DocumentTypeStrings

A configuration defining string resources to be used for areas of the capture flow that contain "Document type specific" string resources.

enableAutoCapture

@SerializedName(value = enableAutoCapture)

val enableAutoCapture: Boolean = true

Enables the auto-capture feature.

enableCaptureProgressFeedback

@SerializedName(value = enableCaptureProgressFeedback)

val enableCaptureProgressFeedback: Boolean = true

Enables capture progress messages that will be displayed when a user is capturing a receipt.

enableCaptureTips

@SerializedName(value = enableCaptureTips)

val enableCaptureTips: Boolean = true

Enables the tips feature for capture.

enableCrop

@SerializedName(value = enableCrop)

val enableCrop: Boolean = true

Enables the user to manually crop, or adjust the existing cropping on a captured image.

enableGalleryImport

@SerializedName(value = enableGalleryImport)

val enableGalleryImport: Boolean = true

Enables the ability for a user to select an image from their device's image gallery.

enableLongCapture

@SerializedName(value = enableLongCapture)

val enableLongCapture: Boolean = true

Enables the long receipt feature.

enableLongReceiptPageToast

@SerializedName(value = enableLongReceiptPageToast)

val enableLongReceiptPageToast: Boolean = true

Enables a toast message that displays feedback on the capture screen when the long receipt capture process has started.

enableSecureWindow

@SerializedName(value = enableSecureWindow)

val enableSecureWindow: Boolean = false

Enables Android's secure window feature for the capture flow.

initialAutoCaptureState

@SerializedName(value = initialAutoCaptureState)

val initialAutoCaptureState: Boolean = true

Sets the initial state of the auto-capture functionality (true represents ON).

maxImages

@SerializedName(value = maxImages)

val maxImages: Int = 1

Determines the maximum number of distinct images that can be captured in a single capture flow.