Protocols Reference


                    
                    
                    Diffable

Undocumented

Declaration

Swift

public protocol Diffable


                    
                    
                    GiniCaptureDelegate

Delegate to inform the reveiver about the current status of the Gini Capture SDK. Makes use of callbacks for handling incoming data and to control view controller presentation.

Declaration

Swift

@objc
public protocol GiniCaptureDelegate


                    
                    
                    LocalizableStringResource

Undocumented

Declaration

Swift

public protocol LocalizableStringResource


                    
                    
                    PreferredButtonResource

Undocumented

Declaration

Swift

@objc
public protocol PreferredButtonResource


                    
                    
                    GiniLogger

Undocumented

Declaration

Swift

@objc
public protocol GiniLogger


                    
                    
                    GiniCaptureErrorLoggerDelegate

Undocumented

Declaration

Swift

public protocol GiniCaptureErrorLoggerDelegate : AnyObject


                    
                    
                    GiniCaptureDocument

Document processed by the GiniCapture library.

Declaration

Swift

@objc
public protocol GiniCaptureDocument


                    
                    
                    GiniCaptureError

Undocumented

Declaration

Swift

public protocol GiniCaptureError : Error


                    
                    
                    AnalysisDelegate

Delegate which can be used to communicate back to the analysis screen allowing to display custom messages on screen.

Declaration

Swift

@objc
public protocol AnalysisDelegate


                    
                    
                    CustomLoadingIndicatorAdapter

Adapter for injecting a custom loading indicator for the analysis viewcontroller.

Declaration

Swift

public protocol CustomLoadingIndicatorAdapter : InjectedViewAdapter


                    
                    
                    CameraBottomNavigationBarAdapter

Protocol for injecting a custom bottom navigation bar on the camera screen.

Note

Bottom navigation only.

Declaration

Swift

public protocol CameraBottomNavigationBarAdapter : InjectedViewAdapter


                    
                    
                    CameraScreen

Undocumented

Declaration

Swift

@objc
public protocol CameraScreen : UIViewController, CameraTips


                    
                    
                    CameraTips

Undocumented

Declaration

Swift

@objc
public protocol CameraTips


                    
                    
                    CameraViewControllerDelegate

The CameraViewControllerDelegate protocol defines methods that allow you to handle captured images and user actions.

Declaration

Swift

@objc
public protocol CameraViewControllerDelegate


                    
                    
                    DocumentPickerCoordinatorDelegate

The CameraViewControllerDelegate protocol defines methods that allow you to handle picked documents from both Gallery and Files Explorer.

Declaration

Swift

public protocol DocumentPickerCoordinatorDelegate : AnyObject


                    
                    
                    ImagePickerBottomNavigationBarAdapter

Protocol for injecting a custom bottom navigation bar on the image picker screen.

Note

Bottom navigation only.

Declaration

Swift

public protocol ImagePickerBottomNavigationBarAdapter : InjectedViewAdapter


                    
                    
                    HelpBottomNavigationBarAdapter

Protocol for injecting a custom bottom navigation bar on the help screens.

Note

Bottom navigation only.

Declaration

Swift

public protocol HelpBottomNavigationBarAdapter : InjectedViewAdapter


                    
                    
                    InjectedViewAdapter

Adapter for injectable views. It allows clients to inject their own views into our layouts.

Declaration

Swift

public protocol InjectedViewAdapter


                    
                    
                    OnboardingIllustrationAdapter

Adapter for injecting a custom onboarding illustration with a custom animation for the onboarding page.

Declaration

Swift

public protocol OnboardingIllustrationAdapter : InjectedViewAdapter


                    
                    
                    OnboardingNavigationBarBottomAdapter

Protocol for injecting a custom bottom navigation bar on the onboarding screen.

Note

Bottom navigation only.

Declaration

Swift

public protocol OnboardingNavigationBarBottomAdapter : InjectedViewAdapter


                    
                    
                    OnButtonLoadingIndicatorAdapter

Adapter for injecting a custom loading indicator on top of buttons.

Declaration

Swift

public protocol OnButtonLoadingIndicatorAdapter : InjectedViewAdapter


                    
                    
                    ReviewScreenBottomNavigationBarAdapter

Protocol for injecting a custom bottom navigation bar on the Review screen.

Note

Bottom navigation only.

Declaration

Swift

public protocol ReviewScreenBottomNavigationBarAdapter : InjectedViewAdapter


                    
                    
                    ReviewViewControllerDelegate

The ReviewViewControllerDelegate protocol defines methods that allow you to handle user actions in the ReviewViewControllerDelegate (tap add, delete…

Declaration

Swift

public protocol ReviewViewControllerDelegate : AnyObject


                    
                    
                    UploadDelegate

The UploadDelegate protocol defines methods that allow you to notify the Gini Capture SDK when a document upload has finished (either successfully or with an error)

Declaration

Swift

@objc
public protocol UploadDelegate


                    
                    
                    GiniCaptureTrackingDelegate

Delegate protocol that Gini Capture SDK uses to report user events. Implement the delegate methods and pass the delegate to GiniCapture.viewController() when initializing Gini Capture SDK.

The delegate is separated into smaller protocols relating to different parts of Gini Capture SDK.

Note

The delegate isn’t retained by Gini Capture SDK. It should be retained by the client code.

Declaration

Swift

public protocol GiniCaptureTrackingDelegate: OnboardingScreenTrackingDelegate,
                                             CameraScreenTrackingDelegate,
                                             ReviewScreenTrackingDelegate,
                                             AnalysisScreenTrackingDelegate


                    
                    
                    OnboardingScreenTrackingDelegate

Tracking delegate relating to onboarding.

Declaration

Swift

public protocol OnboardingScreenTrackingDelegate : AnyObject


                    
                    
                    CameraScreenTrackingDelegate

Tracking delegate relating to the camera screen.

Declaration

Swift

public protocol CameraScreenTrackingDelegate : AnyObject


                    
                    
                    ReviewScreenTrackingDelegate

Tracking delegate relating to the review screen.

Declaration

Swift

public protocol ReviewScreenTrackingDelegate : AnyObject


                    
                    
                    AnalysisScreenTrackingDelegate

Tracking delegate relating to the analysis screen.

Declaration

Swift

public protocol AnalysisScreenTrackingDelegate : AnyObject


                    
                    
                    DocumentServiceProtocol

Undocumented

Declaration

Swift

public protocol DocumentServiceProtocol : AnyObject


                    
                    
                    GiniCaptureNetworkService

Undocumented

Declaration

Swift

public protocol GiniCaptureNetworkService : AnyObject


                    
                    
                    GiniCaptureResultsDelegate

The GiniCaptureResultsDelegate protocol defines methods that allow you to handle the analysis result.

Declaration

Swift

@objc
public protocol GiniCaptureResultsDelegate