ginivision/net.gini.android.vision/GiniVision/Builder

Builder

Builder for GiniVision . To get an instance call newInstance .

public class Builder
Content copied to clipboard

Functions

areBackButtonsEnabled
Link copied to clipboard
boolean areBackButtonsEnabled()
Content copied to clipboard
build
Link copied to clipboard

Create a new GiniVision instance.

void build()
Content copied to clipboard
getDocumentImportEnabledFileTypes
Link copied to clipboard
@NonNull()
DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()
Content copied to clipboard
getEventTracker
Link copied to clipboard
EventTracker getEventTracker()
Content copied to clipboard
getGiniVisionNetworkApi
Link copied to clipboard
@Nullable()
GiniVisionNetworkApi getGiniVisionNetworkApi()
Content copied to clipboard
getGiniVisionNetworkService
Link copied to clipboard
@Nullable()
GiniVisionNetworkService getGiniVisionNetworkService()
Content copied to clipboard
getOnboardingPages
Link copied to clipboard
@Nullable()
ArrayList<OnboardingPage> getOnboardingPages()
Content copied to clipboard
isFileImportEnabled
Link copied to clipboard
boolean isFileImportEnabled()
Content copied to clipboard
isFlashButtonEnabled
Link copied to clipboard
boolean isFlashButtonEnabled()
Content copied to clipboard
isFlashOnByDefault
Link copied to clipboard
boolean isFlashOnByDefault()
Content copied to clipboard
isMultiPageEnabled
Link copied to clipboard
boolean isMultiPageEnabled()
Content copied to clipboard
isQRCodeScanningEnabled
Link copied to clipboard
boolean isQRCodeScanningEnabled()
Content copied to clipboard
isSupportedFormatsHelpScreenEnabled
Link copied to clipboard
boolean isSupportedFormatsHelpScreenEnabled()
Content copied to clipboard
setBackButtonsEnabled
Link copied to clipboard

Screen API only

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

Enabled by default.

GiniVision.Builder setBackButtonsEnabled(boolean enabled)
Content copied to clipboard
setCustomOnboardingPages
Link copied to clipboard

Set custom pages to be shown in the Onboarding Screen.

@NonNull()
GiniVision.Builder setCustomOnboardingPages(ArrayList<OnboardingPage> onboardingPages)
Content copied to clipboard
setDocumentImportEnabledFileTypes
Link copied to clipboard

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

Disabled by default.

@NonNull()
GiniVision.Builder setDocumentImportEnabledFileTypes(DocumentImportEnabledFileTypes documentImportEnabledFileTypes)
Content copied to clipboard
setEventTracker
Link copied to clipboard

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 setEventTracker(EventTracker eventTracker)
Content copied to clipboard
setFileImportEnabled
Link copied to clipboard

Enable/disable the file import feature.

Disabled by default.

@NonNull()
GiniVision.Builder setFileImportEnabled(boolean fileImportEnabled)
Content copied to clipboard
setFlashButtonEnabled
Link copied to clipboard

Enable/disable the flash button in the Camera Screen.

Disabled by default.

GiniVision.Builder setFlashButtonEnabled(boolean enabled)
Content copied to clipboard
setFlashOnByDefault
Link copied to clipboard

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

If not changed, then flash is on by default.

GiniVision.Builder setFlashOnByDefault(boolean flashOn)
Content copied to clipboard
setGiniVisionNetworkApi
Link copied to clipboard

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

@NonNull()
GiniVision.Builder setGiniVisionNetworkApi(GiniVisionNetworkApi giniVisionNetworkApi)
Content copied to clipboard
setGiniVisionNetworkService
Link copied to clipboard

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

@NonNull()
GiniVision.Builder setGiniVisionNetworkService(GiniVisionNetworkService giniVisionNetworkService)
Content copied to clipboard
setMultiPageEnabled
Link copied to clipboard

Enable/disable the multi-page feature.

Disabled by default.

GiniVision.Builder setMultiPageEnabled(boolean multiPageEnabled)
Content copied to clipboard
setQRCodeScanningEnabled
Link copied to clipboard

Enable/disable the QRCode scanning feature.

Disabled by default.

@NonNull()
GiniVision.Builder setQRCodeScanningEnabled(boolean qrCodeScanningEnabled)
Content copied to clipboard
setShouldShowOnboarding
Link copied to clipboard

Screen API only

Set to {@code true} to show the Onboarding Screen every time the CameraActivity starts.

Default value is {@code false} .

@NonNull()
GiniVision.Builder setShouldShowOnboarding(boolean shouldShowOnboarding)
Content copied to clipboard
setShouldShowOnboardingAtFirstRun
Link copied to clipboard

Screen API only

Set to {@code 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 {@code true} .

@NonNull()
GiniVision.Builder setShouldShowOnboardingAtFirstRun(boolean shouldShowOnboardingAtFirstRun)
Content copied to clipboard
setSupportedFormatsHelpScreenEnabled
Link copied to clipboard

Enable/disable the Supported Formats help screen.

Enabled by default.

GiniVision.Builder setSupportedFormatsHelpScreenEnabled(boolean enabled)
Content copied to clipboard
shouldShowOnboarding
Link copied to clipboard
boolean shouldShowOnboarding()
Content copied to clipboard
shouldShowOnboardingAtFirstRun
Link copied to clipboard
boolean shouldShowOnboardingAtFirstRun()
Content copied to clipboard
© 2020 CopyrightSponsored and developed by dokka