NetverifyCustomScanViewController


@interface NetverifyCustomScanViewController : UIViewController

View Controller that handles scanning. It can display and handle different scanning methods.

  • Delegate class which implements the NetverifyCustomScanViewControllerDelegate protocol

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite, nonnull)
    id<NetverifyCustomScanViewControllerDelegate>
        customScanViewControllerDelegate;

    Swift

    unowned(unsafe) var customScanViewControllerDelegate: NetverifyCustomScanViewControllerDelegate { get set }
    Show on GitHub

  • UIView which should be used to add any additional custom views as a subview

    Declaration

    Objective-C

    @property (nonatomic, strong, readwrite) UIView *_Nonnull customOverlayLayer;

    Swift

    var customOverlayLayer: UIView { get set }
    Show on GitHub

  • This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (BOOL)isFallbackAvailable;

    Swift

    func isFallbackAvailable() -> Bool

    Return Value

    BOOL Determines whether an alternative scan method is available

    Show on GitHub

  • Switch to the alternative scan method

    Declaration

    Objective-C

    - (void)switchToFallback;

    Swift

    func switchToFallback()
    Show on GitHub

  • This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (BOOL)hasFlash;

    Swift

    func hasFlash() -> Bool

    Return Value

    true if a flash is available

    Show on GitHub

  • This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (BOOL)hasMultipleCameras;

    Swift

    func hasMultipleCameras() -> Bool

    Return Value

    true if there is AVCaptureDevicePositionFront and AVCaptureDevicePositionBack

    Show on GitHub

  • This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (BOOL)isFlashOn;

    Swift

    func isFlashOn() -> Bool

    Return Value

    true if the flash is currently on.

    Show on GitHub

  • This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (JumioCameraPosition)currentCameraPosition;

    Swift

    func currentCameraPosition() -> JumioCameraPosition

    Return Value

    The current camera position.

    Show on GitHub

  • Determines whether the Scan View is a manual image picker

    Declaration

    Objective-C

    - (BOOL)isImagePicker;

    Swift

    func isImagePicker() -> Bool
    Show on GitHub

  • Target action for the shutter button in case the Scan View is a manual image picker

    Declaration

    Objective-C

    - (void)takeImage;

    Swift

    func takeImage()
    Show on GitHub

  • Declaration

    Objective-C

    - (BOOL)canToggleFlash;

    Swift

    func canToggleFlash() -> Bool

    Return Value

    Determines whether the flash can be toggled

    Show on GitHub

  • Toggles the built-in flash. This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (void)toggleFlash;

    Swift

    func toggleFlash()
    Show on GitHub

  • Determines whether the primary camera position can be switched

    Declaration

    Objective-C

    - (BOOL)canSwitchCamera;

    Swift

    func canSwitchCamera() -> Bool
    Show on GitHub

  • Switches between available cameraPositions. This method can not be called if scanning is paused or stopped

    Declaration

    Objective-C

    - (void)switchCamera;

    Swift

    func switchCamera()
    Show on GitHub

  • Call this method if you want to restart the capturing process.

    Declaration

    Objective-C

    - (void)retryScan;

    Swift

    func retryScan()
    Show on GitHub

  • Call this method if you want to pause the capturing process. Camera preview will not be paused.

    Declaration

    Objective-C

    - (void)pauseScan;

    Swift

    func pauseScan()
    Show on GitHub

  • Declaration

    Objective-C

    - (CGRect)overlayFrame;

    Swift

    func overlayFrame() -> CGRect

    Return Value

    the dimensions of the ROI overlay which must not be overlayed by any custom views

    Show on GitHub

  • Method to get the suggested help text

    Declaration

    Objective-C

    - (NSString *_Nonnull)localizedShortHelpText;

    Swift

    func localizedShortHelpText() -> String

    Return Value

    String of localized short help text

    Show on GitHub

  • Method to get the suggested help text in long version

    Declaration

    Objective-C

    - (NSString *_Nonnull)localizedLongHelpText;

    Swift

    func localizedLongHelpText() -> String

    Return Value

    String of localized full help text

    Show on GitHub

  • Declaration

    Objective-C

    - (NSUInteger)currentStep;

    Swift

    func currentStep() -> UInt

    Return Value

    the running number of scanViewControllers within the whole workflow which can be used to display the progress in the workflow. e.g. Step 1 of 3

    Show on GitHub

  • Declaration

    Objective-C

    - (NSUInteger)totalSteps;

    Swift

    func totalSteps() -> UInt

    Return Value

    the number of total scanViewControllers which can be used to display the progress in the workflow. e.g. Step 1 of 3

    Show on GitHub

  • Declaration

    Objective-C

    - (NetverifyScanMode)currentScanMode;

    Swift

    func currentScanMode() -> NetverifyScanMode

    Return Value

    the scanMode of the current scanViewController

    Show on GitHub

  • Sets the vertical offset of the overlay (MRZ, OCR_Card) from the center.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat verticalRoiOffset;

    Swift

    var verticalRoiOffset: CGFloat { get set }
    Show on GitHub

  • Sets the top margin of the Jumio logo and Privacy Policy.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
    CGFloat brandingLogoTopMargin;

    Swift

    var brandingLogoTopMargin: CGFloat { get set }
    Show on GitHub