Classes

Objective-C

@interface RGLAccessControlProcedureType : NSObject

@property(nonatomic, assign, readonly) NSInteger activeOptionIdx;
@property(nonatomic, strong, readonly, nonnull) NSArray <NSNumber *> *notifications;
@property(nonatomic, assign, readonly) RGLRFIDErrorCodes status;
@property(nonatomic, assign, readonly) RGLRFIDAccessControlProcedureType type;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class AccessControlProcedureType : NSObject

Objective-C

@interface RGLActivityIndicator : UIActivityIndicatorView

@end

Swift

class ActivityIndicator : UIActivityIndicatorView

Objective-C

@interface RGLApplication : NSObject

@property(nonatomic, strong, readonly, nonnull) NSString *applicationID;
@property(nonatomic, strong, readonly, nonnull) NSString *dataHashAlgorithm;
@property(nonatomic, strong, readonly, nonnull) NSArray <RGLFile *> *files;
@property(nonatomic, assign, readonly) NSInteger type;
@property(nonatomic, assign, readonly) RGLRFIDErrorCodes status;
@property(nonatomic, strong, readonly, nonnull) NSString *unicodeVersion;
@property(nonatomic, strong, readonly, nonnull) NSString *version;


- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class Application : NSObject

Objective-C

@interface RGLAttribute : NSObject

@property(nonatomic, strong, readonly, nonnull) NSString *type;
@property(nonatomic, strong, readonly, nonnull) RGLRFIDValue *value;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class Attribute : NSObject

Objective-C

@interface RGLAuthenticityCheck : NSObject

@property(nonatomic, assign, readonly) RGLAuthenticity type;
@property(nonatomic, strong, readonly, nonnull) NSString *typeName;
@property(nonatomic, assign, readonly) RGLCheckResult status;
@property(nonatomic, strong, readonly, nullable) NSArray <RGLAuthenticityElement *> *elements;
@property(nonatomic, assign, readonly) NSInteger pageIndex;

- (instancetype _Nonnull)initWithAuthenticity:(RGLAuthenticity)type elements:(NSArray <RGLAuthenticityElement *> *_Nullable)elements pageIndex:(NSInteger)pageIndex;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class AuthenticityCheck : NSObject

Objective-C

@interface RGLAuthenticityElement : NSObject

@property(nonatomic, assign, readonly) RGLCheckResult status;
@property(nonatomic, assign, readonly) RGLSecurityFeatureType elementType;
@property(nonatomic, strong, readonly, nonnull) NSString *elementTypeName;
@property(nonatomic, assign, readonly) RGLCheckDiagnose elementDiagnose;
@property(nonatomic, strong, readonly, nonnull) NSString *elementDiagnoseName;

- (instancetype _Nonnull)initWithStatus:(RGLCheckResult)status elementType:(RGLSecurityFeatureType)elementType elementDiagnose:(RGLCheckDiagnose)elementDiagnose;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class AuthenticityElement : NSObject

Objective-C

@interface RGLAuthenticityParams : NSObject

/// This parameter is used to enable document liveness check.
/// Type: Bool.
@property(nullable, nonatomic, strong) NSNumber *useLivenessCheck;
@property(nullable, nonatomic, strong) RGLLivenessParams *livenessParams;
@property(nullable, nonatomic, strong) NSNumber *checkUVLuminiscence;
@property(nullable, nonatomic, strong) NSNumber *checkIRB900;
@property(nullable, nonatomic, strong) NSNumber *checkImagePatterns;
@property(nullable, nonatomic, strong) NSNumber *checkFibers;
@property(nullable, nonatomic, strong) NSNumber *checkExtMRZ;
@property(nullable, nonatomic, strong) NSNumber *checkExtOCR;
@property(nullable, nonatomic, strong) NSNumber *checkAxial;
@property(nullable, nonatomic, strong) NSNumber *checkBarcodeFormat;
@property(nullable, nonatomic, strong) NSNumber *checkIRVisibility;
@property(nullable, nonatomic, strong) NSNumber *checkIPI;
@property(nullable, nonatomic, strong) NSNumber *checkPhotoEmbedding;
@property(nullable, nonatomic, strong) NSNumber *checkPhotoComparison;
@property(nullable, nonatomic, strong) NSNumber *checkLetterScreen;

RGL_EMPTY_INIT_UNAVAILABLE

+ (instancetype)defaultParams;

@end

Swift

class AuthenticityParams : NSObject

Objective-C

@interface RGLAuthority : NSObject

@property(nonatomic, strong, readonly, nonnull) NSArray <RGLAttribute *> *attributes;
@property(nonatomic, strong, readonly, nonnull) NSString *data;
@property(nonatomic, strong, readonly, nonnull) RGLRFIDValue *friendlyName;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class Authority : NSObject

Objective-C

@interface RGLBackendProcessingConfig : NSObject

@property(nonatomic, strong, nullable) NSString *url;
@property(nonatomic, strong, nullable) NSDictionary *httpHeaders;
@property(nonatomic, strong, nullable) NSNumber *rfidServerSideChipVerification;

@end

Swift

class RGLBackendProcessingConfig : NSObject

Objective-C

@interface RGLBarcodePosition : RGLPosition

@end

Swift

class BarcodePosition : Position

Objective-C

@interface RGLBaseConfig : NSObject

@property (nonatomic, strong, nullable) RGLOnlineProcessingConfig *onlineProcessingConfig;

/// Documents processing scenario.
@property (nonatomic, strong, nullable) NSString *scenario;

/// Live portrait photo.
/// Requires network connection.
@property (nonatomic, strong, nullable) UIImage *livePortrait;
/// Portrait photo from an external source.
/// Requires network connection.
@property (nonatomic, strong, nullable) UIImage *extPortrait;

RGL_EMPTY_INIT_UNAVAILABLE

- (instancetype)initWithScenario:(NSString *)scenario;
- (instancetype)initWithOnlineProcessingConfig:(RGLOnlineProcessingConfig *)onlineProcessingConfig;

@end

Objective-C

@interface RGLBaseReaderConfig : NSObject

// Enables automatic license update check during `DocumentReader` initialization.
/// Defaults to `true`.
@property(readwrite, nonatomic, assign) BOOL licenseUpdateCheck;

/// The path to the database file.
@property(readwrite, nonatomic, copy, nullable) NSString *databasePath;

/// Defines whether the `DocumentReader` delays loading of neural networks. Defaults to `false`.
///
/// When set to `true` the initialization starts in the background thread after a completion block passed to the method
/// `-[RGLDocReader initializeReaderWithConfig:completion:]` is called. If the document processing is initiated before all the networks are loaded,
/// the `DocumentReader` will wait for it before starting the handling.
///
/// When set to `false` the initialization is performed during `DocumentReader` initialization `-[RGLDocReader initializeReaderWithConfig:completion:]` method.
@property(readwrite, nonatomic, assign, getter=isDelayedNNLoadEnabled) BOOL delayedNNLoadEnabled;

RGL_EMPTY_INIT_UNAVAILABLE

@end

Objective-C

@interface RGLBleConfig : RGLBaseReaderConfig

Objective-C

@interface RGLBluetooth : NSObject

/// Device name of connected periphery.
@property (nonatomic, strong, readonly) NSString *deviceName;

/// Indicates whether Redula device flash light is on.
@property (nonatomic, assign, readonly) BOOL isFlashing;

/// Battery level of connected device.
@property (nonatomic, assign, readonly) NSUInteger batteryLevel;

@property (nullable, nonatomic, strong, readonly) NSString *manufacturerName;
@property (nullable, nonatomic, strong, readonly) NSString *modelNumber;
@property (nullable, nonatomic, strong, readonly) NSString *serialNumber;
@property (nullable, nonatomic, strong, readonly) NSString *hardwareRevision;
@property (nullable, nonatomic, strong, readonly) NSString *firmwareRevision;
@property (nullable, nonatomic, strong, readonly) NSString *softwareRevision;
@property (nullable, nonatomic, strong, readonly) NSString *hardwareId;

/// Connection state of connected Regula device
@property (nonatomic, assign, readonly) RGLBluetoothConnectionState state;

/// The delegate object that will receive `RGLBluetooth` events.
@property (nullable, nonatomic, weak) id<RGLBluetoothDelegate> delegate;

- (instancetype)init NS_DESIGNATED_INITIALIZER;

/// Flashes Regula device light.
- (void)actionFlashOn;

/// Starts to establish connection with Regula device.
/// - Parameter deviceName: Name of the device
- (void)connectWithDeviceName:(NSString *)deviceName;

/// Starts to establish connection with Regula device.
/// - Parameter periphery: Periphery instance
- (void)connectPeriphery:(CBPeripheral *)periphery;

/// Scans for all available Regula devices for a short period of time.
/// Callbacks are available through `RGLBluetoothDelegate didFindDevice:bluetooth:device`
- (void)startSearchDevices;

/// Stops Regula devices scanning
- (void)stopSearchDevices;

/// Stops current connection.
- (void)disconnect;

/// Indicates whether Regula Device connected and available for usage
- (BOOL)isPowerOn;

@end

Swift

class Bluetooth : NSObject

Objective-C

@interface RGLBytesData : NSObject

@property(nonatomic, readonly, strong, nonnull) NSString *data;
@property(nonatomic, readonly, assign) NSInteger length;
@property(nonatomic, readonly, assign) NSInteger status;
@property(nonatomic, readonly, assign) NSInteger type;

RGL_EMPTY_INIT_UNAVAILABLE

@end

Swift

class BytesData : NSObject

Objective-C

@interface RGLCardProperties : NSObject

@property(nonatomic, assign, readonly) NSInteger aTQA;
@property(nonatomic, strong, readonly, nonnull) NSString *aTQB;
@property(nonatomic, strong, readonly, nonnull) NSString *aTR;
@property(nonatomic, strong, readonly, nonnull) NSString *baudrate1;
@property(nonatomic, strong, readonly, nonnull) NSString *baudrate2;
@property(nonatomic, assign, readonly) NSInteger bitRateR;
@property(nonatomic, assign, readonly) NSInteger bitRateS;
@property(nonatomic, assign, readonly) NSInteger chipTypeA;
@property(nonatomic, assign, readonly) NSInteger mifareMemory;
@property(nonatomic, assign, readonly) NSInteger rfidType;
@property(nonatomic, assign, readonly) NSInteger sAK;
@property(nonatomic, assign, readonly) BOOL support4;
@property(nonatomic, assign, readonly) BOOL supportMifare;
@property(nonatomic, strong, readonly, nonnull) NSString *uID;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class CardProperties : NSObject

Objective-C

@interface RGLCertificateChain : NSObject

@property(nonatomic, strong, readonly, nonnull) NSArray <RGLExtension *> *extensions;
@property(nonatomic, strong, readonly, nonnull) RGLRFIDValue *fileName;
@property(nonatomic, strong, readonly, nonnull) RGLAuthority *issuer;
@property(nonatomic, strong, readonly, nonnull) NSArray <NSNumber *> *notifications;
@property(nonatomic, assign, readonly) NSInteger origin;
@property(nonatomic, assign, readonly) double paStatus;
@property(nonatomic, strong, readonly, nonnull) NSString *serialNumber;
@property(nonatomic, strong, readonly, nonnull) NSString *signatureAlgorithm;
@property(nonatomic, strong, readonly, nonnull) RGLAuthority *subject;
@property(nonatomic, strong, readonly, nonnull) NSString *subjectPKAlgorithm;
@property(nonatomic, assign, readonly) RGLRFIDCertificateType type;
@property(nonatomic, strong, readonly, nonnull) RGLValidity *validity;
@property(nonatomic, assign, readonly) NSInteger version;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class CertificateChain : NSObject

Objective-C

@interface RGLCertificateData : NSObject

@property(nonatomic, strong, readonly, nonnull) NSString *data;
@property(nonatomic, assign, readonly) NSInteger length;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class CertificateData : NSObject

Objective-C

@interface RGLConfig : RGLBaseReaderConfig

Objective-C

@interface RGLCornerView : UIView

@property(nonatomic) CGFloat lineLength;
@property(nonatomic) CGFloat lineWidth;
@property(nonatomic) CGFloat cornerRadius;
@property(nonatomic) CGLineCap lineCap;
@property(nonatomic, strong) UIColor *lineColor;
@property(nonatomic, assign) RGLCameraFrameShapeType shapeType;

@end

Swift

class CornerView : UIView

Objective-C

@interface RGLCustomization : NSObject

/// If it's set to true, the animation showing how to position a document will be displayed. Default: false.
@property(nonatomic, assign) BOOL showHelpAnimation;

/// Allows you to set any UIImage for the help animation.
@property(nonatomic, strong, nullable) UIImage *helpAnimationImage;

/// If it's set to true, status messages during the document processing will be shown. Default: true.
@property(nonatomic, assign) BOOL showStatusMessages;

/// If it's set to true, result status messages during the document processing will be shown. Default: true.
@property(nonatomic, assign) BOOL showResultStatusMessages;

/// Allows you to set any NSString to the status.
@property(nonatomic, strong, nullable) NSString *status;

/// Allows you to set any NSString to the result status.
@property(nonatomic, strong, nullable) NSString *resultStatus;

/// Allows you to change the location of the status.
/// For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800, your message will be centralized and located at 200 px from the top,
/// i.e. (800 / 2) * 0.5 = 200 px. If the multiplier is equal to 1, the message will be centered.
/// If the multiplier is equal to zero, the default location will be used. Default: 0.
@property(nonatomic, assign) CGFloat statusPositionMultiplier;

/// Allows you to change the location of the result status.
/// For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800, your message will be centralized and located at 200 px from the top,
/// i.e. (800 / 2) * 0.5 = 200 px. If the multiplier is equal to 1, the message will be centered.
/// If the multiplier is equal to zero, the default location will be used. Default: 0.
@property(nonatomic, assign) CGFloat resultStatusPositionMultiplier;

/// Allows you to set a shape type for the camera frame. Default: RGLCameraFrameShapeTypeLine.
@property(nonatomic, assign) RGLCameraFrameShapeType cameraFrameShapeType;

/// Allows you to customize the beginning and ending of stroked lines of the camera frame. Default: kCGLineCapButt.
@property(nonatomic, assign) CGLineCap cameraFrameLineCap;

/// Allows you to set a background color for the camera preview (top and bottom frames). Default: UIColor.blackColor.
@property(nonatomic, strong, nullable) UIColor *cameraPreviewBackgroundColor;

/// Allows you to set a color for all visual elements.
@property(nonatomic, strong, null_resettable) UIColor *tintColor;

/// Allows you to set a color for the result status messages. Default: UIColor.whiteColor.
@property(nonatomic, strong, null_resettable) UIColor *resultStatusTextColor;

/// Allows you to set a font for the result status messages.
@property(nonatomic, strong, null_resettable) UIFont *resultStatusTextFont;

/// Allows you to set a color of the background for the result status messages.
@property(nonatomic, strong, nullable) UIColor *resultStatusBackgroundColor;

/// Allows you to set a color for the camera frame when a document is out of the camera frame or is not detected. Default: UIColor.whiteColor.
@property(nonatomic, strong, null_resettable) UIColor *cameraFrameDefaultColor;

/// Allows you to set a color for the camera frame when a document is detected. Default: UIColor.greenColor.
@property(nonatomic, strong, null_resettable) UIColor *cameraFrameActiveColor;

/// Allows you to set thickness of the camera frame borders. Default: 3.
@property(nonatomic, assign) CGFloat cameraFrameBorderWidth;

/// Allows you to set a color for the status messages. Default: UIColor.whiteColor.
@property(nonatomic, strong, nullable) UIColor *statusTextColor;

/// Allows you to set a font for the status messages.
@property(nonatomic, strong, null_resettable) UIFont *statusTextFont;

/// Allows you to set a background color for the status messages. Default: UIColor.clearColor.
@property(nonatomic, strong, nullable) UIColor *statusBackgroundColor;

/// Allows you to set a color for the activity indicator.
@property(nonatomic, strong, nullable) UIColor *activityIndicatorColor;

/// Allows you to set a color for the "Skip next page" button.
@property(nonatomic, strong, nullable) UIColor *multipageButtonBackgroundColor;

/// Allows you to set any UIImage for the multipage animation (front side).
@property(nonatomic, strong, nullable) UIImage *multipageAnimationFrontImage;

/// Allows you to set any UIImage for the multipage animation (back side).
@property(nonatomic, strong, nullable) UIImage *multipageAnimationBackImage;

/// Allows you to set length of the lines of the camera frame. It's applied once you change the "cameraFrameShapeType" property to "RGLCameraFrameShapeTypeCorners". Default: 25.
@property(nonatomic, assign) CGFloat cameraFrameLineLength;

/// Allows you to set an aspect ratio of the camera frame (portrait orientation). Default: 0.
@property(nonatomic, assign) CGFloat cameraFramePortraitAspectRatio;

/// Allows you to set an aspect ratio of the camera frame (landscape orientation). Default: 0.
@property(nonatomic, assign) CGFloat cameraFrameLandscapeAspectRatio;

/// Allows you to set an offset for the camera frame (portrait orientation). Default: 3.
@property(nonatomic, assign) CGFloat cameraFrameOffsetWidth;

/// If it's set to true, the animation asking for processing the next page will be displayed. Default: true.
@property(nonatomic, assign) BOOL showNextPageAnimation;

/// If it's set to true, the background mask next to the camera frame will be displayed. Default: true.
@property(nonatomic, assign) BOOL showBackgroundMask;

/// Allows you to set any UIImage within the camera frame.
@property(nonatomic, strong, nullable) UIImage *borderBackgroundImage;

/// Allows you to set intensity of the background mask. Default: 0.3.
@property(nonatomic, assign) CGFloat backgroundMaskAlpha;

/// Allows you to specify how a view of the help animation adjusts its content when its size changes. Default: UIViewContentModeScaleAspectFit.
@property(nonatomic, assign) UIViewContentMode helpAnimationImageContentMode;

/// Allows you to specify how a view of the multipage animation (front side) adjusts its content when its size changes. Default: UIViewContentModeScaleAspectFit.
@property(nonatomic, assign) UIViewContentMode multipageAnimationFrontImageContentMode;

/// Allows you to specify how a view of the multipage animation (back side) adjusts its content when its size changes. Default: UIViewContentModeScaleAspectFit.
@property(nonatomic, assign) UIViewContentMode multipageAnimationBackImageContentMode;

/// Allows you to specify how a view within the camera frame adjusts its content when its size changes. Default: UIViewContentModeScaleAspectFit.
@property(nonatomic, assign) UIViewContentMode borderBackgroundImageContentMode;

/// Allows you to change the location of the camera frame vertically.
@property(nonatomic, assign) CGFloat cameraFrameVerticalPositionMultiplier;

/// Allows you to change the location of the custom status.
/// For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800, your message will be centralized and located at 200 px from the top,
/// i.e. (800 / 2) * 0.5 = 200 px. If the multiplier is equal to 1, the message will be centered.
/// If the multiplier is equal to zero, the default location will be used. Default: 1.
@property(nonatomic, assign) CGFloat customStatusPositionMultiplier;

/// Allows you to create a custom status as NSAttributedString.
@property(nonatomic, strong, nullable) NSAttributedString *customLabelStatus;

/// Allows you to set a corner radius of the camera frame. Default: 10.
@property(nonatomic, assign) CGFloat cameraFrameCornerRadius;

/// Allows you to set any UIImage for the torch button when its state is ON.
@property(nonatomic, strong, nullable) UIImage *torchButtonOnImage;

/// Allows you to set any UIImage for the torch button when its state is OFF.
@property(nonatomic, strong, nullable) UIImage *torchButtonOffImage;

/// Allows you to set any UIImage for the close button.
@property(nonatomic, strong, nullable) UIImage *closeButtonImage;

/// Allows you to set any UIImage for the capture button.
@property(nonatomic, strong, nullable) UIImage *captureButtonImage;

/// Allows you to set any UIImage for the button that allows changing shapes of the camera (collapsed state).
@property(nonatomic, strong, nullable) UIImage *changeFrameButtonCollapseImage;

/// Allows you to set any UIImage for the button that allows changing shapes of the camera (expanded state).
@property(nonatomic, strong, nullable) UIImage *changeFrameButtonExpandImage;

/// Allows you to set any UIImage for the button that allows changing positions of the capture device.
@property(nonatomic, strong, nullable) UIImage *cameraSwitchButtonImage;

/// Allows you to set a size for the toolbar (it's where all buttons are located).
@property(nonatomic, assign) CGFloat toolbarSize;

/// Allows you to set any `UIImage` for the hologram animation.
/// When set to `nil` the default image will be used.
/// This property can be set during the scanning process to tailor the user experiese for different types of documents.
@property(nonatomic, strong, nullable) UIImage *hologramAnimationImage RGL_DEPRECATED(7.1, "Use `livenessAnimationImage` instead.");

/// Allows you to specify how a view of the help animation adjusts its content when its size changes.
/// Defaults to `UIViewContentModeScaleAspectFit`.
@property(nonatomic, assign) UIViewContentMode hologramAnimationImageContentMode RGL_DEPRECATED(7.1, "Use `livenessAnimationImageContentMode` instead.");


/// Allows you to change the location of the hologram animation.
/// For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800,
/// the animation will be centralized and located at 200 px from the top, i.e. (800 / 2) * 0.5 = 200 px.
/// If the multiplier is set to 1, the animation will be centered.
/// If the multiplier is set to 0, the default value will be used. Defaults to 1.
@property(nonatomic, assign) CGFloat hologramAnimationPositionMultiplier RGL_DEPRECATED(7.1, "Use `livenessAnimationPositionMultiplier` instead.");

/// Allows you to set any `UIImage` for the liveness animation.
/// When set to `nil` the default image will be used.
/// This property can be set during the scanning process to tailor the user experiese for different types of documents.
@property(nonatomic, strong, nullable) UIImage *livenessAnimationImage;

/// Allows you to specify how a view of the help animation adjusts its content when its size changes.
/// Defaults to `UIViewContentModeScaleAspectFit`.
@property(nonatomic, assign) UIViewContentMode livenessAnimationImageContentMode;

/// Allows you to change the location of the liveness animation.
/// For example, if you set the multiplier to 0.5 and the number of pixels by vertical is equal to 800,
/// the animation will be centralized and located at 200 px from the top, i.e. (800 / 2) * 0.5 = 200 px.
/// If the multiplier is set to 1, the animation will be centered.
/// If the multiplier is set to 0, the default value will be used. Defaults to 1.
@property(nonatomic, assign) CGFloat livenessAnimationPositionMultiplier;

@property(nonatomic, strong, nullable) RGLUIConfiguration *uiConfiguration;

@property(nonatomic, strong, nullable) NSDictionary *customUILayerJSON;

@property(readwrite, nonatomic, weak, nullable) id<RGLCustomizationActionDelegate> actionDelegate;


@end

Swift

class Customization : NSObject

Objective-C

@interface RGLDataField : NSObject

@property(nonatomic, strong, readonly, nonnull) NSString *data;
@property(nonatomic, assign, readonly) NSInteger fieldType;


- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DataField : NSObject

Objective-C

@interface RGLDataGroup : NSObject

@property(nonatomic, assign) BOOL dG1;
@property(nonatomic, assign) BOOL dG2;
@property(nonatomic, assign) BOOL dG3;
@property(nonatomic, assign) BOOL dG4;
@property(nonatomic, assign) BOOL dG5;
@property(nonatomic, assign) BOOL dG6;
@property(nonatomic, assign) BOOL dG7;
@property(nonatomic, assign) BOOL dG8;
@property(nonatomic, assign) BOOL dG9;
@property(nonatomic, assign) BOOL dG10;
@property(nonatomic, assign) BOOL dG11;
@property(nonatomic, assign) BOOL dG12;
@property(nonatomic, assign) BOOL dG13;
@property(nonatomic, assign) BOOL dG14;

- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
- (NSDictionary *_Nonnull)dataGroupsDictionary;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;

@end

Swift

class DataGroup : NSObject

Objective-C

@interface RGLDocReader : NSObject

RGL_EMPTY_INIT_UNAVAILABLE

@property(readonly, class, nonatomic, strong, nonnull) RGLDocReader *shared;

/**
 Params that influence the scanning process
 */
@property(nonatomic, strong, nonnull) RGLProcessParams *processParams;
/**
 Information about the SDK
 */
@property(nonatomic, strong, readonly, nullable) RGLDocReaderVersion *version;
/**
 A list of scenarios that can be used for documents recognition based on your license and Core framework capabilities
 */
@property(nonatomic, strong, readonly, nonnull) NSArray<RGLScenario *> *availableScenarios;
/**
 Allows you to check if Document Reader is ready for use
 */
@property(nonatomic, assign, readonly, getter=isDocumentReaderIsReady) BOOL documentReaderIsReady;
/**
 Allows you to check if RFID chip reading can be performed based on your license and Core framework capabilities
 */
@property(nonatomic, assign, readonly, getter=isRFIDAvailableForUse) BOOL rfidAvailable;
/**
 Allows you to check if you can use external Regula Bluetooth devices based on your license and Core framework capabilities
 */
@property(nonatomic, assign, readonly, getter=isAuthenticatorAvailableForUse) BOOL useAuthenticatorAvailable;
/**
 An instance to control and listen Regula Bluetooth device events.
 */
@property(nonatomic, strong, readonly, nullable) RGLBluetooth *bluetooth;
/**
 Allows you to pause the scanning process and resume it when it's needed
 */
@property(nonatomic, assign, readwrite, getter=isCameraSessionIsPaused) BOOL cameraSessionIsPaused;
/**
 Allows you to get a status of Document Reader
 */
@property(nonatomic, strong, readonly, nonnull) NSString *documentReaderStatus;
/**
 Allows you to get a status of the RFID chip reading process
 */
@property(nonatomic, strong, nullable) NSString *rfidSessionStatus;

/**
 Information about your license
 */
@property(nonatomic, strong, nullable) RGLLicense *license;
@property(nonatomic, weak, nullable) id <RGLDocReaderRFIDDelegate> rfidDelegate;

/**
 Params that influence the scanning process, camera view controller customization and etc.
 */
@property(nonatomic, strong, nonnull) RGLFunctionality *functionality;
/**
 Params that relate to the camera view controller customization and etc.
 */
@property(nonatomic, strong, nonnull) RGLCustomization *customization;
/**
 Params that influence the RFID chip processing
 */
@property(nonatomic, strong, nonnull) RGLRFIDScenario *rfidScenario;
/**
 Current Session identifier
 */
@property(nonatomic, strong, nullable) NSString *tag;
/**
 Customer name
 */
@property(nonatomic, strong, nullable) NSString *tenant;
/**
 Environment type
 */
@property(nonatomic, strong, nullable) NSString *env;
/**
 It should be used when you add Document Reader SDK inside yours and do localization
 */
@property(nonatomic, strong) _Nullable Class localizationClassName;

/// A localization hook to override default localization search logic.
/// If this block is not set or the implementation of the block returns `nil` the default localization will be used.
@property(readwrite, nonatomic, copy, nullable) RGLLocalizationHandler localizationHandler;

@property(nonatomic, weak, nullable) id <RGLDocReaderDatabaseFetchDelegate> databaseFetchDelegate;

/**
 Allows you to initialize Document Reader
 @param config A configuration file for DocumentReader initialization
 @param completion The block to execute after the initialization finishes
 */
- (void)initializeReaderWithConfig:(nonnull RGLBaseReaderConfig *)config
                        completion:(RGLDocumentReaderInitializationCompletion _Nonnull)completion NS_SWIFT_NAME(initializeReader(config:completion:));

/**
 Allows you to to check database update
 @param databaseID An identifier of the database
 @param completion The block to execute after the check database update finishes
 */
- (void)checkDatabaseUpdate:(nonnull NSString *)databaseID
                 completion:(RGLDocumentReaderCheckUpdateCompletion _Nonnull)completion NS_SWIFT_NAME(checkDatabaseUpdate(databaseID:completion:));

/**
 Allows you to download a database from the Regula server. If it exists in your app and compatible with the SDK, it won't be downloaded
 @param databaseID An identifier of the database
 @param progress Downloading progress
 @param completion The block to execute after the download finishes
 */
- (void)prepareDatabase:(nonnull NSString *)databaseID
        progressHandler:(void (^_Nullable)(NSProgress * _Nonnull progress))progress
             completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion NS_SWIFT_NAME(prepareDatabase(databaseID:progressHandler:completion:));
/**
 Allows you to download a database from the Regula server. If it exists in your app and compatible with the SDK, it won't be downloaded
 @param databaseID An identifier of the database
 @param completion The block to execute after the download finishes
 */
- (void)prepareDatabase:(nonnull NSString *)databaseID
             completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion NS_SWIFT_NAME(prepareDatabase(databaseID:completion:));
/**
 Allows you to download a database from the Regula server. Each new update of the database will be downloaded
 @param databaseID An identifier of the database
 @param progress Downloading progress
 @param completion The block to execute after the download finishes
 */
- (void)runAutoUpdate:(nonnull NSString *)databaseID
      progressHandler:(void (^_Nullable)(NSProgress * _Nonnull progress))progress
           completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion NS_SWIFT_NAME(runAutoUpdate(databaseID:progressHandler:completion:));
/**
 Allows you to download a database from the Regula server. Each new update of the database will be downloaded
 @param databaseID An identifier of the database
 @param completion The block to execute after the download finishes
 */
- (void)runAutoUpdate:(nonnull NSString *)databaseID
           completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion NS_SWIFT_NAME(runAutoUpdate(databaseID:completion:));
- (UIViewController * _Nullable)prepareCameraViewController:(RGLDocumentReaderCameraViewController *_Nullable)controller cameraHandler:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(prepareCameraViewController(cameraViewController:cameraHandler:));
- (UIViewController * _Nullable)prepareCameraViewController:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(prepareCameraViewController(cameraHandler:));
/**
 Allows you to remove the database from your app
 @param completion The block to execute after the removal finishes
 */
- (void)removeDatabase:(RGLDocumentReaderPrepareCompletion _Nullable)completion NS_SWIFT_NAME(removeDatabase(completion:));
/**
 Allows you to cancel the database update
 */
- (void)cancelDBUpdate;

/**
 It's used to start the processing of the next page of the document once the current one is processed
 */
- (void)startNewPage;
/**
 It's used to start a scanning process
 */
- (void)startNewSession;
/**
 It's used for single frame processing where input is UIImage with a crop operation if needed.
 @param config Recognition config
 @param completion The block to execute after the recognition process finishes
 */
- (void)recognizeImageFromPresenter:(UIViewController * _Nonnull)presenter
                             config:(RGLRecognizeConfig * _Nonnull)config
                         completion:(RGLDocumentReaderCompletion _Nonnull)completion;
/**
 It's used for multiple frames processing with RGLImageInput
 @param completion The block to execute after the recognition process finishes
 */
- (void)recognizeWithConfig:(RGLRecognizeConfig *)config
                 completion:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(recognize(config:completion:));

/**
 It's used for multiple frames processing when a stream of frames has to be processed
@param completion The block to execute after the recognition process finishes
 */
- (void)recognizeVideoFrame:(UIImage *)frame
                 completion:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(recognize(videoFrame:completion:));

/**
 It's used for multiple frames processing which are captured from the camera
 @param presenter controller scanner shoud be presented from
 @param config scanning configuration
 @param completion The block to execute after the recognition process finishes
 */
- (void)showScannerFromPresenter:(UIViewController * _Nonnull)presenter
                          config:(RGLScannerConfig *)config
                      completion:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(showScanner(presenter:config:completion:));
/**
 It's used for the RFID chip processing
 @param completion The block to execute after the scanning process finishes
 */
- (void)startRFIDReaderFromPresenter:(UIViewController * _Nonnull)presenter
                          completion:(RGLDocumentReaderCompletion _Nonnull)completion;
/**
 It's used for the RFID chip processing
 @param notificationCallback Notifications of the RFID chip processing
 @param completion The block to execute after the scanning process finishes
 */
- (void)readRFID:(RGLRFIDNotificationCallback _Nullable)notificationCallback completion:(RGLRFIDProcessCompletion _Nonnull)completion;
/**
 It's used to stop the scanning process
 @param completion The block to execute after the scanning process finishes. This block has no return value and takes no parameters. You can specify nil for this parameter
 */
- (void)stopScanner:(void(^_Nullable)(void))completion;
/**
 It's used to stop the RFID chip processing
 @param completion The block to execute after the RFID chip processing finishes. This block has no return value and takes no parameters. You can specify nil for this parameter
 */
- (void)stopRFIDReader:(void(^_Nullable)(void))completion;
/**
 It's used to stop the RFID chip processing
 @param errorMessage The error message to display. You can specify nil for this parameter, to avoid display of error alert
 @param completion The block to execute after the RFID chip processing finishes. This block has no return value and takes no parameters. You can specify nil for this parameter
 */
- (void)stopRFIDReaderWithErrorMessage:(NSString * _Nullable)errorMessage completion:(void(^_Nullable)(void))completion NS_SWIFT_NAME(stopRFIDReader(errorMessage:completion:));
/**
 It's used to pass certificates to Document Reader that will be used during the RFID chip processing
 @param certificates PKD certificates
 */
- (void)addPKDCertificates:(NSArray <RGLPKDCertificate *> * _Nonnull)certificates NS_SWIFT_NAME(addPKDCertificates(certificates:));
/**
 It's used to remove certificates from your app that are used during the RFID chip processing
 */
- (void)clearPKDCertificates;

/// Sets the given `TCCParams` to the RFID  session. The parameters are required to be set before starting RFID session.
///
/// @param params TCC related parameters.
/// @param completion Completion block of the operation. The block is executed on the main thread.
- (void)setTCCParams:(RGLTCCParams *)params completion:(void (^_Nullable)(BOOL success, NSError * _Nullable error))completion;

- (RGLScenario * _Nullable)selectedScenario;

- (void)finalizePackageWithCompletion:(nonnull RGLDocumentReaderFinalizePackageCompletion)completion;

/**
 It's used to deinitialize Document Reader and free up RAM as a consequence of this
 */
- (void)deinitializeReader;

@end

Swift

class DocReader : NSObject

Objective-C

@interface RGLDocReaderDocumentsDatabase : NSObject

Swift

class DocReaderDocumentsDatabase : NSObject

Objective-C

@interface RGLDocReaderVersion : NSObject

Swift

class DocReaderVersion : NSObject

Objective-C

@interface RGLDocumentPosition : RGLPosition

@end

Swift

class DocumentPosition : Position

Objective-C

@interface RGLDocumentReaderAuthenticityResult : NSObject

@property(nonatomic, assign, readonly) RGLCheckResult status;
@property(nonatomic, strong, readonly, nullable) NSArray <RGLAuthenticityCheck *> *checks;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithAuthenticityChecks:(NSArray <RGLAuthenticityCheck *> *_Nullable)checks;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderAuthenticityResult : NSObject

Objective-C

@interface RGLDocumentReaderBarcodeField : NSObject

/**
 Decoded barcode type
 */
@property(nonatomic, assign, readonly) RGLBarcodeType barcodeType;
/**
 Indicates barcode reading result
 */
@property(nonatomic, assign, readonly) RGLBarcodeResult status;
/**
 Contains the information about the PDF417 barcode
 */
@property(nonatomic, strong, readonly, nullable) RGLPDF417Info *pdf417Info;
/**
 Results of reading data from barcode modules
 */
@property(nonatomic, strong, readonly, nonnull) NSData *data;
/**
 Indicates an index of the document page, whence the result is received
 */
@property(nonatomic, assign, readonly) NSInteger pageIndex;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderBarcodeField : NSObject

Objective-C

@interface RGLDocumentReaderBarcodeResult : NSObject

/**
 Barcode fields
 */
@property(nonatomic, strong, readonly, nullable) NSArray <RGLDocumentReaderBarcodeField *> *fields;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithFields:(NSArray <RGLDocumentReaderBarcodeField *> *_Nonnull)fields;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderBarcodeResult : NSObject

Objective-C

@interface RGLDocumentReaderCameraViewController : UIViewController

@property(nonatomic, assign) BOOL resultStatusLocked;

@property(readonly, nonatomic, assign) AVCaptureDevicePosition cameraPosition;
@property(nonatomic, assign) BOOL showHelpPopup;
@property(nonatomic, assign) BOOL helpAnimationShowed;
@property(nonatomic, assign) BOOL showResultMessages;
@property(nonatomic, assign) BOOL showStatusMessages;
@property(nonatomic, assign) BOOL recognizeWasInterrupted;
@property(nonatomic, assign) BOOL skipNextPageRecognition;
@property(nonatomic, assign) double motionRate;
@property(nonatomic, strong, nullable) NSString *cameraStatusString;

@property(nonatomic, strong, nullable) RGLDocumentReaderResults *latestResult;

@property (nonatomic, getter=isCameraControllerPresentedModally) BOOL cameraControllerPresentedModally;

@property(nonatomic, strong, nullable) RGLPreviewView *previewView;
@property(nonatomic, strong, nullable) UIButton *closeButton;
@property(nonatomic, strong, nullable) UIButton *flashButton;
@property(nonatomic, strong, nullable) UIButton *swapCameraButton;
@property(nonatomic, strong, nullable) UIButton *bleButton;
@property(nonatomic, strong, nullable) UIButton *batteryButton;
@property(nonatomic, strong, nullable) UILabel *statusLabel;
@property(nonatomic, strong, nullable) UIView *statusView;
@property(nonatomic, strong, nullable) UIButton *captureButton;
@property(nonatomic, strong, nullable) UIButton *skipMultipageButton;
@property(nonatomic, strong, nullable) UILabel *resultStatusLabel;
@property(nonatomic, strong, nullable) UIView *resultStatusView;
@property(nonatomic, strong, nullable) UIButton *frameSizeButton;
@property(nonatomic, strong, nullable) RGLMaskView *maskView;
@property(nonatomic, strong, nullable) UILabel *logoLabel;
@property(nonatomic, strong, nullable) UIImageView *logoImage;
@property(nonatomic, strong, nullable) RGLCornerView *borderView;
@property(nonatomic, strong, nullable) UIView *focusView;
@property(nonatomic, strong, nullable) UILabel *cameraUnavailableLabel;
@property(nonatomic, strong, nullable) RGLActivityIndicator *activityIndicator;
@property(nonatomic, strong, nullable) RGLDocumentView *multipageScaningView;
@property(nonatomic, strong, nullable) RGLDocumentView *helpAnimationView;
@property(nonatomic, strong, nullable) UIImageView *borderPlaceholderImage;
@property(nonatomic, assign) BOOL barcodeEnabled;
@property(nonatomic, assign) BOOL faceEnabled;
@property(nonatomic, assign) RGLCameraScanMode cameraScanMode;
@property(nonatomic, strong, nullable) UILabel *customLabel;

@property(nonatomic, weak, nullable) id<RGLDocumentReaderCameraViewControllerDelegate> cameraViewControllerDelegate;
@property(nonatomic, strong, nullable) RGLCameraViewControllerHandler cameraViewControllerHandler;
@property(nonatomic, assign) BOOL recognitionIsActive;

@property(nonatomic, assign) BOOL showChangeFrameButton;

@property(nonatomic, assign) RGLDocReaderFrame currentCameraFrame;

- (void)closeTapped:(UIButton *)button;
- (void)flashTapped:(UIButton *)button;
- (void)swapTapped:(UIButton *)button;
- (void)captureButtonTapped:(UIButton *)button;
- (void)skipMultipageTapped:(UIButton *)button;
- (void)changeFrameTapped:(UIButton *)button;
- (void)processParamChanged;
- (void)setHiddenForFlashButton:(BOOL)isHidden;
- (void)setHiddenForCloseButton:(BOOL)isHidden;
- (void)setHiddenForCaptureButton:(BOOL)isHidden;
- (void)setHiddenForSwapCameraButton:(BOOL)isHidden;
- (void)setVideoSessionPreset:(AVCaptureSessionPreset )sessionPreset;
- (void)setVideoZoomFactor:(CGFloat)videoZoomFactor;
- (void)setAVCaptureDevicePosition:(AVCaptureDevicePosition)cameraPosition;
- (void)enableProcessingUI:(BOOL)enable;

- (void)notifyCameraPreviewBackgroundColorChanged;
- (void)notifyTintColorChanged;
- (void)notifyResultStatusTextColorChanged;
- (void)notifyResultStatusTextFontChanged;
- (void)notifyCameraFrameDefaultColorChanged;
- (void)notifyCameraFrameActiveColorChanged;
- (void)notifyStatusTextColorChanged;
- (void)notifyStatusTextFontChanged;
- (void)notifyStatusBackgroundColorChanged;
- (void)notifyShowStatusMessagesChanged;
- (void)notifyShowResultStatusMessagesChanged;
- (void)notifyCameraStatusChanged;
- (void)notifyCameraResultStatusChanged;
- (void)notifyCameraFrameShapeTypeChanged;
- (void)notifyMultipageButtonBackgroundColorChanged;
- (void)notifyCameraFrameBorderWidthChanged;
- (void)notifyActivityIndicatorColorChanged;
- (void)notifyResultStatusBackgroundColorChanged;
- (void)notifyCameraFrameLineLengthChanged;
- (void)notifyCameraFrameOffsetWidthChanged;
- (void)notifyShowBackgroundMaskChanged;
- (void)notifyBorderBackgroundImageChanged;
- (void)notifyBackgroundMaskAlphaChanged;
- (void)notifyMultipageAnimationFrontImageContentModeChanged;
- (void)notifyMultipageAnimationBackImageContentModeChanged;
- (void)notifyBorderBackgroundImageContentModeChanged;
- (void)notifyMultipageAnimationFrontImageChanged;
- (void)notifyMultipageAnimationBackImageChanged;
- (void)notifyCustomLabelStatusChanged;
- (void)notifyLivenessAnimationImageChanged;
- (void)notifyLivenessAnimationImageContentModeChanged;
- (void)notifyCustomUILayerJSONChanged;

- (void)closeCameraViewController:(void(^_Nullable)(void))completion;
    
@end

Swift

class DocumentReaderCameraViewController : UIViewController

Objective-C

@interface RGLDocumentReaderComparison : NSObject

/**
The value's origin source
 */
@property(nonatomic, assign, readonly) RGLResultType sourceTypeLeft;

/**
The value's origin source
 */
@property(nonatomic, assign, readonly) RGLResultType sourceTypeRight;

/**
 The status of field comparisons
 */
@property(nonatomic, assign, readonly) RGLCheckResult status;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json sourceList:(NSDictionary *_Nonnull)sourceList;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json sourceList:(NSDictionary *_Nonnull)sourceList;;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderComparison : NSObject

Objective-C

@interface RGLDocumentReaderDocumentType : NSObject

/**
 Document type name
 */
@property(nonatomic, strong, readonly, nullable) NSString *name;
/**
 Document type numeric code
 */
@property(nonatomic, assign, readonly) NSInteger documentID;
/**
 Document issuing country ICAO code
 */
@property(nonatomic, strong, readonly, nullable) NSString *ICAOCode;
/**
 An array of IRS document identifiers
 */
@property(nonatomic, strong, readonly, nonnull) NSArray<NSNumber *> *FDSID;
/**
 Document type, one of RGLDiDocType enumeration values
 */
@property(nonatomic, assign, readonly) RGLDiDocType dType;
/**
 Document format, one of RGLDocFormat enumeration values
 */
@property(nonatomic, assign, readonly) RGLDocFormat dFormat;
/**
 Flag for MRZ presence on a document
 */
@property(nonatomic, assign, readonly) BOOL dMRZ;
/**
 Document deprecation.
 */
@property(nonatomic, assign, readonly) BOOL isDeprecated;
/**
 Document description text
 */
@property(nonatomic, strong, readonly, nullable) NSString *dDescription;
/**
 Document issue year
 */
@property(nonatomic, strong, readonly, nullable) NSString *dYear;
/**
 Document issuing country name
 */
@property(nonatomic, strong, readonly, nullable) NSString *dCountryName;
/**
 An index of the document page whence results are received
 */
@property(nonatomic, assign, readonly) NSInteger pageIndex;

- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderDocumentType : NSObject

Objective-C

@interface RGLDocumentReaderGraphicField : NSObject

/**
 Identifies zone whence data is extracted
 */
@property(nonatomic, assign, readonly) RGLResultType sourceType;
/**
 Graphic field logical type, one of RGLGraphicFieldType values
 */
@property(nonatomic, assign, readonly) RGLGraphicFieldType fieldType;
/**
 Graphic field symbolic name
 */
@property(nonatomic, strong, readonly, nonnull) NSString *fieldName;
/**
 Field area coordinates on the general image
 */
@property(nonatomic, assign, readonly) CGRect boundRect;
/**
 An image
 */
@property(nonatomic, strong, readonly, nonnull) UIImage *value;
/**
 Light type, one of RGLGraphicFieldLight values
 */
@property(nonatomic, assign, readonly) RGLGraphicFieldLight lightType;
/**
 Light symbolic name
 */
@property(nonatomic, strong, readonly, nonnull) NSString *lightName;
/**
 An index of the document page whence the graphic field is extracted
 */
@property(nonatomic, assign, readonly) NSInteger pageIndex;
/**
 Original page index
 */
@property(nonatomic, assign, readonly) NSInteger originalPageIndex;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithSourceType:(RGLResultType)sourceType fieldType:(RGLGraphicFieldType)fieldType boundRect:(CGRect)boundRect value:(UIImage *_Nonnull)value light:(RGLGraphicFieldLight) light pageIndex:(NSInteger)pageIndex originalPageIndex:(NSInteger)originalPageIndex;
- (instancetype _Nonnull)initWithFieldType:(RGLGraphicFieldType)fieldType valueJSON:(NSDictionary *_Nullable)json;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

+ (NSString *_Nullable)graphicFieldTypeName:(RGLGraphicFieldType)graphicFieldType;
+ (NSString *_Nullable)graphicFieldLightName:(RGLGraphicFieldLight)graphicFieldLight;

@end

Swift

class DocumentReaderGraphicField : NSObject

Objective-C

@interface RGLDocumentReaderGraphicResult : NSObject

/**
 An array of graphic results
 */
@property(nonatomic, strong, readonly, nonnull) NSArray <RGLDocumentReaderGraphicField *> *fields;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithFields:(NSArray <RGLDocumentReaderGraphicField *> *_Nonnull)fields;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderGraphicResult : NSObject

Objective-C

@interface RGLDocumentReaderJsonResultGroup : NSObject

@property(nonatomic, assign, readonly) RGLResultType resultType;
@property(nonatomic, assign, readonly) NSInteger lightType;
@property(nonatomic, assign, readonly) NSInteger pageIdx;
@property(nonatomic, strong, readonly, nonnull) NSString *jsonResult;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderJsonResultGroup : NSObject

Objective-C

@interface RGLDocumentReaderResults : NSObject

/// Document type results
@property(nonatomic, strong, readonly, nullable) NSArray <RGLDocumentReaderDocumentType *> *documentType;

/// Textual results
@property(nonatomic, strong, readonly, nonnull) RGLDocumentReaderTextResult *textResult;

/// Graphic results
@property(nonatomic, strong, readonly, nonnull) RGLDocumentReaderGraphicResult *graphicResult;

/// Position of a document
@property(nonatomic, strong, readonly, nullable) NSArray <RGLDocumentPosition *> *documentPosition;

/// Position of a barcode
@property(nonatomic, strong, readonly, nullable) NSArray <RGLBarcodePosition *> *barcodePosition;

/// Position of MRZ
@property(nonatomic, strong, readonly, nullable) NSArray <RGLMrzPosition *> *mrzPosition;

/// Image quality results
@property(nonatomic, strong, readonly, nullable) NSArray <RGLImageQualityGroup *> *imageQualityGroup;

/// Status information for each operation.
@property(nonatomic, strong, readonly, nonnull) RGLDocumentReaderResultsStatus *status;

/// Authenticity results
@property(nonatomic, strong, readonly, nullable) RGLDocumentReaderAuthenticityResult *authenticityResults;

/// RFID session data
@property(nonatomic, strong, readonly, nullable) RGLRFIDSessionData *rfidSessionData;

/// Indicates which page of the document contains an RFID chip (0 if there's no page containing it).
/// Requires document type recognition, otherwise 1 by default
@property(nonatomic, assign, readonly) NSInteger chipPage;

/// Barcode results
@property(nonatomic, strong, readonly, nonnull) RGLDocumentReaderBarcodeResult *barcodeResult;

/// Visible Digital Seal data.
@property(nonatomic, strong, readonly, nullable) RGLVDSNCData *vdsncData;

/// Document processing finish status, one of RGLProcessingFinishedStatus values
@property(nonatomic, assign, readonly) RGLProcessingFinishedStatus processingFinishedStatus;

/// Indicates how many pages of a document remains to process. Requires Document Type recognition, otherwise 0 by default
@property(nonatomic, assign, readonly) NSInteger morePagesAvailable;

/// Indicates how much time has been required for document processing, milliseconds
@property(nonatomic, assign, readonly) NSInteger elapsedTime;

/// Indicates how much time has been required for RFID chip processing, milliseconds
@property(nonatomic, assign, readonly) NSInteger elapsedTimeRFID;

/// Raw results, i.e. in their initial view
@property(nonatomic, strong, readonly, nonnull) NSString *rawResult;

@property(nonatomic, strong, readonly, nullable) RGLTransactionInfo *transactionInfo;

- (nonnull instancetype)initWithDocumentTypes:(nullable NSArray<RGLDocumentReaderDocumentType *> *)documentType
                                   textResult:(nullable RGLDocumentReaderTextResult *)textResult
                                graphicResult:(nonnull RGLDocumentReaderGraphicResult *)graphicResult
                                    rawResult:(nullable NSString *)rawResult
                             documentPosition:(nullable NSArray<RGLDocumentPosition *> *)documentPosition
                              barcodePosition:(nullable NSArray<RGLBarcodePosition *> *)barcodePosition
                                  mrzPosition:(nullable NSArray<RGLMrzPosition *> *)mrzPosition
                            imageQualityGroup:(nullable NSArray<RGLImageQualityGroup *> *)imageQualityGroup
                          authenticityResults:(nullable RGLDocumentReaderAuthenticityResult *)authenticityResults
                              rfidSessionData:(nullable RGLRFIDSessionData *)rfidSessionData
                                     chipPage:(NSInteger)chipPage
                                barcodeResult:(nullable RGLDocumentReaderBarcodeResult *)barcodeResult
                                    vdsncData:(nullable RGLVDSNCData *)vdsncData
                                       status:(nonnull RGLDocumentReaderResultsStatus *)status
                           processingFinished:(NSInteger)processingFinished
                           morePagesAvailable:(NSInteger)morePagesAvailable
                                  elapsedTime:(NSInteger)elapsedTime
                              elapsedTimeRFID:(NSInteger)elapsedTimeRFID
                              transactionInfo:(nullable RGLTransactionInfo *)transactionInfo;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
- (instancetype _Nonnull)initWithRawJSON:(NSString *_Nonnull)rawString;
- (nonnull NSDictionary *)jsonDictionary;
- (BOOL)isResultsEmpty;

/**
 Allows you to get a value of a text field based on LCID, a source type and its originality
 @param fieldType Field type, one of RGLFieldType values
 @param lcid LCID, one of RGLLCID values
 @param source Source type, one of RGLResultType values
 @param original Originality
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType lcid:(RGLLCID)lcid source:(RGLResultType)source original:(BOOL)original NS_SWIFT_NAME(getTextFieldValueByType(fieldType:lcid:source:original:));
/**
 Allows you to get a value of a text field based on LCID and a source type
 @param fieldType Field type, one of RGLFieldType values
 @param lcid LCID, one of RGLLCID values
 @param source Source type, one of RGLResultType values
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType lcid:(RGLLCID)lcid source:(RGLResultType)source NS_SWIFT_NAME(getTextFieldValueByType(fieldType:lcid:source:));
/**
 Allows you to get a value of a text field based on LCID
 @param fieldType Field type, one of RGLFieldType values
 @param lcid LCID, one of RGLLCID values
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType lcid:(RGLLCID)lcid NS_SWIFT_NAME(getTextFieldValueByType(fieldType:lcid:));
/**
 Allows you to get a value of a text field
 @param fieldType Field type, one of RGLFieldType values
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType NS_SWIFT_NAME(getTextFieldValueByType(fieldType:));
/**
 Allows you to get a value of a text field based on a source type
 @param fieldType Field type, one of RGLFieldType values
 @param source Source type, one of RGLResultType values
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType source:(RGLResultType)source NS_SWIFT_NAME(getTextFieldValueByType(fieldType:source:));
/**
 Allows you to get a value of a text field based on a source type and its originality
 @param fieldType Field type, one of RGLFieldType values
 @param source Source type, one of RGLResultType values
 @param original Originality
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType source:(RGLResultType)source original:(BOOL)original NS_SWIFT_NAME(getTextFieldValueByType(fieldType:source:original:));
/**
 Allows you to get a value of a text field based on its originality
 @param fieldType Field type, one of RGLFieldType values
 @param original Originality
 */
- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType original:(BOOL)original NS_SWIFT_NAME(getTextFieldValueByType(fieldType:original:));
/**
 Allows you to get an instance of a text field
 @param fieldType Field type, one of RGLFieldType values
 */
- (RGLDocumentReaderTextField *_Nullable)getTextFieldByType:(RGLFieldType)fieldType NS_SWIFT_NAME(getTextFieldByType(fieldType:));
/**
 Allows you to get an instance of a text field based on LCID
 @param fieldType Field type, one of RGLFieldType values
 @param lcid LCID, one of RGLLCID values
 */
- (RGLDocumentReaderTextField *_Nullable)getTextFieldByType:(RGLFieldType)fieldType lcid:(RGLLCID)lcid NS_SWIFT_NAME(getTextFieldByType(fieldType:lcid:));

/**
 Allows you to get an image of a graphic field based on a source type, page index and light type
 @param fieldType Field type, one of RGLGraphicFieldType values
 @param source Source type, one of RGLResultType values
 @param pageIndex An index of the document page
 @param light Light type, one of RGLGraphicFieldLight values
 */
- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType source:(RGLResultType)source pageIndex:(NSInteger)pageIndex light:(RGLGraphicFieldLight)light NS_SWIFT_NAME(getGraphicFieldImageByType(fieldType:source:pageIndex:light:));
/**
 Allows you to get an image of a graphic field based on a source type and page index
 @param fieldType Field type, one of RGLGraphicFieldType values
 @param source Source type, one of RGLResultType values
 @param pageIndex An index of the document page
 */
- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType source:(RGLResultType)source pageIndex:(NSInteger)pageIndex NS_SWIFT_NAME(getGraphicFieldImageByType(fieldType:source:pageIndex:));
/**
 Allows you to get an image of a graphic field based on a source type and page index
 @param fieldType Field type, one of RGLGraphicFieldType values
 @param source Source type, one of RGLResultType values
 */
- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType source:(RGLResultType)source NS_SWIFT_NAME(getGraphicFieldImageByType(fieldType:source:));
/**
 Allows you to get an image of a graphic field
 @param fieldType Field type, one of RGLGraphicFieldType values
 */
- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType NS_SWIFT_NAME(getGraphicFieldImageByType(fieldType:));
/**
 Allows you to get an instance of a graphic field based on a source type, page index and light type
 @param fieldType Field type, one of RGLGraphicFieldType values
 @param source Source type, one of RGLResultType values
 @param pageIndex An index of the document page
 @param light Light type, one of RGLGraphicFieldLight values
 */
- (RGLDocumentReaderGraphicField *_Nullable)getGraphicFieldByType:(RGLGraphicFieldType)fieldType source:(RGLResultType)source pageIndex:(NSInteger)pageIndex light:(RGLGraphicFieldLight)light NS_SWIFT_NAME(getGraphicFieldByType(fieldType:source:pageIndex:light:));
/**
 Allows you to get an instance of a graphic field based on a source type and page index
 @param fieldType Field type, one of RGLGraphicFieldType values
 @param source Source type, one of RGLResultType values
 @param pageIndex An index of the document page
 */
- (RGLDocumentReaderGraphicField *_Nullable)getGraphicFieldByType:(RGLGraphicFieldType)fieldType source:(RGLResultType)source pageIndex:(NSInteger)pageIndex NS_SWIFT_NAME(getGraphicFieldByType(fieldType:source:pageIndex:));
/**
 Allows you to get an instance of a graphic field based on a source type
 @param fieldType Field type, one of RGLGraphicFieldType values
 @param source Source type, one of RGLResultType values
 */
- (RGLDocumentReaderGraphicField *_Nullable)getGraphicFieldByType:(RGLGraphicFieldType)fieldType source:(RGLResultType)source NS_SWIFT_NAME(getGraphicFieldByType(fieldType:source:));
/**
 Allows you to get an instance of a graphic field
 @param fieldType Field type, one of RGLGraphicFieldType values
 */
- (RGLDocumentReaderGraphicField *_Nullable)getGraphicFieldByType:(RGLGraphicFieldType)fieldType NS_SWIFT_NAME(getGraphicFieldByType(fieldType:));
/**
 Method returns containers by result type. If result type doesn't exist, the result of the search will be null.
 @param resultTypes array of result type specified in  `RGLResultType` raw values.
 @return get original containers from rawResult value in NSString format including information about the transaction.
 */
- (NSString *_Nullable)getContainersByResultTypes:(NSArray<NSNumber *> *_Nonnull)resultTypes NS_SWIFT_NAME(getContainers(byResultTypes:));
/**
 Method returns only containers for `RGLResultTypeRFIDSession`, `RGLResultTypeEncryptedRCL` and `RGLResultTypeLicense` values
 from `RGLResultType` enum. For more details, see `getContainersByResultTypes` method.
 @return Get all encrypted containers from rawResult to reprocess data on the server side.
 */
- (NSString *_Nullable)getEncryptedContainers NS_SWIFT_NAME(getEncryptedContainers());

+ (nonnull instancetype)initWithJSON:(nonnull NSDictionary *)json;
+ (nonnull instancetype)initWithRawString:(nonnull NSString *)rawString;

@end

Swift

class DocumentReaderResults : NSObject

Objective-C

@interface RGLDocumentReaderResultsStatus : NSObject

Objective-C

@interface RGLDocumentReaderRfidOrigin: NSObject

@property(nonatomic, assign, readonly) NSInteger dg;
@property(nonatomic, assign, readonly) NSInteger dgTag;
@property(nonatomic, assign, readonly) NSInteger entryView;
@property(nonatomic, assign, readonly) NSInteger tagEntry;

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithJSON:(NSDictionary *)json;
+ (instancetype)initWithJSON:(NSDictionary *)json;
- (NSDictionary *)jsonDictionary;

@end

Swift

class DocumentReaderRfidOrigin : NSObject

Objective-C

@interface RGLDocumentReaderSymbol : NSObject

/**
 * ASCII code of symbol
 */
@property(nonatomic, assign, readonly) NSInteger code;

/**
 * bounds result of the particular value
 */
@property(nonatomic, assign, readonly) CGRect rect;

/**
 * symbol recognition probability (0–100, %)
 */
@property(nonatomic, assign, readonly) NSInteger probability;

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithJSON:(NSDictionary *)json;
+ (instancetype)initWithJSON:(NSDictionary *)json;
- (NSDictionary *)jsonDictionary;

@end