SBSDKUIIDCardScannerBehaviorConfiguration

@interface SBSDKUIIDCardScannerBehaviorConfiguration : NSObject

Configuration for the behavior of ID card scanner.

  • Whether the torch light is toggled on or off.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isFlashEnabled) BOOL flashEnabled;

    Swift

    var isFlashEnabled: Bool { get set }

  • Defines, if signature image should be stored in internal storage (SBSDKUIIDCardStorage) on disk.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldSaveSignatureImageInStorage;

    Swift

    var shouldSaveSignatureImageInStorage: Bool { get set }

  • Defines, if photo image should be stored in internal storage (SBSDKUIIDCardStorage) on disk.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldSavePhotoImageInStorage;

    Swift

    var shouldSavePhotoImageInStorage: Bool { get set }

  • Array of recognizable document types. Pass an empty array or nil to accept all supported document types. Default value is nil, accepting all supported document types.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) NSArray<SBSDKIDCardType *> *acceptedDocumentTypes;

    Swift

    var acceptedDocumentTypes: [SBSDKIDCardType]? { get set }

  • The accepted minimal sharpness score. Images with a score less than that will be rejected with blurry status.

    0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.

    The default value is 80.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat sharpnessAcceptanceFactor;

    Swift

    var sharpnessAcceptanceFactor: CGFloat { get set }