RGLDocumentReaderValue

Objective-C

@interface RGLDocumentReaderValue : NSObject

/**
 * current text field
 */
@property(nullable, nonatomic, readonly, assign) RGLDocumentReaderTextField *field;
/**
 Identifies zone whence data is extracted, one of RGLResultType values
 */
@property(nonatomic, assign, readonly) RGLResultType sourceType;
/**
 A value
 */
@property(nonatomic, strong, readonly, nonnull) NSString *value;
/**
 An original value
 */
@property(nonatomic, strong, readonly, nonnull) NSString *originalValue;
/**
 Field rectangular area coordinates on the image
 */
@property(nonatomic, assign, readonly) CGRect boundRect;
/**
 RFID origin data.
 Only for the 'RFID' source
 */
@property(nonatomic, strong, readonly, nullable) RGLDocumentReaderRfidOrigin *rfidOrigin;
;
/**
 An index of the document page whence the textual field is extracted
 */
@property(nonatomic, assign, readonly) NSInteger pageIndex;
/**
 Textual field recognition probability (0 - 100, %)
 */
@property(nonatomic, assign, readonly) NSInteger probability;

/**
 * list of all symbols for this value
 */
@property(nonatomic, strong, readonly) NSArray <RGLDocumentReaderSymbol *> *originalSymbols;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json
                                field:(RGLDocumentReaderTextField *)field;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json
                                field:(RGLDocumentReaderTextField *)field;
- (NSDictionary *_Nonnull)jsonDictionary;

@end

Swift

class DocumentReaderValue : NSObject

Undocumented

  • current text field

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) RGLDocumentReaderTextField *field;

    Swift

    unowned(unsafe) var field: RGLDocumentReaderTextField? { get }

  • Identifies zone whence data is extracted, one of RGLResultType values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLResultType sourceType;

    Swift

    var sourceType: ResultType { get }

  • A value

    Declaration

    Objective-C

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

    Swift

    var value: String { get }

  • An original value

    Declaration

    Objective-C

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

    Swift

    var originalValue: String { get }

  • Field rectangular area coordinates on the image

    Declaration

    Objective-C

    @property (nonatomic, readonly) CGRect boundRect;

    Swift

    var boundRect: CGRect { get }

  • RFID origin data. Only for the ‘RFID’ source

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) RGLDocumentReaderRfidOrigin *rfidOrigin;

    Swift

    var rfidOrigin: RGLDocumentReaderRfidOrigin? { get }

  • An index of the document page whence the textual field is extracted

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger pageIndex;

    Swift

    var pageIndex: Int { get }

  • Textual field recognition probability (0 - 100, %)

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger probability;

    Swift

    var probability: Int { get }

  • list of all symbols for this value

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSArray<RGLDocumentReaderSymbol *> *_Nonnull originalSymbols;

    Swift

    var originalSymbols: [RGLDocumentReaderSymbol] { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    init(json: [AnyHashable : Any], field: RGLDocumentReaderTextField)

  • Undocumented

    Declaration

    Objective-C

    + (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json
                                field:(RGLDocumentReaderTextField *)field;

    Swift

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

  • Undocumented

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)jsonDictionary;

    Swift

    func jsonDictionary() -> [AnyHashable : Any]