RGLDocReader

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;
/**
 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;
/**
 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;


/**
 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 RGLConfig *)config
                        completion:(RGLDocumentReaderInitializationCompletion _Nonnull)completion NS_SWIFT_NAME(initializeReader(config:completion:));

/**
 Allows you to initialize Document Reader
 @param license A license as NSData
 @param completion The block to execute after the initialization finishes
 */
- (void)initializeReader:(nonnull NSData *)license
              completion:(RGLDocumentReaderInitializationCompletion _Nonnull)completion NS_SWIFT_NAME(initializeReader(license:completion:)) RGL_DEPRECATED(5.8, "Use `-[initializeReaderWithConfig:completion:]` instead.");
/**
 Allows you to initialize Document Reader
 @param license A license as NSData
 @param databasePath A path to the database
 @param completion The block to execute after the initialization finishes
 */
- (void)initializeReader:(nonnull NSData *)license
            databasePath:(nonnull NSString *)databasePath
              completion:(RGLDocumentReaderInitializationCompletion _Nonnull)completion NS_SWIFT_NAME(initializeReader(license:databasePath:completion:)) RGL_DEPRECATED(5.8, "Use `-[initializeReaderWithConfig:completion:]` instead.");

/**
 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
 @param completion The block to execute after the recognition process finishes
 */
- (void)recognizeImage:(UIImage * _Nonnull)image
            completion:(RGLDocumentReaderCompletion _Nonnull)completion;
/**
 It's used for single frame processing where input is binary
 @param completion The block to execute after the recognition process finishes
 */
- (void)recognizeData:(NSData * _Nonnull)data
            completion:(RGLDocumentReaderCompletion _Nonnull)completion;
- (void)recognizeImageFromPresenter:(UIViewController * _Nonnull)presenter image:(UIImage * _Nonnull)image
            completion:(RGLDocumentReaderCompletion _Nonnull)completion;
/**
 It's used for multiple frames processing
 @param cameraMode Indicates whether a stream of frames has to be processed or not
 @param completion The block to execute after the recognition process finishes
 */
- (void)recognizeImage:(UIImage * _Nonnull)image
            cameraMode:(BOOL)cameraMode
            completion:(RGLDocumentReaderCompletion _Nonnull)completion;
/**
 It's used for multiple frames processing
 @param completion The block to execute after the recognition process finishes
 */
- (void)recognizeImages:(NSArray<UIImage *> *_Nonnull)images 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)recognizeImagesWithImageInputs:(NSArray<RGLImageInput *> *_Nonnull)inputs completion:(RGLDocumentReaderCompletion _Nonnull)completion;
/**
 It's used for multiple frames processing which are captured from the camera
 @param completion The block to execute after the recognition process finishes
 */
- (void)showScanner:(UIViewController * _Nonnull)presenter
         completion:(RGLDocumentReaderCompletion _Nonnull)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;

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

@end

Swift

class DocReader : NSObject

Undocumented

  • Unavailable

    Not the designated initializer.

    Undocumented

    Declaration

    Objective-C

    RGL_EMPTY_INIT_UNAVAILABLE
  • Unavailable

    Not the designated initializer.

    Undocumented

    Declaration

    Objective-C

    RGL_EMPTY_INIT_UNAVAILABLE
  • Undocumented

    Declaration

    Objective-C

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

    Swift

    class var shared: DocReader { get }
  • Params that influence the scanning process

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) RGLProcessParams *processParams;

    Swift

    var processParams: ProcessParams { get set }
  • Information about the SDK

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RGLDocReaderVersion *version;

    Swift

    var version: RGLDocReaderVersion? { get }
  • A list of scenarios that can be used for documents recognition based on your license and Core framework capabilities

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<RGLScenario *> *availableScenarios;

    Swift

    var availableScenarios: [RGLScenario] { get }
  • Allows you to check if Document Reader is ready for use

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
              getter=isDocumentReaderIsReady) BOOL documentReaderIsReady;

    Swift

    var isDocumentReaderIsReady: Bool { get }
  • Allows you to check if RFID chip reading can be performed based on your license and Core framework capabilities

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
              getter=isRFIDAvailableForUse) BOOL rfidAvailable;

    Swift

    var isRFIDAvailableForUse: Bool { get }
  • Allows you to check if you can use external Regula Bluetooth devices based on your license and Core framework capabilities

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
              getter=isAuthenticatorAvailableForUse) BOOL useAuthenticatorAvailable;

    Swift

    var isAuthenticatorAvailableForUse: Bool { get }
  • Allows you to pause the scanning process and resume it when it’s needed

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readwrite,
              getter=isCameraSessionIsPaused) BOOL cameraSessionIsPaused;

    Swift

    var isCameraSessionIsPaused: Bool { get set }
  • Allows you to get a status of Document Reader

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *documentReaderStatus;

    Swift

    var documentReaderStatus: String { get }
  • Allows you to get a status of the RFID chip reading process

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *rfidSessionStatus;

    Swift

    var rfidSessionStatus: String? { get set }
  • Information about your license

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) RGLLicense *license;

    Swift

    var license: RGLLicense? { get set }
  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, weak, nullable) id <RGLDocReaderRFIDDelegate> rfidDelegate

    Swift

    weak var rfidDelegate: RGLDocReaderRFIDDelegate? { get set }
  • Params that influence the scanning process, camera view controller customization and etc.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) RGLFunctionality *functionality;

    Swift

    var functionality: RGLFunctionality { get set }
  • Params that relate to the camera view controller customization and etc.

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) RGLCustomization *customization;

    Swift

    var customization: RGLCustomization { get set }
  • Params that influence the RFID chip processing

    Declaration

    Objective-C

    @property (nonatomic, strong, nonnull) RGLRFIDScenario *rfidScenario;

    Swift

    var rfidScenario: RGLRFIDScenario { get set }
  • tag

    Current Session identifier

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSString *tag;

    Swift

    var tag: String? { get set }
  • It should be used when you add Document Reader SDK inside yours and do localization

    Declaration

    Objective-C

    @property (nonatomic, strong) Class _Nullable localizationClassName;

    Swift

    var localizationClassName: AnyClass? { get set }
  • 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.

    Declaration

    Objective-C

    @property (nonatomic, copy, nullable) RGLLocalizationHandler localizationHandler;

    Swift

    var localizationHandler: RGLLocalizationHandler? { get set }
  • Allows you to initialize Document Reader

    Declaration

    Objective-C

    - (void)initializeReaderWithConfig:(nonnull RGLConfig *)config
                            completion:
                                (RGLDocumentReaderInitializationCompletion _Nonnull)
                                    completion;

    Swift

    func initializeReader(config: RGLConfig) async throws -> Bool

    Parameters

    config

    A configuration file for DocumentReader initialization

    completion

    The block to execute after the initialization finishes

  • Deprecated

    Deprecated in DocumentReader 5.8. Use -[initializeReaderWithConfig:completion:] instead.

    Allows you to initialize Document Reader

    Declaration

    Objective-C

    - (void)initializeReader:(nonnull NSData *)license
                  completion:(RGLDocumentReaderInitializationCompletion _Nonnull)
                                 completion;

    Swift

    func initializeReader(license: Data) async throws -> Bool

    Parameters

    license

    A license as NSData

    completion

    The block to execute after the initialization finishes

  • Deprecated

    Deprecated in DocumentReader 5.8. Use -[initializeReaderWithConfig:completion:] instead.

    Allows you to initialize Document Reader

    Declaration

    Objective-C

    - (void)initializeReader:(nonnull NSData *)license
                databasePath:(nonnull NSString *)databasePath
                  completion:(RGLDocumentReaderInitializationCompletion _Nonnull)
                                 completion;

    Swift

    func initializeReader(license: Data, databasePath: String) async throws -> Bool

    Parameters

    license

    A license as NSData

    databasePath

    A path to the database

    completion

    The block to execute after the initialization finishes

  • Allows you to to check database update

    Declaration

    Objective-C

    - (void)checkDatabaseUpdate:(nonnull NSString *)databaseID
                     completion:(RGLDocumentReaderCheckUpdateCompletion _Nonnull)
                                    completion;

    Swift

    func checkDatabaseUpdate(databaseID: String) async -> RGLDocReaderDocumentsDatabase?

    Parameters

    databaseID

    An identifier of the database

    completion

    The block to execute after the check database update finishes

  • 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

    Declaration

    Objective-C

    - (void)prepareDatabase:(nonnull NSString *)databaseID
            progressHandler:(void (^_Nullable)(NSProgress *_Nonnull))progress
                 completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion;

    Swift

    func prepareDatabase(databaseID: String, progressHandler progress: ((Progress) -> Void)?) async throws -> Bool

    Parameters

    databaseID

    An identifier of the database

    progress

    Downloading progress

    completion

    The block to execute after the download finishes

  • 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

    Declaration

    Objective-C

    - (void)prepareDatabase:(nonnull NSString *)databaseID
                 completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion;

    Swift

    func prepareDatabase(databaseID: String) async throws -> Bool

    Parameters

    databaseID

    An identifier of the database

    completion

    The block to execute after the download finishes

  • Allows you to download a database from the Regula server. Each new update of the database will be downloaded

    Declaration

    Objective-C

    - (void)runAutoUpdate:(nonnull NSString *)databaseID
          progressHandler:(void (^_Nullable)(NSProgress *_Nonnull))progress
               completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion;

    Swift

    func runAutoUpdate(databaseID: String, progressHandler progress: ((Progress) -> Void)?) async throws -> Bool

    Parameters

    databaseID

    An identifier of the database

    progress

    Downloading progress

    completion

    The block to execute after the download finishes

  • Allows you to download a database from the Regula server. Each new update of the database will be downloaded

    Declaration

    Objective-C

    - (void)runAutoUpdate:(nonnull NSString *)databaseID
               completion:(RGLDocumentReaderPrepareCompletion _Nonnull)completion;

    Swift

    func runAutoUpdate(databaseID: String) async throws -> Bool

    Parameters

    databaseID

    An identifier of the database

    completion

    The block to execute after the download finishes

  • Undocumented

    Declaration

    Objective-C

    - (UIViewController * _Nullable)prepareCameraViewController:(RGLDocumentReaderCameraViewController *_Nullable)controller cameraHandler:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(prepareCameraViewController(cameraViewController:cameraHandler:));

    Swift

    func prepareCameraViewController(cameraViewController controller: RGLDocumentReaderCameraViewController?, cameraHandler completion: @escaping DocumentReaderCompletion) -> UIViewController?
  • Undocumented

    Declaration

    Objective-C

    - (UIViewController * _Nullable)prepareCameraViewController:(RGLDocumentReaderCompletion _Nonnull)completion NS_SWIFT_NAME(prepareCameraViewController(cameraHandler:));

    Swift

    func prepareCameraViewController(cameraHandler completion: @escaping DocumentReaderCompletion) -> UIViewController?
  • Allows you to remove the database from your app

    Declaration

    Objective-C

    - (void)removeDatabase:(RGLDocumentReaderPrepareCompletion _Nullable)completion;

    Swift

    func removeDatabase() async throws -> Bool

    Parameters

    completion

    The block to execute after the removal finishes

  • Allows you to cancel the database update

    Declaration

    Objective-C

    - (void)cancelDBUpdate;

    Swift

    func cancelDBUpdate()
  • It’s used to start the processing of the next page of the document once the current one is processed

    Declaration

    Objective-C

    - (void)startNewPage;

    Swift

    func startNewPage()
  • It’s used to start a scanning process

    Declaration

    Objective-C

    - (void)startNewSession;

    Swift

    func startNewSession()
  • It’s used for single frame processing where input is UIImage

    Declaration

    Objective-C

    - (void)recognizeImage:(UIImage *_Nonnull)image
                completion:(RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func recognizeImage(_ image: UIImage) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    completion

    The block to execute after the recognition process finishes

  • It’s used for single frame processing where input is binary

    Declaration

    Objective-C

    - (void)recognizeData:(NSData *_Nonnull)data
               completion:(RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func recognizeData(_ data: Data) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    completion

    The block to execute after the recognition process finishes

  • Undocumented

    Declaration

    Objective-C

    - (void)recognizeImageFromPresenter:(UIViewController * _Nonnull)presenter image:(UIImage * _Nonnull)image
                completion:(RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func recognizeImage(fromPresenter presenter: UIViewController, image: UIImage) async throws -> (DocReaderAction, RGLDocumentReaderResults)
  • It’s used for multiple frames processing

    Declaration

    Objective-C

    - (void)recognizeImage:(UIImage *_Nonnull)image
                cameraMode:(BOOL)cameraMode
                completion:(RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func recognizeImage(_ image: UIImage, cameraMode: Bool) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    cameraMode

    Indicates whether a stream of frames has to be processed or not

    completion

    The block to execute after the recognition process finishes

  • It’s used for multiple frames processing

    Declaration

    Objective-C

    - (void)recognizeImages:(NSArray<UIImage *> *_Nonnull)images
                 completion:(RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func recognizeImages(_ images: [UIImage]) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    completion

    The block to execute after the recognition process finishes

  • It’s used for multiple frames processing with RGLImageInput

    Declaration

    Objective-C

    - (void)
        recognizeImagesWithImageInputs:(NSArray<RGLImageInput *> *_Nonnull)inputs
                            completion:
                                (RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func recognizeImages(with inputs: [RGLImageInput]) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    completion

    The block to execute after the recognition process finishes

  • It’s used for multiple frames processing which are captured from the camera

    Declaration

    Objective-C

    - (void)showScanner:(UIViewController *_Nonnull)presenter
             completion:(RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func showScanner(_ presenter: UIViewController) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    completion

    The block to execute after the recognition process finishes

  • It’s used for the RFID chip processing

    Declaration

    Objective-C

    - (void)startRFIDReaderFromPresenter:(UIViewController *_Nonnull)presenter
                              completion:
                                  (RGLDocumentReaderCompletion _Nonnull)completion;

    Swift

    func startRFIDReader(fromPresenter presenter: UIViewController) async throws -> (DocReaderAction, RGLDocumentReaderResults)

    Parameters

    completion

    The block to execute after the scanning process finishes

  • It’s used for the RFID chip processing

    Declaration

    Objective-C

    - (void)readRFID:(RGLRFIDNotificationCallback _Nullable)notificationCallback
          completion:(RGLRFIDProcessCompletion _Nonnull)completion;

    Swift

    func readRFID(_ notificationCallback: RFIDNotificationCallback?) async throws -> (RFIDCompleteAction, RGLDocumentReaderResults, RFIDErrorCodes)

    Parameters

    notificationCallback

    Notifications of the RFID chip processing

    completion

    The block to execute after the scanning process finishes

  • It’s used to stop the scanning process

    Declaration

    Objective-C

    - (void)stopScanner:(void (^_Nullable)(void))completion;

    Swift

    func stopScanner() async

    Parameters

    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

  • It’s used to stop the RFID chip processing

    Declaration

    Objective-C

    - (void)stopRFIDReader:(void (^_Nullable)(void))completion;

    Swift

    func stopRFIDReader() async

    Parameters

    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

  • It’s used to stop the RFID chip processing

    Declaration

    Objective-C

    - (void)stopRFIDReaderWithErrorMessage:(NSString *_Nullable)errorMessage
                                completion:(void (^_Nullable)(void))completion;

    Swift

    func stopRFIDReader(errorMessage: String?) async

    Parameters

    errorMessage

    The error message to display. You can specify nil for this parameter, to avoid display of error alert

    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

  • It’s used to pass certificates to Document Reader that will be used during the RFID chip processing

    Declaration

    Objective-C

    - (void)addPKDCertificates:(NSArray<RGLPKDCertificate *> *_Nonnull)certificates;

    Swift

    func addPKDCertificates(certificates: [RGLPKDCertificate])

    Parameters

    certificates

    PKD certificates

  • It’s used to remove certificates from your app that are used during the RFID chip processing

    Declaration

    Objective-C

    - (void)clearPKDCertificates;

    Swift

    func clearPKDCertificates()
  • Sets the given TCCParams to the RFID session. The parameters are required to be set before starting RFID session.

    Declaration

    Objective-C

    - (void)setTCCParams:(nonnull RGLTCCParams *)params
              completion:(void (^_Nullable)(BOOL, NSError *_Nullable))completion;

    Swift

    func setTCCParams(_ params: RGLTCCParams) async throws -> Bool

    Parameters

    params

    TCC related parameters.

    completion

    Completion block of the operation. The block is executed on the main thread.

  • Undocumented

    Declaration

    Objective-C

    - (RGLScenario * _Nullable)selectedScenario;

    Swift

    func selectedScenario() -> RGLScenario?
  • It’s used to deinitialize Document Reader and free up RAM as a consequence of this

    Declaration

    Objective-C

    - (void)deinitializeReader;

    Swift

    func deinitializeReader()