net.gini.android.vision.network

Class GiniVisionDefaultNetworkApi

java.lang.Object

net.gini.android.vision.network.GiniVisionDefaultNetworkApi

All Implemented Interfaces:

GiniVisionNetworkApi

public class GiniVisionDefaultNetworkApi
extends java.lang.Object
implements GiniVisionNetworkApi

Default implementation of network calls which can be performed manually from outside the Gini Vision Library (e.g. for sending feedback).

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

In order to easily access this implementation pass an instance of it to GiniVision.Builder#setGiniVisionNetworkApi(GiniVisionNetworkApi) when creating a GiniVision instance. You can then get the instance in your app with GiniVision#getGiniVisionNetworkApi().

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static GiniVisionDefaultNetworkApi.Builder	builder() Creates a new GiniVisionDefaultNetworkApi.Builder to configure and create a new instance.
void	deleteGiniUserCredentials() Delete the anonymous gini user credentials.
void	sendFeedback(java.util.Map extractions, GiniVisionNetworkCallback callback) Call this method with the extractions the user has seen and accepted.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static GiniVisionDefaultNetworkApi.Builder builder()

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

Returns:

a new GiniVisionDefaultNetworkApi.Builder

sendFeedback

public void sendFeedback(java.util.Map extractions,
                         GiniVisionNetworkCallback callback)

Description copied from interface: GiniVisionNetworkApi

Call this method with the extractions the user has seen and accepted. The GiniVisionSpecificExtractions must contain the final user corrected and/or accepted values.

Specified by:

sendFeedback in interface GiniVisionNetworkApi

Parameters:

extractions - a map of extraction labels and specific extractions

callback - a callback implementation to return the outcome

deleteGiniUserCredentials

public void deleteGiniUserCredentials()

Description copied from interface: GiniVisionNetworkApi

Delete the anonymous gini user credentials. These were automatically generated when the first document was uploaded.

By deleting the credentials, new ones will be generated at the next upload.

Specified by:

deleteGiniUserCredentials in interface GiniVisionNetworkApi