Classes

The following classes are available globally.

  • A utility class to read barcodes via camera

    See more

    Declaration

    Objective-C

    @interface BarcodeReader : NSObject

    Swift

    class BarcodeReader : NSObject

  • A utility object to create and control the camera

    See more

    Declaration

    Objective-C

    @interface Camera : NSObject <ZoomDelegate, TorchDelegate>

    Swift

    class Camera : NSObject, ZoomDelegate, TorchDelegate

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CameraUtils : NSObject

NS_ASSUME_NONNULL_BEGIN

+ (AVCaptureDevice *) deviceFromDeviceType:(AVCaptureDeviceType)deviceType mediaType:(nullable AVMediaType)mediaType position:(AVCaptureDevicePosition)position;
+ (NSArray<AVCaptureDeviceType>*) availableDeviceTypes;
+ (NSString*) deviceNameForType:(AVCaptureDeviceType) type;
+ (NSArray<AVCaptureDeviceFormat *> *)availableFormatsForDeviceType:(AVCaptureDeviceType) type;

NS_ASSUME_NONNULL_END

@end

    Swift

    class CameraUtils : NSObject

  • A class which represents the Info of the host app. Must needed for accessing APIManager

    See more

    Declaration

    Objective-C

    @interface AppInfo : NSObject

    Swift

    class AppInfo : NSObject

  • A model object to hold the scanned image

    See more

    Declaration

    Objective-C

    @interface ScanImage : NSObject <NSCoding, NSSecureCoding>

    Swift

    class ScanImage : NSObject, NSCoding, NSSecureCoding

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AuthenticationScanCandidate : NSObject

@property (nonatomic, strong, readonly, getter=getParsedContent) ParsedContent *content;
@property (nonatomic, strong, readonly, getter=getCodeOrigin) CodeOrigin *codeOrigin;

@property (nonatomic, readonly, getter=getQualityState) QualityState qualityState;
@property (nonatomic, readonly, getter=getBlurScore) double blurScore;
@property (nonatomic, readonly, getter=getTimestamp) unsigned long long timestamp;

/// Get the captured secure grpahic. nil if not available
@property (nonatomic, strong, readonly, getter=getSecureGraphicImage) ScanImage *secureGraphicImage;

/// Get the captured secure code (with SG). nil if not available
@property (nonatomic, strong, readonly, getter=getSecureCodeImage) ScanImage *secureCodeImage;

/// Get the captured secure code (with SG). nil if not available
@property (nonatomic, strong, readonly, getter=getImage) ScanImage *image;
@end

    Swift

    class AuthenticationScanCandidate : NSObject

  • A model class to hold the basic scan candidate which can be used to send network request

    See more

    Declaration

    Objective-C

    @interface BasicScanCandidate : NSObject <NSCoding, NSSecureCoding>

    Swift

    class BasicScanCandidate : NSObject, NSCoding, NSSecureCoding

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface Carrier : NSObject
@property (strong, readonly) ParsedContent* content;
@property (strong, readonly) AVMetadataObjectType type;
@property (readonly) CGPoint center;

- (instancetype)initWithContent: (ParsedContent *) content type:(AVMetadataObjectType) type center:(CGPoint) center;
@end

    Swift

    class Carrier : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface PointF : NSObject
@property float x;
@property float y;
@end

    Swift

    class PointF : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CodeDetectionObject : NSObject

@property (readonly) AVMetadataObjectType type;
@property (readonly) CMTime time;
@property (readonly) CMTime duration;
@property (readonly) NSArray<NSDictionary *>* corners;
@property (readonly) CGPoint center;
@property (readonly) CGSize frameSize;
@property (readonly) CGSize codeCells;

@property (readonly) NSString* content;

- (instancetype) initWithAVMetadataMachineReadableCodeObject:(AVMetadataMachineReadableCodeObject *)metadataObject frameSize:(CGSize) frameSize;
- (instancetype) initWithAVMetadataMachineReadableCodeObject:(AVMetadataMachineReadableCodeObject *)metadataObject codeCells:(CGSize) codeCells frameSize:(CGSize) frameSize;

- (BOOL)hasValidCodeCellsInfo;

@end

    Swift

    class CodeDetectionObject : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CodeOrigin : NSObject<NSCoding, NSSecureCoding>

/*! The raw content string. */
@property (nonatomic, strong, readonly) NSString* apiHost;

/*! The code ID */
@property (nonatomic, strong, readonly) NSString* codeSpace;

- (instancetype) initApiHost:(NSString*) apiHost codeSpace:(NSString*) codeSpace;

@end

    Swift

    class CodeOrigin : NSObject, NSCoding, NSSecureCoding

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface Configuration : NSObject<NSCopying>

@property (nonatomic, readonly) double  qrCodeBlurThreshold;
@property (nonatomic, readonly) double  secureGraphicBlurThreshold;
@property (nonatomic, readonly) double  glareThreshold;
@property (nonatomic, readonly) float   zoomFactor;
@property (nonatomic, readonly) float   initialZoomFactor;
@property (nonatomic, readonly) float   upscaleZoomFactorLimit;
@property (nonatomic, readonly) double  minimumCaptureResolution;
@property (nonatomic, readonly) double  maximumCaptureResolution;
@property (nonatomic, readonly) bool    limitedMode;
@property (nonatomic, readonly) AVCaptureDeviceType captureDeviceType;
@property (nonatomic, readonly) double   torchPowerRatio;

@property (nonatomic, readonly) CGSize frameSize;

@property (strong, nonatomic, readonly) AVCaptureDeviceFormat *preferredFormat;
@property (readonly) NSUInteger preferredFormatIndex;

@property (readonly, getter=isDefault) BOOL isDefault;

- (void) setFormatFromType:(AVCaptureDeviceType) type andIndex:(NSUInteger)index;
- (NSDictionary *) toDictionary;
- (void) updateWithDictionary:(NSDictionary *) dict;

@end

    Swift

    class Configuration : NSObject, NSCopying

  • A model object to hold the details of the scanned code

    See more

    Declaration

    Objective-C

    @interface ParsedContent : NSObject <NSCoding, NSSecureCoding>

    Swift

    class ParsedContent : NSObject, NSCoding, NSSecureCoding

  • A model class which represents the brand details and to represent the details about brand which was associcated to the scanned QR code

    See more

    Declaration

    Objective-C

    @interface STBrand : NSObject <NSCoding, NSCopying>

    Swift

    class STBrand : NSObject, NSCoding, NSCopying

  • A model class which represents the product details and to represent the details about product which was associcated to the scanned QR code

    See more

    Declaration

    Objective-C

    @interface STProduct : NSObject <NSCoding, NSCopying>

    Swift

    class STProduct : NSObject, NSCoding, NSCopying

  • A serializable model object to perform request via APIManager

    See more

    Declaration

    Objective-C

    @interface SerializableAuthenticationRequestData
    : NSObject <NSCoding, NSSecureCoding>

    Swift

    class SerializableAuthenticationRequestData : NSObject, NSCoding, NSSecureCoding

  • A utitlity class used to perform all the different calls to ScanTrust’s backend server.

    See more

    Declaration

    Objective-C

    @interface APIManager

    Swift

    class APIManager

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface AuthenticationDetails : NSObject
@property (readonly) BOOL codeExists;

@property (readonly) ActivationStatus activationStatus;
@property (readonly) TrainingStatus trainingStatus;

@property (readonly) double blurThresholdAdjustment;
@property (readonly, strong) NSString* encodedParameters;

+ (instancetype) newWithDictionnary: (NSDictionary*) dict;

- (instancetype) initWithEncodedParameters:(NSString *) encodedParameters
                   blurThresholdAdjustment:(double) blurThresholdAdjustment
                          activationStatus:(ActivationStatus) activationStatus
                            trainingStatus:(TrainingStatus) trainingStatus;

@end

    Swift

    class AuthenticationDetails : NSObject

  • The entry point of the Scantrust Processing is the ScanEngine, this class does all the heavy lifting, setting up the camera and the preview (view finder) view, running the image processing on the incoming frames and reporting the various outcomes.

    See more

    Declaration

    Objective-C

    @interface ScanEngine : NSObject

    Swift

    class ScanEngine : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface CodeOriginManager : NSObject
+(CodeOrigin*) getCodeOrigin:(NSString*) content;
@end

    Swift

    class CodeOriginManager

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface ContentParser : NSObject
+(ParsedContent*) parseContent:(NSString*) content;
@end

    Swift

    class ContentParser

  • A utility object for the camera settings

    See more

    Declaration

    Objective-C

    @interface SupportedDeviceCameraSettings : NSObject

    Swift

    class SupportedDeviceCameraSettings : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface DeviceManager : NSObject

    Swift

    class DeviceManager : NSObject

  • STLocationManager is a singleton utility class to take of all geo location service methods on top of CLLocationManager. Use this class to get the authorization status of location permission, ask for authorization, start updating as well as stop updating the location pooling.

    See more

    Declaration

    Objective-C

    @interface STLocationManager : NSObject

    Swift

    class STLocationManager : NSObject

  • A subclass of UIView to represent the camera preview and extendes from UIView Which hold the preview layer to customize and view the camera frames

    Declaration

    Objective-C

    @interface DebugPreviewView : OverlaidPreview

    Swift

    class DebugPreviewView : OverlaidPreview

  • A subclass of UIView to represent the camera preview and extendes from UIView Which hold the preview layer to customize and view the camera frames

    Provides with a very basic overlay with QR code markers to fit the QR code in a box

    Declaration

    Objective-C

    @interface OverlaidPreview : PreviewView

    Swift

    class OverlaidPreview : PreviewView

  • A subclass of UIView to represent the camera preview and extendes from UIView Which hold the preview layer to customize and view the camera frames

    See more

    Declaration

    Objective-C

    @interface PreviewView

    Swift

    class PreviewView