ginivision/net.gini.android.vision.network

Package net.gini.android.vision.network

Contains interfaces and classes for adding networking calls to the Gini Vision Library in order to communicate with the Gini API.

The Gini Vision Library uses the net.gini.android.vision.network.GiniVisionNetworkService interface to request network calls when required. By implementing the interface and passing it to the net.gini.android.vision.GiniVision.Builder.setGiniVisionNetworkService() when creating the net.gini.android.vision.GiniVision instance clients are free to use any networking implementation that fits their needs.

The net.gini.android.vision.network.GiniVisionNetworkApi can be implemented and used to perform network calls manually outside of the Gini Vision Library (e.g. for sending feedback).

The easiest way to get started is to use the Gini Vision Network Library package which provides a default implementation of both interfaces.

Types

AnalysisResult

androidJvm

Used by the GiniVisionNetworkService to return analysis results.

public class AnalysisResult extends Result

Error

androidJvm

Used by the GiniVisionNetworkService and GiniVisionNetworkApi to return error messages.

public class Error

GiniVisionNetworkApi

androidJvm

Interface specifying network calls which can be performed manually from outside the Gini Vision Library (e.g. for sending feedback). *

In order to easily access your implementation pass an instance of it to when creating a instance. You can then get the instance in your app with .

public interface GiniVisionNetworkApi

GiniVisionNetworkCallback

androidJvm

Used by the GiniVisionNetworkService and GiniVisionNetworkApi to return the outcome of network calls.

public interface GiniVisionNetworkCallback<R, E>

GiniVisionNetworkService

androidJvm

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

The easiest way to get started is to use the Gini Vision 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 API SDK.

In order for the Gini Vision Library to use your implementation pass an instance of it to setGiniVisionNetworkService when creating a GiniVision 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 Vision Library falls back to invoking those methods.

public interface GiniVisionNetworkService

Result

androidJvm

Used by the GiniVisionNetworkService to return network call results.

public class Result