DocumentTaskManager

public class DocumentTaskManager

The DocumentTaskManager 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

DocumentTaskManager

void DocumentTaskManager(ApiCommunicator apiCommunicator, SessionManager sessionManager, GiniApiType giniApiType, Moshi moshi)

Types

DocumentType

public enum DocumentType

The available document type hints.

Functions

cancelDocumentPolling

void cancelDocumentPolling(@NonNull() Document document)

Cancels document polling.

createCompositeDocument

Task<Document> createCompositeDocument(@NonNull() LinkedHashMap<Document, Integer> documentRotationMap, @Nullable() DocumentTaskManager.DocumentType documentType)

Task<Document> createCompositeDocument(@NonNull() List<Document> documents, @Nullable() DocumentTaskManager.DocumentType documentType)

Creates a new Gini composite document.

createDocument

Task<Document> createDocument(@NonNull() Array<byte> document, @Nullable() String filename, @Nullable() DocumentTaskManager.DocumentType documentType)

Task<Document> createDocument(@NonNull() Array<byte> document, @Nullable() String filename, @Nullable() DocumentTaskManager.DocumentType documentType, @NonNull() DocumentMetadata documentMetadata)

Uploads raw data and creates a new Gini document.

createPartialDocument

Task<Document> createPartialDocument(@NonNull() Array<byte> document, @NonNull() String contentType, @Nullable() String filename, @Nullable() DocumentTaskManager.DocumentType documentType)

Task<Document> createPartialDocument(@NonNull() Array<byte> document, @NonNull() String contentType, @Nullable() String filename, @Nullable() DocumentTaskManager.DocumentType documentType, @NonNull() DocumentMetadata documentMetadata)

Uploads raw data and creates a new Gini partial document.

createPaymentRequest

Task<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

Task<String> deleteDocument(@NonNull() String documentId)

Deletes a Gini document.

deletePartialDocumentAndParents

Task<String> deletePartialDocumentAndParents(@NonNull() String documentId)

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

getAllExtractions

Task<ExtractionsContainer> getAllExtractions(@NonNull() Document document)

Get the extractions for the given document.

getDocument

Task<Document> getDocument(@NonNull() Uri documentUri)

Task<Document> getDocument(@NonNull() String documentId)

Get the document with the given unique identifier.

getLayout

Task<JSONObject> getLayout(@NonNull() Document document)

Gets the layout of a document.

getPageImage

Task<Array<byte>> getPageImage(String documentId, int page)

Get the rendered image of a page as byte[]

getPayment

Task<Payment> getPayment(String id)

Get information about the payment of the PaymentRequest

getPaymentProvider

Task<PaymentProvider> getPaymentProvider(String id)

getPaymentProviders

Task<List<PaymentProvider>> getPaymentProviders()

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

getPaymentRequest

Task<PaymentRequest> getPaymentRequest(String id)

getPaymentRequests

Task<List<PaymentRequest>> getPaymentRequests()

logErrorEvent

Task<Void> logErrorEvent(ErrorEvent errorEvent)

pollDocument

Task<Document> pollDocument(@NonNull() Document document)

Continually checks the document status (via the Gini API) until the document is fully processed.

reportDocument

Task<String> reportDocument(@NonNull() Document document, @Nullable() String summary, @Nullable() String description)

Sends an error report for the given document to Gini.

resolvePaymentRequest

Task<ResolvedPayment> resolvePaymentRequest(String requestId, ResolvePaymentInput resolvePaymentInput)

Mark a PaymentRequest as paid.

sendFeedbackForExtractions

Task<Document> sendFeedbackForExtractions(@NonNull() Document document, @NonNull() Map<String, SpecificExtraction> extractions)

Task<Document> sendFeedbackForExtractions(@NonNull() Document document, @NonNull() Map<String, SpecificExtraction> extractions, @NonNull() Map<String, CompoundExtraction> compoundExtractions)

Sends approved and conceivably corrected extractions for the given document.

Properties

DEFAULT_COMPRESSION

public final static int DEFAULT_COMPRESSION

The default compression rate which is used for JPEG compression in per cent.

mApiCommunicator

public final ApiCommunicator mApiCommunicator

The ApiCommunicator instance which is used to communicate with the Gini API.

POLLING_INTERVAL

public static long POLLING_INTERVAL

The time in milliseconds between HTTP requests when a document is polled.