Gini Capture SDK for Android/net.gini.android.capture/GiniCapture

GiniCapture

Single entry point for the Gini Capture SDK for configuration and interaction.

To create and configure a singleton instance use the newInstance method and the returned Builder.

Please first provide the transfer summary via the sendTransferSummary method. The transfer summary is used to improve the future extraction accuracy. Then, use the cleanup method to clean up the SDK. Please follow the recommendations below:

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.

Types

Builder

public class Builder

Builder for GiniCapture.

CreateGiniCaptureFragmentForIntentCallback

public interface CreateGiniCaptureFragmentForIntentCallback

CreateGiniCaptureFragmentForIntentResult

public class CreateGiniCaptureFragmentForIntentResult

Internal

public class Internal

Internal use only.

Functions

cleanup

public static void cleanup(Context context)

@Deprecated()

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

createDocumentForImportedFiles

@NonNull()

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

createGiniCaptureFragment

public static GiniCaptureFragment createGiniCaptureFragment()

createGiniCaptureFragmentForIntent

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

createIntentForImportedFiles

@NonNull()

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

When your application receives one or multiple files from another application you can use this method to create an Intent for launching the Gini Capture SDK.

getAllowScreenshots

public boolean getAllowScreenshots()

Get whether screenshots are allowed or not.

getCameraNavigationBarBottomAdapter

@NonNull()

public CameraNavigationBarBottomAdapter getCameraNavigationBarBottomAdapter()

getCustomHelpItems

@NonNull()

public List<HelpItem.Custom> getCustomHelpItems()

The custom help items, if configured.

getCustomOnboardingPages

@Nullable()

public ArrayList<OnboardingPage> getCustomOnboardingPages()

The custom Onboarding Screen pages, if configured.

getDocumentImportEnabledFileTypes

@NonNull()

public DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()

Retrieve the file types enabled for document import.

getEntryPoint

@NonNull()

public EntryPoint getEntryPoint()

The entry point used for launching the SDK.

getHelpNavigationBarBottomAdapter

@NonNull()

public HelpNavigationBarBottomAdapter getHelpNavigationBarBottomAdapter()

getImportedFileSizeBytesLimit

public int getImportedFileSizeBytesLimit()

The size limit in bytes for imported files.

getInstance

@NonNull()

public static synchronized GiniCapture getInstance()

Retrieve the current instance.

getLoadingIndicatorAdapter

@Nullable()

public CustomLoadingIndicatorAdapter getLoadingIndicatorAdapter()

getNavigationBarTopAdapter

@NonNull()

public NavigationBarTopAdapter getNavigationBarTopAdapter()

getOnboardingAlignCornersIllustrationAdapter

@Nullable()

public OnboardingIllustrationAdapter getOnboardingAlignCornersIllustrationAdapter()

getOnboardingLightingIllustrationAdapter

@Nullable()

public OnboardingIllustrationAdapter getOnboardingLightingIllustrationAdapter()

getOnboardingMultiPageIllustrationAdapter

@Nullable()

public OnboardingIllustrationAdapter getOnboardingMultiPageIllustrationAdapter()

getOnboardingNavigationBarBottomAdapter

@NonNull()

public OnboardingNavigationBarBottomAdapter getOnboardingNavigationBarBottomAdapter()

getOnboardingQRCodeIllustrationAdapter

@Nullable()

public OnboardingIllustrationAdapter getOnboardingQRCodeIllustrationAdapter()

getOnButtonLoadingIndicatorAdapter

@Nullable()

public OnButtonLoadingIndicatorAdapter getOnButtonLoadingIndicatorAdapter()

getReviewNavigationBarBottomAdapter

@NonNull()

public ReviewNavigationBarBottomAdapter getReviewNavigationBarBottomAdapter()

hasInstance

public static synchronized boolean hasInstance()

Check whether an instance exists.

internal

@NonNull()

public GiniCapture.Internal internal()

Internal use only.

isBottomNavigationBarEnabled

public boolean isBottomNavigationBarEnabled()

isFileImportEnabled

public boolean isFileImportEnabled()

Find out whether file import has been enabled.

isFlashButtonEnabled

public boolean isFlashButtonEnabled()

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

isFlashOnByDefault

public boolean isFlashOnByDefault()

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

isMultiPageEnabled

public boolean isMultiPageEnabled()

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

isOnlyQRCodeScanning

public boolean isOnlyQRCodeScanning()

Find out whether only QRCode scanning has been enabled.

isQRCodeScanningEnabled

public boolean isQRCodeScanningEnabled()

Find out whether QRCode scanning has been enabled.

isSupportedFormatsHelpScreenEnabled

public boolean isSupportedFormatsHelpScreenEnabled()

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

newInstance

@NonNull()

@Deprecated()

public static synchronized GiniCapture.Builder ~~newInstance~~()

@NonNull()

public static synchronized GiniCapture.Builder newInstance(Context context)

Configure and create a new instance using the returned Builder.

sendTransferSummary

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

Provides transfer summary to Gini.

setShouldShowOnboarding

public void setShouldShowOnboarding(boolean shouldShowOnboarding)

Screen API only Set to true to show the Onboarding Screen every time the CameraActivity starts.

shouldShowOnboarding

public boolean shouldShowOnboarding()

Screen API only If set to true, the Onboarding Screen will be shown every every time the CameraActivity starts.

shouldShowOnboardingAtFirstRun

public boolean shouldShowOnboardingAtFirstRun()

Screen API only If set to false, the Onboarding Screen won't be shown on the first run.

Properties

allowScreenshots

public final boolean allowScreenshots

entryPoint

public final EntryPoint entryPoint

isBottomNavigationBarEnabled

public final boolean isBottomNavigationBarEnabled