Constants

The following constants are available globally.

  • Deprecated

    will be remove.

    Default zoom factor used in the SDK

    Declaration

    Objective-C

    static const float kZoomFactor = 4.F

    Swift

    let kZoomFactor: Float

  • Deprecated

    will be remove.

    Declaration

    Objective-C

    static NSString *const kScanProgress = @"scan_progress"

    Swift

    let kScanProgress: String

  • Deprecated

    will be remove.

    Declaration

    Objective-C

    static NSString *const kScannedQRCode = @"qr_code"

    Swift

    let kScannedQRCode: String

  • Deprecated

    will be remove.

    Declaration

    Objective-C

    static NSString *const kBlurScore = @"blur_score"

    Swift

    let kBlurScore: String

  • Deprecated

    will be remove.

    Declaration

    Objective-C

    static NSString *const kZoomLevel = @"zoom_level"

    Swift

    let kZoomLevel: String

Error Constants

  • Deprecated

    use ‘kHTTPError’ in ‘Errors.h’ instead.

    Undocumented

    Declaration

    Objective-C

    __deprecated_msg("use 'kHTTPError' in 'Errors.h' instead.")
static NSString * const STHTTPError  = @"com.scantrust.network.HTTPError"

    Swift

    let STHTTPError: String

  • Deprecated

    use ‘kSTCameraErrorDomain’ in ‘Errors.h’ instead.

    Undocumented

    Declaration

    Objective-C

    __deprecated_msg("use 'kSTCameraErrorDomain' in 'Errors.h' instead.")
static NSString * const STCameraErrorDomain   = @"com.scantrust.enterprise.ios.authenticate.CameraErrorDomain"

    Swift

    let STCameraErrorDomain: String

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTDebugCarrierDetected        = @"com.scantrust.debug.carrierdetected"

    Swift

    let kSTDebugCarrierDetected: String

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTDebugMarkersDetected        = @"com.scantrust.debug.markersdetected"

    Swift

    let kSTDebugMarkersDetected: String

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTDebugQualityDetails        = @"com.scantrust.debug.qualitydetails"

    Swift

    let kSTDebugQualityDetails: String

Errors

  • Error Domain for Camera setup failures

    Declaration

    Objective-C

    static NSString *const kSTCameraErrorDomain =
    @"com.scantrust.enterprise.ios.authenticate.CameraErrorDomain"

  • Unexpected Network error

    Declaration

    Objective-C

    static NSString *const kSTHTTPDomainMismatchError =
    @"com.scantrust.sdk.network.DomainMismatchError"

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTHTTPError  = @"com.scantrust.sdk.network.HTTPError"

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTDataParsingError  = @"com.scantrust.sdk.network.DataParsingError"

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTSDKConfigurationError  = @"com.scantrust.sdk.SDKConfigurationError"

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kTSDKUsageError  = @"com.scantrust.sdk.SDKUsageError"

Internal Errors

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTCodeNotFound  = @"com.scantrust.sdk.CodeNotFound"

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kInvalidStateMachinJump = @"com.scantrust.sdk.InvalidStateMachinJump"

  • Undocumented

    Declaration

    Objective-C

    static NSString * const kSTCameraOutputSetupError = @"com.scanturst.sdk.CameraOutputSetupError"

  • @userInfo: NSDictionnary @“lowerBounds”: NSValue(CGSize), @“upperBounds”: NSValue(CGSize), @“target”: NSValue(CGSize), @“frameSize”: NSValue(CGSize), @“layout”: NSNumber(int)

    Declaration

    Objective-C

    static NSString *const kSTTargetedSizeUpdated =
    @"com.scantrust.sdk.codetargetedsizeupdated"

  • @userInfo: NSDictionnary @“parsedContent”: ParsedContent

    Declaration

    Objective-C

    static NSString *const kSTCarrierRead = @"com.scantrust.sdk.carrierRead"

  • @userInfo: NSDictionnary @“oldStateIndex”: NSValue(NSinteger), => old state of the scan engine @“newStateIndex”: NSValue(NSInteger), => new state of the scan engine @“StateCounts”: NSValue(NSInteger), => new state of the scan engine

    Declaration

    Objective-C

    static NSString *const kSTScanEngineStateChanged =
    @"com.scantrust.sdk.scanenginestatechanged"

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString* const kST_SDKVersion

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString* const kST_SDKVersionHash

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString* const kST_SDKBuildNumber

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString* const kST_SDKNativeVersion

  • Undocumented

    Declaration

    Objective-C

    FOUNDATION_EXPORT NSString* const kST_SDKNativeVersionHash

  • Undocumented

    Declaration

    Objective-C

    extern double ios_frameworkVersionNumber

  • Undocumented

    Declaration

    Objective-C

    extern const unsigned char ios_frameworkVersionString[]