ginivision/net.gini.android.vision.document/GiniVisionDocument

GiniVisionDocument

Internal use only.

public class GiniVisionDocument implements Document

Constructors

GiniVisionDocument

androidJvm

void GiniVisionDocument(Document.Type type, Document.Source source, Document.ImportMethod importMethod, String mimeType, Array<byte> data, Intent intent, Uri uri, boolean isReviewable)

GiniVisionDocument

androidJvm

void GiniVisionDocument(String uniqueId, Document.Type type, Document.Source source, Document.ImportMethod importMethod, String mimeType, Array<byte> data, Intent intent, Uri uri, boolean isReviewable)

GiniVisionDocument

androidJvm

void GiniVisionDocument(Parcel in)

Functions

describeContents

androidJvm

abstract int describeContents()

Internal use only.

int describeContents()

equals

androidJvm

boolean equals(Object o)

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.

synchronized Array<byte> getData()

getId

androidJvm

Retrieve the document's unique id.

getImportMethod

androidJvm

Retrieve with which method the document has been imported.

Document.ImportMethod getImportMethod()

getIntent

androidJvm

The Intent with which the imported document was received.

Intent getIntent()

getJpeg

androidJvm

The image of a document as a JPEG.

Array<byte> getJpeg()

getMimeType

androidJvm

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

String getMimeType()

getParcelableMemoryCacheTag

androidJvm

String getParcelableMemoryCacheTag()

getRotationForDisplay

androidJvm

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

Degrees are positive and multiples of 90.

int getRotationForDisplay()

getSource

androidJvm

Retrieve from which source the document originates from.

Document.Source getSource()

getType

androidJvm

Get the concrete document type.

Document.Type getType()

getUri

androidJvm

The Uri of the imported document.

hashCode

androidJvm

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.

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.

boolean isReviewable()

loadData

androidJvm

synchronized void loadData(Context context, AsyncCallback<Array<byte>, Exception> callback)

setData

androidJvm

synchronized void setData(Array<byte> data)

setParcelableMemoryCacheTag

androidJvm

void setParcelableMemoryCacheTag(String tag)

toString

androidJvm

String toString()

unloadData

androidJvm

synchronized void unloadData()

writeToParcel

androidJvm

abstract void writeToParcel(Parcel p, int p1)

Internal use only.

void writeToParcel(Parcel dest, int flags)

Properties

CREATOR

androidJvm

Internal use only.

public final static Parcelable.Creator<GiniVisionDocument> CREATOR

Inheritors

QRCodeDocument

androidJvm

ImageDocument

androidJvm

GiniVisionMultiPageDocument

androidJvm

PdfDocument

androidJvm