GiniBankConfiguration

public final class GiniBankConfiguration : NSObject

Undocumented

  • Singleton to make configuration internally accessible in all classes of the Gini Bank SDK.

    Declaration

    Swift

    public static var shared: GiniBankConfiguration

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

    Declaration

    Swift

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

    Declaration

    Swift

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

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

    Warning

    Should never be used outside of a development enviroment.

    Declaration

    Swift

    @objc
public var debugModeOn: Bool

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

    Declaration

    Swift

    @objc
public var logger: GiniLogger

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

    Declaration

    Swift

    @objc
public var multipageEnabled: Bool

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

    Declaration

    Swift

    @objc
public var customNavigationController: UINavigationController?

  • Sets the tint color of the UIDocumentPickerViewController navigation bar.

    Note

    Use only if you have a custom UIAppearance for your UINavigationBar

    Declaration

    Swift

    @objc
public var documentPickerNavigationBarTintColor: UIColor?

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

    Declaration

    Swift

    @objc
public var noticeInformationBackgroundColor: UIColor

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

    Declaration

    Swift

    @objc
public var noticeInformationTextColor: UIColor

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

    Declaration

    Swift

    @objc
public var noticeErrorBackgroundColor: UIColor

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

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
public var openWithEnabled: Bool

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

    Declaration

    Swift

    @objc
public var qrCodeScanningEnabled: Bool

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

    Declaration

    Swift

    @objc
public var onlyQRCodeScanningEnabled: Bool

  • Indicates the status bar style in the Gini Bank SDK.

    Declaration

    Swift

    @objc
public var statusBarStyle: UIStatusBarStyle

Camera options

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

    Declaration

    Swift

    @objc
public var fileImportSupportedTypes: GiniConfiguration.GiniCaptureImportFileTypes

  • Indicates whether the flash toggle should be shown in the camera screen.

    Declaration

    Swift

    @objc
public var flashToggleEnabled: Bool

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

    Declaration

    Swift

    @objc
public var flashOnByDefault: Bool

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

    Declaration

    Swift

    @objc
public var navigationBarCameraTitleCloseButton: String

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

    Declaration

    Swift

    @objc
public var navigationBarCameraTitleHelpButton: String

Onboarding screens

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

    Declaration

    Swift

    @objc
public var navigationBarOnboardingTitleContinueButton: String

  • Indicates whether the onboarding screen should be presented at each start of the Gini Bank SDK.

    Declaration

    Swift

    @objc
public var onboardingShowAtLaunch: Bool

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

    Note

    Overwrites onboardingShowAtLaunch for the first launch.

    Declaration

    Swift

    @objc
public var onboardingShowAtFirstLaunch: Bool

  • Set custom onboarding pages

    Note

    For your convenience we provide the OnboardingPage struct.

    Declaration

    Swift

    public var customOnboardingPages: [OnboardingPage]?

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

    Declaration

    Swift

    public var onboardingAlignCornersIllustrationAdapter: OnboardingIllustrationAdapter?

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

    Declaration

    Swift

    public var onboardingLightingIllustrationAdapter: OnboardingIllustrationAdapter?

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

    Declaration

    Swift

    public var onboardingMultiPageIllustrationAdapter: OnboardingIllustrationAdapter?

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

    Declaration

    Swift

    public var onboardingQRCodeIllustrationAdapter: OnboardingIllustrationAdapter?

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

    Declaration

    Swift

    public var digitalInvoiceOnboardingIllustrationAdapter: OnboardingIllustrationAdapter?

  • Enable/disable the bottom navigation bar.

    Declaration

    Swift

    public var bottomNavigationBarEnabled: Bool

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

    Declaration

    Swift

    public var helpNavigationBarBottomAdapter: HelpBottomNavigationBarAdapter?

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

    Declaration

    Swift

    public var cameraNavigationBarBottomAdapter: CameraBottomNavigationBarAdapter?

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

    Declaration

    Swift

    public var onboardingNavigationBarBottomAdapter: OnboardingNavigationBarBottomAdapter?

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

    Declaration

    Swift

    public var reviewNavigationBarBottomAdapter: ReviewScreenBottomNavigationBarAdapter?

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

    Declaration

    Swift

    public var imagePickerNavigationBarBottomAdapter: ImagePickerBottomNavigationBarAdapter?

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

    Declaration

    Swift

    public var digitalInvoiceHelpNavigationBarBottomAdapter: DigitalInvoiceHelpNavigationBarBottomAdapter?

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

    Declaration

    Swift

    public var digitalInvoiceOnboardingNavigationBarBottomAdapter: DigitalInvoiceOnboardingNavigationBarBottomAdapter?

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

    Declaration

    Swift

    public var digitalInvoiceNavigationBarBottomAdapter: DigitalInvoiceNavigationBarBottomAdapter?

  • Set an adapter implementation to show a custom loading indicator on the buttons which support loading.

    Declaration

    Swift

    public var onButtonLoadingIndicator: OnButtonLoadingIndicatorAdapter?

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

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
public var navigationBarReviewTitleCloseButton: String

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

    Declaration

    Swift

    @objc
public var navigationBarReviewTitleContinueButton: String

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.

    Declaration

    Swift

    @objc
public var navigationBarAnalysisTitleBackButton: String

Help screens

  • Sets the background color for all help screens.

    Declaration

    Swift

    @objc
public var helpScreenBackgroundColor: GiniColor

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

    @objc
public var shouldShowSupportedFormatsScreen: Bool

Supported formats

  • Sets the color of the unsupported formats icon background to the specified color.

    Declaration

    Swift

    @objc
public var nonSupportedFormatsIconColor: UIColor

  • Sets the color of the supported formats icon background to the specified color.

    Declaration

    Swift

    @objc
public var supportedFormatsIconColor: UIColor

Open with tutorial options

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

    Declaration

    Swift

    @objc
public var openWithAppNameForTexts: String

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

    Declaration

    Swift

    @objc
public var shouldShowDragAndDropTutorial: Bool

  • Undocumented

    Declaration

    Swift

    @objc
public var closeButtonResource: PreferredButtonResource?

  • Undocumented

    Declaration

    Swift

    @objc
public var helpButtonResource: PreferredButtonResource?

  • Undocumented

    Declaration

    Swift

    @objc
public var backToCameraButtonResource: PreferredButtonResource?

  • Undocumented

    Declaration

    Swift

    @objc
public var backToMenuButtonResource: PreferredButtonResource?

  • Undocumented

    Declaration

    Swift

    @objc
public var nextButtonResource: PreferredButtonResource?

  • Undocumented

    Declaration

    Swift

    @objc
public var cancelButtonResource: PreferredButtonResource?

  • Shows the return reasons dialog.

    Declaration

    Swift

    @objc
public var enableReturnReasons: Bool

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

    Declaration

    Swift

    public var customLoadingIndicator: CustomLoadingIndicatorAdapter?

Button configuration options

TODO DELETE

  • Sets the font used in the Return Assistant screens by default.

    Declaration

    Swift

    @objc
public lazy var customFont: GiniCaptureFont { get set }

  • Set an array of additional custom help menu items . Those items will be presented as table view cells on the help menu screen. By selecting the cell the user will be redirected to the page, which represented by viewController provided by customer during the HelpMenuViewController.Item initialization.

    Declaration

    Swift

    public var customMenuItems: [HelpMenuItem]

  • Sets if the default error logging implementation is on.

    Declaration

    Swift

    public var giniErrorLoggerIsOn: Bool

  • Should be set if the custom error logging is implemented.

    Declaration

    Swift

    public var customGiniErrorLoggerDelegate: GiniCaptureErrorLoggerDelegate?

  • Should be set if the default name “Localizable.strings” are not used.

    Declaration

    Swift

    public var localizedStringsTableName: String?

  • Undocumented

    Declaration

    Swift

    public func captureConfiguration() -> GiniConfiguration

  • Sets the configuration flags back. Used only in the example app. See SettingsViewController for the details.

    Declaration

    Swift

    public func updateConfiguration(withCaptureConfiguration configuration: GiniConfiguration)

  • Allows setting a custom font for specific text styles. The change will affect all screens where a specific text style was used.

    Declaration

    Swift

    public func updateFont(_ font: UIFont, for textStyle: UIFont.TextStyle)

    Parameters

    font

    Font that is going to be assosiated with specific text style. You can use scaled font or scale your font with our util method UIFont.scaledFont(_ font: UIFont, textStyle: UIFont.TextStyle)
    textStyle

    Constants that describe the preferred styles for fonts. Please, find additional information here

  • Function for clean up

    Declaration

    Swift

    public func cleanup(paymentRecipient: String, paymentReference: String, paymentPurpose: String, iban: String, bic: String, amountToPay: ExtractionAmount)

    Parameters

    paymentRecipient

    paymentRecipient description
    paymentReference

    paymentReference description
    iban

    iban description
    bic

    bic description
    amountToPay

    amountToPay description