GiniVisionCoordinator

The {@code GiniVisionCoordinator} facilitates the default behavior for the Gini Vision Library.

You can ignore this class when using the Screen API.

If you use the Component API we recommend relying on this class to provide the default behavior of the Gini Vision Library. This can be achieved by calling the required methods at pre-defined points in your code and by implementing the GiniVisionCoordinator.Listener .

public class GiniVisionCoordinator

Constructors

GiniVisionCoordinator
Link copied to clipboard

Types

Listener
Link copied to clipboard

Interface for the GiniVisionCoordinator to dispatch events.

If you use the GiniVisionCoordinator you should implement this interface in your Activity to facilitate the default behavior of the Gini Vision Library.

public interface Listener

Functions

createInstance
Link copied to clipboard

Factory method to create and configure a GiniVisionCoordinator instance.

static GiniVisionCoordinator createInstance(Context context)
onCameraStarted
Link copied to clipboard

Call this method when the CameraFragmentStandard or CameraFragmentCompat has started.

Can be called in your Acitivity's onStart method, which hosts the Camera Fragment.

void onCameraStarted()
setListener
Link copied to clipboard

Listener for handling events from the GiniVisionCoordinator to provide the default behavior.

setShowOnboardingAtFirstRun
Link copied to clipboard

Enable or disable showing the Onboarding Screen once per installation the first time the Camera Screen is started.

Default value is {@code true} .

shouldShowGiniVisionNoResultsScreen
Link copied to clipboard
static boolean shouldShowGiniVisionNoResultsScreen(Document document)