GiniVision (Gini Vision Library for Android)

java.lang.Object
- net.gini.android.vision.GiniVision

```
public class GiniVision
extends java.lang.Object
```
Single entry point for the Gini Vision Library for configuration and interaction.
This singleton class is preferred over the previous methods of configuration and interaction. It is only mandatory for new features. You can continue using features from previous releases without any modification.
To create and configure a singleton instance use the GiniVision.newInstance() method and the returned GiniVision.Builder. If an instance is already available you need to call GiniVision.cleanup(Context) before creating a new instance. Failing to do so will throw an exception.
After you are done using the Gini Vision Library use the GiniVision.cleanup(Context) method. This will free up resources used by the library.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GiniVision.Builder
Builder for GiniVision.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GiniVision.Builder` Builder for `GiniVision`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`areBackButtonsEnabled()` Screen API only
`static void`	`cleanup(Context context)` Destroys the `GiniVision` instance and frees up used resources.
`static Document`	`createDocumentForImportedFile(Intent intent, Context context)` Component API
`CancellationToken`	`createDocumentForImportedFiles(Intent intent, Context context, AsyncCallback callback)` Component API
`static Intent`	`createIntentForImportedFile(Intent intent, Context context, java.lang.Class reviewActivityClass, java.lang.Class analysisActivityClass)` Screen API
`CancellationToken`	`createIntentForImportedFiles(Intent intent, Context context, AsyncCallback callback)` Screen API
`java.util.ArrayList`	`getCustomOnboardingPages()` The custom Onboarding Screen pages, if configured.
`DocumentImportEnabledFileTypes`	`getDocumentImportEnabledFileTypes()` Retrieve the file types enabled for document import.
`GiniVisionNetworkApi`	`getGiniVisionNetworkApi()` Retrieve the `GiniVisionNetworkApi` instance, if available.
`static GiniVision`	`getInstance()` Retrieve the current instance.
`static boolean`	`hasInstance()` Check whether an instance exists.
`boolean`	`isFileImportEnabled()` Find out whether file import has been enabled.
`boolean`	`isFlashButtonEnabled()` Find out whether the flash button on the Camera Screen has been enabled.
`boolean`	`isFlashOnByDefault()` Find out whether the camera flash is on or off by default.
`boolean`	`isMultiPageEnabled()` Find out whether scanning multi-page documents has been enabled.
`boolean`	`isQRCodeScanningEnabled()` Find out whether QRCode scanning has been enabled.
`boolean`	`isSupportedFormatsHelpScreenEnabled()` Find out whether the Supported Formats help screen has been enabled.
`static GiniVision.Builder`	`newInstance()` Configure and create a new instance using the returned `GiniVision.Builder`.
`void`	`setShouldShowOnboarding(boolean shouldShowOnboarding)` Screen API only
`boolean`	`shouldShowOnboarding()` Screen API only
`boolean`	`shouldShowOnboardingAtFirstRun()` Screen API only

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static GiniVision getInstance()
```
    Retrieve the current instance.
    
    Returns:
    
    GiniVision instance
    
    Throws:
    
    java.lang.IllegalStateException - when there is no instance
  - hasInstance
```
public static boolean hasInstance()
```
    Check whether an instance exists.
    
    Returns:
    
    true if there is an instance
  - newInstance
```
public static GiniVision.Builder newInstance()
```
    Configure and create a new instance using the returned GiniVision.Builder.
    
    Returns:
    
    a new GiniVision.Builder
    
    Throws:
    
    java.lang.IllegalStateException - when an instance already exists. Call GiniVision.cleanup(Context) before trying to create a new instance
  - cleanup
```
public static void cleanup(Context context)
```
    Destroys the GiniVision instance and frees up used resources.
    
    Parameters:
    
    context - Android context
  - getGiniVisionNetworkApi
```
public GiniVisionNetworkApi getGiniVisionNetworkApi()
```
    Retrieve the GiniVisionNetworkApi instance, if available.
    
    Returns:
    
    GiniVisionNetworkApi instance or null
  - getDocumentImportEnabledFileTypes
```
public DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()
```
    Retrieve the file types enabled for document import.
    Disabled by default.
    
    Returns:
    
    enabled file types
  - isFileImportEnabled
```
public boolean isFileImportEnabled()
```
    Find out whether file import has been enabled.
    Disabled by default.
    
    Returns:
    
    true if file import was enabled
  - isQRCodeScanningEnabled
```
public boolean isQRCodeScanningEnabled()
```
    Find out whether QRCode scanning has been enabled.
    Disabled by default.
    
    Returns:
    
    true if QRCode scanning was enabled
  - isMultiPageEnabled
```
public boolean isMultiPageEnabled()
```
    Find out whether scanning multi-page documents has been enabled.
    Disabled by default
    
    Returns:
    
    true if multi-page is enabled
  - getCustomOnboardingPages
```
public java.util.ArrayList getCustomOnboardingPages()
```
    The custom Onboarding Screen pages, if configured.
    
    Returns:
    
    list of OnboardingPages
  - shouldShowOnboardingAtFirstRun
```
public boolean shouldShowOnboardingAtFirstRun()
```
    Screen API only
    If set to false, the Onboarding Screen won't be shown on the first run.
    
    Returns:
    
    whether to show the Onboarding Screen or not
  - shouldShowOnboarding
```
public boolean shouldShowOnboarding()
```
    Screen API only
    If set to true, the Onboarding Screen will be shown every every time the CameraActivity starts.
    Default value is false.
    You can change it on the existing GiniVision instance with GiniVision.setShouldShowOnboarding(boolean).
    
    Returns:
    
    whether to show the Onboarding Screen or not
  - setShouldShowOnboarding
```
public void setShouldShowOnboarding(boolean shouldShowOnboarding)
```
    Screen API only
    Set to true to show the Onboarding Screen every time the CameraActivity starts.
    Default value is false.
    
    Parameters:
    
    shouldShowOnboarding - whether to show the onboarding on every launch
  - isSupportedFormatsHelpScreenEnabled
```
public boolean isSupportedFormatsHelpScreenEnabled()
```
    Find out whether the Supported Formats help screen has been enabled.
    Enabled by default.
    
    Returns:
    
    true if the Supported Formats help screen was enabled
  - isFlashButtonEnabled
```
public boolean isFlashButtonEnabled()
```
    Find out whether the flash button on the Camera Screen has been enabled.
    Disabled by default.
    
    Returns:
    
    true if the flash button was enabled
  - areBackButtonsEnabled
```
public boolean areBackButtonsEnabled()
```
    Screen API only
    Find out whether back buttons in all Activities have been enabled. ReviewActivity and AnalysisActivity are not affected and always show back buttons.
    Enabled by default.
    
    Returns:
    
    true if the back buttons were enabled
  - isFlashOnByDefault
```
public boolean isFlashOnByDefault()
```
    Find out whether the camera flash is on or off by default.
    If not changed, then flash is on by default.
    
    Returns:
    
    true if the flash is on by default
  - createIntentForImportedFiles
```
public CancellationToken createIntentForImportedFiles(Intent intent,
                                                      Context context,
                                                      AsyncCallback callback)
```
    Screen API
    If you have enabled the multi-page feature and your application receives one or multiple files from another application you can use this method to create an Intent for launching the Gini Vision Library.
    Importing the files is executed on a secondary thread as it can take several seconds for the process to complete. The callback methods are invoked on the main thread.
    In your callback's onSuccess(Intent) method start the Intent with android.app.Activity#startActivityForResult(Intent, int) to receive the extractions or a GiniVisionError in case there was an error.
    
    Parameters:
    
    intent - the Intent your app received
    
    context - Android context
    
    callback - A AsyncCallback implementation
    
    Returns:
    
    a CancellationToken for cancelling the import process
  - createDocumentForImportedFiles
```
public CancellationToken createDocumentForImportedFiles(Intent intent,
                                                        Context context,
                                                        AsyncCallback callback)
```
    Component API
    If you have enabled the multi-page feature and your application receives one or multiple files from another application you can use this method to create a Document for launching the Gini Vision Library's MultiPageReviewFragment or one of the Analysis Fragments.
    Importing the files is executed on a secondary thread as it can take several seconds for the process to complete. The callback methods are invoked on the main thread.
    If the Document can be reviewed (Document.isReviewable()) launch the MultiPageReviewFragment.
    If the Document cannot be reviewed you must launch one of the Analysis Fragments (AnalysisFragmentCompat or AnalysisFragmentStandard).
    
    Parameters:
    
    intent - the Intent your app received
    
    context - Android context
    
    callback - A AsyncCallback implementation
    
    Returns:
    
    a CancellationToken for cancelling the import process
  - createIntentForImportedFile
```
public static Intent createIntentForImportedFile(Intent intent,
                                                 Context context,
                                                 java.lang.Class reviewActivityClass,
                                                 java.lang.Class analysisActivityClass)
                                          throws ImportedFileValidationException
```
    Screen API
    When your application receives a file from another application you can use this method to create an Intent for launching the Gini Vision Library.
    Start the Intent with android.app.Activity#startActivityForResult(Intent, int) to receive the extractions or a GiniVisionError in case there was an error.
    
    Parameters:
    
    intent - the Intent your app received
    
    context - Android context
    
    reviewActivityClass - (optional) the class of your application's ReviewActivity subclass
    
    analysisActivityClass - (optional) the class of your application's AnalysisActivity subclass
    
    Returns:
    
    an Intent for launching the Gini Vision Library
    
    Throws:
    
    ImportedFileValidationException - if the file didn't pass validation
    
    java.lang.IllegalArgumentException - if the Intent's data is not valid or the mime type is not supported
  - createDocumentForImportedFile
```
public static Document createDocumentForImportedFile(Intent intent,
                                                     Context context)
                                              throws ImportedFileValidationException
```
    Component API
    When your application receives a file from another application you can use this method to create a Document for launching one of the Gini Vision Library's Review Fragments or Analysis Fragments.
    If the Document can be reviewed (Document.isReviewable()) launch one of the Review Fragments (ReviewFragmentCompat or ReviewFragmentStandard).
    If the Document cannot be reviewed you must launch one of the Analysis Fragments (AnalysisFragmentCompat or AnalysisFragmentStandard).
    
    Parameters:
    
    intent - the Intent your app received
    
    context - Android context
    
    Returns:
    
    a Document for launching one of the Gini Vision Library's Review Fragments or Analysis Fragments
    
    Throws:
    
    ImportedFileValidationException - if the file didn't pass validation

Class GiniVision

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

hasInstance

newInstance

cleanup

getGiniVisionNetworkApi

getDocumentImportEnabledFileTypes

isFileImportEnabled

isQRCodeScanningEnabled

isMultiPageEnabled

getCustomOnboardingPages

shouldShowOnboardingAtFirstRun

shouldShowOnboarding

setShouldShowOnboarding

isSupportedFormatsHelpScreenEnabled

isFlashButtonEnabled

areBackButtonsEnabled

isFlashOnByDefault

createIntentForImportedFiles

createDocumentForImportedFiles

createIntentForImportedFile

createDocumentForImportedFile