CaptureConfiguration

public final class CaptureConfiguration

Configuration class for Capture feature.

Constructors

Link copied to clipboard
CaptureConfiguration CaptureConfiguration(GiniCaptureNetworkService networkService, GiniCaptureNetworkApi networkApi, Boolean showOnboardingAtFirstRun, List<OnboardingPage> onboardingPages, Boolean showOnboarding, Boolean multiPageEnabled, DocumentImportEnabledFileTypes documentImportEnabledFileTypes, Boolean fileImportEnabled, Boolean qrCodeScanningEnabled, Boolean supportedFormatsHelpScreenEnabled, Boolean flashButtonEnabled, Boolean flashOnByDefault, Boolean backButtonsEnabled, Boolean returnAssistantEnabled, EventTracker eventTracker, List<HelpItem.Custom> customHelpItems, Boolean giniErrorLoggerIsOn, ErrorLoggerListener errorLoggerListener, Integer importedFileSizeBytesLimit)

Functions

Link copied to clipboard
final Boolean getBackButtonsEnabled()

Screen API only

Link copied to clipboard
final List<HelpItem.Custom> getCustomHelpItems()

A list of HelpItem.Custom defining the custom help items to be shown in the Help Screen.

Link copied to clipboard

Enable and configure the document import feature or disable it by passing in DocumentImportEnabledFileTypes.NONE.

Link copied to clipboard
final ErrorLoggerListener getErrorLoggerListener()

Set an ErrorLoggerListener to be notified of errors.

Link copied to clipboard
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.

Link copied to clipboard
final Boolean getFileImportEnabled()

Enable/disable the file import feature.

Link copied to clipboard
final Boolean getFlashButtonEnabled()

Enable/disable the flash button in the Camera Screen.

Link copied to clipboard
final Boolean getFlashOnByDefault()

Set whether the camera flash is on or off by default.

Link copied to clipboard
final Boolean getGiniErrorLoggerIsOn()

Set whether the default Gini error logging implementation is on or not.

Link copied to clipboard
final Integer getImportedFileSizeBytesLimit()

Set a custom imported file size limit in bytes.

Link copied to clipboard
final Boolean getMultiPageEnabled()

Enable/disable the multi-page feature.

Link copied to clipboard
final GiniCaptureNetworkApi getNetworkApi()

Set the GiniCaptureNetworkApi instance which clients can use to request network calls (e.g. for sending feedback).

Link copied to clipboard
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).

Link copied to clipboard
final List<OnboardingPage> getOnboardingPages()

Set custom pages to be shown in the Onboarding Screen.

Link copied to clipboard
final Boolean getQrCodeScanningEnabled()

Enable/disable the QRCode scanning feature.

Link copied to clipboard
final Boolean getReturnAssistantEnabled()

Enable/disable the return assistant feature.

Link copied to clipboard
final Boolean getShowOnboarding()

Screen API only

Link copied to clipboard
final Boolean getShowOnboardingAtFirstRun()

Screen API only

Link copied to clipboard
final Boolean getSupportedFormatsHelpScreenEnabled()

Enable/disable the Supported Formats help screen.

Properties

Link copied to clipboard
private final Boolean backButtonsEnabled

Screen API only

Link copied to clipboard
private final List<HelpItem.Custom> customHelpItems

A list of HelpItem.Custom defining the custom help items to be shown in the Help Screen.

Link copied to clipboard
private final DocumentImportEnabledFileTypes documentImportEnabledFileTypes

Enable and configure the document import feature or disable it by passing in DocumentImportEnabledFileTypes.NONE.

Link copied to clipboard
private final ErrorLoggerListener errorLoggerListener

Set an ErrorLoggerListener to be notified of errors.

Link copied to clipboard
private final EventTracker eventTracker

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.

Link copied to clipboard
private final Boolean fileImportEnabled

Enable/disable the file import feature.

Link copied to clipboard
private final Boolean flashButtonEnabled

Enable/disable the flash button in the Camera Screen.

Link copied to clipboard
private final Boolean flashOnByDefault

Set whether the camera flash is on or off by default.

Link copied to clipboard
private final Boolean giniErrorLoggerIsOn

Set whether the default Gini error logging implementation is on or not.

Link copied to clipboard
private final Integer importedFileSizeBytesLimit

Set a custom imported file size limit in bytes.

Link copied to clipboard
private final Boolean multiPageEnabled

Enable/disable the multi-page feature.

Link copied to clipboard
private final GiniCaptureNetworkApi networkApi

Set the GiniCaptureNetworkApi instance which clients can use to request network calls (e.g. for sending feedback).

Link copied to clipboard
private final GiniCaptureNetworkService networkService

Set the GiniCaptureNetworkService instance which will be used by the library to request document related network calls (e.g. upload, analysis or deletion).

Link copied to clipboard
private final List<OnboardingPage> onboardingPages

Set custom pages to be shown in the Onboarding Screen.

Link copied to clipboard
private final Boolean qrCodeScanningEnabled

Enable/disable the QRCode scanning feature.

Link copied to clipboard
private final Boolean returnAssistantEnabled

Enable/disable the return assistant feature.

Link copied to clipboard
private final Boolean showOnboarding

Screen API only

Link copied to clipboard
private final Boolean showOnboardingAtFirstRun

Screen API only

Link copied to clipboard
private final Boolean supportedFormatsHelpScreenEnabled

Enable/disable the Supported Formats help screen.