sdk/net.gini.android.capture/GiniCapture

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

Builder

public class Builder

Builder for GiniCapture.

Internal

public class Internal

Internal use only.

Functions

areBackButtonsEnabled

boolean areBackButtonsEnabled()

Screen API only Find out whether back buttons in all Activities have been enabled.

cleanup

static synchronized void cleanup(@NonNull() Context context)

Destroys the GiniCapture instance and frees up used resources.

createDocumentForImportedFile

@NonNull()

static Document createDocumentForImportedFile(@NonNull() Intent intent, @NonNull() Context context)

Component API When your application receives a file from another application you can use this method to create a Document for launching the Gini Capture SDK's Review Fragment or Analysis Fragment.

createDocumentForImportedFiles

@NonNull()

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

Component API If you have enabled the multi-page feature and your application receives one or multiple files from another application you can use this method to create a Document for launching the Gini Capture SDK's MultiPageReviewFragment or the Analysis Fragment.

createIntentForImportedFile

@NonNull()

static Intent createIntentForImportedFile(@NonNull() Intent intent, @NonNull() Context context, @Nullable() Class<? extends ReviewActivity> reviewActivityClass, @Nullable() Class<? extends AnalysisActivity> analysisActivityClass)

Screen API When your application receives a file from another application you can use this method to create an Intent for launching the Gini Capture SDK.

createIntentForImportedFiles

@NonNull()

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

Screen API If you have enabled the multi-page feature and 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.

getCustomHelpItems

@NonNull()

List<HelpItem.Custom> getCustomHelpItems()

The custom help items, if configured.

getCustomOnboardingPages

@Nullable()

ArrayList<OnboardingPage> getCustomOnboardingPages()

The custom Onboarding Screen pages, if configured.

getDocumentImportEnabledFileTypes

@NonNull()

DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()

Retrieve the file types enabled for document import.