SBSDKMachineReadableZoneRecognizerResult Class Reference


                    
                    
                    recognitionSuccessful

Whether the recognition was successful or not.

Declaration

Objective-C

@property (nonatomic) BOOL recognitionSuccessful;

Swift

var recognitionSuccessful: Bool { get set }


                    
                    
                    rawString

The raw string of the recognized machine readable zone.

Declaration

Objective-C

@property (nonatomic, strong, nonnull) NSString *rawString;

Swift

var rawString: String { get set }


                    
                    
                    documentType

The type of the recognized document.

Declaration

Objective-C

@property (nonatomic) SBSDKMachineReadableZoneRecognizerResultDocumentType documentType;

Swift

var documentType: SBSDKMachineReadableZoneRecognizerResultDocumentType { get set }


                    
                    
                    documentCodeField

The document code.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *documentCodeField;

Swift

var documentCodeField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    issuingStateOrOrganizationField

The issuing state or organization.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *issuingStateOrOrganizationField;

Swift

var issuingStateOrOrganizationField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    departmentOfIssuanceField

The issuing department.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *departmentOfIssuanceField;

Swift

var departmentOfIssuanceField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    firstNameField

The first name.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *firstNameField;

Swift

var firstNameField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    lastNameField

The last name.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *lastNameField;

Swift

var lastNameField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    nationalityField

The nationality.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *nationalityField;

Swift

var nationalityField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    dateOfBirthField

The date of birth.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *dateOfBirthField;

Swift

var dateOfBirthField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    genderField

The gender.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *genderField;

Swift

var genderField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    dateOfExpiryField

The expiration date.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *dateOfExpiryField;

Swift

var dateOfExpiryField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    personalNumberField

The personal number.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *personalNumberField;

Swift

var personalNumberField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    travelDocumentTypeField

The travel document type.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *travelDocumentTypeField;

Swift

var travelDocumentTypeField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    optional1Field

The optional field #1.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *optional1Field;

Swift

var optional1Field: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    optional2Field

The optional field #2.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *optional2Field;

Swift

var optional2Field: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    discreetIssuingStateOrOrganizationField

The discreet issuing state or organization.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *discreetIssuingStateOrOrganizationField;

Swift

var discreetIssuingStateOrOrganizationField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    kindOfDocumentField

The kind of document in Swiss driver license.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *kindOfDocumentField;

Swift

var kindOfDocumentField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    PINNumberField

The PIN number in Swiss driver license.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *PINNumberField;

Swift

var pinNumberField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    languageCodeField

The language code in Swiss driver license.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *languageCodeField;

Swift

var languageCodeField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    versionNumberField

The version of the document in Swiss driver license.

Declaration

Objective-C

@property (nonatomic, strong, nullable) SBSDKMachineReadableZoneRecognizerField *versionNumberField;

Swift

var versionNumberField: SBSDKMachineReadableZoneRecognizerField? { get set }


                    
                    
                    fields

An array of all recognized fields.

Declaration

Objective-C

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

Swift

var fields: [SBSDKMachineReadableZoneRecognizerField] { get set }


                    
                    
                    checkDigits

An array of recognized checkdigits.

Declaration

Objective-C

@property (nonatomic, strong, nonnull) NSArray<SBSDKMachineReadableZoneRecognizerResultCheckDigit *> *checkDigits;

Swift

var checkDigits: [SBSDKMachineReadableZoneRecognizerResultCheckDigit] { get set }


                    
                    
                    -stringRepresentation

Returns a string representation of all fields.

Declaration

Objective-C

- (nonnull NSString *)stringRepresentation;

Swift

func stringRepresentation() -> String

Return Value

String, containing the field names, values and confidences of all fields.


                    
                    
                    -stringRepresentationWithoutConfidence

Returns a string representation of all fields.

Declaration

Objective-C

- (nonnull NSString *)stringRepresentationWithoutConfidence;

Swift

func stringRepresentationWithoutConfidence() -> String

Return Value

String, containing the field names and values of all fields.


                    
                    
                    validCheckDigitsCount

Number of successfully validated check digits.

Declaration

Objective-C

@property (nonatomic) int validCheckDigitsCount;

Swift

var validCheckDigitsCount: Int32 { get set }


                    
                    
                    checkDigitsCount

Total number of check digits as required by the travel document type

Declaration

Objective-C

@property (nonatomic) int checkDigitsCount;

Swift

var checkDigitsCount: Int32 { get set }