RGLDocumentReaderResults

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;

/// DTCVC data.
@property(nonatomic, strong, readonly, nullable) NSData *dtcData;

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

Undocumented


                    
                    
                    documentType

Document type results

Declaration

Objective-C

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

Swift

var documentType: [RGLDocumentReaderDocumentType]? { get }


                    
                    
                    textResult

Textual results

Declaration

Objective-C

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

Swift

var textResult: RGLDocumentReaderTextResult { get }


                    
                    
                    graphicResult

Graphic results

Declaration

Objective-C

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

Swift

var graphicResult: RGLDocumentReaderGraphicResult { get }


                    
                    
                    documentPosition

Position of a document

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSArray<RGLDocumentPosition *> *documentPosition;

Swift

var documentPosition: [RGLDocumentPosition]? { get }


                    
                    
                    barcodePosition

Position of a barcode

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSArray<RGLBarcodePosition *> *barcodePosition;

Swift

var barcodePosition: [RGLBarcodePosition]? { get }


                    
                    
                    mrzPosition

Position of MRZ

Declaration

Objective-C

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

Swift

var mrzPosition: [RGLMrzPosition]? { get }


                    
                    
                    imageQualityGroup

Image quality results

Declaration

Objective-C

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

Swift

var imageQualityGroup: [RGLImageQualityGroup]? { get }


                    
                    
                    status

Status information for each operation.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nonnull) RGLDocumentReaderResultsStatus *status;

Swift

var status: RGLDocumentReaderResultsStatus { get }


                    
                    
                    authenticityResults

Authenticity results

Declaration

Objective-C

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

Swift

var authenticityResults: RGLDocumentReaderAuthenticityResult? { get }


                    
                    
                    rfidSessionData

RFID session data

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) RGLRFIDSessionData *rfidSessionData;

Swift

var rfidSessionData: RGLRFIDSessionData? { get }

chipPage
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
Declaration
Objective-C

@property (nonatomic, readonly) NSInteger chipPage;
Swift

var chipPage: Int { get }


                    
                    
                    barcodeResult

Barcode results

Declaration

Objective-C

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

Swift

var barcodeResult: RGLDocumentReaderBarcodeResult { get }


                    
                    
                    vdsncData

Visible Digital Seal data.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) RGLVDSNCData *vdsncData;

Swift

var vdsncData: RGLVDSNCData? { get }


                    
                    
                    dtcData

DTCVC data.

Declaration

Objective-C

@property (nonatomic, strong, readonly, nullable) NSData *dtcData;

Swift

var dtcData: Data? { get }


                    
                    
                    processingFinishedStatus

Document processing finish status, one of RGLProcessingFinishedStatus values

Declaration

Objective-C

@property (nonatomic, readonly) RGLProcessingFinishedStatus processingFinishedStatus;

Swift

var processingFinishedStatus: ProcessingFinishedStatus { get }

morePagesAvailable
Indicates how many pages of a document remains to process. Requires Document Type recognition, otherwise 0 by default
Declaration
Objective-C

@property (nonatomic, readonly) NSInteger morePagesAvailable;
Swift

var morePagesAvailable: Int { get }
elapsedTime
Indicates how much time has been required for document processing, milliseconds
Declaration
Objective-C

@property (nonatomic, readonly) NSInteger elapsedTime;
Swift

var elapsedTime: Int { get }
elapsedTimeRFID
Indicates how much time has been required for RFID chip processing, milliseconds
Declaration
Objective-C

@property (nonatomic, readonly) NSInteger elapsedTimeRFID;
Swift

var elapsedTimeRFID: Int { get }


                    
                    
                    rawResult

Raw results, i.e. in their initial view

Declaration

Objective-C

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

Swift

var rawResult: String { get }


                    
                    
                    transactionInfo

Undocumented

Declaration

Objective-C

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

Swift

var transactionInfo: RGLTransactionInfo? { get }


                    
                    
                    -initWithDocumentTypes:textResult:graphicResult:rawResult:documentPosition:barcodePosition:mrzPosition:imageQualityGroup:authenticityResults:rfidSessionData:chipPage:barcodeResult:vdsncData:status:processingFinished:morePagesAvailable:elapsedTime:elapsedTimeRFID:transactionInfo:

Undocumented

Declaration

Objective-C

- (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;

Swift

init(documentTypes documentType: [RGLDocumentReaderDocumentType]?, textResult: RGLDocumentReaderTextResult?, graphicResult: RGLDocumentReaderGraphicResult, rawResult: String?, documentPosition: [RGLDocumentPosition]?, barcodePosition: [RGLBarcodePosition]?, mrzPosition: [RGLMrzPosition]?, imageQualityGroup: [RGLImageQualityGroup]?, authenticityResults: RGLDocumentReaderAuthenticityResult?, rfidSessionData: RGLRFIDSessionData?, chipPage: Int, barcodeResult: RGLDocumentReaderBarcodeResult?, vdsncData: RGLVDSNCData?, status: RGLDocumentReaderResultsStatus, processingFinished: Int, morePagesAvailable: Int, elapsedTime: Int, elapsedTimeRFID: Int, transactionInfo: RGLTransactionInfo?)


                    
                    
                    -initWithJSON:

Undocumented

Declaration

Objective-C

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

Swift

init(json: [AnyHashable : Any])


                    
                    
                    -initWithRawJSON:

Undocumented

Declaration

Objective-C

- (instancetype _Nonnull)initWithRawJSON:(NSString *_Nonnull)rawString;

Swift

init(rawJSON rawString: String)


                    
                    
                    -jsonDictionary

Undocumented

Declaration

Objective-C

- (nonnull NSDictionary *)jsonDictionary;

Swift

func jsonDictionary() -> [AnyHashable : Any]


                    
                    
                    -isResultsEmpty

Undocumented

Declaration

Objective-C

- (BOOL)isResultsEmpty;

Swift

func isResultsEmpty() -> Bool


                    
                    
                    -getTextFieldValueByType:lcid:source:original:

Allows you to get a value of a text field based on LCID, a source type and its originality

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType
                                          lcid:(RGLLCID)lcid
                                        source:(RGLResultType)source
                                      original:(BOOL)original;

Swift

func getTextFieldValueByType(fieldType: FieldType, lcid: LCID, source: ResultType, original: Bool) -> String?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`lcid`	LCID, one of RGLLCID values
`source`	Source type, one of RGLResultType values
`original`	Originality


                    
                    
                    -getTextFieldValueByType:lcid:source:

Allows you to get a value of a text field based on LCID and a source type

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType
                                          lcid:(RGLLCID)lcid
                                        source:(RGLResultType)source;

Swift

func getTextFieldValueByType(fieldType: FieldType, lcid: LCID, source: ResultType) -> String?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`lcid`	LCID, one of RGLLCID values
`source`	Source type, one of RGLResultType values


                    
                    
                    -getTextFieldValueByType:lcid:

Allows you to get a value of a text field based on LCID

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType
                                          lcid:(RGLLCID)lcid;

Swift

func getTextFieldValueByType(fieldType: FieldType, lcid: LCID) -> String?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`lcid`	LCID, one of RGLLCID values


                    
                    
                    -getTextFieldValueByType:

Allows you to get a value of a text field

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType;

Swift

func getTextFieldValueByType(fieldType: FieldType) -> String?

Parameters


                                fieldType

Field type, one of RGLFieldType values


                    
                    
                    -getTextFieldValueByType:source:

Allows you to get a value of a text field based on a source type

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType
                                        source:(RGLResultType)source;

Swift

func getTextFieldValueByType(fieldType: FieldType, source: ResultType) -> String?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`source`	Source type, one of RGLResultType values


                    
                    
                    -getTextFieldValueByType:source:original:

Allows you to get a value of a text field based on a source type and its originality

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType
                                        source:(RGLResultType)source
                                      original:(BOOL)original;

Swift

func getTextFieldValueByType(fieldType: FieldType, source: ResultType, original: Bool) -> String?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`source`	Source type, one of RGLResultType values
`original`	Originality


                    
                    
                    -getTextFieldValueByType:original:

Allows you to get a value of a text field based on its originality

Declaration

Objective-C

- (NSString *_Nullable)getTextFieldValueByType:(RGLFieldType)fieldType
                                      original:(BOOL)original;

Swift

func getTextFieldValueByType(fieldType: FieldType, original: Bool) -> String?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`original`	Originality


                    
                    
                    -getTextFieldByType:

Allows you to get an instance of a text field

Declaration

Objective-C

- (RGLDocumentReaderTextField *_Nullable)getTextFieldByType:
    (RGLFieldType)fieldType;

Swift

func getTextFieldByType(fieldType: FieldType) -> RGLDocumentReaderTextField?

Parameters


                                fieldType

Field type, one of RGLFieldType values


                    
                    
                    -getTextFieldByType:lcid:

Allows you to get an instance of a text field based on LCID

Declaration

Objective-C

- (RGLDocumentReaderTextField *_Nullable)getTextFieldByType:
                                             (RGLFieldType)fieldType
                                                       lcid:(RGLLCID)lcid;

Swift

func getTextFieldByType(fieldType: FieldType, lcid: LCID) -> RGLDocumentReaderTextField?

Parameters

`fieldType`	Field type, one of RGLFieldType values
`lcid`	LCID, one of RGLLCID values


                    
                    
                    -getGraphicFieldImageByType:source:pageIndex:light:

Allows you to get an image of a graphic field based on a source type, page index and light type

Declaration

Objective-C

- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType
                                          source:(RGLResultType)source
                                       pageIndex:(NSInteger)pageIndex
                                           light:(RGLGraphicFieldLight)light;

Swift

func getGraphicFieldImageByType(fieldType: GraphicFieldType, source: ResultType, pageIndex: Int, light: GraphicFieldLight) -> UIImage?

Parameters

`fieldType`	Field type, one of RGLGraphicFieldType values
`source`	Source type, one of RGLResultType values
`pageIndex`	An index of the document page
`light`	Light type, one of RGLGraphicFieldLight values


                    
                    
                    -getGraphicFieldImageByType:source:pageIndex:

Allows you to get an image of a graphic field based on a source type and page index

Declaration

Objective-C

- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType
                                          source:(RGLResultType)source
                                       pageIndex:(NSInteger)pageIndex;

Swift

func getGraphicFieldImageByType(fieldType: GraphicFieldType, source: ResultType, pageIndex: Int) -> UIImage?

Parameters

`fieldType`	Field type, one of RGLGraphicFieldType values
`source`	Source type, one of RGLResultType values
`pageIndex`	An index of the document page


                    
                    
                    -getGraphicFieldImageByType:source:

Allows you to get an image of a graphic field based on a source type and page index

Declaration

Objective-C

- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType
                                          source:(RGLResultType)source;

Swift

func getGraphicFieldImageByType(fieldType: GraphicFieldType, source: ResultType) -> UIImage?

Parameters

`fieldType`	Field type, one of RGLGraphicFieldType values
`source`	Source type, one of RGLResultType values


                    
                    
                    -getGraphicFieldImageByType:

Allows you to get an image of a graphic field

Declaration

Objective-C

- (UIImage *_Nullable)getGraphicFieldImageByType:(RGLGraphicFieldType)fieldType;

Swift

func getGraphicFieldImageByType(fieldType: GraphicFieldType) -> UIImage?

Parameters


                                fieldType

Field type, one of RGLGraphicFieldType values


                    
                    
                    -getGraphicFieldByType:source:pageIndex:light:

Allows you to get an instance of a graphic field based on a source type, page index and light type

Declaration

Objective-C

- (RGLDocumentReaderGraphicField *_Nullable)
    getGraphicFieldByType:(RGLGraphicFieldType)fieldType
                   source:(RGLResultType)source
                pageIndex:(NSInteger)pageIndex
                    light:(RGLGraphicFieldLight)light;

Swift

func getGraphicFieldByType(fieldType: GraphicFieldType, source: ResultType, pageIndex: Int, light: GraphicFieldLight) -> RGLDocumentReaderGraphicField?

Parameters

`fieldType`	Field type, one of RGLGraphicFieldType values
`source`	Source type, one of RGLResultType values
`pageIndex`	An index of the document page
`light`	Light type, one of RGLGraphicFieldLight values


                    
                    
                    -getGraphicFieldByType:source:pageIndex:

Allows you to get an instance of a graphic field based on a source type and page index

Declaration

Objective-C

- (RGLDocumentReaderGraphicField *_Nullable)
    getGraphicFieldByType:(RGLGraphicFieldType)fieldType
                   source:(RGLResultType)source
                pageIndex:(NSInteger)pageIndex;

Swift

func getGraphicFieldByType(fieldType: GraphicFieldType, source: ResultType, pageIndex: Int) -> RGLDocumentReaderGraphicField?

Parameters

`fieldType`	Field type, one of RGLGraphicFieldType values
`source`	Source type, one of RGLResultType values
`pageIndex`	An index of the document page


                    
                    
                    -getGraphicFieldByType:source:

Allows you to get an instance of a graphic field based on a source type

Declaration

Objective-C

- (RGLDocumentReaderGraphicField *_Nullable)
    getGraphicFieldByType:(RGLGraphicFieldType)fieldType
                   source:(RGLResultType)source;

Swift

func getGraphicFieldByType(fieldType: GraphicFieldType, source: ResultType) -> RGLDocumentReaderGraphicField?

Parameters

`fieldType`	Field type, one of RGLGraphicFieldType values
`source`	Source type, one of RGLResultType values


                    
                    
                    -getGraphicFieldByType:

Allows you to get an instance of a graphic field

Declaration

Objective-C

- (RGLDocumentReaderGraphicField *_Nullable)getGraphicFieldByType:
    (RGLGraphicFieldType)fieldType;

Swift

func getGraphicFieldByType(fieldType: GraphicFieldType) -> RGLDocumentReaderGraphicField?

Parameters


                                fieldType

Field type, one of RGLGraphicFieldType values


                    
                    
                    -getContainersByResultTypes:

Method returns containers by result type. If result type doesn’t exist, the result of the search will be null.

Declaration

Objective-C

- (NSString *_Nullable)getContainersByResultTypes:
    (NSArray<NSNumber *> *_Nonnull)resultTypes;

Swift

func getContainers(byResultTypes resultTypes: [NSNumber]) -> String?

Parameters


                                resultTypes

array of result type specified in RGLResultType raw values.

Return Value

get original containers from rawResult value in NSString format including information about the transaction.

-getEncryptedContainers
Method returns only containers for RGLResultTypeRFIDSession, RGLResultTypeEncryptedRCL and RGLResultTypeLicense values from RGLResultType enum. For more details, see getContainersByResultTypes method.
Declaration
Objective-C

- (NSString *_Nullable)getEncryptedContainers;
Swift

func getEncryptedContainers() -> String?
Return Value

Get all encrypted containers from rawResult to reprocess data on the server side.


                    
                    
                    +initWithJSON:

Undocumented

Declaration

Objective-C

+ (nonnull instancetype)initWithJSON:(nonnull NSDictionary *)json;

Swift

class func initWithJSON(_ json: [AnyHashable : Any]) -> Self


                    
                    
                    +initWithRawString:

Undocumented

Declaration

Objective-C

+ (nonnull instancetype)initWithRawString:(nonnull NSString *)rawString;

Swift

class func initWithRawString(_ rawString: String) -> Self