SBSDKUIWorkflowStepResult Class Reference


                    
                    
                    step

The workflow step the receiver belongs to.

Declaration

Objective-C

@property (readonly, nonatomic, nonnull) SBSDKUIWorkflowStep *step;

Swift

var step: SBSDKUIWorkflowStep { get }


                    
                    
                    validationError

If the validation of the workflow step returns an error, it is stored here. Nil if validation was successful.

Declaration

Objective-C

@property (readonly, nonatomic, nullable) NSError *validationError;

Swift

var validationError: Error? { get }


                    
                    
                    capturedPage

The high-res still image, if the step requested one.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable) SBSDKUIPage *capturedPage;

Swift

var capturedPage: SBSDKUIPage? { get set }


                    
                    
                    videoFramePage

The low-res video frame image, if the step requested one.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable) SBSDKUIPage *videoFramePage;

Swift

var videoFramePage: SBSDKUIPage? { get set }


                    
                    
                    barcodeResults

Array of detected machine readable codes, if the step requested them.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    NSArray<SBSDKBarcodeScannerResult *> *barcodeResults;

Swift

var barcodeResults: [SBSDKBarcodeScannerResult]? { get set }


                    
                    
                    mrzResult

The machine readable zone recognition result, if requested by the step.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SBSDKMachineReadableZoneRecognizerResult *mrzResult;

Swift

var mrzResult: SBSDKMachineReadableZoneRecognizerResult? { get set }


                    
                    
                    disabilityCertificateResult

The disability certificate recognition result, if requested by the step.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SBSDKDisabilityCertificatesRecognizerResult *disabilityCertificateResult;

Swift

var disabilityCertificateResult: SBSDKDisabilityCertificatesRecognizerResult? { get set }


                    
                    
                    payformResult

The payform recognition result, if requested by the step.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SBSDKPayFormRecognitionResult *payformResult;

Swift

var payformResult: SBSDKPayFormRecognitionResult? { get set }


                    
                    
                    ehicResult

The health insurance card recognition result, if requested by the step.

Declaration

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SBSDKHealthInsuranceCardRecognitionResult *ehicResult;

Swift

var ehicResult: SBSDKHealthInsuranceCardRecognitionResult? { get set }


                    
                    
                    -init

Not available.

Declaration

Objective-C

- (nonnull instancetype)init;


                    
                    
                    +new

Not available.

Declaration

Objective-C

+ (nonnull instancetype)new;


                    
                    
                    -initWithStep:

Designated initializer. Usually you must not create instances of this class, except when you create custom workflow steps.

Declaration

Objective-C

- (nonnull instancetype)initWithStep:(nonnull SBSDKUIWorkflowStep *)step;

Swift

init(step: SBSDKUIWorkflowStep)

Parameters


                                step

The workflow step this result belongs to.


                    
                    
                    -thumbnail

A thumbnail of either the high-res still image or the low-res video frame, depending on what was requested. If none of both was requested thumbnail may be nil.

Declaration

Objective-C

- (nullable UIImage *)thumbnail;

Swift

func thumbnail() -> UIImage?