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) : 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)

Types

Companion

object Companion

Properties

allowFlashToggling

val allowFlashToggling: Boolean = true

Allows the user to toggle the flash mode.

attachLocationData

val attachLocationData: Boolean = false

Enables attaching GPS location data via EXIF to captured images.

compressForSensibillApi

val compressForSensibillApi: Boolean = true

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

defaultFlashMode

val defaultFlashMode: FlashMode

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

enableAutoCapture

val enableAutoCapture: Boolean = true

Enables the auto-capture feature.

enableCaptureProgressFeedback

val enableCaptureProgressFeedback: Boolean = true

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

enableCaptureTips

val enableCaptureTips: Boolean = true

Enables the tips feature for capture.

enableCrop

val enableCrop: Boolean = true

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

enableGalleryImport

val enableGalleryImport: Boolean = true

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

enableLongCapture

val enableLongCapture: Boolean = true

Enables the long receipt feature.

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

val enableSecureWindow: Boolean = false

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

initialAutoCaptureState

val initialAutoCaptureState: Boolean = true

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

maxImages

val maxImages: Int = 1

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