MBBlinkIdOverlaySettings


@interface MBBlinkIdOverlaySettings : MBBaseOverlaySettings

Settings class containing parameters for BlinkId UI

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

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        BOOL requireDocumentSidesDataMatch;

    Swift

    var requireDocumentSidesDataMatch: Bool { get set }
  • Defines whether Document Not Supported dialog will be displayed in UI. ni bnhju

    Default: YES

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        BOOL showNotSupportedDialog;

    Swift

    var showNotSupportedDialog: Bool { get set }
  • Option to configure back side scanning timeout.

    Default: 17.0

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite)
        NSTimeInterval backSideScanningTimeout;

    Swift

    var backSideScanningTimeout: TimeInterval { get set }
  • 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, readwrite)
        NSString *_Nonnull firstSideInstructionsText;

    Swift

    var firstSideInstructionsText: String { get set }
  • Message that is shown after fornt side of the USDL document is scanned. Default: Scan the barcode

    Declaration

    Objective-C

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

    Swift

    var scanBarcodeText: String { get set }
  • 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, readwrite) NSString *_Nonnull flipInstructions;

    Swift

    var flipInstructions: String { get set }
  • Instructions for the user to move the document closer. Default: Move closer

    Declaration

    Objective-C

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

    Swift

    var errorMoveCloser: String { get set }
  • Instructions for the user to move the document farther. Default: Move farther

    Declaration

    Objective-C

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

    Swift

    var errorMoveFarther: String { get set }
  • Instructions for the user to move the document from the edge. Default: Move the document from the edge

    Declaration

    Objective-C

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

    Swift

    var errorDocumentTooCloseToEdge: String { get set }
  • 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, readwrite)
        NSString *_Nonnull sidesNotMatchingTitle;

    Swift

    var sidesNotMatchingTitle: String { get set }
  • 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, readwrite)
        NSString *_Nonnull sidesNotMatchingMessage;

    Swift

    var sidesNotMatchingMessage: String { get set }
  • 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, readwrite)
        NSString *_Nonnull unsupportedDocumentTitle;

    Swift

    var unsupportedDocumentTitle: String { get set }
  • 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, readwrite)
        NSString *_Nonnull unsupportedDocumentMessage;

    Swift

    var unsupportedDocumentMessage: String { get set }
  • 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, readwrite)
        NSString *_Nonnull recognitionTimeoutTitle;

    Swift

    var recognitionTimeoutTitle: String { get set }
  • 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, readwrite)
        NSString *_Nonnull recognitionTimeoutMessage;

    Swift

    var recognitionTimeoutMessage: String { get set }
  • 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, readwrite) NSString *_Nonnull retryButtonText;

    Swift

    var retryButtonText: String { get set }
  • Designated initializer. Initializes the object with default settings.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

    Swift

    init()

    Return Value

    object initialized with default values.