Gini Vision
public class GiniVision
Content copied to clipboard
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 newInstance method and the returned Builder. If an instance is already available you need to call cleanup before creating a new instance. Failing to do so will throw an exception.
After you are done using the Gini Vision Library use the cleanup method. This will free up resources used by the library.
Types
Builder
Link copied to clipboard
public class Builder
Content copied to clipboard
Builder for GiniVision.
Functions
are Back Buttons Enabled
Link copied to clipboard
boolean areBackButtonsEnabled()
Content copied to clipboard
Screen API only Find out whether back buttons in all Activities have been enabled.
cleanup
Link copied to clipboard
Destroys the GiniVision instance and frees up used resources.
create Document For Imported File
Link copied to clipboard
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.
create Document For Imported Files
Link copied to clipboard
@NonNull()
Content copied to clipboard
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.
create Intent For Imported File
Link copied to clipboard
@NonNull()
Content copied to clipboard
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.
create Intent For Imported Files
Link copied to clipboard
@NonNull()
Content copied to clipboard
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.
get Custom Onboarding Pages
Link copied to clipboard
The custom Onboarding Screen pages, if configured.
get Document Import Enabled File Types
Link copied to clipboard
@NonNull()
Content copied to clipboard
Retrieve the file types enabled for document import.
get Gini Vision Network Api
Link copied to clipboard
Retrieve the GiniVisionNetworkApi instance, if available.
get Instance
Link copied to clipboard
Retrieve the current instance.
has Instance
Link copied to clipboard
static synchronized boolean hasInstance()
Content copied to clipboard
Check whether an instance exists.
internal
Link copied to clipboard
Internal use only.
is File Import Enabled
Link copied to clipboard
boolean isFileImportEnabled()
Content copied to clipboard
Find out whether file import has been enabled.
is Flash Button Enabled
Link copied to clipboard
boolean isFlashButtonEnabled()
Content copied to clipboard
Find out whether the flash button on the Camera Screen has been enabled.
is Flash On By Default
Link copied to clipboard
boolean isFlashOnByDefault()
Content copied to clipboard
Find out whether the camera flash is on or off by default.
is Multi Page Enabled
Link copied to clipboard
boolean isMultiPageEnabled()
Content copied to clipboard
Find out whether scanning multi-page documents has been enabled.
is QRCode Scanning Enabled
Link copied to clipboard
boolean isQRCodeScanningEnabled()
Content copied to clipboard
Find out whether QRCode scanning has been enabled.
is Supported Formats Help Screen Enabled
Link copied to clipboard
boolean isSupportedFormatsHelpScreenEnabled()
Content copied to clipboard
Find out whether the Supported Formats help screen has been enabled.
new Instance
Link copied to clipboard
Configure and create a new instance using the returned Builder.
set Should Show Onboarding
Link copied to clipboard
void setShouldShowOnboarding(boolean shouldShowOnboarding)
Content copied to clipboard
Screen API only Set to
true
to show the Onboarding Screen every time the CameraActivity starts.should Show Onboarding
Link copied to clipboard
boolean shouldShowOnboarding()
Content copied to clipboard
Screen API only If set to
true
, the Onboarding Screen will be shown every every time the CameraActivity starts.should Show Onboarding At First Run
Link copied to clipboard
boolean shouldShowOnboardingAtFirstRun()
Content copied to clipboard
Screen API only If set to
false
, the Onboarding Screen won't be shown on the first run.