DocumentManager

public final class DocumentManager

The DocumentManager is a high level API on top of the Gini API, which is used via the ApiCommunicator. It provides high level methods to handle document related tasks easily.

Constructors

DocumentManager

DocumentManager DocumentManager(DocumentTaskManager documentTaskManager)

Functions

createCompositeDocument

final Document createCompositeDocument(LinkedHashMap<Document, Integer> documentRotationMap, DocumentTaskManager.DocumentType documentType)

Creates a new Gini composite document. The input Map must contain the partial documents as keys. These will be part of the multi-page document. The value for each partial document key is the amount in degrees the document has been rotated by the user.

final Document createCompositeDocument(List<Document> documents, DocumentTaskManager.DocumentType documentType)

Creates a new Gini composite document.

createPartialDocument

final Document createPartialDocument(ByteArray document, String contentType, String filename, DocumentTaskManager.DocumentType documentType, DocumentMetadata documentMetadata)

Uploads raw data and creates a new Gini partial document.

createPaymentRequest

final String createPaymentRequest(PaymentRequestInput paymentRequestInput)

A PaymentRequest is used to have on the backend the intent of making a payment for a document with its (modified) extractions and specific payment provider.

deleteDocument

final Unit deleteDocument(String documentId)

Deletes a Gini document.

deletePartialDocumentAndParents

final Unit deletePartialDocumentAndParents(String documentId)

Deletes a Gini partial document and all its parent composite documents.

getDocument

final Document getDocument(Uri uri)

final Document getDocument(String id)

Get the document with the given unique identifier.

getExtractions

final ExtractionsContainer getExtractions(Document document)

Get the extractions for the given document.

getLayout

final JSONObject getLayout(Document document)

Gets the layout of a document. The layout of the document describes the textual content of a document with positional information, based on the processed document.

getPageImage

final ByteArray getPageImage(String documentId, Integer page)

Get the rendered image of a page as byte[]

getPayment

final Payment getPayment(String id)

Get information about the payment of the PaymentRequest

getPaymentProvider

final PaymentProvider getPaymentProvider(String id)

getPaymentProviders

final List<PaymentProvider> getPaymentProviders()

A payment provider is a Gini partner which integrated the GiniPay for Banks SDK into their mobile apps.

getPaymentRequest

final PaymentRequest getPaymentRequest(String id)

getPaymentRequests

final List<PaymentRequest> getPaymentRequests()

pollDocument

final Document pollDocument(Document document)

Continually checks the document status (via the Gini API) until the document is fully processed. To avoid flooding the network, there is a pause of at least the number of seconds that is set in the POLLING_INTERVAL constant of DocumentTaskManager.

reportDocument

final String reportDocument(Document document, String summary, String description)

Sends an error report for the given document to Gini. If the processing result for a document was not satisfactory (e.g. extractions where empty or incorrect), you can create an error report for a document. This allows Gini to analyze and correct the problem that was found.

resolvePaymentRequest

final ResolvedPayment resolvePaymentRequest(String requestId, ResolvePaymentInput resolvePaymentInput)

Mark a PaymentRequest as paid.

sendFeedback

final Document sendFeedback(Document document, Map<String, SpecificExtraction> specificExtractions, Map<String, CompoundExtraction> compoundExtractions)

Sends approved and conceivably corrected extractions for the given document. This is called "submitting feedback on extractions" in the Gini API documentation.