GiniConfiguration

@objc
public final class GiniConfiguration : NSObject

The GiniConfiguration class allows customizations to the look and feel of the Gini Capture SDK. If there are limitations regarding which API can be used, this is clearly stated for the specific attribute.

Note

Text can also be set by using the appropriate keys in a Localizable.strings file in the projects bundle. The library will prefer whatever value is set in the following order: attribute in configuration, key in strings file in project bundle, key in strings file in GiniCapture bundle.

Note

Images can only be set by providing images with the same filename in an assets file or as individual files in the projects bundle. The library will prefer whatever value is set in the following order: asset file in project bundle, asset file in GiniCapture bundle.

Attention

If there are conflicting pairs of image and text for an interface element (e.g. navigationBarCameraTitleCloseButton) the image will always be preferred, while making sure the accessibility label is set.

shared
Singleton to make configuration internally accessible in all classes of the Gini Capture SDK.
Declaration
Swift

public static var shared: GiniConfiguration
GiniCaptureImportFileTypes
Supported document types by Gini Capture SDK.
See more
Declaration
Swift

@objc public enum GiniCaptureImportFileTypes : Int

General options

customDocumentValidations
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)
customResourceBundle
Should be set if the main app’s bundle is not used.
Declaration
Swift

public var customResourceBundle: Bundle?

Button configuration options


                    
                    
                    primaryButtonConfiguration

Undocumented

Declaration

Swift

public lazy var primaryButtonConfiguration: ButtonConfiguration { get set }


                    
                    
                    secondaryButtonConfiguration

Undocumented

Declaration

Swift

public lazy var secondaryButtonConfiguration: ButtonConfiguration { get set }


                    
                    
                    transparentButtonConfiguration

Undocumented

Declaration

Swift

public lazy var transparentButtonConfiguration: ButtonConfiguration { get set }


                    
                    
                    cameraControlButtonConfiguration

Undocumented

Declaration

Swift

public lazy var cameraControlButtonConfiguration: ButtonConfiguration { get set }


                    
                    
                    addPageButtonConfiguration

Undocumented

Declaration

Swift

public lazy var addPageButtonConfiguration: ButtonConfiguration { get set }

debugModeOn
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
logger
Used to handle all the logging messages in order to log them in a different way.
Declaration
Swift

@objc public var logger: GiniLogger
multipageEnabled
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
customNavigationController
Sets the custom navigation view controller as a root view controller for Gini Capture SDK screens.
Declaration
Swift

@objc public var customNavigationController: UINavigationController?
openWithEnabled
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
qrCodeScanningEnabled
Indicates whether the QR Code scanning feature is enabled or not.
Declaration
Swift

@objc public var qrCodeScanningEnabled: Bool
onlyQRCodeScanningEnabled
Indicates whether only the QR Code scanning feature is enabled or not.
Declaration
Swift

@objc public var onlyQRCodeScanningEnabled: Bool
statusBarStyle
Indicates the status bar style in the Gini Capture SDK.
Declaration
Swift

@objc public var statusBarStyle: UIStatusBarStyle

Camera options

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

@objc public var fileImportSupportedTypes: GiniCaptureImportFileTypes
flashToggleEnabled
Indicates whether the flash toggle should be shown in the camera screen.
Declaration
Swift

@objc public var flashToggleEnabled: Bool
flashOnByDefault
Set whether the camera flash should be on or off when the SDK starts. The flash is off by default.
Declaration
Swift

@objc public var flashOnByDefault: Bool
navigationBarCameraTitleCloseButton
Sets the close button text in the navigation bar on the camera screen.
Declaration
Swift

@objc public var navigationBarCameraTitleCloseButton: String
navigationBarCameraTitleHelpButton
Sets the help button text in the navigation bar on the camera screen.
Declaration
Swift

@objc public var navigationBarCameraTitleHelpButton: String

Onboarding screens

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

@objc public var navigationBarOnboardingTitleContinueButton: String
onboardingShowAtLaunch
Indicates whether the onboarding screen should be presented at each start of the Gini Capture SDK.
Declaration
Swift

@objc public var onboardingShowAtLaunch: Bool
onboardingShowAtFirstLaunch
Indicates whether the onboarding screen should be presented at the first start of the Gini Capture SDK. It is advised to do so.

Note
Overwrites onboardingShowAtLaunch for the first launch.
Declaration
Swift

@objc public var onboardingShowAtFirstLaunch: Bool
customOnboardingPages
Set custom onboarding pages

Note
For your convenience we provide the OnboardingPage struct.
Declaration
Swift

public var customOnboardingPages: [OnboardingPage]?
bottomNavigationBarEnabled
Enable/disable the bottom navigation bar.
Declaration
Swift

public var bottomNavigationBarEnabled: Bool
helpNavigationBarBottomAdapter
Set an adapter implementation to show a custom bottom navigation bar on the help screens.
Declaration
Swift

public var helpNavigationBarBottomAdapter: HelpBottomNavigationBarAdapter?
cameraNavigationBarBottomAdapter
Set an adapter implementation to show a custom bottom navigation bar on the camera screen.
Declaration
Swift

public var cameraNavigationBarBottomAdapter: CameraBottomNavigationBarAdapter?
reviewNavigationBarBottomAdapter
Set an adapter implementation to show a custom bottom navigation bar on the review screen.
Declaration
Swift

public var reviewNavigationBarBottomAdapter: ReviewScreenBottomNavigationBarAdapter?
imagePickerNavigationBarBottomAdapter
Set an adapter implementation to show a custom bottom navigation bar on the image picker screen.
Declaration
Swift

public var imagePickerNavigationBarBottomAdapter: ImagePickerBottomNavigationBarAdapter?
onboardingNavigationBarBottomAdapter
Set an adapter implementation to show a custom bottom navigation bar on the onboarding screen.
Declaration
Swift

public var onboardingNavigationBarBottomAdapter: OnboardingNavigationBarBottomAdapter?
onboardingAlignCornersIllustrationAdapter
Set an adapter implementation to show a custom illustration on the “align corners” onboarding page.
Declaration
Swift

public var onboardingAlignCornersIllustrationAdapter: OnboardingIllustrationAdapter?
onboardingLightingIllustrationAdapter
Set an adapter implementation to show a custom illustration on the “lighting” onboarding page.
Declaration
Swift

public var onboardingLightingIllustrationAdapter: OnboardingIllustrationAdapter?
onboardingMultiPageIllustrationAdapter
Set an adapter implementation to show a custom illustration on the “multi-page” onboarding page.
Declaration
Swift

public var onboardingMultiPageIllustrationAdapter: OnboardingIllustrationAdapter?
onboardingQRCodeIllustrationAdapter
Set an adapter implementation to show a custom illustration on the “QR code” onboarding page.
Declaration
Swift

public var onboardingQRCodeIllustrationAdapter: OnboardingIllustrationAdapter?
customLoadingIndicator
Set an adapter implementation to show a custom loading indicator on the document analysis screen.
Declaration
Swift

public var customLoadingIndicator: CustomLoadingIndicatorAdapter?
onButtonLoadingIndicator
Set an adapter implementation to show a custom loading indicator on the buttons which support loading.
Declaration
Swift

public var onButtonLoadingIndicator: OnButtonLoadingIndicatorAdapter?
navigationBarReviewTitleBackButton
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
navigationBarReviewTitleCloseButton
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
navigationBarReviewTitleContinueButton
Sets the continue button text in the navigation bar on the review screen.
Declaration
Swift

@objc public var navigationBarReviewTitleContinueButton: String

Analysis options

navigationBarAnalysisTitleBackButton
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

navigationBarHelpMenuTitleBackToCameraButton
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
navigationBarHelpScreenTitleBackToMenuButton
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
shouldShowSupportedFormatsScreen
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

Open with tutorial options

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

@objc public var openWithAppNameForTexts: String
shouldShowDragAndDropTutorial
Sets if the Drag&Drop step should be shown in the “Open with” tutorial.
Declaration
Swift

@objc public var shouldShowDragAndDropTutorial: Bool
customMenuItems
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]
giniErrorLoggerIsOn
Sets if the default error logging implementation is on.
Declaration
Swift

@objc public var giniErrorLoggerIsOn: Bool { get set }
customGiniErrorLoggerDelegate
Should sets if the custom error logging is implemented.
Declaration
Swift

public var customGiniErrorLoggerDelegate: GiniCaptureErrorLoggerDelegate? { get set }
localizedStringsTableName
Should be set if the default name “Localizable.strings” are not used.
Declaration
Swift

public var localizedStringsTableName: String?


                    
                    
                    closeButtonResource

Undocumented

Declaration

Swift

@objc
public var closeButtonResource: PreferredButtonResource?


                    
                    
                    helpButtonResource

Undocumented

Declaration

Swift

@objc
public var helpButtonResource: PreferredButtonResource?


                    
                    
                    backToCameraButtonResource

Undocumented

Declaration

Swift

@objc
public var backToCameraButtonResource: PreferredButtonResource?


                    
                    
                    backToMenuButtonResource

Undocumented

Declaration

Swift

@objc
public var backToMenuButtonResource: PreferredButtonResource?


                    
                    
                    nextButtonResource

Undocumented

Declaration

Swift

@objc
public var nextButtonResource: PreferredButtonResource?


                    
                    
                    cancelButtonResource

Undocumented

Declaration

Swift

@objc
public var cancelButtonResource: PreferredButtonResource?


                    
                    
                    updateFont(_:for:)

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


                    
                    
                    cleanup(paymentRecipient:paymentReference:paymentPurpose:iban:bic:amountToPay:)

Undocumented

Declaration

Swift

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

GiniEntryPoint
Enum that represents entry points used for launching the SDK.
See more
Declaration
Swift

public enum GiniEntryPoint : Int
entryPoint
Set the entry point used for launching the Gini Capture SDK. Default value is GiniEntryPoint.button.
Declaration
Swift

public var entryPoint: GiniEntryPoint

Transfer summary sending and cleanup


                    
                    
                    sendTransferSummary(paymentRecipient:paymentReference:paymentPurpose:iban:bic:amountToPay:)

Function for transfer summary. Provides transfer summary to Gini. Please provide the required transfer summary to improve the future extraction accuracy.

Please follow the recommendations below:

Make sure to call this method before calling cleanup() if the user has completed TAN verification.
Provide values for all necessary fields, including those that were not extracted.
Provide the final data approved by the user (and not the initially extracted only).
Send the transfer summary after TAN verification and provide the extraction values the user has used.

Declaration

Swift

public func sendTransferSummary(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

cleanup()
Frees up resources used by the capture flow.
Declaration
Swift

public func cleanup()