java.lang.Object
- com.microblink.documentverification.entities.Entity.Result
- - com.microblink.documentverification.entities.recognizers.Recognizer.Result
  - - com.microblink.documentverification.entities.recognizers.blinkid.generic.BlinkIdCombinedRecognizer.Result

All Implemented Interfaces:: android.os.Parcelable, CombinedDataMatchResult, CombinedResult, ClassInfoResult, CombinedFullDocumentImageResult, EncodedCombinedFullDocumentImageResult, EncodedFaceImageResult, EncodedSignatureImageResult, FaceImageResult, SignatureImageResult, ProcessingStatusResult

Enclosing class:: BlinkIdCombinedRecognizer

public static final class BlinkIdCombinedRecognizer.Result
extends Recognizer.Result
implements CombinedResult, CombinedDataMatchResult, FaceImageResult, EncodedFaceImageResult, CombinedFullDocumentImageResult, EncodedCombinedFullDocumentImageResult, SignatureImageResult, EncodedSignatureImageResult, ProcessingStatusResult, ClassInfoResult

Nested Class Summary
- Nested classes/interfaces inherited from class com.microblink.documentverification.entities.recognizers.Recognizer.Result
  Recognizer.Result.State
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields
Modifier and Type Field Description

static android.os.Parcelable.Creator<BlinkIdCombinedRecognizer.Result> CREATOR
- Fields inherited from class com.microblink.documentverification.entities.Entity.Result
  mOwner
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.CombinedDataMatchResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.CombinedFullDocumentImageResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.CombinedResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.EncodedCombinedFullDocumentImageResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.EncodedFaceImageResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.EncodedSignatureImageResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.FaceImageResult
  CLASS_NAME
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.ProcessingStatusResult
  CLASS_NAME
- Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.SignatureImageResult
  CLASS_NAME

Constructor Summary

Constructors
Modifier Constructor Description

protected Result(long nativeResult)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`BlinkIdCombinedRecognizer.Result`	`clone()`	Create a copy of the result.
`protected void`	`deserializeFromByteArray(byte[] arr)`
`java.lang.String`	`getAdditionalAddressInformation()`	The additional name information of the document owner.
`java.lang.String`	`getAdditionalNameInformation()`	The additional name information of the document owner.
`java.lang.String`	`getAdditionalOptionalAddressInformation()`	The one more additional address information of the document owner.
`java.lang.String`	`getAddress()`	The address of the document owner.
`int`	`getAge()`	The current age of the document owner in years.
`AgeLimitStatus`	`getAgeLimitStatus(int ageLimit)`	Calculates whether the document owner is older than the given `ageLimit` in years or not.
`Image`	`getBackCameraFrame()`	Back camera frame.
`ImageAnalysisResult`	`getBackImageAnalysisResult()`	Image analysis result for the scanned document back side image
`ProcessingStatus`	`getBackProcessingStatus()`	Status of the last back side recognition process.
`VizResult`	`getBackVizResult()`	The data extracted from the back side visual inspection zone.
`Image`	`getBarcodeCameraFrame()`	Barcode camera frame.
`BarcodeResult`	`getBarcodeResult()`	The data extracted from the barcode.
`ClassInfo`	`getClassInfo()`	The document class information.
`DataMatchDetailedInfo`	`getDataMatchDetailedInfo()`	Detailed info on data match.
`DateResult`	`getDateOfBirth()`	The date of birth of the document owner.
`DateResult`	`getDateOfExpiry()`	The date of expiry of the document.
`DateResult`	`getDateOfIssue()`	The date of issue of the document.
`java.lang.String`	`getDocumentAdditionalNumber()`	The additional number of the document.
`DataMatchResult`	`getDocumentDataMatch()`	Returns result of the data matching algorithm for scanned parts/sides of the document.
`java.lang.String`	`getDocumentNumber()`	The document number.
`java.lang.String`	`getDocumentOptionalAdditionalNumber()`	The one more additional number of the document.
`DriverLicenseDetailedInfo`	`getDriverLicenseDetailedInfo()`	The driver license detailed info.
`java.lang.String`	`getEmployer()`	The employer of the document owner.
`byte[]`	`getEncodedBackFullDocumentImage()`
`byte[]`	`getEncodedFaceImage()`
`byte[]`	`getEncodedFrontFullDocumentImage()`
`byte[]`	`getEncodedSignatureImage()`
`Image`	`getFaceImage()`
`java.lang.String`	`getFathersName()`	The fathers name of the document owner.
`java.lang.String`	`getFirstName()`	The first name of the document owner.
`Image`	`getFrontCameraFrame()`	Front camera frame.
`ImageAnalysisResult`	`getFrontImageAnalysisResult()`	Image analysis result for the scanned document front side image
`ProcessingStatus`	`getFrontProcessingStatus()`	Status of the last front side recognition process.
`VizResult`	`getFrontVizResult()`	The data extracted from the front side visual inspection zone.
`Image`	`getFullDocumentBackImage()`
`Image`	`getFullDocumentFrontImage()`
`java.lang.String`	`getFullName()`	The full name of the document owner.
`java.lang.String`	`getIssuingAuthority()`	The issuing authority of the document.
`java.lang.String`	`getLastName()`	The last name of the document owner.
`java.lang.String`	`getLocalizedName()`	The localized name of the document owner.
`java.lang.String`	`getMaritalStatus()`	The marital status of the document owner.
`java.lang.String`	`getMothersName()`	The mothers name of the document owner.
`MrzResult`	`getMrzResult()`	The data extracted from the machine readable zone.
`java.lang.String`	`getNationality()`	The nationality of the documet owner.
`java.lang.String`	`getPersonalIdNumber()`	The personal identification number.
`java.lang.String`	`getPlaceOfBirth()`	The place of birth of the document owner.
`ProcessingStatus`	`getProcessingStatus()`	Status of the last recognition process.
`java.lang.String`	`getProfession()`	The profession of the document owner.
`java.lang.String`	`getRace()`	The race of the document owner.
`RecognitionMode`	`getRecognitionMode()`	Recognition mode used to scan current document.
`java.lang.String`	`getReligion()`	The religion of the document owner.
`java.lang.String`	`getResidentialStatus()`	The residential stauts of the document owner.
`java.lang.String`	`getSex()`	The sex of the document owner.
`Image`	`getSignatureImage()`
`boolean`	`isDateOfExpiryPermanent()`	Determines if date of expiry is permanent.
`boolean`	`isExpired()`	Checks whether the document has expired or not by comparing the current time on the device with the date of expiry.
`boolean`	`isScanningFirstSideDone()`
`protected byte[]`	`serializeToByteArray()`
`protected void`	`terminateNative(long nativeContext)`
`java.lang.String`	`toString()`

Methods inherited from class com.microblink.documentverification.entities.recognizers.Recognizer.Result
getResultState, isEmpty

Methods inherited from class com.microblink.documentverification.entities.Entity.Result
describeContents, finalize, getNativeContext, readFromParcel, writeToParcel

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CREATOR
```
public static final android.os.Parcelable.Creator<BlinkIdCombinedRecognizer.Result> CREATOR
```
- Constructor Detail
  - Result
```
protected Result(long nativeResult)
```
- Method Detail
  - getFrontImageAnalysisResult
```
@NonNull
public ImageAnalysisResult getFrontImageAnalysisResult()
```
    Image analysis result for the scanned document front side image
  - getAdditionalOptionalAddressInformation
```
@NonNull
public java.lang.String getAdditionalOptionalAddressInformation()
```
    The one more additional address information of the document owner.
  - getFathersName
```
@NonNull
public java.lang.String getFathersName()
```
    The fathers name of the document owner.
  - getDocumentNumber
```
@NonNull
public java.lang.String getDocumentNumber()
```
    The document number.
  - getDocumentOptionalAdditionalNumber
```
@NonNull
public java.lang.String getDocumentOptionalAdditionalNumber()
```
    The one more additional number of the document.
  - getFrontProcessingStatus
```
@NonNull
public ProcessingStatus getFrontProcessingStatus()
```
    Status of the last front side recognition process.
  - getBarcodeCameraFrame
```
@NonNull
public Image getBarcodeCameraFrame()
```
    Barcode camera frame.
  - getAdditionalAddressInformation
```
@NonNull
public java.lang.String getAdditionalAddressInformation()
```
    The additional name information of the document owner.
  - getEmployer
```
@NonNull
public java.lang.String getEmployer()
```
    The employer of the document owner.
  - getProfession
```
@NonNull
public java.lang.String getProfession()
```
    The profession of the document owner.
  - getEncodedFrontFullDocumentImage
```
@NonNull
public byte[] getEncodedFrontFullDocumentImage()
```
    Specified by:
    
    getEncodedFrontFullDocumentImage in interface EncodedCombinedFullDocumentImageResult
    
    Returns:
    
    encoded full document image from the front side in JPEG format if enabled with EncodeFullDocumentImagesOptions.setEncodeFullDocumentImage(boolean) , else null
  - getClassInfo
```
@NonNull
public ClassInfo getClassInfo()
```
    The document class information.
    
    Specified by:
    
    getClassInfo in interface ClassInfoResult
  - getDateOfExpiry
```
@NonNull
public DateResult getDateOfExpiry()
```
    The date of expiry of the document.
  - getLocalizedName
```
@NonNull
public java.lang.String getLocalizedName()
```
    The localized name of the document owner.
  - getBackVizResult
```
@NonNull
public VizResult getBackVizResult()
```
    The data extracted from the back side visual inspection zone.
  - getMrzResult
```
@NonNull
public MrzResult getMrzResult()
```
    The data extracted from the machine readable zone.
  - getFullDocumentBackImage
```
@Nullable
public Image getFullDocumentBackImage()
```
    Specified by:
    
    getFullDocumentBackImage in interface CombinedFullDocumentImageResult
    
    Returns:
    
    back side image of the document if enabled with FullDocumentImageOptions.setReturnFullDocumentImage(boolean), else null
  - getProcessingStatus
```
@NonNull
public ProcessingStatus getProcessingStatus()
```
    Description copied from interface: ProcessingStatusResult
    
    Status of the last recognition process.
    
    Specified by:
    
    getProcessingStatus in interface ProcessingStatusResult
  - getFirstName
```
@NonNull
public java.lang.String getFirstName()
```
    The first name of the document owner.
  - isScanningFirstSideDone
```
public boolean isScanningFirstSideDone()
```
    Specified by:
    
    isScanningFirstSideDone in interface CombinedResult
    
    Returns:
    
    true if recognizer has finished scanning first side and is now scanning back side, false if it's still scanning first side.
  - getNationality
```
@NonNull
public java.lang.String getNationality()
```
    The nationality of the documet owner.
  - getAdditionalNameInformation
```
@NonNull
public java.lang.String getAdditionalNameInformation()
```
    The additional name information of the document owner.
  - getDataMatchDetailedInfo
```
@NonNull
public DataMatchDetailedInfo getDataMatchDetailedInfo()
```
    Detailed info on data match.
  - getMothersName
```
@NonNull
public java.lang.String getMothersName()
```
    The mothers name of the document owner.
  - getMaritalStatus
```
@NonNull
public java.lang.String getMaritalStatus()
```
    The marital status of the document owner.
  - getLastName
```
@NonNull
public java.lang.String getLastName()
```
    The last name of the document owner.
  - getDriverLicenseDetailedInfo
```
@NonNull
public DriverLicenseDetailedInfo getDriverLicenseDetailedInfo()
```
    The driver license detailed info.
  - getPersonalIdNumber
```
@NonNull
public java.lang.String getPersonalIdNumber()
```
    The personal identification number.
  - getEncodedFaceImage
```
@NonNull
public byte[] getEncodedFaceImage()
```
    Specified by:
    
    getEncodedFaceImage in interface EncodedFaceImageResult
    
    Returns:
    
    encoded face image in JPEG from the document if enabled with EncodeFaceImageOptions.setEncodeFaceImage(boolean) , else null
  - getFaceImage
```
@Nullable
public Image getFaceImage()
```
    Specified by:
    
    getFaceImage in interface FaceImageResult
    
    Returns:
    
    face image from the document if enabled with FaceImageOptions.setReturnFaceImage(boolean), else null
  - getEncodedSignatureImage
```
@NonNull
public byte[] getEncodedSignatureImage()
```
    Specified by:
    
    getEncodedSignatureImage in interface EncodedSignatureImageResult
    
    Returns:
    
    encoded signature in JPEG from the document if enabled with EncodeSignatureImageOptions.setEncodeSignatureImage(boolean) , else null
  - getFrontCameraFrame
```
@NonNull
public Image getFrontCameraFrame()
```
    Front camera frame.
  - getFullDocumentFrontImage
```
@Nullable
public Image getFullDocumentFrontImage()
```
    Specified by:
    
    getFullDocumentFrontImage in interface CombinedFullDocumentImageResult
    
    Returns:
    
    front side image of the document if enabled with FullDocumentImageOptions.setReturnFullDocumentImage(boolean), else null
  - isDateOfExpiryPermanent
```
public boolean isDateOfExpiryPermanent()
```
    Determines if date of expiry is permanent.
  - getResidentialStatus
```
@NonNull
public java.lang.String getResidentialStatus()
```
    The residential stauts of the document owner.
  - getBackCameraFrame
```
@NonNull
public Image getBackCameraFrame()
```
    Back camera frame.
  - getBarcodeResult
```
@NonNull
public BarcodeResult getBarcodeResult()
```
    The data extracted from the barcode.
  - getDocumentDataMatch
```
@NonNull
public DataMatchResult getDocumentDataMatch()
```
    Description copied from interface: CombinedDataMatchResult
    
    Returns result of the data matching algorithm for scanned parts/sides of the document. For example if date of expiry is scanned from the front and back side of the document and values do not match, this method will return DataMatchResult.Failed. Result will be DataMatchResult.Success only if scanned values for all fields that are compared are the same. If data matching has not been performed, result will be DataMatchResult.NotPerformed.
    
    Specified by:
    
    getDocumentDataMatch in interface CombinedDataMatchResult
    
    Returns:
    
    result of the data matching algorithm for scanned parts/sides of the document.
  - getPlaceOfBirth
```
@NonNull
public java.lang.String getPlaceOfBirth()
```
    The place of birth of the document owner.
  - getAddress
```
@NonNull
public java.lang.String getAddress()
```
    The address of the document owner.
  - getRace
```
@NonNull
public java.lang.String getRace()
```
    The race of the document owner.
  - getEncodedBackFullDocumentImage
```
@NonNull
public byte[] getEncodedBackFullDocumentImage()
```
    Specified by:
    
    getEncodedBackFullDocumentImage in interface EncodedCombinedFullDocumentImageResult
    
    Returns:
    
    encoded full document image from the back side in JPEG format if enabled with EncodeFullDocumentImagesOptions.setEncodeFullDocumentImage(boolean) , else null
  - getRecognitionMode
```
@NonNull
public RecognitionMode getRecognitionMode()
```
    Recognition mode used to scan current document.
  - getSex
```
@NonNull
public java.lang.String getSex()
```
    The sex of the document owner.
  - getFullName
```
@NonNull
public java.lang.String getFullName()
```
    The full name of the document owner.
  - getBackProcessingStatus
```
@NonNull
public ProcessingStatus getBackProcessingStatus()
```
    Status of the last back side recognition process.
  - getDateOfBirth
```
@NonNull
public DateResult getDateOfBirth()
```
    The date of birth of the document owner.
  - getDocumentAdditionalNumber
```
@NonNull
public java.lang.String getDocumentAdditionalNumber()
```
    The additional number of the document.
  - getDateOfIssue
```
@NonNull
public DateResult getDateOfIssue()
```
    The date of issue of the document.
  - getReligion
```
@NonNull
public java.lang.String getReligion()
```
    The religion of the document owner.
  - getBackImageAnalysisResult
```
@NonNull
public ImageAnalysisResult getBackImageAnalysisResult()
```
    Image analysis result for the scanned document back side image
  - getIssuingAuthority
```
@NonNull
public java.lang.String getIssuingAuthority()
```
    The issuing authority of the document.
  - getFrontVizResult
```
@NonNull
public VizResult getFrontVizResult()
```
    The data extracted from the front side visual inspection zone.
  - getSignatureImage
```
@Nullable
public Image getSignatureImage()
```
    Specified by:
    
    getSignatureImage in interface SignatureImageResult
    
    Returns:
    
    signature image from the document if enabled with SignatureImageOptions.setReturnSignatureImage(boolean), else null
  - getAge
```
public int getAge()
```
    The current age of the document owner in years. It is calculated difference between now and date of birth. Now is current time on the device.
    
    Returns:
    
    current age of the document owner in years or -1 if date of birth is unknown.
  - getAgeLimitStatus
```
public AgeLimitStatus getAgeLimitStatus(int ageLimit)
```
    Calculates whether the document owner is older than the given ageLimit in years or not. Status is calculated by using the date of birth and the current time on the device.
    Parameters:
    
    ageLimit - age limit in years
    
    Returns:
    
    age limit status for the document owner:
    
    AgeLimitStatus.OverAgeLimit: age is greater than or equal to the given age limit
    
    AgeLimitStatus.BelowAgeLimit: age is less than the given age limit
    
    AgeLimitStatus.NotAvailable: date of birth is unknown
  - isExpired
```
public boolean isExpired()
```
    Checks whether the document has expired or not by comparing the current time on the device with the date of expiry.
    Returns:
    
    true if the document has expired, false in following cases:
    
    document does not expire (date of expiry is permanent)
    
    date of expiry has passed
    
    date of expiry is unknown and it is not permanent
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    string version of this result
  - serializeToByteArray
```
@Nullable
protected byte[] serializeToByteArray()
```
    Specified by:
    
    serializeToByteArray in class Entity.Result
  - deserializeFromByteArray
```
protected void deserializeFromByteArray(@NonNull
                                        byte[] arr)
```
    Specified by:
    
    deserializeFromByteArray in class Entity.Result
  - clone
```
public BlinkIdCombinedRecognizer.Result clone()
```
    Description copied from class: Entity.Result
    
    Create a copy of the result. This is required in order to retain the result even after owning entity has mutated it.
    
    Specified by:
    
    clone in class Recognizer.Result
    
    Returns:
    
    a copy of the result
  - terminateNative
```
protected void terminateNative(long nativeContext)
```
    Specified by:
    
    terminateNative in class Entity.Result

Class BlinkIdCombinedRecognizer.Result

Nested Class Summary

Nested classes/interfaces inherited from class com.microblink.documentverification.entities.recognizers.Recognizer.Result

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from class com.microblink.documentverification.entities.Entity.Result

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.CombinedDataMatchResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.CombinedFullDocumentImageResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.CombinedResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.EncodedCombinedFullDocumentImageResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.EncodedFaceImageResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.EncodedSignatureImageResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.FaceImageResult

Fields inherited from interface android.os.Parcelable

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.ProcessingStatusResult

Fields inherited from interface com.microblink.documentverification.entities.recognizers.blinkid.imageresult.SignatureImageResult

Constructor Summary

Method Summary

Methods inherited from class com.microblink.documentverification.entities.recognizers.Recognizer.Result

Methods inherited from class com.microblink.documentverification.entities.Entity.Result

Methods inherited from class java.lang.Object

Field Detail

CREATOR

Constructor Detail

Result

Method Detail

getFrontImageAnalysisResult

getAdditionalOptionalAddressInformation

getFathersName

getDocumentNumber

getDocumentOptionalAdditionalNumber

getFrontProcessingStatus

getBarcodeCameraFrame

getAdditionalAddressInformation

getEmployer

getProfession

getEncodedFrontFullDocumentImage

getClassInfo

getDateOfExpiry

getLocalizedName

getBackVizResult

getMrzResult

getFullDocumentBackImage

getProcessingStatus

getFirstName

isScanningFirstSideDone

getNationality

getAdditionalNameInformation

getDataMatchDetailedInfo

getMothersName

getMaritalStatus

getLastName

getDriverLicenseDetailedInfo

getPersonalIdNumber

getEncodedFaceImage

getFaceImage

getEncodedSignatureImage

getFrontCameraFrame

getFullDocumentFrontImage

isDateOfExpiryPermanent

getResidentialStatus

getBackCameraFrame

getBarcodeResult

getDocumentDataMatch

getPlaceOfBirth

getAddress

getRace

getEncodedBackFullDocumentImage

getRecognitionMode

getSex

getFullName

getBackProcessingStatus

getDateOfBirth

getDocumentAdditionalNumber

getDateOfIssue

getReligion

getBackImageAnalysisResult

getIssuingAuthority

getFrontVizResult

getSignatureImage