Gini Bank SDK for Android/net.gini.android.bank.sdk.capture/CaptureConfiguration

CaptureConfiguration

Configuration class for Capture feature.

Constructors

public CaptureConfiguration CaptureConfiguration(GiniCaptureNetworkService networkService, Boolean showOnboardingAtFirstRun, List<OnboardingPage> onboardingPages, Boolean showOnboarding, Boolean multiPageEnabled, DocumentImportEnabledFileTypes documentImportEnabledFileTypes, Boolean fileImportEnabled, Boolean qrCodeScanningEnabled, Boolean onlyQRCodeScanningEnabled, Boolean supportedFormatsHelpScreenEnabled, Boolean flashButtonEnabled, Boolean flashOnByDefault, Boolean returnAssistantEnabled, EventTracker eventTracker, List<HelpItem.Custom> customHelpItems, Boolean giniErrorLoggerIsOn, ErrorLoggerListener errorLoggerListener, Integer importedFileSizeBytesLimit, NavigationBarTopAdapter navigationBarTopAdapter, Boolean bottomNavigationBarEnabled, OnboardingNavigationBarBottomAdapter onboardingNavigationBarBottomAdapter, OnboardingIllustrationAdapter onboardingAlignCornersIllustrationAdapter, OnboardingIllustrationAdapter onboardingLightingIllustrationAdapter, OnboardingIllustrationAdapter onboardingMultiPageIllustrationAdapter, OnboardingIllustrationAdapter onboardingQRCodeIllustrationAdapter, CustomLoadingIndicatorAdapter customLoadingIndicatorAdapter, OnButtonLoadingIndicatorAdapter onButtonLoadingIndicatorAdapter, CameraNavigationBarBottomAdapter cameraNavigationBarBottomAdapter, ReviewNavigationBarBottomAdapter reviewNavigationBarBottomAdapter, HelpNavigationBarBottomAdapter helpNavigationBarBottomAdapter, EntryPoint entryPoint)

Functions

getBottomNavigationBarEnabled

public final Boolean getBottomNavigationBarEnabled()

Enable/disable the bottom navigation bar.

getCameraNavigationBarBottomAdapter

public final CameraNavigationBarBottomAdapter getCameraNavigationBarBottomAdapter()

Set an adapter implementation to show a custom bottom navigation bar on the camera screen.

getCustomHelpItems

public final List<HelpItem.Custom> getCustomHelpItems()

A list of HelpItem.Custom defining the custom help items to be shown in the Help Screen.

getCustomLoadingIndicatorAdapter

public final CustomLoadingIndicatorAdapter getCustomLoadingIndicatorAdapter()

Set an adapter implementation to show a custom loading animation during analyse and scan.

getDocumentImportEnabledFileTypes

public final DocumentImportEnabledFileTypes getDocumentImportEnabledFileTypes()

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

getEntryPoint

public final EntryPoint getEntryPoint()

Set the entry point used for launching the SDK. See EntryPoint for possible values.

getErrorLoggerListener

public final ErrorLoggerListener getErrorLoggerListener()

Set an ErrorLoggerListener to be notified of errors.

getEventTracker

public final EventTracker getEventTracker()

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 Capture feature.

getFileImportEnabled

public final Boolean getFileImportEnabled()

Enable/disable the file import feature.

getFlashButtonEnabled

public final Boolean getFlashButtonEnabled()

Enable/disable the flash button in the Camera Screen.

getFlashOnByDefault

public final Boolean getFlashOnByDefault()

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

getGiniErrorLoggerIsOn

public final Boolean getGiniErrorLoggerIsOn()

Set whether the default Gini error logging implementation is on or not.

getHelpNavigationBarBottomAdapter

public final HelpNavigationBarBottomAdapter getHelpNavigationBarBottomAdapter()

Set an adapter implementation to show a custom bottom navigation bar on the help screen.

getImportedFileSizeBytesLimit

public final Integer getImportedFileSizeBytesLimit()

Set a custom imported file size limit in bytes.

getMultiPageEnabled

public final Boolean getMultiPageEnabled()

Enable/disable the multi-page feature.

getNavigationBarTopAdapter

public final NavigationBarTopAdapter getNavigationBarTopAdapter()

Set an adapter implementation to show a custom top navigation bar.

getNetworkService

public final GiniCaptureNetworkService getNetworkService()

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

getOnboardingAlignCornersIllustrationAdapter

public final OnboardingIllustrationAdapter getOnboardingAlignCornersIllustrationAdapter()

Set an adapter implementation to show a custom illustration on the "align corners" onboarding page.

getOnboardingLightingIllustrationAdapter

public final OnboardingIllustrationAdapter getOnboardingLightingIllustrationAdapter()

Set an adapter implementation to show a custom illustration on the "lighting" onboarding page.

getOnboardingMultiPageIllustrationAdapter

public final OnboardingIllustrationAdapter getOnboardingMultiPageIllustrationAdapter()

Set an adapter implementation to show a custom illustration on the "multi-page" onboarding page.

getOnboardingNavigationBarBottomAdapter

public final OnboardingNavigationBarBottomAdapter getOnboardingNavigationBarBottomAdapter()

Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.

getOnboardingPages

public final List<OnboardingPage> getOnboardingPages()

Set custom pages to be shown in the Onboarding Screen.

getOnboardingQRCodeIllustrationAdapter

public final OnboardingIllustrationAdapter getOnboardingQRCodeIllustrationAdapter()

Set an adapter implementation to show a custom illustration on the "QR code" onboarding page.

getOnButtonLoadingIndicatorAdapter

public final OnButtonLoadingIndicatorAdapter getOnButtonLoadingIndicatorAdapter()

Set an adapter implementation to show a custom loading animation during analyse and scan.

getOnlyQRCodeScanningEnabled

public final Boolean getOnlyQRCodeScanningEnabled()

Enable/disable only the QRCode scanning feature.

getQrCodeScanningEnabled

public final Boolean getQrCodeScanningEnabled()

Enable/disable the QRCode scanning feature.

getReturnAssistantEnabled

public final Boolean getReturnAssistantEnabled()

Enable/disable the return assistant feature.

getReviewNavigationBarBottomAdapter

public final ReviewNavigationBarBottomAdapter getReviewNavigationBarBottomAdapter()

Set an adapter implementation to show a custom bottom navigation bar on the review screen.

getShowOnboarding

public final Boolean getShowOnboarding()

Screen API only

getShowOnboardingAtFirstRun

public final Boolean getShowOnboardingAtFirstRun()

Screen API only

getSupportedFormatsHelpScreenEnabled

public final Boolean getSupportedFormatsHelpScreenEnabled()

Enable/disable the Supported Formats help screen.

Properties

bottomNavigationBarEnabled

private final Boolean bottomNavigationBarEnabled

Enable/disable the bottom navigation bar.

cameraNavigationBarBottomAdapter

private final CameraNavigationBarBottomAdapter cameraNavigationBarBottomAdapter

Set an adapter implementation to show a custom bottom navigation bar on the camera screen.

customHelpItems

private final List<HelpItem.Custom> customHelpItems

A list of HelpItem.Custom defining the custom help items to be shown in the Help Screen.

customLoadingIndicatorAdapter

private final CustomLoadingIndicatorAdapter customLoadingIndicatorAdapter

Set an adapter implementation to show a custom loading animation during analyse and scan.

documentImportEnabledFileTypes

private final DocumentImportEnabledFileTypes documentImportEnabledFileTypes

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

entryPoint

private final EntryPoint entryPoint

Set the entry point used for launching the SDK. See EntryPoint for possible values.

errorLoggerListener

private final ErrorLoggerListener errorLoggerListener

Set an ErrorLoggerListener to be notified of errors.

eventTracker

private final EventTracker eventTracker

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 Capture feature.

fileImportEnabled

private final Boolean fileImportEnabled

Enable/disable the file import feature.

flashButtonEnabled

private final Boolean flashButtonEnabled

Enable/disable the flash button in the Camera Screen.

flashOnByDefault

private final Boolean flashOnByDefault

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

giniErrorLoggerIsOn

private final Boolean giniErrorLoggerIsOn

Set whether the default Gini error logging implementation is on or not.

helpNavigationBarBottomAdapter

private final HelpNavigationBarBottomAdapter helpNavigationBarBottomAdapter

Set an adapter implementation to show a custom bottom navigation bar on the help screen.

importedFileSizeBytesLimit

private final Integer importedFileSizeBytesLimit

Set a custom imported file size limit in bytes.

multiPageEnabled

private final Boolean multiPageEnabled

Enable/disable the multi-page feature.

navigationBarTopAdapter

private final NavigationBarTopAdapter navigationBarTopAdapter

Set an adapter implementation to show a custom top navigation bar.

networkService

private final GiniCaptureNetworkService networkService

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

onboardingAlignCornersIllustrationAdapter

private final OnboardingIllustrationAdapter onboardingAlignCornersIllustrationAdapter

Set an adapter implementation to show a custom illustration on the "align corners" onboarding page.

onboardingLightingIllustrationAdapter

private final OnboardingIllustrationAdapter onboardingLightingIllustrationAdapter

Set an adapter implementation to show a custom illustration on the "lighting" onboarding page.

onboardingMultiPageIllustrationAdapter

private final OnboardingIllustrationAdapter onboardingMultiPageIllustrationAdapter

Set an adapter implementation to show a custom illustration on the "multi-page" onboarding page.

onboardingNavigationBarBottomAdapter

private final OnboardingNavigationBarBottomAdapter onboardingNavigationBarBottomAdapter

Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.

onboardingPages

private final List<OnboardingPage> onboardingPages

Set custom pages to be shown in the Onboarding Screen.

onboardingQRCodeIllustrationAdapter

private final OnboardingIllustrationAdapter onboardingQRCodeIllustrationAdapter

Set an adapter implementation to show a custom illustration on the "QR code" onboarding page.

onButtonLoadingIndicatorAdapter

private final OnButtonLoadingIndicatorAdapter onButtonLoadingIndicatorAdapter

Set an adapter implementation to show a custom loading animation during analyse and scan.

onlyQRCodeScanningEnabled

private final Boolean onlyQRCodeScanningEnabled

Enable/disable only the QRCode scanning feature.

qrCodeScanningEnabled

private final Boolean qrCodeScanningEnabled

Enable/disable the QRCode scanning feature.

returnAssistantEnabled

private final Boolean returnAssistantEnabled

Enable/disable the return assistant feature.

reviewNavigationBarBottomAdapter

private final ReviewNavigationBarBottomAdapter reviewNavigationBarBottomAdapter

Set an adapter implementation to show a custom bottom navigation bar on the review screen.

showOnboarding

private final Boolean showOnboarding

Screen API only

showOnboardingAtFirstRun

private final Boolean showOnboardingAtFirstRun

Screen API only

supportedFormatsHelpScreenEnabled

private final Boolean supportedFormatsHelpScreenEnabled

Enable/disable the Supported Formats help screen.