SybrinIdentityConfiguration
A base class conforming to the SybrinCommonConfiguration protocol containing configurable options
Declaration
Only relevant details are shown, boilerplate or standard Swift generated code is omitted
Summary
Public constructors
Signature
Description
Creates a new configuration with the specified license key.
Public variables
Name
Type
Description
String
Returns the license key you initialised the configuration with.
UIColor
Changes the color of the overlay.
UIColor
Changes the color of the top instruction message.
UIColor
Changes the color of the bottom instruction message.
UIColor
Changes the color of the border corners around the cutout.
CGFloat
Changes the thickness of the border corners around the cutout.
CGFloat
Changes the length of the border corners around the cutout.
UIBlurEffect.Style
Changes the style of the blur applied to the overlay.
CGFloat
Changes the intensity of the blur applied to the overlay.
AVCaptureDevice.Position
Changes which camera will be used (front or back).
String
An encrypted key that changes the SDKs environment variables.
String
Changes the text of the top label (at the bottom of the screen).
UIColor
Changes the color of the top label (at the bottom of the screen).
String
Changes the text of the bottom label (at the bottom of the screen).
UIColor
Changes the color of the bottom label (at the bottom of the screen).
Bool
Shows or hides the back button.
Bool
Enables or disables the swipe right to dismiss functionality.
Bool
Shows or hides the flash button.
Bool
Determines if toast messages will be displayed to the UI.
Bool
Enables or disables if images are auto saved when captured.
CGFloat
Changes the radius of the cutout corners.
Bool
Enables or disables validation of the front and back ID card scanning.
Bool
Enables or disables displaying help messages if the user is taking too long to scan.
Public constructors
init(license: String)
@objc public init(license: String)
Creates a new configuration with the specified license key.
Public variables
license
@objc final public var license: String { get }
Returns the license key you initialised the configuration with.
overlayColor
@objc final public var overlayColor: UIColor
Changes the color of the overlay.
Default: UIColor(red: 0, green: 0, blue: 0, alpha: 0.4)
Visual example:
Default
UIColor.green.withAlphaComponent(0.7)
overlayLabelTextColor
@objc final public var overlayLabelTextColor: UIColor
Changes the color of the top instruction message.
Default: UIColor(red: 1, green: 1, blue: 1, alpha: 1)
Visual example:
Default
UIColor.green
overlaySubLabelTextColor
@objc final public var overlaySubLabelTextColor: UIColor
Changes the color of the bottom instruction message.
Default: UIColor(red: 1, green: 1, blue: 1, alpha: 1)
Visual example:
Default
UIColor.green
overlayBorderColor
@objc final public var overlayBorderColor: UIColor
Changes the color of the border corners around the cutout.
Default: UIColor(red: 1, green: 1, blue: 1, alpha: 1)
Visual example:
Default
UIColor.green
overlayBorderThickness
@objc final public var overlayBorderThickness: CGFloat
Changes the thickness of the border corners around the cutout.
Default: 4
Setting this to 0 will disable the border
Visual example:
Default
10
overlayBorderLength
@objc final public var overlayBorderLength: CGFloat
Changes the length of the border corners around the cutout.
Default: 30
Setting this to 0 will disable the border
Visual example:
Default
100
overlayBlurStyle
@objc final public var overlayBlurStyle: UIBlurEffect.Style
Changes the style of the blur applied to the overlay.
Default: UIBlurEffect.Style.dark
Visual example:
Default
Light
overlayBlurIntensity
@objc final public var overlayBlurIntensity: CGFloat
Changes the intensity of the blur applied to the overlay. 1 being the most blur applied. 0 being no blur applied.
Default: 0.8
Setting this to 0 will disable the blur
Visual example:
Default
0
cameraPosition
@objc final public var cameraPosition: AVCaptureDevice.Position
Changes which camera will be used (front or back).
Default: AVCaptureDevice.Position.back
environmentKey
@objc final public var environmentKey: String
An encrypted key that changes the SDKs environment variables.
overlayBrandingTitleText
@objc final public var overlayBrandingTitleText: String
Changes the text of the top label (at the bottom of the screen).
Default: "INNOVATIONS LAB"
Visual example:
Default
Example Text
overlayBrandingTitleColor
@objc final public var overlayBrandingTitleColor: UIColor
Changes the color of the top label (at the bottom of the screen).
Default: UIColor(red: 1, green: 1, blue: 1, alpha: 1)
Visual example:
Default
UIColor.green
overlayBrandingSubtitleText
@objc final public var overlayBrandingSubtitleText: String
Changes the text of the bottom label (at the bottom of the screen).
Default: "A DIVISION OF SYBRIN"
Visual example:
Default
Example Text
overlayBrandingSubtitleColor
@objc final public var overlayBrandingSubtitleColor: UIColor
Changes the color of the bottom label (at the bottom of the screen).
Default: UIColor(red: 1, green: 1, blue: 1, alpha: 1)
Visual example:
Default
UIColor.green
enableBackButton
@objc final public var enableBackButton: Bool
Shows or hides the back button.
Default: true
Visual example:
Default
False
enableSwipeRightGesture
@objc final public var enableSwipeRightGesture: Bool
Enables or disables the swipe right to dismiss functionality.
Default: true
showFlashButton
@objc final public var showFlashButton: Bool
Shows or hides the flash button.
Default: true
The flash button will only show (when enabled) if the flash is available (like on the back camera).
Visual example:
Default
False
displayToastMessages
@objc final public var displayToastMessages: Bool
Determines if toast messages will be displayed to the UI.
Default: true
saveImages
@objc final public var saveImages: Bool
Enables or disables if images are auto saved when captured.
Default: false
cutoutCornerRadius
@objc final public var cutoutCornerRadius: CGFloat
Changes the radius of the cutout corners.
Default: 0
Visual example:
Default
25 - dark
25 - light
enableMultiPhaseVerification
@objc final public var enableMultiPhaseVerification: Bool
Enables or disables validation of the front and back ID card scanning.
Default: true
enableHelpMessages
@objc final public var enableHelpMessages: Bool
Enables or disables displaying help messages if the user is taking too long to scan.
Default: true
Visual example:
Default
Where this is used
Last updated