
public final class CaptureConfiguration

Configuration class for Capture feature.

Field Summary

Fields
Modifier and Type	Field	Description
`private final GiniCaptureNetworkService`	`networkService`
`private final Boolean`	`showOnboardingAtFirstRun`
`private final List<OnboardingPage>`	`onboardingPages`
`private final Boolean`	`showOnboarding`
`private final Boolean`	`multiPageEnabled`
`private final DocumentImportEnabledFileTypes`	`documentImportEnabledFileTypes`
`private final Boolean`	`fileImportEnabled`
`private final Boolean`	`qrCodeScanningEnabled`
`private final Boolean`	`onlyQRCodeScanningEnabled`
`private final Boolean`	`supportedFormatsHelpScreenEnabled`
`private final Boolean`	`flashButtonEnabled`
`private final Boolean`	`flashOnByDefault`
`private final Boolean`	`returnAssistantEnabled`
`private final EventTracker`	`eventTracker`
`private final List<HelpItem.Custom>`	`customHelpItems`
`private final Boolean`	`giniErrorLoggerIsOn`
`private final ErrorLoggerListener`	`errorLoggerListener`
`private final Integer`	`importedFileSizeBytesLimit`
`private final NavigationBarTopAdapter`	`navigationBarTopAdapter`
`private final Boolean`	`bottomNavigationBarEnabled`
`private final OnboardingNavigationBarBottomAdapter`	`onboardingNavigationBarBottomAdapter`
`private final OnboardingIllustrationAdapter`	`onboardingAlignCornersIllustrationAdapter`
`private final OnboardingIllustrationAdapter`	`onboardingLightingIllustrationAdapter`
`private final OnboardingIllustrationAdapter`	`onboardingMultiPageIllustrationAdapter`
`private final OnboardingIllustrationAdapter`	`onboardingQRCodeIllustrationAdapter`
`private final CustomLoadingIndicatorAdapter`	`customLoadingIndicatorAdapter`
`private final OnButtonLoadingIndicatorAdapter`	`onButtonLoadingIndicatorAdapter`
`private final CameraNavigationBarBottomAdapter`	`cameraNavigationBarBottomAdapter`
`private final ReviewNavigationBarBottomAdapter`	`reviewNavigationBarBottomAdapter`
`private final SkontoNavigationBarBottomAdapter`	`skontoNavigationBarBottomAdapter`
`private final HelpNavigationBarBottomAdapter`	`helpNavigationBarBottomAdapter`
`private final ErrorNavigationBarBottomAdapter`	`errorNavigationBarBottomAdapter`
`private final EntryPoint`	`entryPoint`
`private final Boolean`	`allowScreenshots`
`private final Boolean`	`skontoEnabled`
`private final Boolean`	`transactionDocsEnabled`
`private final GiniComposableStyleProvider`	`giniComposableStyleProvider`

Constructor Summary

Constructors
Constructor	Description
CaptureConfiguration(GiniCaptureNetworkService networkService, Boolean showOnboardingAtFirstRun, List<OnboardingPage> onboardingPages, Boolean showOnboarding, Boolean multiPageEnabled, DocumentImportEnabledFileTypes documentImportEnabledFileTypes, Boolean fileImportEnabled, Boolean qrCodeScanningEnabled, Boolean onlyQRCodeScanningEnabled, Boolean supportedFormatsHelpScreenEnabled, Boolean flashButtonEnabled, Boolean flashOnByDefault, Boolean returnAssistantEnabled, EventTracker eventTracker, List<HelpItem.Custom> customHelpItems, Boolean giniErrorLoggerIsOn, ErrorLoggerListener errorLoggerListener, Integer importedFileSizeBytesLimit, NavigationBarTopAdapter navigationBarTopAdapter, Boolean bottomNavigationBarEnabled, OnboardingNavigationBarBottomAdapter onboardingNavigationBarBottomAdapter, OnboardingIllustrationAdapter onboardingAlignCornersIllustrationAdapter, OnboardingIllustrationAdapter onboardingLightingIllustrationAdapter, OnboardingIllustrationAdapter onboardingMultiPageIllustrationAdapter, OnboardingIllustrationAdapter onboardingQRCodeIllustrationAdapter, CustomLoadingIndicatorAdapter customLoadingIndicatorAdapter, OnButtonLoadingIndicatorAdapter onButtonLoadingIndicatorAdapter, CameraNavigationBarBottomAdapter cameraNavigationBarBottomAdapter, ReviewNavigationBarBottomAdapter reviewNavigationBarBottomAdapter, SkontoNavigationBarBottomAdapter skontoNavigationBarBottomAdapter, HelpNavigationBarBottomAdapter helpNavigationBarBottomAdapter, ErrorNavigationBarBottomAdapter errorNavigationBarBottomAdapter, EntryPoint entryPoint, Boolean allowScreenshots, Boolean skontoEnabled, Boolean transactionDocsEnabled, GiniComposableStyleProvider giniComposableStyleProvider)

Method Summary

Modifier and Type	Method	Description
`final GiniCaptureNetworkService`	`getNetworkService()`	Set the GiniCaptureNetworkService instance which will be used by the library to request document related network calls (e.g.
`final Boolean`	`getShowOnboardingAtFirstRun()`	Screen API onlyWhen enabled shows the OnboardingActivity the first time the CameraActivity is launched.
`final List<OnboardingPage>`	`getOnboardingPages()`	Set custom pages to be shown in the Onboarding Screen.
`final Boolean`	`getShowOnboarding()`	Screen API onlyWhen enabled shows the Onboarding Screen every time the CameraActivity starts.
`final Boolean`	`getMultiPageEnabled()`	Enable/disable the multi-page feature.
`final DocumentImportEnabledFileTypes`	`getDocumentImportEnabledFileTypes()`	Enable and configure the document import feature or disable it by passing in DocumentImportEnabledFileTypes.NONE.
`final Boolean`	`getFileImportEnabled()`	Enable/disable the file import feature.
`final Boolean`	`getQrCodeScanningEnabled()`	Enable/disable the QRCode scanning feature.
`final Boolean`	`getOnlyQRCodeScanningEnabled()`	Enable/disable only the QRCode scanning feature.
`final Boolean`	`getSupportedFormatsHelpScreenEnabled()`	Enable/disable the Supported Formats help screen.
`final Boolean`	`getFlashButtonEnabled()`	Enable/disable the flash button in the Camera Screen.
`final Boolean`	`getFlashOnByDefault()`	Set whether the camera flash should be on or off when the SDK starts.
`final Boolean`	`getReturnAssistantEnabled()`	Enable/disable the return assistant feature.
`final EventTracker`	`getEventTracker()`	EventTracker instance which will be called from the different screens to inform you about the various events which can occur during the usage of the Capture feature.
`final List<HelpItem.Custom>`	`getCustomHelpItems()`	A list of HelpItem.Custom defining the custom help items to be shown in the Help Screen.
`final Boolean`	`getGiniErrorLoggerIsOn()`	Set whether the default Gini error logging implementation is on or not.
`final ErrorLoggerListener`	`getErrorLoggerListener()`	Set an ErrorLoggerListener to be notified of errors.
`final Integer`	`getImportedFileSizeBytesLimit()`	Set a custom imported file size limit in bytes.
`final NavigationBarTopAdapter`	`getNavigationBarTopAdapter()`	Set an adapter implementation to show a custom top navigation bar.
`final Boolean`	`getBottomNavigationBarEnabled()`	Enable/disable the bottom navigation bar.
`final OnboardingNavigationBarBottomAdapter`	`getOnboardingNavigationBarBottomAdapter()`	Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.
`final OnboardingIllustrationAdapter`	`getOnboardingAlignCornersIllustrationAdapter()`	Set an adapter implementation to show a custom illustration on the "align corners" onboarding page.
`final OnboardingIllustrationAdapter`	`getOnboardingLightingIllustrationAdapter()`	Set an adapter implementation to show a custom illustration on the "lighting" onboarding page.
`final OnboardingIllustrationAdapter`	`getOnboardingMultiPageIllustrationAdapter()`	Set an adapter implementation to show a custom illustration on the "multi-page" onboarding page.
`final OnboardingIllustrationAdapter`	`getOnboardingQRCodeIllustrationAdapter()`	Set an adapter implementation to show a custom illustration on the "QR code" onboarding page.
`final CustomLoadingIndicatorAdapter`	`getCustomLoadingIndicatorAdapter()`	Set an adapter implementation to show a custom loading animation during analyse and scan.
`final OnButtonLoadingIndicatorAdapter`	`getOnButtonLoadingIndicatorAdapter()`	Set an adapter implementation to show a custom loading animation during analyse and scan.
`final CameraNavigationBarBottomAdapter`	`getCameraNavigationBarBottomAdapter()`	Set an adapter implementation to show a custom bottom navigation bar on the camera screen.
`final ReviewNavigationBarBottomAdapter`	`getReviewNavigationBarBottomAdapter()`	Set an adapter implementation to show a custom bottom navigation bar on the review screen.
`final SkontoNavigationBarBottomAdapter`	`getSkontoNavigationBarBottomAdapter()`	Set an adapter implementation to show a custom bottom navigation bar on the Skonto screen.
`final HelpNavigationBarBottomAdapter`	`getHelpNavigationBarBottomAdapter()`	Set an adapter implementation to show a custom bottom navigation bar on the help screen.
`final ErrorNavigationBarBottomAdapter`	`getErrorNavigationBarBottomAdapter()`	Set an adapter implementation to show a custom bottom navigation bar on the error screen.
`final EntryPoint`	`getEntryPoint()`	Set the entry point used for launching the SDK.
`final Boolean`	`getAllowScreenshots()`	Set whether screenshots should be allowed or not.
`final Boolean`	`getSkontoEnabled()`	Enable/disable the skonto feature.
`final Boolean`	`getTransactionDocsEnabled()`	Enable/disable the transaction docs feature.
`final GiniComposableStyleProvider`	`getGiniComposableStyleProvider()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CaptureConfiguration
```
CaptureConfiguration(GiniCaptureNetworkService networkService, Boolean showOnboardingAtFirstRun, List<OnboardingPage> onboardingPages, Boolean showOnboarding, Boolean multiPageEnabled, DocumentImportEnabledFileTypes documentImportEnabledFileTypes, Boolean fileImportEnabled, Boolean qrCodeScanningEnabled, Boolean onlyQRCodeScanningEnabled, Boolean supportedFormatsHelpScreenEnabled, Boolean flashButtonEnabled, Boolean flashOnByDefault, Boolean returnAssistantEnabled, EventTracker eventTracker, List<HelpItem.Custom> customHelpItems, Boolean giniErrorLoggerIsOn, ErrorLoggerListener errorLoggerListener, Integer importedFileSizeBytesLimit, NavigationBarTopAdapter navigationBarTopAdapter, Boolean bottomNavigationBarEnabled, OnboardingNavigationBarBottomAdapter onboardingNavigationBarBottomAdapter, OnboardingIllustrationAdapter onboardingAlignCornersIllustrationAdapter, OnboardingIllustrationAdapter onboardingLightingIllustrationAdapter, OnboardingIllustrationAdapter onboardingMultiPageIllustrationAdapter, OnboardingIllustrationAdapter onboardingQRCodeIllustrationAdapter, CustomLoadingIndicatorAdapter customLoadingIndicatorAdapter, OnButtonLoadingIndicatorAdapter onButtonLoadingIndicatorAdapter, CameraNavigationBarBottomAdapter cameraNavigationBarBottomAdapter, ReviewNavigationBarBottomAdapter reviewNavigationBarBottomAdapter, SkontoNavigationBarBottomAdapter skontoNavigationBarBottomAdapter, HelpNavigationBarBottomAdapter helpNavigationBarBottomAdapter, ErrorNavigationBarBottomAdapter errorNavigationBarBottomAdapter, EntryPoint entryPoint, Boolean allowScreenshots, Boolean skontoEnabled, Boolean transactionDocsEnabled, GiniComposableStyleProvider giniComposableStyleProvider)
```
- Method Detail
  - getNetworkService
```
 final GiniCaptureNetworkService getNetworkService()
```
    Set the GiniCaptureNetworkService instance which will be used by the library to request document related network calls (e.g. upload, analysis or deletion).
  - getShowOnboardingAtFirstRun
```
 final Boolean getShowOnboardingAtFirstRun()
```
    Screen API only
    When enabled shows the OnboardingActivity the first time the CameraActivity is launched. We highly recommend having it enabled.
  - getOnboardingPages
```
 final List<OnboardingPage> getOnboardingPages()
```
    Set custom pages to be shown in the Onboarding Screen.
  - getShowOnboarding
```
 final Boolean getShowOnboarding()
```
    Screen API only
    When enabled shows the Onboarding Screen every time the CameraActivity starts.
  - getMultiPageEnabled
```
 final Boolean getMultiPageEnabled()
```
    Enable/disable the multi-page feature.
  - getDocumentImportEnabledFileTypes
```
 final DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()
```
    Enable and configure the document import feature or disable it by passing in DocumentImportEnabledFileTypes.NONE.
  - getFileImportEnabled
```
 final Boolean getFileImportEnabled()
```
    Enable/disable the file import feature.
  - getQrCodeScanningEnabled
```
 final Boolean getQrCodeScanningEnabled()
```
    Enable/disable the QRCode scanning feature.
  - getOnlyQRCodeScanningEnabled
```
 final Boolean getOnlyQRCodeScanningEnabled()
```
    Enable/disable only the QRCode scanning feature.
  - getSupportedFormatsHelpScreenEnabled
```
 final Boolean getSupportedFormatsHelpScreenEnabled()
```
    Enable/disable the Supported Formats help screen.
  - getFlashButtonEnabled
```
 final Boolean getFlashButtonEnabled()
```
    Enable/disable the flash button in the Camera Screen.
  - getFlashOnByDefault
```
 final Boolean getFlashOnByDefault()
```
    Set whether the camera flash should be on or off when the SDK starts. The flash is off by default.
  - getReturnAssistantEnabled
```
 final Boolean getReturnAssistantEnabled()
```
    Enable/disable the return assistant feature.
  - getEventTracker
```
 final EventTracker getEventTracker()
```
    EventTracker instance which will be called from the different screens to inform you about the various events which can occur during the usage of the Capture feature.
  - getCustomHelpItems
```
 final List<HelpItem.Custom> getCustomHelpItems()
```
    A list of HelpItem.Custom defining the custom help items to be shown in the Help Screen.
  - getGiniErrorLoggerIsOn
```
 final Boolean getGiniErrorLoggerIsOn()
```
    Set whether the default Gini error logging implementation is on or not.
    On by default.
  - getErrorLoggerListener
```
 final ErrorLoggerListener getErrorLoggerListener()
```
    Set an ErrorLoggerListener to be notified of errors.
  - getImportedFileSizeBytesLimit
```
 final Integer getImportedFileSizeBytesLimit()
```
    Set a custom imported file size limit in bytes.
  - getNavigationBarTopAdapter
```
 final NavigationBarTopAdapter getNavigationBarTopAdapter()
```
    Set an adapter implementation to show a custom top navigation bar.
  - getBottomNavigationBarEnabled
```
 final Boolean getBottomNavigationBarEnabled()
```
    Enable/disable the bottom navigation bar.
    Disabled by default.
  - getOnboardingNavigationBarBottomAdapter
```
 final OnboardingNavigationBarBottomAdapter getOnboardingNavigationBarBottomAdapter()
```
    Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.
  - getOnboardingAlignCornersIllustrationAdapter
```
 final OnboardingIllustrationAdapter getOnboardingAlignCornersIllustrationAdapter()
```
    Set an adapter implementation to show a custom illustration on the "align corners" onboarding page.
  - getOnboardingLightingIllustrationAdapter
```
 final OnboardingIllustrationAdapter getOnboardingLightingIllustrationAdapter()
```
    Set an adapter implementation to show a custom illustration on the "lighting" onboarding page.
  - getOnboardingMultiPageIllustrationAdapter
```
 final OnboardingIllustrationAdapter getOnboardingMultiPageIllustrationAdapter()
```
    Set an adapter implementation to show a custom illustration on the "multi-page" onboarding page.
  - getOnboardingQRCodeIllustrationAdapter
```
 final OnboardingIllustrationAdapter getOnboardingQRCodeIllustrationAdapter()
```
    Set an adapter implementation to show a custom illustration on the "QR code" onboarding page.
  - getCustomLoadingIndicatorAdapter
```
 final CustomLoadingIndicatorAdapter getCustomLoadingIndicatorAdapter()
```
    Set an adapter implementation to show a custom loading animation during analyse and scan.
  - getOnButtonLoadingIndicatorAdapter
```
 final OnButtonLoadingIndicatorAdapter getOnButtonLoadingIndicatorAdapter()
```
    Set an adapter implementation to show a custom loading animation during analyse and scan.
  - getCameraNavigationBarBottomAdapter
```
 final CameraNavigationBarBottomAdapter getCameraNavigationBarBottomAdapter()
```
    Set an adapter implementation to show a custom bottom navigation bar on the camera screen.
  - getReviewNavigationBarBottomAdapter
```
 final ReviewNavigationBarBottomAdapter getReviewNavigationBarBottomAdapter()
```
    Set an adapter implementation to show a custom bottom navigation bar on the review screen.
  - getSkontoNavigationBarBottomAdapter
```
 final SkontoNavigationBarBottomAdapter getSkontoNavigationBarBottomAdapter()
```
    Set an adapter implementation to show a custom bottom navigation bar on the Skonto screen.
  - getHelpNavigationBarBottomAdapter
```
 final HelpNavigationBarBottomAdapter getHelpNavigationBarBottomAdapter()
```
    Set an adapter implementation to show a custom bottom navigation bar on the help screen.
  - getErrorNavigationBarBottomAdapter
```
 final ErrorNavigationBarBottomAdapter getErrorNavigationBarBottomAdapter()
```
    Set an adapter implementation to show a custom bottom navigation bar on the error screen.
  - getEntryPoint
```
 final EntryPoint getEntryPoint()
```
    Set the entry point used for launching the SDK. See EntryPoint for possible values.
    Default value is EntryPoint.BUTTON.
  - getAllowScreenshots
```
 final Boolean getAllowScreenshots()
```
    Set whether screenshots should be allowed or not.
    Screenshots are allowed by default.
    IMPORTANT: If you disallow screenshots and use the CaptureFlowFragment for launching the SDK in your activity, please clear the android.view.WindowManager.LayoutParams.FLAG_SECURE on your activity's window after the SDK has finished to allow users to take screenshots of your app again.
  - getSkontoEnabled
```
 final Boolean getSkontoEnabled()
```
    Enable/disable the skonto feature.
  - getTransactionDocsEnabled
```
 final Boolean getTransactionDocsEnabled()
```
    Enable/disable the transaction docs feature.
  - getGiniComposableStyleProvider
```
 final GiniComposableStyleProvider getGiniComposableStyleProvider()
```

Class CaptureConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CaptureConfiguration

Method Detail

getNetworkService

getShowOnboardingAtFirstRun

getOnboardingPages

getShowOnboarding

getMultiPageEnabled

getDocumentImportEnabledFileTypes

getFileImportEnabled

getQrCodeScanningEnabled

getOnlyQRCodeScanningEnabled

getSupportedFormatsHelpScreenEnabled

getFlashButtonEnabled

getFlashOnByDefault

getReturnAssistantEnabled

getEventTracker

getCustomHelpItems

getGiniErrorLoggerIsOn

getErrorLoggerListener

getImportedFileSizeBytesLimit

getNavigationBarTopAdapter

getBottomNavigationBarEnabled

getOnboardingNavigationBarBottomAdapter

getOnboardingAlignCornersIllustrationAdapter

getOnboardingLightingIllustrationAdapter

getOnboardingMultiPageIllustrationAdapter

getOnboardingQRCodeIllustrationAdapter

getCustomLoadingIndicatorAdapter

getOnButtonLoadingIndicatorAdapter

getCameraNavigationBarBottomAdapter

getReviewNavigationBarBottomAdapter

getSkontoNavigationBarBottomAdapter

getHelpNavigationBarBottomAdapter

getErrorNavigationBarBottomAdapter

getEntryPoint

getAllowScreenshots

getSkontoEnabled

getTransactionDocsEnabled

getGiniComposableStyleProvider