Package net.gini.android.vision

The Gini Vision Library for Android provides Activities and Fragments for capturing, reviewing and analyzing photos, images and pdfs of invoices and remittance slips.

Types

AsyncCallback
Link copied to clipboard

Callback interface for asynchronous tasks.

public interface AsyncCallback<T, E extends Exception>
Document
Link copied to clipboard

This class is the container for transferring documents between the client application and the Gini Vision Library and between the Fragments of the Gini Vision Library.

Due to the size limitations of the android.os.Bundle , the document data byte array has to be stored in a memory cache when parceling and read from the cache when unparceling.

Warning: Always retrieve the Document extras from a Bundle to force unparceling and removing of the reference to the byte array from the memory cache. Failing to do so will lead to memory leaks.

public interface Document implements Parcelable
DocumentImportEnabledFileTypes
Link copied to clipboard

Use this enum to select the file types to be allowed for document import in the Camera Screen.

public enum DocumentImportEnabledFileTypes
GiniVision
Link copied to clipboard

Single entry point for the Gini Vision Library 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 Vision Library use the cleanup method. This will free up resources used by the library.

public class GiniVision
GiniVisionBasePresenter
Link copied to clipboard

Internal use only.

public abstract class GiniVisionBasePresenter<V extends GiniVisionBaseView>
GiniVisionBaseView
Link copied to clipboard

Internal use only.

public interface GiniVisionBaseView<P extends GiniVisionBasePresenter>
GiniVisionCoordinator
Link copied to clipboard

The {@code GiniVisionCoordinator} facilitates the default behavior for the Gini Vision Library.

You can ignore this class when using the Screen API.

If you use the Component API we recommend relying on this class to provide the default behavior of the Gini Vision Library. This can be achieved by calling the required methods at pre-defined points in your code and by implementing the GiniVisionCoordinator.Listener .

public class GiniVisionCoordinator
GiniVisionDebug
Link copied to clipboard

This class allows you to enable and disable debugging for the Gini Vision Library.

Debugging is disabled by default.

Warning: Don't forget to disable debugging before releasing.

If debug is enabled:

  • The reviewed jpegs are written to a folder called {@code ginivisionlib} in your app's external directory.

public final class GiniVisionDebug
GiniVisionError
Link copied to clipboard

Provides details about the error which caused the Gini Vision Library to fail.

public class GiniVisionError implements Parcelable
GiniVisionFeatureConfiguration
Link copied to clipboard

Using this class the features of the Gini Vision Library can be configured.

Use the builder by invoking buildNewConfiguration to configure and create a new instance.

public class GiniVisionFeatureConfiguration implements Parcelable
GiniVisionFileImport
Link copied to clipboard

This class contains methods for preparing launching the Gini Vision Library with a file received from another app.

public final class GiniVisionFileImport
ImportedFileValidationException
Link copied to clipboard

Thrown when a file failed validation.

Call getValidationError to find out the failure reason.

public class ImportedFileValidationException extends Exception
ImportImageFileUrisAsyncTask
Link copied to clipboard

Created by Alpar Szotyori on 22.05.2018. Copyright (c) 2018 Gini GmbH.

class ImportImageFileUrisAsyncTask extends AbstractImportImageUrisAsyncTask
OncePerInstallEvent
Link copied to clipboard

Internal use only.

public enum OncePerInstallEvent
OncePerInstallEventStore
Link copied to clipboard

Internal use only.

public class OncePerInstallEventStore