View on GitHub
Install in Dash
Classes Reference
Classes
The following classes are available globally.
-
Main container class, contains both
MBBlinkIdOverlayViewControllerandMBScanningProvider.MBBlinkIdOverlayViewControlleris used as the UI part of BlinkIDUI, whileMBScanningProvideris the part handling scanning logic.To start scanning create an instance of MBBlinkIDUI and set it’s delegate.
See moreWarning
Hold the reference to your instance ofMBBlinkIDUIbecause it holds the reference toMBScanningProviderandMBBlinkIdOverlayViewController. If you lose the reference to it, scanning might work but you won’t recieve the events.Declaration
Swift
@objc public class MBBlinkIDUI : NSObject
-
MBBlinkSettingsis a singleton containing general setting ofMBBlinkIDUIContains almost all the customization options available without changing the framework If you want to change the color or fonts seeMBTheme.swiftfile.See moreWarning
Make sure to setup your settings before creating an instance ofMBBlinkIDUI.Declaration
Swift
@objc public class MBBlinkSettings : NSObject
-
Container class that has all the properties that define the text being presented to the user through UI components. By default all the strings are read from the
See moreBlinkIDUI.stringsfile shipped with frameworkDeclaration
Swift
@objc public class MBBlinkLanguageSettings : NSObject
-
Class will return an array of countries that match the provided set of country codes.
See moreDeclaration
Swift
@objc public class MBWhitelistCountryFilter : NSObject, MBCountryFilter -
Class will return an array of countries that don’t match the provided set of country codes.
See moreDeclaration
Swift
@objc public class MBBlacklistCountryFilter : NSObject, MBCountryFilter -
Class will return same array as provided through filter method.
See moreDeclaration
Swift
@objc public class MBAllowAllCountryFilter : NSObject, MBCountryFilter
-
Default implementation of
See moreMBDocumentChooserSettings.Declaration
Swift
@objc open class MBDefaultDocumentChooserSettings : NSObject, MBDocumentChooserSettings
-
Alert contorller will be presented with a mesage that the front and back side data does not match if scanning two sided documents is enabled and the document recognizer is either a combined recognizer, or it’s recognizers can be matched using MBResultValidator.
See moreDeclaration
Swift
@objc public class MBDefaultInvalidDocumentHandler : NSObject, MBInvalidDocumentHandler
-
See moreMBDefaultTimeoutHandleris used to present the user with anUIAlertControllerthat notifes them that they can change the Country/Document being scanned. If timerTimeout number of seconds pass without any successfull results this class will present aUIAlertControllerwith a message to user to try changing the Country.Declaration
Swift
@objc open class MBDefaultTimeoutHandler : NSObject, MBTimeoutHandler
-
Class that presents a table view containing all the countries allowed by
See moreMBCountryFilterused.Declaration
Swift
@objc public class MBCountryTableViewController : UIViewController
-
See moreMBDocumentChooserViewControllerclass used to present the user with a UI flow to change the document being scanned. It provides the UI to change the country and/or the document being scanned by the user.Declaration
Swift
public class MBDocumentChooserViewController : UIViewController
-
MBBlinkIdOverlayViewControllercontains the UI ofBlinkIDUImodule. It contains UI components that guide user through scanning process. Main components are:- Viewfinder is a simple frame which points the user toward the area where card should be presented, concrete implementation in in
MBViewfinderViewDocumentSelectionstoryboard which presents the user with a way to change the type of document they are scanning.Buttons to turn on/off the torch and dismiss the
BlinkIDUIview controller.See moreNote
Most of the UI aspects are customizable either by changing the properties defined through extensions of
UIFontandUIColorpresented inMBThemefile, or by changing the various properties throughMBBlinkSettingssharedInstance.Declaration
Swift
public class MBBlinkIdOverlayViewController : MBCustomOverlayViewController - Viewfinder is a simple frame which points the user toward the area where card should be presented, concrete implementation in in
-
Class representing one field, or result of document being scanned.
See moreDeclaration
Swift
public class MBField : NSObject
-
Class representing the results of document scanning
See moreDeclaration
Swift
@objc public class MBRecognitionResult : NSObject
-
Class containing country code for countries and country providers
See moreDeclaration
Swift
@objc public class MBCountry : NSObject, MBLocalizable
-
Class describing a country document provider. Contains general document providers by default.
See moreDeclaration
Swift
@objc public class MBCountryProvider : NSObject
-
Class that describes a document provider It is used to describe what parts of the document can be scanned, what
See moreMBRecognizers, what type of document this…Declaration
Swift
public class MBDocumentProvider : NSObject