ApiCommunicator

public class ApiCommunicator

The ApiCommunicator is responsible for communication with the Gini API. It only converts the server's responses to more convenient objects (e.g. a JSON response to a JSONObject) but does not interpret the results in any way. Therefore it is not recommended to use the ApiCommunicator directly, but to use the DocumentTaskManager instead which provides much more convenient methods to work with the Gini API and uses defined models.

Constructors

ApiCommunicator

void ApiCommunicator(String baseUriString, GiniApiType giniApiType, RequestQueue mRequestQueue, RetryPolicyFactory retryPolicyFactory)

Types

PreviewSize

public enum PreviewSize

Functions

deleteDocument

Task<String> deleteDocument(Uri documentUri, Session session)

Task<String> deleteDocument(String documentId, Session session)

errorReportForDocument

Task<JSONObject> errorReportForDocument(String documentId, @Nullable() String summary, @Nullable() String description, Session session)

getDocument

Task<JSONObject> getDocument(Uri documentUri, Session session)

Task<JSONObject> getDocument(String documentId, Session session)

getDocumentList

Task<JSONObject> getDocumentList(int offset, int limit, Session session)

getExtractions

Task<JSONObject> getExtractions(String documentId, Session session)

getIncubatorExtractions

Task<JSONObject> getIncubatorExtractions(String documentId, Session session)

getLayoutForDocument

Task<JSONObject> getLayoutForDocument(String documentId, Session session)

getPageImage

Task<Array<byte>> getPageImage(@NonNull() String documentId, int pageCount, Session session)

getPayment

Task<JSONObject> getPayment(String id, Session session)

getPaymentProvider

Task<JSONObject> getPaymentProvider(String id, Session session)

getPaymentProviders

Task<JSONArray> getPaymentProviders(Session session)

getPaymentRequest

Task<JSONObject> getPaymentRequest(String id, Session session)

getPaymentRequests

Task<JSONArray> getPaymentRequests(Session session)

getPreview

Task<Bitmap> getPreview(String documentId, int pageNumber, ApiCommunicator.PreviewSize previewSize, Session session)

logErrorEvent

Task<JSONObject> logErrorEvent(@NonNull() JSONObject errorEvent, @NonNull() Session session)

postPaymentRequests

Task<JSONObject> postPaymentRequests(JSONObject body, Session session)

resolvePaymentRequests

Task<JSONObject> resolvePaymentRequests(String id, JSONObject body, Session session)

searchDocuments

Task<JSONObject> searchDocuments(String searchTerm, @Nullable() String docType, int offset, int limit, Session session)

sendFeedback

Task<JSONObject> sendFeedback(String documentId, JSONObject extractions, Session session)

Task<JSONObject> sendFeedback(String documentId, JSONObject extractions, JSONObject compoundExtractions, Session session)

uploadDocument

Task<Uri> uploadDocument(Array<byte> documentData, String contentType, @Nullable() String documentName, @Nullable() String docTypeHint, Session session, @Nullable() DocumentMetadata documentMetadata)

Properties

mRequestQueue

public final RequestQueue mRequestQueue

mRetryPolicyFactory

public final RetryPolicyFactory mRetryPolicyFactory