RGLDocumentReaderTextResult

Objective-C

@interface RGLDocumentReaderTextResult : NSObject

/**
 An array of textual results
 */
@property(nonatomic, strong, readonly, nonnull) NSArray <RGLDocumentReaderTextField *> *fields;

/**
 Textual fields check result, one of RGLCheckResult values
 */
@property(nonatomic, assign, readonly) RGLCheckResult status;

/**
 List of all available origin source
 with overall validity status of all text fields of a particular source type
 */
@property(nonnull, nonatomic, strong, readonly) NSArray <RGLDocumentReaderTextSource *> *availableSourceList;

/**
 Comparison status of all text fields
 */
@property(nonatomic, assign, readonly) RGLCheckResult comparisonStatus;

/**
 Validity status of all text fields
 */
@property(nonatomic, assign, readonly) RGLCheckResult validityStatus;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json;
- (NSDictionary *_Nonnull)jsonDictionary;
- (void)sortByFieldType:(BOOL)desc;

@end

Swift

class DocumentReaderTextResult : NSObject

Undocumented

  • An array of textual results

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<RGLDocumentReaderTextField *> *fields;

    Swift

    var fields: [RGLDocumentReaderTextField] { get }

  • Textual fields check result, one of RGLCheckResult values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLCheckResult status;

    Swift

    var status: CheckResult { get }

  • List of all available origin source with overall validity status of all text fields of a particular source type

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<RGLDocumentReaderTextSource *> *availableSourceList;

    Swift

    var availableSourceList: [RGLDocumentReaderTextSource] { get }

  • Comparison status of all text fields

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLCheckResult comparisonStatus;

    Swift

    var comparisonStatus: CheckResult { get }

  • Validity status of all text fields

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLCheckResult validityStatus;

    Swift

    var validityStatus: CheckResult { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    init(json: [AnyHashable : Any])

  • Undocumented

    Declaration

    Objective-C

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

    Swift

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

  • Undocumented

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)jsonDictionary;

    Swift

    func jsonDictionary() -> [AnyHashable : Any]

  • Undocumented

    Declaration

    Objective-C

    - (void)sortByFieldType:(BOOL)desc;

    Swift

    func sort(byFieldType desc: Bool)