RGLDocumentReaderTextField

Objective-C

@interface RGLDocumentReaderTextField : NSObject

/**
 Textual field logical type, one of RGLFieldType values
 */
@property(nonatomic, assign, readonly) RGLFieldType fieldType;
/**
 Textual field symbolic name
 */
@property(nonatomic, strong, readonly, nonnull) NSString *fieldName;
/**
 ID of language-culture to differentiate one field of the same type from another (for example Belarus Passport Page # 31 – Belarusian and Russian fields of the same type), one of RGLLCID values
 */
@property(nonatomic, assign, readonly) RGLLCID lcid;

@property(nonnull, nonatomic, strong, readonly) NSString *lcidName;
/**
 * value from the field
 */
@property(nonatomic, strong, readonly, nonnull) NSString *value;
/**
 An array of values
 */
@property(nonatomic, strong, readonly, nonnull) NSArray <RGLDocumentReaderValue *> *values;
/**
 Textual field check result, one of RGLCheckResult values
 */
@property(nonatomic, assign, readonly) RGLCheckResult status;

/**
 List of all comparison statuses for this field type
 */
@property(nonnull, nonatomic, strong, readonly) NSArray <RGLDocumentReaderComparison *> *comparisonList;

/**
 List of all  validity statuses for this field type
 */
@property(nonnull, nonatomic, strong, readonly) NSArray<RGLDocumentReaderValidity *> *validityList;

/**
 Comparison result of the field
 */
@property(nonatomic, assign, readonly) RGLCheckResult comparisonStatus;

/**
 Validity result of the field
 */
@property(nonatomic, assign, readonly) RGLCheckResult validityStatus;

- (RGLDocumentReaderValue *_Nullable)getValue;

- (instancetype _Nonnull)init NS_UNAVAILABLE;
- (instancetype _Nonnull)initWithFieldType:(RGLFieldType)fieldType;
- (instancetype _Nonnull)initWithFieldType:(RGLFieldType)fieldType lcid:(RGLLCID)lcid;
- (instancetype _Nonnull)initWithJSON:(NSDictionary *_Nonnull)json sourceList:(NSDictionary *_Nonnull)sourceList;;
+ (instancetype _Nonnull)initWithJSON:(NSDictionary * _Nonnull)json sourceList:(NSDictionary *_Nonnull)sourceList;;
- (NSDictionary *_Nonnull)jsonDictionary;

+ (NSString *_Nonnull)fieldTypeName:(RGLFieldType) fieldType;
+ (NSString *_Nonnull)lcidName:(RGLLCID) lcid;

@end

Swift

class DocumentReaderTextField : NSObject

Undocumented

  • Textual field logical type, one of RGLFieldType values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLFieldType fieldType;

    Swift

    var fieldType: FieldType { get }

  • Textual field symbolic name

    Declaration

    Objective-C

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

    Swift

    var fieldName: String { get }

  • ID of language-culture to differentiate one field of the same type from another (for example Belarus Passport Page # 31 – Belarusian and Russian fields of the same type), one of RGLLCID values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLLCID lcid;

    Swift

    var lcid: LCID { get }

  • Undocumented

    Declaration

    Objective-C

    @property(nonnull, nonatomic, strong, readonly) NSString *lcidName

    Swift

    var lcidName: String { get }

  • value from the field

    Declaration

    Objective-C

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

    Swift

    var value: String { get }

  • An array of values

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<RGLDocumentReaderValue *> *values;

    Swift

    var values: [RGLDocumentReaderValue] { get }

  • Textual field check result, one of RGLCheckResult values

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLCheckResult status;

    Swift

    var status: CheckResult { get }

  • List of all comparison statuses for this field type

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<RGLDocumentReaderComparison *> *comparisonList;

    Swift

    var comparisonList: [RGLDocumentReaderComparison] { get }

  • List of all validity statuses for this field type

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSArray<RGLDocumentReaderValidity *> *validityList;

    Swift

    var validityList: [RGLDocumentReaderValidity] { get }

  • Comparison result of the field

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLCheckResult comparisonStatus;

    Swift

    var comparisonStatus: CheckResult { get }

  • Validity result of the field

    Declaration

    Objective-C

    @property (nonatomic, readonly) RGLCheckResult validityStatus;

    Swift

    var validityStatus: CheckResult { get }

  • Undocumented

    Declaration

    Objective-C

    - (RGLDocumentReaderValue *_Nullable)getValue;

    Swift

    func getValue() -> RGLDocumentReaderValue?

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)init NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithFieldType:(RGLFieldType)fieldType;

    Swift

    init(fieldType: FieldType)

  • Undocumented

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithFieldType:(RGLFieldType)fieldType lcid:(RGLLCID)lcid;

    Swift

    init(fieldType: FieldType, lcid: LCID)

  • Undocumented

    Declaration

    Objective-C

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

    Swift

    init(json: [AnyHashable : Any], sourceList: [AnyHashable : Any])

  • Undocumented

    Declaration

    Objective-C

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

    Swift

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

  • Undocumented

    Declaration

    Objective-C

    - (NSDictionary *_Nonnull)jsonDictionary;

    Swift

    func jsonDictionary() -> [AnyHashable : Any]

  • Undocumented

    Declaration

    Objective-C

    + (NSString *_Nonnull)fieldTypeName:(RGLFieldType) fieldType;

    Swift

    class func fieldTypeName(_ fieldType: FieldType) -> String

  • Undocumented

    Declaration

    Objective-C

    + (NSString *_Nonnull)lcidName:(RGLLCID) lcid;

    Swift

    class func lcidName(_ lcid: LCID) -> String