Method Detail

• isBottomNavigationBarEnabled

   boolean isBottomNavigationBarEnabled()

• getEntryPoint

  @NonNull() EntryPoint getEntryPoint()

  The entry point used for launching the SDK.

  Default value is {@code EntryPoint.BUTTON}.

• getAllowScreenshots

   boolean getAllowScreenshots()

  Get whether screenshots are allowed or not.

  Default value is {@code true}.

• getInstance

  @NonNull() static synchronized GiniCapture getInstance()

  Retrieve the current instance.

• hasInstance

   static synchronized boolean hasInstance()

  Check whether an instance exists.

• newInstance

  @NonNull()@Deprecated() static synchronized GiniCapture.Builder newInstance()

  Configure and create a new instance using the returned Builder.

• newInstance

  @NonNull() static synchronized GiniCapture.Builder newInstance(Context context)

  Configure and create a new instance using the returned Builder.

  Parameters:

  context - Android context

• sendTransferSummary

   static synchronized void sendTransferSummary(@NonNull() String paymentRecipient, @NonNull() String paymentReference, @NonNull() String paymentPurpose, @NonNull() String iban, @NonNull() String bic, @NonNull() Amount amount, @Nullable() Boolean instantPayment)

  Provides transfer summary to Gini.

  Please provide the required transfer summary to improve the future extraction accuracy.Follow the recommendations below:

  • Make sure to call this method before calling cleanup if the user has completed TAN verification.
  • Provide values for all necessary fields, including those that were not extracted.
  • Provide the final data approved by the user (and not the initially extracted only).
  • Send the transfer summary after TAN verification and provide the extraction values the user has used.

  Parameters:

  paymentRecipient - payment receiver

  paymentReference - ID based on Client ID (Kundennummer) and invoice ID (Rechnungsnummer)

  paymentPurpose - statement what this payment is for

  iban - international bank account

  bic - bank identification code

  amount - accepts extracted amount and currency

  instantPayment - based on the user's preference to have the payment as instant payment

• sendTransferSummaryForSkonto

   static synchronized void sendTransferSummaryForSkonto(@NonNull() Amount amount, @NonNull() String skontoAmountToPayCalculated, @NonNull() String skontoPercentageDiscountedCalculated, @NonNull() String skontoDueDateCalculated)

  Internal use only.

• cleanup

  @Deprecated() static synchronized void cleanup(@NonNull() Context context, @NonNull() String paymentRecipient, @NonNull() String paymentReference, @NonNull() String paymentPurpose, @NonNull() String iban, @NonNull() String bic, @NonNull() Amount amount)

  Destroys the GiniCapture instance and frees up used resources.

  Please provide the required transfer summary to improve the future extraction accuracy.Follow the recommendations below:

  • Provide values for all necessary fields, including those that were not extracted.
  • Provide the final data approved by the user (and not the initially extracted only).
  • Do cleanup after TAN verification.to clean up and provide the extraction values the user has used.

  Parameters:

  context - Android context

  paymentRecipient - payment receiver

  paymentReference - ID based on Client ID (Kundennummer) and invoice ID (Rechnungsnummer)

  paymentPurpose - statement what this payment is for

  iban - international bank account

  bic - bank identification code

  amount - accepts extracted amount and currency

• cleanup

   static void cleanup(Context context)

  Destroys the GiniCapture instance and frees up used resources.

• internal

  @NonNull() GiniCapture.Internal internal()

  Internal use only.

• getDocumentImportEnabledFileTypes

  @NonNull() DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()

  Retrieve the file types enabled for document import.

  Disabled by default.

• isFileImportEnabled

   boolean isFileImportEnabled()

  Find out whether file import has been enabled.

  Disabled by default.

• isQRCodeScanningEnabled

   boolean isQRCodeScanningEnabled()

  Find out whether QRCode scanning has been enabled.

  Disabled by default.

• isOnlyQRCodeScanning

   boolean isOnlyQRCodeScanning()

  Find out whether only QRCode scanning has been enabled.

  Disabled by default.

• isMultiPageEnabled

   boolean isMultiPageEnabled()

  Find out whether scanning multi-page documents has been enabled.

  Disabled by default

• getCustomOnboardingPages

  @Nullable() ArrayList<OnboardingPage> getCustomOnboardingPages()

  The custom Onboarding Screen pages, if configured.

• shouldShowOnboardingAtFirstRun

   boolean shouldShowOnboardingAtFirstRun()

  Screen API only

  If set to {@code false}, the Onboarding Screen won't be shown on the first run.

• shouldShowOnboarding

   boolean shouldShowOnboarding()

  Screen API only

  If set to {@code true}, the Onboarding Screen will be shown every every time theCameraActivity starts.

  Default value is {@code false}.

  You can change it on the existing GiniCapture instance with .

• setShouldShowOnboarding

   void setShouldShowOnboarding(boolean shouldShowOnboarding)

  Screen API only

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

  Default value is {@code false}.

  Parameters:

  shouldShowOnboarding - whether to show the onboarding on every launch

• isSupportedFormatsHelpScreenEnabled

   boolean isSupportedFormatsHelpScreenEnabled()

  Find out whether the Supported Formats help screen has been enabled.

  Enabled by default.

• isFlashButtonEnabled

   boolean isFlashButtonEnabled()

  Find out whether the flash button on the Camera Screen has been enabled.

  Disabled by default.

• isFlashOnByDefault

   boolean isFlashOnByDefault()

  Find out whether the camera flash is on or off by default.

  If not changed, then flash is off by default.

• createIntentForImportedFiles

  @NonNull() CancellationToken createIntentForImportedFiles(@NonNull() Intent intent, @NonNull() Context context, @NonNull() AsyncCallback<Intent, ImportedFileValidationException> callback)

  When your application receives one or multiplefiles from another application you can use this method to create an Intent for launching theGini Capture SDK.

  Importing the files is executed on a secondary thread as it can take several seconds forthe process to complete. The callback methods are invoked on the main thread.

  In your callback's {@code onSuccess(Intent)} method start the Intent with to receive the extractions or a GiniCaptureError in case there was an error.

  Parameters:

  intent - the Intent your app received

  context - Android context

  callback - A AsyncCallback implementation

• createDocumentForImportedFiles

  @NonNull() CancellationToken createDocumentForImportedFiles(@NonNull() Intent intent, @NonNull() Context context, @NonNull() AsyncCallback<Document, ImportedFileValidationException> callback)

• getCustomHelpItems

  @NonNull() List<HelpItem.Custom> getCustomHelpItems()

  The custom help items, if configured.

• getNavigationBarTopAdapter

  @NonNull() NavigationBarTopAdapter getNavigationBarTopAdapter()

• getOnboardingNavigationBarBottomAdapter

  @NonNull() OnboardingNavigationBarBottomAdapter getOnboardingNavigationBarBottomAdapter()

• getHelpNavigationBarBottomAdapter

  @NonNull() HelpNavigationBarBottomAdapter getHelpNavigationBarBottomAdapter()

• getErrorNavigationBarBottomAdapter

  @NonNull() ErrorNavigationBarBottomAdapter getErrorNavigationBarBottomAdapter()

• getCameraNavigationBarBottomAdapter

  @NonNull() CameraNavigationBarBottomAdapter getCameraNavigationBarBottomAdapter()

• getOnboardingAlignCornersIllustrationAdapter

  @Nullable() OnboardingIllustrationAdapter getOnboardingAlignCornersIllustrationAdapter()

• getOnboardingLightingIllustrationAdapter

  @Nullable() OnboardingIllustrationAdapter getOnboardingLightingIllustrationAdapter()

• getOnboardingMultiPageIllustrationAdapter

  @Nullable() OnboardingIllustrationAdapter getOnboardingMultiPageIllustrationAdapter()

• getOnboardingQRCodeIllustrationAdapter

  @Nullable() OnboardingIllustrationAdapter getOnboardingQRCodeIllustrationAdapter()

• getLoadingIndicatorAdapter

  @Nullable() CustomLoadingIndicatorAdapter getLoadingIndicatorAdapter()

• getReviewNavigationBarBottomAdapter

  @NonNull() ReviewNavigationBarBottomAdapter getReviewNavigationBarBottomAdapter()

• getOnButtonLoadingIndicatorAdapter

  @Nullable() OnButtonLoadingIndicatorAdapter getOnButtonLoadingIndicatorAdapter()

• getImportedFileSizeBytesLimit

   int getImportedFileSizeBytesLimit()

  The size limit in bytes for imported files.

• getCustomUploadMetadata

  @Nullable() Map<String, String> getCustomUploadMetadata()

  Get upload metadata to be added to the HTTP headers

• createGiniCaptureFragment

   static GiniCaptureFragment createGiniCaptureFragment()

• createGiniCaptureFragmentForIntent

   CancellationToken createGiniCaptureFragmentForIntent(Context context, Intent intent, GiniCapture.CreateGiniCaptureFragmentForIntentCallback captureIntentCallback)

• getGiniComposableStyleProvider

  @Nullable() GiniComposableStyleProvider getGiniComposableStyleProvider()