Gini Capture SDK for Android/net.gini.android.capture.document/XmlMultiPageDocument

XmlMultiPageDocument

public final class XmlMultiPageDocument extends GiniCaptureMultiPageDocument<XmlDocument, GiniCaptureDocumentError>

A document consisting of multiple XML documents. This is created to conform to what is already supported for other file types

Constructors

XmlMultiPageDocument

public XmlMultiPageDocument XmlMultiPageDocument(Document.Source source, Document.ImportMethod importMethod)

public XmlMultiPageDocument XmlMultiPageDocument(XmlDocument document)

Properties

public final static Parcelable.Creator<XmlMultiPageDocument> CREATOR

Functions

public Unit addDocument(@NonNull() XmlDocument document)

public Unit addDocuments(@NonNull() List<XmlDocument> documents)

describeContents

public Integer describeContents()

Internal use only.

public Boolean equals(Object other)

generateUploadMetadata

public String generateUploadMetadata(Context context)

Generate metadata to be sent to backend when creating partial document.

public ByteArray getData()

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

public List<XmlDocument> getDocuments()

getErrorForDocument

public GiniCaptureDocumentError getErrorForDocument(@NonNull() XmlDocument document)

public String getId()

Retrieve the document's unique id.

getImportMethod

public Document.ImportMethod getImportMethod()

Retrieve with which method the document has been imported.

public Intent getIntent()

The Intent with which the imported document was received.

public String getMimeType()

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

getParcelableMemoryCacheTag

public String getParcelableMemoryCacheTag()

public Document.Source getSource()

Retrieve from which source the document originates from.

public Document.Type getType()

Get the concrete document type.

public Uri getUri()

The Uri of the imported document.

hasDocumentError

public Boolean hasDocumentError(ImageDocument imageDocument)

public Integer hashCode()

public 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.

public 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 the Analysis Screen.

public Unit loadData(@NonNull() Context context, @NonNull() AsyncCallback<ByteArray, Exception> callback)

removeErrorForDocument

public Unit removeErrorForDocument(@NonNull() XmlDocument document)

removeImageDocumentAtPosition

public Unit removeImageDocumentAtPosition(Integer position)

public Unit setData(ByteArray data)

setErrorForDocument

public Unit setErrorForDocument(@NonNull() XmlDocument document, @NonNull() GiniCaptureDocumentError error)

setParcelableMemoryCacheTag

public Unit setParcelableMemoryCacheTag(@NonNull() String tag)

public String toString()

unloadAllDocumentData

public Unit unloadAllDocumentData()

public Unit unloadData()

public Unit writeToParcel(Parcel dest, Integer flags)

Internal use only.