Constructor Detail

Method Detail

• build

   void build()

  Create a new GiniCapture instance.

• setShouldShowOnboardingAtFirstRun

  @NonNull() 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.

  Default value is true.

  Parameters:

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

• setCustomOnboardingPages

  @NonNull() GiniCapture.Builder setCustomOnboardingPages(@NonNull() ArrayList<OnboardingPage> onboardingPages)

  Set custom pages to be shown in the Onboarding Screen.

  Parameters:

  onboardingPages - an ArrayList of OnboardingPages

• setShouldShowOnboarding

  @NonNull() GiniCapture.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

• setMultiPageEnabled

   GiniCapture.Builder setMultiPageEnabled(boolean multiPageEnabled)

  Enable/disable the multi-page feature.

  Disabled by default.

  Parameters:

  multiPageEnabled - true to enable multi-page

• setGiniCaptureNetworkService

  @NonNull() 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. upload, analysis or deletion).

  Parameters:

  giniCaptureNetworkService - a GiniCaptureNetworkService instance

• setGiniCaptureNetworkApi

  @NonNull() GiniCapture.Builder setGiniCaptureNetworkApi(@NonNull() GiniCaptureNetworkApi giniCaptureNetworkApi)

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

  Parameters:

  giniCaptureNetworkApi - a GiniCaptureNetworkApi instance

• setDocumentImportEnabledFileTypes

  @NonNull() GiniCapture.Builder setDocumentImportEnabledFileTypes(@NonNull() DocumentImportEnabledFileTypes documentImportEnabledFileTypes)

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

  Disabled by default.

  Parameters:

  documentImportEnabledFileTypes - file types to be enabled for document import

• setFileImportEnabled

  @NonNull() GiniCapture.Builder setFileImportEnabled(boolean fileImportEnabled)

  Enable/disable the file import feature.

  Disabled by default.

  Parameters:

  fileImportEnabled - true to enable file import

• setQRCodeScanningEnabled

  @NonNull() GiniCapture.Builder setQRCodeScanningEnabled(boolean qrCodeScanningEnabled)

  Enable/disable the QRCode scanning feature.

  Disabled by default.

  Parameters:

  qrCodeScanningEnabled - true to enable QRCode scanning

• setSupportedFormatsHelpScreenEnabled

   GiniCapture.Builder setSupportedFormatsHelpScreenEnabled(boolean enabled)

  Enable/disable the Supported Formats help screen.

  Enabled by default.

  Parameters:

  enabled - true to show the Supported Formats help screen

• setFlashButtonEnabled

   GiniCapture.Builder setFlashButtonEnabled(boolean enabled)

  Enable/disable the flash button in the Camera Screen.

  Disabled by default.

  Parameters:

  enabled - true to show the flash button

• setBackButtonsEnabled

   GiniCapture.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

• setFlashOnByDefault

   GiniCapture.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

• setEventTracker

   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.

  Parameters:

  eventTracker - an EventTracker instance

• setCustomHelpItems

   GiniCapture.Builder setCustomHelpItems(@NonNull() List<HelpItem.Custom> customHelpItems)

  Set custom help items to be shown in the Help Screen.

  Parameters:

  customHelpItems - an List of HelpItem.Custom objects

• setGiniErrorLoggerIsOn

   GiniCapture.Builder setGiniErrorLoggerIsOn(boolean isOn)

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

  On by default.

  Parameters:

  isOn - pass true to turn on the error logger or false otherwise.

• setCustomErrorLoggerListener

   GiniCapture.Builder setCustomErrorLoggerListener(@NonNull() ErrorLoggerListener listener)

  Set an ErrorLoggerListener to be notified of Gini Capture SDK errors.

  Parameters:

  listener - your ErrorLoggerListener implementation

• setImportedFileSizeBytesLimit

   GiniCapture.Builder setImportedFileSizeBytesLimit(int fileSizeBytesLimit)

  Set a custom imported file size limit in bytes.

  Parameters:

  fileSizeBytesLimit - file size limit in bytes

• getImportedFileSizeBytesLimit

   int getImportedFileSizeBytesLimit()