Type Definitions

The following type definitions are available globally.

  • An enum describing the current state of the app.

    See more

    Declaration

    Objective-C

    typedef enum SBSDKApplicationState SBSDKApplicationState

  • The status of the license.

    See more

    Declaration

    Objective-C

    typedef enum dooLicenseStatus dooLicenseStatus

  • A block type used on informing observers about progress updating.

    Declaration

    Objective-C

    typedef void (^SBSDKProgessUpdateHandler)(SBSDKProgress *_Nonnull)

    Swift

    typealias SBSDKProgessUpdateHandler = (SBSDKProgress) -> Void

    Parameters

    progress

    The progress object that called the update handler.

  • The type of the completion block that each asynchronous ScanbotSDK operation call upon completion.

    Declaration

    Objective-C

    typedef void (^SBSDKCompletionHandler)(
    BOOL, NSError *_Nullable, NSDictionary<NSString *, NSObject *> *_Nullable)

    Swift

    typealias SBSDKCompletionHandler = (Bool, Error?, [String : NSObject]?) -> Void

    Parameters

    finished

    YES, if the operation was finished successfully. NO, if the operation failed or was cancelled.
    error

    An error describing the reason for an unsuccessful operation.
    resultInfo

    A dictionary containing the results

  • An enum describing the resolution of a video or camera stream.

    See more

    Declaration

    Objective-C

    typedef enum SBSDKVideoFrameResolution SBSDKVideoFrameResolution

  • Typealias for license failure handling block. *

    Declaration

    Objective-C

    typedef void (^SBSDKLicenseFailureHandler)(dooLicenseStatus, dooFeature,
                                           NSString *_Nullable)

    Swift

    typealias SBSDKLicenseFailureHandler = (dooLicenseStatus, dooFeature, String?) -> Void