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