-
- All Implemented Interfaces:
-
android.os.Parcelable,net.gini.android.capture.Document
public class GiniCaptureDocument implements Document
Internal use only.
-
-
Field Summary
Fields Modifier and Type Field Description public final static Parcelable.Creator<GiniCaptureDocument>CREATOR
-
Method Summary
Modifier and Type Method Description StringgetId()Retrieve the document's unique id. intdescribeContents()Internal use only. voidwriteToParcel(Parcel dest, int flags)Internal use only. Document.TypegetType()Get the concrete document type. StringgetMimeType()Retrieve the document's mime type (media type). synchronized Array<byte>getData()The contents of a document, if the document was loaded into memory. synchronized voidsetData(Array<byte> data)IntentgetIntent()The Intent with which the imported document was received. UrigetUri()The Uri of the imported document. booleanisImported()Document is imported if it was picked from another app from the Camera Screen's documentupload button or if a file was passed to the Gini Capture SDK through the clientapplication from another app. Document.ImportMethodgetImportMethod()Retrieve with which method the document has been imported. Document.SourcegetSource()Retrieve from which source the document originates from. booleanisReviewable()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 theAnalysis Screen. voidsetParcelableMemoryCacheTag(@NonNull() String tag)StringgetParcelableMemoryCacheTag()StringgenerateUploadMetadata(Context context)Generate metadata to be sent to backend when creating partial document. StringtoString()synchronized voidloadData(@NonNull() Context context, @NonNull() AsyncCallback<Array<byte>, Exception> callback)synchronized voidunloadData()booleanequals(Object o)inthashCode()-
-
Method Detail
-
describeContents
int describeContents()
Internal use only.
-
writeToParcel
void writeToParcel(Parcel dest, int flags)
Internal use only.
-
getType
Document.Type getType()
Get the concrete document type.
-
getMimeType
String getMimeType()
Retrieve the document's mime type (media type).
-
getData
@Nullable() synchronized Array<byte> getData()
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.
-
isImported
boolean isImported()
Document is imported if it was picked from another app from the Camera Screen's documentupload button or if a file was passed to the Gini Capture SDK through the clientapplication from another app.
-
getImportMethod
@NonNull() Document.ImportMethod getImportMethod()
Retrieve with which method the document has been imported.
-
getSource
@NonNull() Document.Source getSource()
Retrieve from which source the document originates from.
-
isReviewable
boolean isReviewable()
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 theAnalysis Screen.
-
setParcelableMemoryCacheTag
void setParcelableMemoryCacheTag(@NonNull() String tag)
-
getParcelableMemoryCacheTag
@Nullable() String getParcelableMemoryCacheTag()
-
generateUploadMetadata
String generateUploadMetadata(Context context)
Generate metadata to be sent to backend when creating partial document.
-
loadData
synchronized void loadData(@NonNull() Context context, @NonNull() AsyncCallback<Array<byte>, Exception> callback)
-
unloadData
synchronized void unloadData()
-
hashCode
int hashCode()
-
-
-
-