net.gini.android.capture.network

Class GiniCaptureDefaultNetworkService

java.lang.Object

net.gini.android.capture.network.GiniCaptureDefaultNetworkService

All Implemented Interfaces:

GiniCaptureNetworkService

public class GiniCaptureDefaultNetworkService
extends java.lang.Object
implements GiniCaptureNetworkService

Default implementation of the network related tasks required by the Gini Capture SDK.

Relies on the Gini Pay API lib for executing the requests, which implements communication with the Gini API using generated anonymous Gini users.

Important: Access to the Gini User Center API is required which is restricted to selected clients only. Contact Gini if you require access.

To create an instance use the GiniCaptureDefaultNetworkService.Builder returned by the GiniCaptureDefaultNetworkService.builder(Context) method.

In order for the Gini Capture SDK to use this implementation pass an instance of it to GiniCapture.Builder#setGiniCaptureNetworkService(GiniCaptureNetworkService) when creating a GiniCapture instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GiniCaptureDefaultNetworkService.Builder Builder for configuring a new instance of the GiniCaptureDefaultNetworkService.

Method Summary

Modifier and Type	Method and Description
CancellationToken	analyze(java.util.LinkedHashMap giniApiDocumentIdRotationMap, GiniCaptureNetworkCallback callback) Called when a document needs to be analyzed by the Gini API.
static GiniCaptureDefaultNetworkService.Builder	builder(Context context) Creates a new GiniCaptureDefaultNetworkService.Builder to configure and create a new instance.
void	cleanup() Called when the Gini Capture SDK is not needed anymore and the GiniCapture#cleanup(Context) method has been called.
CancellationToken	delete(java.lang.String giniApiDocumentId, GiniCaptureNetworkCallback callback) Called when a document needs to be deleted from the Gini API.
void	handleErrorLog(ErrorLog errorLog)
CancellationToken	upload(Document document, GiniCaptureNetworkCallback callback) Called when a document needs to be uploaded to the Gini API.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static GiniCaptureDefaultNetworkService.Builder builder(Context context)

Creates a new GiniCaptureDefaultNetworkService.Builder to configure and create a new instance.

Parameters:

context - Android context

Returns:

a new GiniCaptureDefaultNetworkService.Builder

upload

public CancellationToken upload(Document document,
                                GiniCaptureNetworkCallback callback)

Description copied from interface: GiniCaptureNetworkService

Called when a document needs to be uploaded to the Gini API.

You should only upload the document. Polling or retrieving extractions is not needed at this point.

Specified by:

upload in interface GiniCaptureNetworkService

Parameters:

document - a Document containing an image, pdf or other supported formats

callback - a callback implementation to return the outcome of the upload

Returns:

a CancellationToken to be used for requesting upload cancellation

delete

public CancellationToken delete(java.lang.String giniApiDocumentId,
                                GiniCaptureNetworkCallback callback)

Description copied from interface: GiniCaptureNetworkService

Called when a document needs to be deleted from the Gini API.

Specified by:

delete in interface GiniCaptureNetworkService

Parameters:

giniApiDocumentId - id of the document received when it was uploaded to the Gini API

callback - a callback implementation to return the outcome of the deletion

Returns:

a CancellationToken to be used for requesting cancellation of the deletion

analyze

public CancellationToken analyze(java.util.LinkedHashMap giniApiDocumentIdRotationMap,
                                 GiniCaptureNetworkCallback callback)

Description copied from interface: GiniCaptureNetworkService

Called when a document needs to be analyzed by the Gini API.

The documents were already uploaded and only the Gini API document ids of documents are passed in along with the user applied document rotations.

Specified by:

analyze in interface GiniCaptureNetworkService

Parameters:

giniApiDocumentIdRotationMap - a map of Gini API document ids and the user applied document rotations

callback - a callback implementation to return the outcome of the analysis

Returns:

a CancellationToken to be used for requesting analysis cancellation

handleErrorLog

public void handleErrorLog(ErrorLog errorLog)

Specified by:

handleErrorLog in interface GiniCaptureNetworkService

cleanup

public void cleanup()

Description copied from interface: GiniCaptureNetworkService

Called when the Gini Capture SDK is not needed anymore and the GiniCapture#cleanup(Context) method has been called.

Free up any resources your implementation is using.

Specified by:

cleanup in interface GiniCaptureNetworkService