CaptureConfiguration

Configuration class for Capture feature.

Constructors

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)

Functions

getBackButtonsEnabled

final Boolean getBackButtonsEnabled()

Screen API onlyEnable/disable back buttons in all Activities except ReviewActivity and AnalysisActivity, which always show back buttons.

getCustomHelpItems

final List<HelpItem.Custom> getCustomHelpItems()

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

getDocumentImportEnabledFileTypes

final DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()

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

getErrorLoggerListener

final ErrorLoggerListener getErrorLoggerListener()

Set an ErrorLoggerListener to be notified of errors.

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.

getFileImportEnabled

final Boolean getFileImportEnabled()

Enable/disable the file import feature.

getFlashButtonEnabled

final Boolean getFlashButtonEnabled()

Enable/disable the flash button in the Camera Screen.

getFlashOnByDefault

final Boolean getFlashOnByDefault()

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

getGiniErrorLoggerIsOn

final Boolean getGiniErrorLoggerIsOn()

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

getMultiPageEnabled

final Boolean getMultiPageEnabled()

Enable/disable the multi-page feature.

getNetworkApi

final GiniCaptureNetworkApi getNetworkApi()

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

getNetworkService

final GiniCaptureNetworkService getNetworkService()

Set the GiniCaptureNetworkService instance which will be used by the library to request document related network calls (e.g.

getOnboardingPages

final List<OnboardingPage> getOnboardingPages()

Set custom pages to be shown in the Onboarding Screen.

getQrCodeScanningEnabled

final Boolean getQrCodeScanningEnabled()

Enable/disable the QRCode scanning feature.

getReturnAssistantEnabled

final Boolean getReturnAssistantEnabled()

Enable/disable the return assistant feature.

getShowOnboarding

final Boolean getShowOnboarding()

Screen API onlyWhen enabled shows the Onboarding Screen every time the CameraActivity starts.

getShowOnboardingAtFirstRun

final Boolean getShowOnboardingAtFirstRun()

Screen API onlyWhen enabled shows the OnboardingActivity the first time the CameraActivity is launched.

getSupportedFormatsHelpScreenEnabled

final Boolean getSupportedFormatsHelpScreenEnabled()

Enable/disable the Supported Formats help screen.

Properties

backButtonsEnabled

private final Boolean backButtonsEnabled

Screen API onlyEnable/disable back buttons in all Activities except ReviewActivity and AnalysisActivity, which always show back buttons.

customHelpItems

private final List<HelpItem.Custom> customHelpItems

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

documentImportEnabledFileTypes

private final DocumentImportEnabledFileTypes documentImportEnabledFileTypes

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

errorLoggerListener

private final ErrorLoggerListener errorLoggerListener

Set an ErrorLoggerListener to be notified of errors.

eventTracker

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.

fileImportEnabled

private final Boolean fileImportEnabled

Enable/disable the file import feature.

flashButtonEnabled

private final Boolean flashButtonEnabled

Enable/disable the flash button in the Camera Screen.

flashOnByDefault

private final Boolean flashOnByDefault

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

giniErrorLoggerIsOn

private final Boolean giniErrorLoggerIsOn

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