Method Detail

• setLoadingIndicatorAdapter

   GiniCapture.Builder setLoadingIndicatorAdapter(@NonNull() CustomLoadingIndicatorAdapter adapter)

  Set an adapter implementation to show a custom loading indicator.

  Parameters:

  adapter - an CustomLoadingIndicatorAdapter interface implementation

• getEntryPoint

   EntryPoint getEntryPoint()

• setEntryPoint

   GiniCapture.Builder setEntryPoint(@NonNull() EntryPoint entryPoint)

  Set the entry point used for launching the SDK. See EntryPoint for possible values.

  Default value is {@code EntryPoint.BUTTON}.

  Parameters:

  entryPoint - an EntryPoint enum value

• getAllowScreenshots

   boolean getAllowScreenshots()

• setAllowScreenshots

   GiniCapture.Builder setAllowScreenshots(boolean allowScreenshots)

  Set whether screenshots should be allowed or not.

  Screenshots are allowed by default.

  IMPORTANT: If you disallow screenshots and use the GiniCaptureFragment for launching the SDK in your activity, please clear the FLAG_SECURE on your activity's window after the SDK has finished to allow users to take screenshots of your app again.

  Parameters:

  allowScreenshots - pass {@code true} to allow screenshots or {@code false} otherwise.

• getGiniComposableStyleProvider

   GiniComposableStyleProvider getGiniComposableStyleProvider()

• setGiniComposableStyleProvider

   GiniCapture.Builder setGiniComposableStyleProvider(GiniComposableStyleProvider giniComposableStyleProvider)

• build

   void build()

  Create a new GiniCapture instance.

• setShouldShowOnboardingAtFirstRun

  @NonNull() GiniCapture.Builder setShouldShowOnboardingAtFirstRun(boolean shouldShowOnboardingAtFirstRun)

  Screen API only

  Set to {@code false} to disable automatically showing the OnboardingActivity thefirst time the CameraActivity is launched - we highly recommend letting the Gini CaptureSDK show the OnboardingActivity at first run.

  Default value is {@code true}.

  Parameters:

  shouldShowOnboardingAtFirstRun - whether to show the onboarding on first run or not

• setCustomOnboardingPages

  @NonNull() GiniCapture.Builder setCustomOnboardingPages(@NonNull() ArrayList<OnboardingPage> onboardingPages)

  Set custom pages to be shown in the Onboarding Screen.

  Parameters:

  onboardingPages - an ArrayList of OnboardingPages

• setShouldShowOnboarding

  @NonNull() GiniCapture.Builder setShouldShowOnboarding(boolean shouldShowOnboarding)

  Screen API only

  Set to {@code true} to show the Onboarding Screen every time the CameraActivitystarts.

  Default value is {@code false}.

  Parameters:

  shouldShowOnboarding - whether to show the onboarding on every launch

• setMultiPageEnabled

   GiniCapture.Builder setMultiPageEnabled(boolean multiPageEnabled)

  Enable/disable the multi-page feature.

  Disabled by default.

  Parameters:

  multiPageEnabled - {@code true} to enable multi-page

• setGiniCaptureNetworkService

  @NonNull() GiniCapture.Builder setGiniCaptureNetworkService(@NonNull() GiniCaptureNetworkService giniCaptureNetworkService)

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

  Parameters:

  giniCaptureNetworkService - a GiniCaptureNetworkService instance

• setDocumentImportEnabledFileTypes

  @NonNull() GiniCapture.Builder setDocumentImportEnabledFileTypes(@NonNull() DocumentImportEnabledFileTypes documentImportEnabledFileTypes)

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

  Disabled by default.

  Parameters:

  documentImportEnabledFileTypes - file types to be enabled for document import

• setFileImportEnabled

  @NonNull() GiniCapture.Builder setFileImportEnabled(boolean fileImportEnabled)

  Enable/disable the file import feature.

  Disabled by default.

  Parameters:

  fileImportEnabled - {@code true} to enable file import

• setQRCodeScanningEnabled

  @NonNull() GiniCapture.Builder setQRCodeScanningEnabled(boolean qrCodeScanningEnabled)

  Enable/disable the QRCode scanning feature.

  Disabled by default.

  Parameters:

  qrCodeScanningEnabled - {@code true} to enable QRCode scanning

• setOnlyQRCodeScanning

   GiniCapture.Builder setOnlyQRCodeScanning(boolean onlyQRCodeScanningEnabled)

  Enable/disable only the QRCode scanning feature.

  Disabled by default.

  Parameters:

  onlyQRCodeScanningEnabled - {@code true} to enable only QRCode scanning

• setSupportedFormatsHelpScreenEnabled

   GiniCapture.Builder setSupportedFormatsHelpScreenEnabled(boolean enabled)

  Enable/disable the Supported Formats help screen.

  Enabled by default.

  Parameters:

  enabled - {@code true} to show the Supported Formats help screen

• setFlashButtonEnabled

   GiniCapture.Builder setFlashButtonEnabled(boolean enabled)

  Enable/disable the flash button in the Camera Screen.

  Disabled by default.

  Parameters:

  enabled - {@code true} to show the flash button

• setFlashOnByDefault

   GiniCapture.Builder setFlashOnByDefault(boolean flashOn)

  Set whether the camera flash is on or off when the SDK starts.

  If not changed, then flash is off by default.

  Parameters:

  flashOn - {@code true} to turn the flash on

• setEventTracker

   GiniCapture.Builder setEventTracker(@NonNull() EventTracker eventTracker)

  Set the EventTracker instance which will be called from the different screens to inform you about the various eventswhich can occur during the usage of the Gini Capture SDK.

  Parameters:

  eventTracker - an EventTracker instance

• setCustomHelpItems

   GiniCapture.Builder setCustomHelpItems(@NonNull() List<HelpItem.Custom> customHelpItems)

  Set custom help items to be shown in the Help Screen.

  Parameters:

  customHelpItems - an List of HelpItem.Custom objects

• setGiniErrorLoggerIsOn

   GiniCapture.Builder setGiniErrorLoggerIsOn(boolean isOn)

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

  On by default.

  Parameters:

  isOn - pass {@code true} to turn on the error logger or {@code false} otherwise.

• setCustomErrorLoggerListener

   GiniCapture.Builder setCustomErrorLoggerListener(@NonNull() ErrorLoggerListener listener)

  Set an ErrorLoggerListener to be notified of Gini Capture SDK errors.

  Parameters:

  listener - your ErrorLoggerListener implementation

• setImportedFileSizeBytesLimit

   GiniCapture.Builder setImportedFileSizeBytesLimit(int fileSizeBytesLimit)

  Set a custom imported file size limit in bytes.

  Parameters:

  fileSizeBytesLimit - file size limit in bytes

• getImportedFileSizeBytesLimit

   int getImportedFileSizeBytesLimit()

• setNavigationBarTopAdapter

   GiniCapture.Builder setNavigationBarTopAdapter(@NonNull() NavigationBarTopAdapter adapter)

  Set an adapter implementation to show a custom top navigation bar.

  Parameters:

  adapter - a NavigationBarTopAdapter interface implementation

• setOnboardingNavigationBarBottomAdapter

   GiniCapture.Builder setOnboardingNavigationBarBottomAdapter(@NonNull() OnboardingNavigationBarBottomAdapter adapter)

  Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.

  Parameters:

  adapter - an OnboardingNavigationBarBottomAdapter interface implementation

• setHelpNavigationBarBottomAdapter

   GiniCapture.Builder setHelpNavigationBarBottomAdapter(@NonNull() HelpNavigationBarBottomAdapter adapter)

  Set an adapter implementation to show a custom bottom navigation bar on the help screen.

  Parameters:

  adapter - a HelpNavigationBarBottomAdapter interface implementation

• setErrorNavigationBarBottomAdapter

   GiniCapture.Builder setErrorNavigationBarBottomAdapter(@NonNull() ErrorNavigationBarBottomAdapter adapter)

  Set an adapter implementation to show a custom bottom navigation bar on the error screen.

  Parameters:

  adapter - a ErrorNavigationBarBottomAdapter interface implementation

• setCameraNavigationBarBottomAdapter

   GiniCapture.Builder setCameraNavigationBarBottomAdapter(@NonNull() CameraNavigationBarBottomAdapter adapter)

  Set an adapter implementation to show a custom bottom navigation bar on the camera screen.

  Parameters:

  adapter - a CameraNavigationBarBottomAdapter interface implementation

• setBottomNavigationBarEnabled

   GiniCapture.Builder setBottomNavigationBarEnabled(Boolean enabled)

  Enable/disable the bottom navigation bar.

  Disabled by default.

• setOnboardingAlignCornersIllustrationAdapter

   GiniCapture.Builder setOnboardingAlignCornersIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)

  Set an adapter implementation to show a custom illustration on the "align corners" onboarding page.

  Parameters:

  adapter - an OnboardingIllustrationAdapter interface implementation

• setOnboardingLightingIllustrationAdapter

   GiniCapture.Builder setOnboardingLightingIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)

  Set an adapter implementation to show a custom illustration on the "lighting" onboarding page.

  Parameters:

  adapter - an OnboardingIllustrationAdapter interface implementation

• setOnboardingMultiPageIllustrationAdapter

   GiniCapture.Builder setOnboardingMultiPageIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)

  Set an adapter implementation to show a custom illustration on the "multi-page" onboarding page.

  Parameters:

  adapter - an OnboardingIllustrationAdapter interface implementation

• setOnboardingQRCodeIllustrationAdapter

   GiniCapture.Builder setOnboardingQRCodeIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)

  Set an adapter implementation to show a custom illustration on the "QR code" onboarding page.

  Parameters:

  adapter - an OnboardingIllustrationAdapter interface implementation

• setOnButtonLoadingIndicatorAdapter

   GiniCapture.Builder setOnButtonLoadingIndicatorAdapter(@NonNull() OnButtonLoadingIndicatorAdapter adapter)

• setReviewBottomBarNavigationAdapter

   GiniCapture.Builder setReviewBottomBarNavigationAdapter(@NonNull() ReviewNavigationBarBottomAdapter adapter)

  Set an adapter implementation to show a custom bottom navigation bar on the review screen.

  Parameters:

  adapter - a ReviewNavigationBarBottomAdapter interface implementation

• addCustomUploadMetadata

   GiniCapture.Builder addCustomUploadMetadata(String key, String value)