Protocols

Objective-C

@protocol RGLBluetoothDelegate <NSObject>

@optional;
/// Tells the delegate that connection state of connected Regula device is changed.
- (void)didChangeConnectionState:(RGLBluetooth *)bluetooth state:(RGLBluetoothConnectionState)state;

/// Tells the delegate that battery level of connected Regula device is changed.
- (void)didChangeBatteryLevel:(RGLBluetooth *)bluetooth level:(NSUInteger)level;

/// Tells the delegate that Regula device is found.
- (void)didFindDevice:(RGLBluetooth *)bluetooth device:(CBPeripheral *)device;

/// Tells the delegate that scan for Regula Devices is started.
- (void)didStartScan:(RGLBluetooth *)bluetooth;

/// Tells the delegate that scan for Regula Devices is started.
- (void)didEndScan:(RGLBluetooth *)bluetooth devices:(NSArray<CBPeripheral *> *)devices;

@end

Swift

protocol RGLBluetoothDelegate : NSObjectProtocol

Objective-C

@protocol RGLCustomizationActionDelegate <NSObject>
- (void)onCustomButtonTappedWithTag:(NSInteger)tag;
@end

Objective-C

@protocol RGLDocReaderDatabaseFetchDelegate <NSObject>
@optional
- (void)onProgressChanged:(NSNumber *)downloadedBytes totalBytes:(NSNumber *)totalBytes;
- (void)onDownloadCompleted;
@end

Swift

protocol RGLDocReaderDatabaseFetchDelegate : NSObjectProtocol

Objective-C

@protocol RGLDocReaderRFIDDelegate <NSObject>
@optional
- (void)onRequestPACertificatesWithSerial:(NSData *)serialNumber
                                   issuer:(RGLPAResourcesIssuer *)issuer
                                 callback:(RGLRFIDCertificatesCallback)callback;

- (void)onRequestTACertificatesWithKey:(NSString *)keyCAR
                                 callback:(RGLRFIDCertificatesCallback)callback;

- (void)onRequestTASignatureWithChallenge:(RGLTAChallenge *)challenge
                              callback:(void(^)(NSData *signature))callback;

- (void)didChipConnected;

- (void)didReceivedError:(RGLRFIDErrorCodes)errorCode;
@end

Swift

protocol RGLDocReaderRFIDDelegate : NSObjectProtocol

Objective-C

@protocol RGLDocumentReaderCameraViewControllerDelegate <NSObject>

- (void)handleCameraOpened;
- (BOOL)didMotionControlEnabledInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)didSkipFocusingFramesInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showCaptureButtonInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showChangeFrameSizeButtonInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showSwapCameraButtonInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showTorchButtonInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showCloseButtonInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable AVCaptureSessionPreset )videoSessionPresetInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showLogoInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showHelpAnimationInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)multipageProcessingInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIInterfaceOrientationMask)supportedOrientationsInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (void)startNewPageInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showStatusMessagesInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showResultMessagesInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)tintColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)cameraPreviewBackgroundColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)resultStatusTextColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIFont *)resultStatusTextFontInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIColor *)resultStatusBackgroundColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)cameraFrameDefaultColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)cameraFrameActiveColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cameraFrameBorderWidthInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cameraFrameWidthOfssetInCameraController:(RGLDocumentReaderBaseCameraViewController * )controller;
- (BOOL)cameraFrameHideInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)statusTextColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIFont *)statusTextFontInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIColor *)statusBackgroundColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIColor *)activityIndicatorViewColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIColor *)skipMultipageButtonBackgroundColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIColor *)skipMultipageButtonTextColorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIFont *)skipMultipageButtonTextFontInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable NSString *)skipMultipageButtonTextInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (RGLCameraFrameShapeType)cameraFrameShapeTypeInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cornerViewLineLengthInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showNextPageAnimationInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (NSTimeInterval)nextPageAnimationStartDelay:(RGLDocumentReaderBaseCameraViewController *)controller;
- (NSTimeInterval)nextPageAnimationEndDelay:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showMaskViewInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (RGLDocReaderFrame)cameraFrameSizeInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (RGLDocReaderFrame)defaultCameraFrameSizeInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable NSArray<NSNumber *> *)barcodeTypesInCameraController:(RGLDocumentReaderBaseCameraViewController * )controller;
- (AVCaptureDevicePosition)cameraPositionInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)showSkipNextPageButtonInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIImage *)helpAnimationImageInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIImage *)multipageAnimationFrontImageInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIImage *)multipageAnimationBackImageInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)statusPositionMultiplierInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)resultStatusPositionMultiplierInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIImage *)borderBackgroundImageInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)isUseAuthenticatorInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable NSString *)cameraStatusInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cameraFrameVerticalPositionMultiplier:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cameraFrameCornerRadius:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cameraBorderAspectRatioPortrait:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)cameraBorderAspectRatioLandscape:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)isShowCaptureButton:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)torchIsUsed:(RGLDocumentReaderBaseCameraViewController *)controller;
- (NSTimeInterval)showCaptureButtonDelayFromDetect:(RGLDocumentReaderBaseCameraViewController *)controller;
- (NSTimeInterval)showCaptureButtonDelayFromStart:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)shouldStartRecordingOnCapture:(RGLDocumentReaderBaseCameraViewController *)controller;
- (BOOL)shouldStartAutoRecording:(RGLDocumentReaderBaseCameraViewController *)controller;
- (nullable UIImage *)livenessAnimationImageInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)livenessAnimationPositionMultiplierInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (UIViewContentMode)livenessAnimationContentModeInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)previewLayerPositionMultiplierInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)acitivityIndicatorPortraitPositionMultiplierInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;
- (CGFloat)acitivityIndicatorLandscapePositionMultiplierInCameraController:(RGLDocumentReaderBaseCameraViewController *)controller;

@end

Swift

protocol RGLDocumentReaderCameraViewControllerDelegate : NSObjectProtocol

Objective-C

@protocol RGLDocumentViewDataSource <NSObject>
- (UIView *_Nonnull)parentView:(RGLDocumentView *_Nullable)documentView;
- (UIView *_Nonnull)mainParentView:(RGLDocumentView *_Nullable)documentView;
- (CGFloat)parentViewYMultiplier:(RGLDocumentView *_Nullable)documentView;
@end

Swift

protocol RGLDocumentViewDataSource : NSObjectProtocol

Objective-C

@protocol RGLRecordScanningProcessDelegate <NSObject>
@optional
/*!
 * @abstract Called by DocumentReader when recording process started.
 *
 * @return A output file URL for every record. Use new file name for every new scanning session.
 *         Already existing files will not overwritten, and error will be produced.
 */
- (nonnull NSURL *)recordingOutputFileURL;

/*!
 * @abstract Called by DocumentReader when recording process finished.
 *
 * @param fileURL The output file URL. Contains URL to recording output for every scanning session.
 */
- (void)didFinishRecordingToFile:(nonnull NSURL *)fileURL;

/*!
 * @abstract Called by DocumentReader when an error has occurred for some reason.
 *
 * @param error The error object.
 */
- (void)didFailWithError:(nonnull NSError *)error;
@end

Swift

protocol RecordScanningProcessDelegate : NSObjectProtocol

Objective-C

@protocol RGLMaskViewDataSource <NSObject>

- (CGRect)maskRect:(RGLMaskView *_Nullable)maskRect;

@end

Swift

protocol RGLMaskViewDataSource : NSObjectProtocol

Objective-C

@protocol RGLURLRequestInterceptingDelegate <NSObject>