MBBlinkIdOverlaySettings

Objective-C


@interface MBBlinkIdOverlaySettings : MBBaseOverlaySettings

Swift

class MBBlinkIdOverlaySettings : MBBaseOverlaySettings

Settings class containing parameters for BlinkId UI

Show on GitHub

  • If YES, MBBlinkIdMultiSideRecognizer will check if sides do match when scanning is finished

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL requireDocumentSidesDataMatch;

    Swift

    var requireDocumentSidesDataMatch: Bool { get set }
    Show on GitHub

  • Defines whether Document Not Supported dialog will be displayed in UI.

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL showNotSupportedDialog;

    Swift

    var showNotSupportedDialog: Bool { get set }
    Show on GitHub

  • Defines whether glare warning will be displayed when user turn on a flashlight

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL showFlashlightWarning;

    Swift

    var showFlashlightWarning: Bool { get set }
    Show on GitHub

  • Option to configure back side scanning timeout.

    Default: 17.0

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval backSideScanningTimeout;

    Swift

    var backSideScanningTimeout: TimeInterval { get set }
    Show on GitHub

  • Message that is shown while scanning first side of the document. Default: Scan the front side of a document

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull firstSideInstructionsText;

    Swift

    var firstSideInstructionsText: String { get set }
    Show on GitHub

  • Message that is shown while scanning back side of the document. Default: Scan the back side of a document

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull backSideInstructionsText;

    Swift

    var backSideInstructionsText: String { get set }
    Show on GitHub

  • Message that is shown after fornt side of the USDL document is scanned. Default: Scan the barcode

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanBarcodeText;

    Swift

    var scanBarcodeText: String { get set }
    Show on GitHub

  • Instructions to flip document, shown when scanning of the first side is done, before scanning the second side of the document. Default: Flip the card

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull flipInstructions;

    Swift

    var flipInstructions: String { get set }
    Show on GitHub

  • Instructions to scan the passport, shown when scanning of the first side is done, before scanning the second side of the document. Default: Move to the page on top

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull turnTopPageInstructions;

    Swift

    var turnTopPageInstructions: String { get set }
    Show on GitHub

  • Instructions to scan the passport, shown when scanning of the first side is done, before scanning the second side of the document. Default: Move to the page on left

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull turnLeftPageInstructions;

    Swift

    var turnLeftPageInstructions: String { get set }
    Show on GitHub

  • Instructions to scan the passport, shown when scanning of the first side is done, before scanning the second side of the document. Default: Move to the page on right

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull turnRightPageInstructions;

    Swift

    var turnRightPageInstructions: String { get set }
    Show on GitHub

  • Instructions to scan the passport, shown when scanning of the first side is done, before scanning the second side of the document. Default: Move to the page on top

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanTopPageInstructions;

    Swift

    var scanTopPageInstructions: String { get set }
    Show on GitHub

  • Instructions to scan the passport, shown when scanning of the first side is done, before scanning the second side of the document. Default: Move to the page on left

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanLeftPageInstructions;

    Swift

    var scanLeftPageInstructions: String { get set }
    Show on GitHub

  • Instructions to scan the passport, shown when scanning of the first side is done, before scanning the second side of the document. Default: Move to the page on right

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanRightPageInstructions;

    Swift

    var scanRightPageInstructions: String { get set }
    Show on GitHub

  • Instructions for the user to move the document closer. Default: Move closer

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull errorMoveCloser;

    Swift

    var errorMoveCloser: String { get set }
    Show on GitHub

  • Instructions for the user to move the document farther. Default: Move farther

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull errorMoveFarther;

    Swift

    var errorMoveFarther: String { get set }
    Show on GitHub

  • Instructions for the user to move the document from the edge. Default: Move the document from the edge

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull errorDocumentTooCloseToEdge;

    Swift

    var errorDocumentTooCloseToEdge: String { get set }
    Show on GitHub

  • Title of the dialog, which is shown when scanned document sides are not from the same document. Default: Sides don’t match

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull sidesNotMatchingTitle;

    Swift

    var sidesNotMatchingTitle: String { get set }
    Show on GitHub

  • Message inside dialog, which is shown when scanned document sides are not from the same document. Default: Please start the scanning process over.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull sidesNotMatchingMessage;

    Swift

    var sidesNotMatchingMessage: String { get set }
    Show on GitHub

  • Title of the dialog, which is shown when scanned document has data mismatch. Default: Something went wrong

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull dataMismatchTitle;

    Swift

    var dataMismatchTitle: String { get set }
    Show on GitHub

  • Message inside dialog, which is shown when scanned document has data mismatch. Default: It appears the information on the document is inconsistent. Please try scanning again.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull dataMismatchMessage;

    Swift

    var dataMismatchMessage: String { get set }
    Show on GitHub

  • Title of the dialog, which is shown when scanned document sides are not from the same document. Default: Document not recognized

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull unsupportedDocumentTitle;

    Swift

    var unsupportedDocumentTitle: String { get set }
    Show on GitHub

  • Message inside dialog, which is shown when unsupported document is scanned. Default: Scan the front side of a supported document.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull unsupportedDocumentMessage;

    Swift

    var unsupportedDocumentMessage: String { get set }
    Show on GitHub

  • Title of the dialog, which is shown on timeout when scanning is stuck on the back document side. Default: Scan unsuccessful

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull recognitionTimeoutTitle;

    Swift

    var recognitionTimeoutTitle: String { get set }
    Show on GitHub

  • Message inside dialog, which is shown on timeout when scanning is stuck on the back document side. Default: Unable to read the document. Please try again.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull recognitionTimeoutMessage;

    Swift

    var recognitionTimeoutMessage: String { get set }
    Show on GitHub

  • Text of the “retry” button inside dialog, which is shown on timeout when scanning is stuck on the back document side. Default: Retry

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull retryButtonText;

    Swift

    var retryButtonText: String { get set }
    Show on GitHub

  • Instructions for the user that is covering more than two mandatory fields for a scan. If defineSpecificMissingMandatoryFields is YES, this message will be shown if user is covering any mandatory field. Default: Keep the document fully visible

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull errorMandatoryFieldMissing;

    Swift

    var errorMandatoryFieldMissing: String { get set }
    Show on GitHub

  • If YES and number of missing mandatory fields is <= 2, names of missing mandatory fields will be present in the message.

    Default: NO

    Declaration

    Objective-C

    @property (nonatomic) BOOL defineSpecificMissingMandatoryFields;

    Swift

    var defineSpecificMissingMandatoryFields: Bool { get set }
    Show on GitHub

  • Option to configure when the onboarding help tooltip will appear. Default: 8.0

    Declaration

    Objective-C

    @property (nonatomic) NSTimeInterval onboardingButtonTooltipDelay;

    Swift

    var onboardingButtonTooltipDelay: TimeInterval { get set }
    Show on GitHub

  • Defines whether button for presenting onboarding screens will be present on screen. Default: YES

    Declaration

    Objective-C

    @property (nonatomic) BOOL showOnboardingInfo;

    Swift

    var showOnboardingInfo: Bool { get set }
    Show on GitHub

  • Defines whether tutorial alert will be presented on appear. Default: NO

    Declaration

    Objective-C

    @property (nonatomic) BOOL showIntroductionDialog;

    Swift

    var showIntroductionDialog: Bool { get set }
    Show on GitHub

  • Instructions for the user to avoid glare. Default: Tilt or move document to remove reflection

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull glareDetectedMessage;

    Swift

    var glareDetectedMessage: String { get set }
    Show on GitHub

  • Instructions for the user to avoid blur. Default: Keep document and phone still

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull blurDetectedMessage;

    Swift

    var blurDetectedMessage: String { get set }
    Show on GitHub

  • Instructions for the user when face image is missing. Default: Keep face photo fully visible

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull faceImageMissingMessage;

    Swift

    var faceImageMissingMessage: String { get set }
    Show on GitHub

  • Instructions for the user when other side is awaiting scanning. Default: Flip the document

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull awaitingOtherSideMessage;

    Swift

    var awaitingOtherSideMessage: String { get set }
    Show on GitHub

  • Instructions for the user when wrong side is being scanned. Default: Flip the document

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanningWrongSideMessage;

    Swift

    var scanningWrongSideMessage: String { get set }
    Show on GitHub

  • Instructions for the user when wrong side of passport is being scanned. Default: Move to the top

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanningWrongSidePassportTopMessage;

    Swift

    var scanningWrongSidePassportTopMessage: String { get set }
    Show on GitHub

  • Instructions for the user when wrong side of passport is being scanned. Default: Move to the right

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanningWrongSidePassportRightMessage;

    Swift

    var scanningWrongSidePassportRightMessage: String { get set }
    Show on GitHub

  • Instructions for the user when wrong side of passport is being scanned. Default: Move to the left

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nonnull scanningWrongSidePassportLeftMessage;

    Swift

    var scanningWrongSidePassportLeftMessage: String { get set }
    Show on GitHub

  • Designated initializer. Initializes the object with default settings.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()

    Return Value

    object initialized with default values.

    Show on GitHub