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

Document

public interface Document implements Parcelable

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

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.

Types

ImportMethod

public enum ImportMethod

Enum of supported methods for importing documents.

Source

public class Source implements Parcelable

Source of the document (e.g.

Type

public enum Type

Supported document types.

Functions

describeContents

public abstract int describeContents()

getData

@Nullable()

public abstract Array<byte> getData()

The contents of a document, if the document was loaded into memory.

getId

@NonNull()

public abstract String getId()

Retrieve the document's unique id.

getImportMethod

@NonNull()

public abstract Document.ImportMethod getImportMethod()

Retrieve with which method the document has been imported.

getIntent

@Nullable()

public abstract Intent getIntent()

The Intent with which the imported document was received.

getMimeType

public abstract String getMimeType()

Retrieve the document's mime type (media type).

getSource

@NonNull()

public abstract Document.Source getSource()

Retrieve from which source the document originates from.

getType

public abstract Document.Type getType()

Get the concrete document type.

getUri

@Nullable()

public abstract Uri getUri()

The Uri of the imported document.

isImported

public abstract boolean isImported()

Document is imported if it was picked from another app from the Camera Screen's document upload button or if a file was passed to the Gini Capture SDK through the client application from another app.

isReviewable

public abstract boolean isReviewable()

Documents like PDFs are not reviewable and can be passed directly to the Analysis Screen.

writeToParcel

public abstract void writeToParcel(Parcel p, int p1)

Inheritors

GiniCaptureDocument