SBSDKUITextDataScannerStep

@interface SBSDKUITextDataScannerStep : NSObject

Defines a single workflow step of ‘SBSDKUITextDataScannerViewController’ flow.

  • The tag of the workflow step. Useful managing multiple workflow steps. By default it is a UUID string.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *stepTag;

    Swift

    var stepTag: String { get set }

  • The title of the step. By default it is an empty.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *title;

    Swift

    var title: String { get set }

  • A user guidance hint for this workflow step. The guidance hint is displayed while the workflow step is active.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) NSString *guidanceText;

    Swift

    var guidanceText: String { get set }

  • Sets a validation pattern to validate to automatically validate recognized text. ‘?’ = any character ‘#’ - any digit All other characters represent themselves.

    An empty string or nil value will disable the validation pattern.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *pattern;

    Swift

    var pattern: String? { get set }

  • If set to YES pattern validation also validates successfully if only a part of the whole recognized text matches the the validation pattern. If set to NO, the whole text must match the validation pattern. Applies to pattern validation only. Defaults to NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldMatchSubstring;

    Swift

    var shouldMatchSubstring: Bool { get set }

  • Callback block for recognized text validation. If pattern validation is not powerful enough, you can specify your own validation block here. Defaults to nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) SBSDKTextLineRecognizerValidationBlock validationBlock;

    Swift

    var validationBlock: SBSDKTextLineRecognizerValidationBlock? { get set }

  • Callback to clean a recognized text prior to validation. Filter out unwanted phrases and textual noise here. Default is nil.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) SBSDKTextLineRecognizerTextSanitizerBlock stringSanitizerBlock;

    Swift

    var stringSanitizerBlock: SBSDKTextLineRecognizerTextSanitizerBlock? { get set }

  • The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height;

    Declaration

    Objective-C

    @property (nonatomic) CGFloat preferredZoom;

    Swift

    var preferredZoom: CGFloat { get set }

  • The aspect ratio for the workflow steps region of interest and, equally, for the finder view. Defaults to 5:1.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) SBSDKAspectRatio *aspectRatio;

    Swift

    var aspectRatio: SBSDKAspectRatio { get set }

  • The preferred height of the finder for zoom scale 1.0 (unzoomed). The actual finder height might change to maintain aspect ratio and to not clip the screen. Defaults to 40 points.

    Declaration

    Objective-C

    @property (nonatomic) CGFloat unzoomedFinderHeight;

    Swift

    var unzoomedFinderHeight: CGFloat { get set }

  • A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted. Defaults to nil.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *allowedSymbols;

    Swift

    var allowedSymbols: String? { get set }

  • The text filter strategy for the text line recognizer step. Defaults to SBSDKTextFilterStrategyDocument.

    Declaration

    Objective-C

    @property (nonatomic) SBSDKTextFilterStrategy textFilterStrategy;

    Swift

    var textFilterStrategy: SBSDKTextFilterStrategy { get set }