Feature Switching
You can customize the experience and features available in the Capture through the use of feature toggles.
Capture can attach current location metadata to the EXIF of captured images, nd can preserve the location metadata for images selected from the photo gallery on Android and photo library on iOS (if available). With default configuration, Capture does not collect location metadata, and does not preserve location metadata for images selected from the photo gallery / library. Follow the steps below to enable location metadata collection.
Available Feature Toggles
Description | Default value | iOS Property | Android Property |
---|---|---|---|
Enables the auto-capture feature | true | enableAutoCapture | enableAutoCapture |
Starts the capture screen with auto-capture mode Note: auto-capture feature must be enabled | true | defaultToAutoCapture | initialAutoCaptureState |
Enables the ability to toggle the phone’s flash on/off to help capture in low-light situations | true | enableFlash | allowFlashToggling |
(Android only) Sets the flash mode that will be set by default when the capture flow begins Note: flash feature must be enabled | FlashMode.FLASH_MODE_AUTO | N/A | defaultFlashMode |
Enables the tips feature | true | enableCaptureTips | enableCaptureTips |
Enables the visibility of feedback while capturing document. | true | enableCaptureProgressFeedback | enableCaptureProgressFeedback |
Enables the user to select an image from their phone’s image gallery | true | enableImageGallery | enableGalleryImport |
Enables the long document capture feature - capturing a longer document composed from a top and bottom image | true | enableLongCapture | enableLongCapture |
Enables toast on the long document capture screen. Note: Long document capture must be enabled. | true | enableLongReceiptPageToast | enableLongReceiptPageToast |
Enables the ability to crop captured images | true | enableCrop | enableCrop |
Determines the maximum number of documents a user can capture in a single capture session. The number must be in 1-10 range. | 1 | maxImages | maxImages |
Enables the ability to attach the device’s current location to the image being captured. Requires location permission to have been granted by the user before launching capture. Ensure your app has appropriate location permission | false | attachLocationData | attachLocationData |
Ensures that the images returned as a result of capture comply with the size and quality requirements of Sensibill API.Note: this flag can only be changed if using standalone capture. | true | compressForSensibillApi | compressForSensibillApi |
(Android only) Will cause the capture flow to set the WindowManager.LayoutParams.FLAG_SECURE flag in order to prevent users from taking screenshots from within the flow | false | N/A | enableSecureWindow |
(Android only) Informs capture what type of document is being captured. Currently, this changes some configuration restrictions and what types of strings are displayed to the user | CaptureDocumentType.RECEIPT | N/A | documentType |
(Android only) A bundle of string resource references defining what string resources will be used in some document type specific locations (eg. “top of receipt” vs “top of invoice”) | DocumentTypeStrings.defaultReceiptStrings | N/A | documentTypeStrings |
(iOS only) Enables a blur warning on the preview screen after capturing | true | enableBlurDetection (Note: this feature is only available on the iPhone 6s and newer) | N/A |