ginivision/net.gini.android.vision/Document

Document

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

Types

ImportMethod

androidJvm

Enum of supported methods for importing documents.

enum ImportMethod

Source

androidJvm

Source of the document (e.g. camera or external).

class Source implements Parcelable

Type

androidJvm

Supported document types.

enum Type

Functions

describeContents

androidJvm

abstract int describeContents()

getData

androidJvm

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

For photos captured with the camera or for QR Codes this is never null.

If isImported is {@code true} then this might be null. If it's null you can use getIntent and access the contents using the Intent.

@Nullable()

abstract Array<byte> getData()

getId

androidJvm

Retrieve the document's unique id.

@NonNull()

abstract String getId()

getImportMethod

androidJvm

Retrieve with which method the document has been imported.

@NonNull()

abstract Document.ImportMethod getImportMethod()

getIntent

androidJvm

The Intent with which the imported document was received.

@Nullable()

abstract Intent getIntent()

getJpeg

androidJvm

The image of a document as a JPEG.

@Deprecated()

@NonNull()

abstract Array<byte> getJpeg()

getMimeType

androidJvm

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

abstract String getMimeType()

getRotationForDisplay

androidJvm

The amount of clockwise rotation needed to display the image in the correct orientation.

Degrees are positive and multiples of 90.

@Deprecated()

abstract int getRotationForDisplay()

getSource

androidJvm

Retrieve from which source the document originates from.

@NonNull()

abstract Document.Source getSource()

getType

androidJvm

Get the concrete document type.

abstract Document.Type getType()

getUri

androidJvm

The Uri of the imported document.

@Nullable()

abstract Uri getUri()

isImported

androidJvm

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 Vision Library through the client application from another app.

abstract boolean isImported()

isReviewable

androidJvm

Documents like PDFs are not reviewable and can be passed directly to the Analysis Screen. Reviewable documents have to be shown in the Review Screen first before passing it on to the Analysis Screen.

abstract boolean isReviewable()

writeToParcel

androidJvm

abstract void writeToParcel(Parcel p, int p1)

Inheritors

GiniVisionDocument

androidJvm