ginicapture/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 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.

public class GiniCapture

Types

Builder

androidJvm

Builder for GiniCapture . To get an instance call newInstance .

public class Builder

Internal

androidJvm

Internal use only.

public class Internal

Functions

areBackButtonsEnabled

androidJvm

Screen API only

Find out whether back buttons in all Activities have been enabled. ReviewActivity and AnalysisActivity are not affected and always show back buttons.

Enabled by default.

boolean areBackButtonsEnabled()

cleanup

androidJvm

Destroys the GiniCapture instance and frees up used resources.

static synchronized void cleanup(Context context)

createDocumentForImportedFile

androidJvm

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.

If the Document can be reviewed ( isReviewable ) launch the Review Fragment ( net.gini.android.capture.review.ReviewFragmentCompat ).

If the Document cannot be reviewed you must launch the Analysis Fragment ( ).

@NonNull()

static Document createDocumentForImportedFile(Intent intent, Context context)

createDocumentForImportedFiles

androidJvm

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.

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

If the Document can be reviewed ( isReviewable ) launch the .

If the Document cannot be reviewed you must launch the Analysis Fragment ( ).

@NonNull()

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

createIntentForImportedFile

androidJvm

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.

Start the Intent with startActivityForResult to receive the extractions or a GiniCaptureError in case there was an error.

@NonNull()

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

createIntentForImportedFiles

androidJvm

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.

Importing the files is executed on a secondary thread as it can take several seconds for the 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.

@NonNull()