SBSDKUIWorkflow


@interface SBSDKUIWorkflow : NSObject

Represents a scanning workflow, consisting of multiple steps, each of it performing an image scan. You can combine document scanning with QR code detection or machine readable zone recognition. Many steps can be run on a captured still image or a video frame, so a step can either be a live-detection or a still-image capturing step. In the end, when all steps have finished you can validate all step results in a single block, and restart the whole workflow if the validation fails. By subclassing ‘SBSDKUIWorkflowStep’ the creation of custom steps is possible.

  • The array of steps to execute.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) NSArray<SBSDKUIWorkflowStep *> *steps;

    Swift

    var steps: [SBSDKUIWorkflowStep] { get }

  • The workflow validation handler. Return an error if you want to fail the workflow validation. Return nil to finish the workflow.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) SBSDKUIWorkflowValidationHandler workflowValidationHandler;

    Swift

    var workflowValidationHandler: SBSDKUIWorkflowValidationHandler? { get }

  • The name of the workflow for identification purposes.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSString *name;

    Swift

    var name: String? { get }

  • Not available.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Not available.

    Declaration

    Objective-C

    + (nonnull instancetype)new;

  • Designated initializer.

    Declaration

    Objective-C

    - (nullable instancetype)
        initWithSteps:(nonnull NSArray<SBSDKUIWorkflowStep *> *)steps
                 name:(nullable NSString *)name
    validationHandler:
        (nullable SBSDKUIWorkflowValidationHandler)validationHandler;

    Swift

    init?(steps: [SBSDKUIWorkflowStep], name: String?, validationHandler: SBSDKUIWorkflowValidationHandler? = nil)

    Parameters

    steps

    The array of steps the workflow consists of.
    name

    The name of the workflow for identification.
    validationHandler

    The workflow validation block.