/
Configuration

Configuration

Owned by Bart Gosiewski
Oct 01, 2024
5 min read

Gini Capture SDK provides various features you can enable. All of them are configured through GiniConfiguration.shared instance. Specifically, the GiniConfiguration is used to configure Gini Capture SDK. For Gini Capture SDK used GiniConfiguration.shared() singleton.

public final class GiniBankConfiguration : NSObject

Makes configuration internally accessible in all classes of Gini Capture SDK.

public static var shared: GiniConfiguration

Indicates whether the Return Assistant feature is enabled or not. In case of true, the user will be presented with a digital representation of their invoice where they can see individual line items and are able to amend them or choose to not to pay for them.

@objc public var returnAssistantEnabled: Bool

General options

Sets custom validations that can be done apart from the default ones (file size, file type…). It should throw a CustomDocumentValidationError error.

@objc public var customDocumentValidations: ((GiniCaptureDocument) -> CustomDocumentValidationResult)

Can be turned on during development to unlock extra information and to save captured images to the camera roll.

Should never be used outside of a development enviroment.

@objc public var debugModeOn: Bool

Used to handle all the logging messages in order to log them in a different way.

@objc public var logger: GiniLogger

Indicates whether the multipage feature is enabled or not. In the case of true, multiple pages can be processed, showing a different review screen when capturing.

@objc public var multipageEnabled: Bool

Sets the custom navigation view controller as a root view controller for Gini Bank SDK screens.

@objc public var customNavigationController: UINavigationController?

Sets the tint color of the UIDocumentPickerViewController navigation bar.

Use only if you have a custom UIAppearance for your UINavigationBar.

@objc public var documentPickerNavigationBarTintColor: UIColor?

Sets the background color of an informal notice. Notices are small pieces of information appearing underneath the navigation bar.

@objc public var noticeInformationBackgroundColor: UIColor

Sets the text color of an informal notice. Notices are small pieces of information appearing underneath the navigation bar.

@objc public var noticeInformationTextColor: UIColor

Sets the background color of an error notice. Notices are small pieces of information appearing underneath the navigation bar.

@objc public var noticeErrorBackgroundColor: UIColor

Sets the text color of an error notice. Notices are small pieces of information appearing underneath the navigation bar.

@objc public var noticeErrorTextColor: UIColor

Indicates whether the Open with feature is enabled or not. In case of true, a new option with the open with tutorial wil be shown in the Help menu.

@objc public var openWithEnabled: Bool

Indicates whether the QR Code scanning feature is enabled or not.

@objc public var qrCodeScanningEnabled: Bool

Indicates whether only the QR Code scanning feature is enabled or not.

@objc public var onlyQRCodeScanningEnabled: Bool

Indicates the status bar style in Gini Bank SDK.

@objc public var statusBarStyle: UIStatusBarStyle

Button configuration options

public lazy var primaryButtonConfiguration: ButtonConfiguration { get set }
public lazy var secondaryButtonConfiguration: ButtonConfiguration { get set }
public lazy var transparentButtonConfiguration: ButtonConfiguration { get set }
public lazy var cameraControlButtonConfiguration: ButtonConfiguration { get set }
public lazy var addPageButtonConfiguration: ButtonConfiguration { get set }

Camera options

Set the types supported by the file import feature. GiniCaptureImportFileTypes.none by default.

@objc public var fileImportSupportedTypes: GiniCaptureImportFileTypes

Indicates whether the flash toggle should be shown on the camera screen.

@objc public var flashToggleEnabled: Bool

When the flash toggle is enabled, this flag indicates if the flash is on by default.

@objc public var flashOnByDefault: Bool

Sets the close button text in the navigation bar on the camera screen.

@objc public var navigationBarCameraTitleCloseButton: String

Sets the help button text in the navigation bar on the camera screen.

@objc public var navigationBarCameraTitleHelpButton: String

Onboarding screens

Sets the continue button text in the navigation bar on the onboarding screen.

@objc public var navigationBarOnboardingTitleContinueButton: String

Sets the back button text in the navigation bar on the review screen. Use this if you only want to show the title.

@objc public var navigationBarReviewTitleBackButton: String

Sets the close button text in the navigation bar on the review screen. Use this if you only want to show the title.

@objc public var navigationBarReviewTitleCloseButton: String

Sets the continue button text in the navigation bar on the review screen.

@objc public var navigationBarReviewTitleContinueButton: String

Sets custom onboarding pages.

For your convenience we provide the OnboardingPage struct.

public var customOnboardingPages: [OnboardingPage]?

Indicates whether the onboarding screen should be presented at each start of Gini Capture SDK

@objc public var onboardingShowAtLaunch: Bool

Indicates whether the onboarding screen should be presented at the first start of the Gini Capture SDK. It is advised to do so.

Overwrites onboardingShowAtLaunch for the first launch.

@objc public var onboardingShowAtFirstLaunch: Bool

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

public var onboardingNavigationBarBottomAdapter: OnboardingNavigationBarBottomAdapter?

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

public var onboardingAlignCornersIllustrationAdapter: OnboardingIllustrationAdapter?

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

public var onboardingLightingIllustrationAdapter: OnboardingIllustrationAdapter?

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

public var onboardingMultiPageIllustrationAdapter: OnboardingIllustrationAdapter?

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

public var onboardingQRCodeIllustrationAdapter: OnboardingIllustrationAdapter?

Enable/deactivate the bottom navigation bar.

public var bottomNavigationBarEnabled: Bool

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

public var helpNavigationBarBottomAdapter: HelpBottomNavigationBarAdapter?

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

public var cameraNavigationBarBottomAdapter: CameraBottomNavigationBarAdapter?

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

public var reviewNavigationBarBottomAdapter: ReviewScreenBottomNavigationBarAdapter?

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

public var imagePickerNavigationBarBottomAdapter: ImagePickerBottomNavigationBarAdapter?

Sets an adapter implementation to show a custom bottom navigation bar on the digital invoice help screen.

public var digitalInvoiceHelpNavigationBarBottomAdapter: DigitalInvoiceHelpNavigationBarBottomAdapter?

Sets an adapter implementation to show a custom bottom navigation bar on the digital invoice onboarding screen.

public var digitalInvoiceOnboardingNavigationBarBottomAdapter: DigitalInvoiceOnboardingNavigationBarBottomAdapter?

Sets an adapter implementation to show a custom bottom navigation bar on the digital invoice overview screen.

@objc public var navigationBarReviewTitleCloseButton: Strin

Sets an adapter implementation to show a custom illustration on the return assistant onboarding page.

public var digitalInvoiceOnboardingIllustrationAdapter: OnboardingIllustrationAdapter?

Enables/deactivates the bottom navigation bar.

public var bottomNavigationBarEnabled: Bool

Analysis options

Sets the back button text in the navigation bar on the analysis screen. Use this if you only want to show the title.

@objc public var navigationBarAnalysisTitleBackButton: String

Help screens

Sets the background color for all help screens

@objc public var helpScreenBackgroundColor: GiniColor

Sets the background color for the cells on the help screen.

@objc public var helpScreenCellsBackgroundColor: GiniColor

Sets the back button text in the navigation bar on the help menu screen. Use this if you only want to show the title.

@objc public var navigationBarHelpMenuTitleBackToCameraButton: String

Sets the back button text in the navigation bar on the help screen. Use this if you only want to show the title.

@objc public var navigationBarHelpScreenTitleBackToMenuButton: String

Indicates whether the supported format screens should be shown. In case of false, the option won’t be shown in the Help menu.

@objc public var shouldShowSupportedFormatsScreen: Bool

Open with tutorial options

Sets the text of the app name for the Open with tutorial texts.

@objc public var openWithAppNameForTexts: String

Sets if the Drag&Drop step should be shown in the Open with tutorial.

@objc public var shouldShowDragAndDropTutorial: Bool
@objc public var closeButtonResource: PreferredButtonResource?
@objc public var helpButtonResource: PreferredButtonResource?
@objc public var backToCameraButtonResource: PreferredButtonResource?
@objc public var backToMenuButtonResource: PreferredButtonResource?
@objc public var nextButtonResource: PreferredButtonResource?
@objc public var cancelButtonResource: PreferredButtonResource?

Shows the return reasons dialog.

@objc public var enableReturnReasons: Bool

Sets an adapter implementation to show a custom loading indicator on the document analysis screen.

public var customLoadingIndicator: CustomLoadingIndicatorAdapter?

Find an example implementation here.

Related content