sdk/net.gini.android.capture/GiniCapture

GiniCapture

public class GiniCapture

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

This singleton class is preferred over the previous methods of configuration and interaction. It is only mandatory for new features. You can continue using features from previous releases without any modification.

To create and configure a singleton instance use the newInstance method and the returned Builder. If an instance is already available you need to call cleanup before creating a new instance. Failing to do so will throw an exception.

After you are done using the Gini Capture SDK use the cleanup method. This will free up resources used by the library.

Types

public class Builder

Builder for GiniCapture.

public class Internal

Internal use only.

Functions

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.

createIntentForImportedFiles

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.

getCameraNavigationBarBottomAdapter

public CameraNavigationBarBottomAdapter getCameraNavigationBarBottomAdapter()

getCustomHelpItems

public List<HelpItem.Custom> getCustomHelpItems()

The custom help items, if configured.

getCustomOnboardingPages

public ArrayList<OnboardingPage> getCustomOnboardingPages()

The custom Onboarding Screen pages, if configured.

getDocumentImportEnabledFileTypes

public DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()

Retrieve the file types enabled for document import.

getHelpNavigationBarBottomAdapter

public HelpNavigationBarBottomAdapter getHelpNavigationBarBottomAdapter()

getImportedFileSizeBytesLimit

public int getImportedFileSizeBytesLimit()

The size limit in bytes for imported files.

public static synchronized GiniCapture getInstance()

Retrieve the current instance.

getLoadingIndicatorAdapter

public CustomLoadingIndicatorAdapter getLoadingIndicatorAdapter()

getNavigationBarTopAdapter

public NavigationBarTopAdapter getNavigationBarTopAdapter()

getOnboardingAlignCornersIllustrationAdapter

public OnboardingIllustrationAdapter getOnboardingAlignCornersIllustrationAdapter()

getOnboardingLightingIllustrationAdapter

public OnboardingIllustrationAdapter getOnboardingLightingIllustrationAdapter()

getOnboardingMultiPageIllustrationAdapter

public OnboardingIllustrationAdapter getOnboardingMultiPageIllustrationAdapter()

getOnboardingNavigationBarBottomAdapter

public OnboardingNavigationBarBottomAdapter getOnboardingNavigationBarBottomAdapter()

getOnboardingQRCodeIllustrationAdapter

public OnboardingIllustrationAdapter getOnboardingQRCodeIllustrationAdapter()

getOnButtonLoadingIndicatorAdapter

public OnButtonLoadingIndicatorAdapter getOnButtonLoadingIndicatorAdapter()

getReviewNavigationBarBottomAdapter

public ReviewNavigationBarBottomAdapter getReviewNavigationBarBottomAdapter()

public static synchronized boolean hasInstance()

Check whether an instance exists.

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.

public static synchronized GiniCapture.Builder newInstance()

Configure and create a new instance using the returned Builder.

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

isBottomNavigationBarEnabled

public final boolean isBottomNavigationBarEnabled