net.gini.android.vision

Class GiniVision.Builder

java.lang.Object

net.gini.android.vision.GiniVision.Builder

Enclosing class:

GiniVision

public static class GiniVision.Builder
extends java.lang.Object

Builder for GiniVision. To get an instance call GiniVision.newInstance().

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
void	build() Create a new GiniVision instance.
GiniVision.Builder	setBackButtonsEnabled(boolean enabled) Screen API only
GiniVision.Builder	setCustomOnboardingPages(java.util.ArrayList onboardingPages) Set custom pages to be shown in the Onboarding Screen.
GiniVision.Builder	setDocumentImportEnabledFileTypes(DocumentImportEnabledFileTypes documentImportEnabledFileTypes) Enable and configure the document import feature or disable it by passing in DocumentImportEnabledFileTypes.NONE.
GiniVision.Builder	setEventTracker(EventTracker eventTracker) Set the EventTracker instance which will be called from the different screens to inform you about the various events which can occur during the usage of the Gini Vision Library.
GiniVision.Builder	setFileImportEnabled(boolean fileImportEnabled) Enable/disable the file import feature.
GiniVision.Builder	setFlashButtonEnabled(boolean enabled) Enable/disable the flash button in the Camera Screen.
GiniVision.Builder	setFlashOnByDefault(boolean flashOn) Set whether the camera flash is on or off by default.
GiniVision.Builder	setGiniVisionNetworkApi(GiniVisionNetworkApi giniVisionNetworkApi) Set the GiniVisionNetworkApi instance which clients can use to request network calls (e.g.
GiniVision.Builder	setGiniVisionNetworkService(GiniVisionNetworkService giniVisionNetworkService) Set the GiniVisionNetworkService instance which will be used by the library to request document related network calls (e.g.
GiniVision.Builder	setMultiPageEnabled(boolean multiPageEnabled) Enable/disable the multi-page feature.
GiniVision.Builder	setQRCodeScanningEnabled(boolean qrCodeScanningEnabled) Enable/disable the QRCode scanning feature.
GiniVision.Builder	setShouldShowOnboarding(boolean shouldShowOnboarding) Screen API only
GiniVision.Builder	setShouldShowOnboardingAtFirstRun(boolean shouldShowOnboardingAtFirstRun) Screen API only
GiniVision.Builder	setSupportedFormatsHelpScreenEnabled(boolean enabled) Enable/disable the Supported Formats help screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public void build()

Create a new GiniVision instance.

setShouldShowOnboardingAtFirstRun

public GiniVision.Builder setShouldShowOnboardingAtFirstRun(boolean shouldShowOnboardingAtFirstRun)

Screen API only

Set to false to disable automatically showing the OnboardingActivity the first time the CameraActivity is launched - we highly recommend letting the Gini Vision Library show the OnboardingActivity at first run.

Default value is true.

Parameters:

shouldShowOnboardingAtFirstRun - whether to show the onboarding on first run or not

Returns:

the GiniVision.Builder instance

setCustomOnboardingPages

public GiniVision.Builder setCustomOnboardingPages(java.util.ArrayList onboardingPages)

Set custom pages to be shown in the Onboarding Screen.

Parameters:

onboardingPages - an ArrayList of OnboardingPages

Returns:

the GiniVision.Builder instance

setShouldShowOnboarding

public GiniVision.Builder 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

Returns:

the GiniVision.Builder instance

setMultiPageEnabled

public GiniVision.Builder setMultiPageEnabled(boolean multiPageEnabled)

Enable/disable the multi-page feature.

Disabled by default.

Parameters:

multiPageEnabled - true to enable multi-page

Returns:

the GiniVision.Builder instance

setGiniVisionNetworkService

public GiniVision.Builder setGiniVisionNetworkService(GiniVisionNetworkService giniVisionNetworkService)

Set the GiniVisionNetworkService instance which will be used by the library to request document related network calls (e.g. upload, analysis or deletion).

Parameters:

giniVisionNetworkService - a GiniVisionNetworkService instance

Returns:

the GiniVision.Builder instance

setGiniVisionNetworkApi

public GiniVision.Builder setGiniVisionNetworkApi(GiniVisionNetworkApi giniVisionNetworkApi)

Set the GiniVisionNetworkApi instance which clients can use to request network calls (e.g. for sending feedback).

Parameters:

giniVisionNetworkApi - a GiniVisionNetworkApi instance

Returns:

the GiniVision.Builder instance

setDocumentImportEnabledFileTypes

public GiniVision.Builder setDocumentImportEnabledFileTypes(DocumentImportEnabledFileTypes documentImportEnabledFileTypes)

Enable and configure the document import feature or disable it by passing in DocumentImportEnabledFileTypes.NONE.

Disabled by default.

Parameters:

documentImportEnabledFileTypes - file types to be enabled for document import

Returns:

the GiniVision.Builder instance

setFileImportEnabled

public GiniVision.Builder setFileImportEnabled(boolean fileImportEnabled)

Enable/disable the file import feature.

Disabled by default.

Parameters:

fileImportEnabled - true to enable file import

Returns:

the GiniVision.Builder instance

setQRCodeScanningEnabled

public GiniVision.Builder setQRCodeScanningEnabled(boolean qrCodeScanningEnabled)

Enable/disable the QRCode scanning feature.

Disabled by default.

Parameters:

qrCodeScanningEnabled - true to enable QRCode scanning

Returns:

the GiniVision.Builder instance

setSupportedFormatsHelpScreenEnabled

public GiniVision.Builder setSupportedFormatsHelpScreenEnabled(boolean enabled)

Enable/disable the Supported Formats help screen.

Enabled by default.

Parameters:

enabled - true to show the Supported Formats help screen

Returns:

the GiniVision.Builder instance

setFlashButtonEnabled

public GiniVision.Builder setFlashButtonEnabled(boolean enabled)

Enable/disable the flash button in the Camera Screen.

Disabled by default.

Parameters:

enabled - true to show the flash button

Returns:

the GiniVision.Builder instance

setBackButtonsEnabled

public GiniVision.Builder setBackButtonsEnabled(boolean enabled)

Screen API only

Enable/disable back buttons in all Activities except ReviewActivity and AnalysisActivity, which always show back buttons.

Enabled by default.

Parameters:

enabled - true to show back buttons

Returns:

the GiniVision.Builder instance

setFlashOnByDefault

public GiniVision.Builder setFlashOnByDefault(boolean flashOn)

Set whether the camera flash is on or off by default.

If not changed, then flash is on by default.

Parameters:

flashOn - true to turn the flash on

Returns:

the GiniVision.Builder instance

setEventTracker

public GiniVision.Builder setEventTracker(EventTracker eventTracker)

Set the EventTracker instance which will be called from the different screens to inform you about the various events which can occur during the usage of the Gini Vision Library.

Parameters:

eventTracker - an EventTracker instance

Returns:

the GiniVision.Builder instance