Package 

Interface GiniCaptureNetworkService

  • All Implemented Interfaces:
    net.gini.android.capture.logging.ErrorLoggerListener 
    
public interface GiniCaptureNetworkService
 implements ErrorLoggerListener

    Interface specifying network related tasks required by the Gini Capture SDK in order to communicate with the Gini API.

    The easiest way to get started is to use the Gini Capture Network Library package which provides a default implementation.

    You can also create your own implementation and communicate directly with the Gini API or pass requests through your backend. For direct communication with the Gini API we recommend using the Gini Bank API lib.

    In order for the Gini Capture SDK to use your implementation pass an instance of it to setGiniCaptureNetworkService when creating a GiniCapture instance.

    When an instance of this interface is available document analysis related methods in the CameraFragmentListener, ReviewFragmentListener and the won't be invoked. Otherwise the Gini Capture SDK falls back to invoking those methods.

    • Constructor Detail

    • Method Detail

      • upload

         abstract CancellationToken upload(@NonNull() Document document, @NonNull() GiniCaptureNetworkCallback<Result, Error> callback)

        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.

        Parameters:
        document - a Document containing an image, pdf or other supported formats
        callback - a callback implementation to return the outcome of the upload

      • analyze

         abstract CancellationToken analyze(@NonNull() LinkedHashMap<String, Integer> giniApiDocumentIdRotationMap, @NonNull() GiniCaptureNetworkCallback<AnalysisResult, Error> callback)

        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.

        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

      • cleanup

         abstract void cleanup()

        Called when the Gini Capture SDK is not needed anymore and the cleanup method has been called.

        Free up any resources your implementation is using.

      • handleErrorLog

         void handleErrorLog(@NonNull() ErrorLog errorLog)

        Called when an error occurred inside the Gini Capture SDK.

        Parameters:
        errorLog - error details and metadata for logging