Skip to main content

StartPhotoPaymentOptions

A configuration class used to alter the default photo payment behaviour.

Properties​

allowCaptureModeSetting?​

optional allowCaptureModeSetting: boolean;

If true, the toolbar will display an Item allowing the user to switch between auto capture and manual capture. Defaults to false.

Default​

false

Since​

6.0.0

autoCapture?​

optional autoCapture: boolean;

If true, the camera will capture the image automatically at the right moment. Defaults to true.

Default​

true

Since​

6.0.0

defaultScanFilter?​

optional defaultScanFilter: ScanFilter;

The default scan filter that will be used after scan. Defaults to [ScanFilter.ILLUSTRATION]. See [ScanFilter] for possible values.

Default​

ScanFilter.ILLUSTRATION

Since​

6.0.0

pageEditConfig?​

optional pageEditConfig: PageEditConfiguration;

Configuration class used to alter the default page editing behaviour.

Since​

6.0.0

ColorConfig?​

optional ColorConfig: ColorConfig;

Configuration class used to alter the default color theming behaviour.

Since​

6.0.0

source?​

optional source: Source;

Select the source for the document scanner. Defaults to [Source.CAMERA]. See [Source] for possible values.

Default​

Source.CAMERA

Since​

6.0.0

sourceImages?​

optional sourceImages: string[];

The source images for the document scanner if you have set the [source] to [Source.IMAGE].

Since​

6.0.0

autoCrop?​

optional autoCrop: boolean;

If true, image gets automatically cropped if document was detected. This applies only if [source] is [Source.IMAGE] or [Source.GALLERY] or [Source.GALLERY_MULTIPLE]. Defaults to true.

Default​

true

Since​

6.0.0

multiPage?​

optional multiPage: boolean;

If true, scanning multi page documents is possible. Set this to false if you need to scan single page documents. Defaults to true.

Default​

true

Since​

6.0.0

preCaptureFocus?​

optional preCaptureFocus: boolean;

If true, the camera will run a focus action right before taking the image. This improves the quality of the scanned images, but depending on the device, image capture might take a little bit longer. Defaults to true.

Default​

true

Since​

6.0.0

textConfig?​

optional textConfig: TextConfiguration;

Configuration class used to alter the default text behaviour.

Default​

true

Since​

6.0.0

buttonConfig?​

optional buttonConfig: ButtonConfiguration;

Configuration class used to alter the default buttons.

Since​

6.0.0

confirmPages?​

optional confirmPages: boolean;

If true, a list of all pages (thumbnails) will be displayed before the scan process can be finished. Defaults to false.

Default​

false

Since​

6.0.0

allowPageEditing?​

optional allowPageEditing: boolean;

If true, after the scan screen is finished, an editing screen with the captured images will be displayed. On the editing screen, the user can crop manually, rotate the page, filter the page and much more. The editing screen can be configured by accessing the [pageEditConfig]. Defaults to true.

Default​

true

Since​

6.0.0

statusBarAppearance?​

optional statusBarAppearance: StatusBarAppearance;

Overrides the status bar appearance. By default, the system chooses the appearance based on the current UI Mode.

Only available on Android.

Since​

6.0.0

optional navigationBarAppearance: NavigationBarAppearance;

Overrides the navigation bar appearance. By default, the system chooses the appearance based on the current UI Mode.

Only available on Android.

Since​

6.0.0

vibrateOnCapture?​

optional vibrateOnCapture: boolean;

If true, when an image is captured, the device vibrates to signal successful capture. Defaults to false.

onboarding?​

optional onboarding: null | Onboarding;

An optional onboarding when the user opens the scanner for the first time. See [Onboarding] for more details.

Since​

6.0.0

scanTips?​

optional scanTips: null | ScanTips;

An optional toolbar item that shows scan tips when clicked. See [ScanTips] for more details.

Since​

6.0.0

analyzeConfig?​

optional analyzeConfig: PaymentAnalyzeConfiguration;

Use this to enable/disable additional values to be detected. See [PaymentAnalyzeConfiguration] for more details.

Since​

6.0.0

emptyResultScreen?​

optional emptyResultScreen: null | EmptyResultScreen;

A screen that will be displayed if no payment information could be extracted. If you do not want to display the screen at all, just set it to null.

Since​

6.0.0