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