Gini Health API Library for Android/net.gini.android.health.api/HealthApiDocumentManager

HealthApiDocumentManager

public final class HealthApiDocumentManager extends DocumentManager<HealthApiDocumentRepository, ExtractionsContainer>

The HealthApiDocumentManager is a high level API on top of the Gini Health API. It provides high level methods to handle document and payment request related tasks easily.

Constructors

HealthApiDocumentManager

public HealthApiDocumentManager HealthApiDocumentManager(HealthApiDocumentRepository documentRepository)

Functions

createCompositeDocument

public final Resource<Document> createCompositeDocument(LinkedHashMap<Document, Integer> documentRotationMap, DocumentManager.DocumentType documentType)

public final Resource<Document> createCompositeDocument(List<Document> documents, DocumentManager.DocumentType documentType)

createPartialDocument

public final Resource<Document> createPartialDocument(ByteArray document, String contentType, String filename, DocumentManager.DocumentType documentType, DocumentMetadata documentMetadata)

createPaymentRequest

public final Resource<String> createPaymentRequest(PaymentRequestInput paymentRequestInput)

A PaymentRequest is used to signal to the API the intent of executing a payment using a specific payment provider for a document with its (possibly modified) extractions.

public final Resource<Unit> deleteDocument(String documentId)

deletePartialDocumentAndParents

public final Resource<Unit> deletePartialDocumentAndParents(String documentId)

getAllExtractions

public final Resource<ExtractionsContainer> getAllExtractions(Document document)

getAllExtractionsWithPolling

public final Resource<ExtractionsContainer> getAllExtractionsWithPolling(Document document)

public final Resource<Document> getDocument(Uri uri)

public final Resource<Document> getDocument(String id)

getDocumentLayout

public final Resource<DocumentLayout> getDocumentLayout(String documentId)

getDocumentPages

public final Resource<List<DocumentPage>> getDocumentPages(String documentId)

public final Resource<ByteArray> getFile(String location)

public final Resource<JSONObject> ~~getLayout~~(Document document)

public final Resource<ByteArray> getPageImage(String documentId, Integer page)

Get the rendered image of a page as byte[]

public final Resource<Payment> getPayment(String id)

getPaymentProvider

public final Resource<PaymentProvider> getPaymentProvider(String id)

getPaymentProviders

public final Resource<List<PaymentProvider>> getPaymentProviders()

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

getPaymentRequest

public final Resource<PaymentRequest> getPaymentRequest(String id)

getPaymentRequestDocument

public final Resource<ByteArray> getPaymentRequestDocument(String paymentRequestId)

Returns a QR code in PDF format which can be shared to payment providers

getPaymentRequestImage

public final Resource<ByteArray> getPaymentRequestImage(String paymentRequestId)

Returns a QR code in PNG format

getPaymentRequests

public final Resource<List<PaymentRequest>> getPaymentRequests()

public final Resource<Document> pollDocument(Document document)

sendFeedbackForExtractions

public final Resource<Unit> sendFeedbackForExtractions(Document document, Map<String, SpecificExtraction> specificExtractions)

public final Resource<Unit> sendFeedbackForExtractions(Document document, Map<String, SpecificExtraction> specificExtractions, Map<String, CompoundExtraction> compoundExtractions)