Constructor Detail

• 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)

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).

• getNetworkApi

   final GiniCaptureNetworkApi getNetworkApi()

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

• 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.

• 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 is on or off by default.

• getBackButtonsEnabled

   final Boolean getBackButtonsEnabled()

  Screen API only

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

• 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.