Gini Capture SDK for Android/net.gini.android.capture/GiniCapture/Builder

Builder

public class Builder

Builder for GiniCapture. To get an instance call newInstance.

Functions

Link copied to clipboard
public void build()
Create a new GiniCapture instance.
Link copied to clipboard
Link copied to clipboard
public GiniCapture.Builder setBottomNavigationBarEnabled(Boolean enabled)
Enable/disable the bottom navigation bar.
Link copied to clipboard
public GiniCapture.Builder setCameraNavigationBarBottomAdapter(@NonNull() CameraNavigationBarBottomAdapter adapter)
Set an adapter implementation to show a custom bottom navigation bar on the camera screen.
Link copied to clipboard
public GiniCapture.Builder setCustomErrorLoggerListener(@NonNull() ErrorLoggerListener listener)
Set an ErrorLoggerListener to be notified of Gini Capture SDK errors.
Link copied to clipboard
public GiniCapture.Builder setCustomHelpItems(@NonNull() List<HelpItem.Custom> customHelpItems)
Set custom help items to be shown in the Help Screen.
Link copied to clipboard
@NonNull()
public GiniCapture.Builder setCustomOnboardingPages(@NonNull() ArrayList<OnboardingPage> onboardingPages)
Set custom pages to be shown in the Onboarding Screen.
Link copied to clipboard
@NonNull()
public GiniCapture.Builder setDocumentImportEnabledFileTypes(@NonNull() DocumentImportEnabledFileTypes documentImportEnabledFileTypes)
Enable and configure the document import feature or disable it by passing in NONE.
Link copied to clipboard
public GiniCapture.Builder setEntryPoint(@NonNull() EntryPoint entryPoint)
Set the entry point used for launching the SDK.
Link copied to clipboard
public GiniCapture.Builder setEventTracker(@NonNull() 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 Capture SDK.
Link copied to clipboard
@NonNull()
public GiniCapture.Builder setFileImportEnabled(boolean fileImportEnabled)
Enable/disable the file import feature.
Link copied to clipboard
public GiniCapture.Builder setFlashButtonEnabled(boolean enabled)
Enable/disable the flash button in the Camera Screen.
Link copied to clipboard
public GiniCapture.Builder setFlashOnByDefault(boolean flashOn)
Set whether the camera flash is on or off by default.
Link copied to clipboard
@NonNull()
public GiniCapture.Builder setGiniCaptureNetworkService(@NonNull() GiniCaptureNetworkService giniCaptureNetworkService)
Set the GiniCaptureNetworkService instance which will be used by the library to request document related network calls (e.g.
Link copied to clipboard
public GiniCapture.Builder setGiniErrorLoggerIsOn(boolean isOn)
Set whether the default Gini error logging implementation is on or not.
Link copied to clipboard
public GiniCapture.Builder setHelpNavigationBarBottomAdapter(@NonNull() HelpNavigationBarBottomAdapter adapter)
Set an adapter implementation to show a custom bottom navigation bar on the help screen.
Link copied to clipboard
public GiniCapture.Builder setImportedFileSizeBytesLimit(int fileSizeBytesLimit)
Set a custom imported file size limit in bytes.
Link copied to clipboard
public GiniCapture.Builder setLoadingIndicatorAdapter(@NonNull() CustomLoadingIndicatorAdapter adapter)
Set an adapter implementation to show a custom loading indicator.
Link copied to clipboard
public GiniCapture.Builder setMultiPageEnabled(boolean multiPageEnabled)
Enable/disable the multi-page feature.
Link copied to clipboard
public GiniCapture.Builder setNavigationBarTopAdapter(@NonNull() NavigationBarTopAdapter adapter)
Set an adapter implementation to show a custom top navigation bar.
public GiniCapture.Builder setOnboardingAlignCornersIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)
Set an adapter implementation to show a custom illustration on the "align corners" onboarding page.
Link copied to clipboard
public GiniCapture.Builder setOnboardingLightingIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)
Set an adapter implementation to show a custom illustration on the "lighting" onboarding page.
public GiniCapture.Builder setOnboardingMultiPageIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)
Set an adapter implementation to show a custom illustration on the "multi-page" onboarding page.
Link copied to clipboard
public GiniCapture.Builder setOnboardingNavigationBarBottomAdapter(@NonNull() OnboardingNavigationBarBottomAdapter adapter)
Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.
Link copied to clipboard
public GiniCapture.Builder setOnboardingQRCodeIllustrationAdapter(@NonNull() OnboardingIllustrationAdapter adapter)
Set an adapter implementation to show a custom illustration on the "QR code" onboarding page.
Link copied to clipboard
Link copied to clipboard
public GiniCapture.Builder setOnlyQRCodeScanning(boolean onlyQRCodeScanningEnabled)
Enable/disable only the QRCode scanning feature.
Link copied to clipboard
@NonNull()
public GiniCapture.Builder setQRCodeScanningEnabled(boolean qrCodeScanningEnabled)
Enable/disable the QRCode scanning feature.
Link copied to clipboard
public GiniCapture.Builder setReviewBottomBarNavigationAdapter(@NonNull() ReviewNavigationBarBottomAdapter adapter)
Set an adapter implementation to show a custom bottom navigation bar on the review screen.
Link copied to clipboard
@NonNull()
public GiniCapture.Builder setShouldShowOnboarding(boolean shouldShowOnboarding)
Screen API only Set to true to show the Onboarding Screen every time the CameraActivity starts.
Link copied to clipboard
@NonNull()
public GiniCapture.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 Capture SDK show the OnboardingActivity at first run.
Link copied to clipboard
public GiniCapture.Builder setSupportedFormatsHelpScreenEnabled(boolean enabled)
Enable/disable the Supported Formats help screen.