Configuration

Owned by Bart Gosiewski
Sept 06, 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.

@objc public final class GiniConfiguration : NSObject

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

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.

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.

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

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

public static var shared: GiniConfiguration

Supported document types by Gini Capture SDK.

@objc public enum GiniCaptureImportFileTypes : Int

  • none

  • pdf

  • pdf_and_images

General options

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

Button configuration options

Camera options

Onboarding screens

Analysis options

Help screens

Open with tutorial options

Find an example implementation here.