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, EntryPoint entryPoint, Boolean allowScreenshots, Boolean skontoEnabled)

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.

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