io.scanbot.sdk.idcardscanner

Class IdScanResult

io.scanbot.sdk.idcardscanner.IdScanResult

public class IdScanResult

Container for results of interface IdCardScanner

See Also:

interface IdCardScanner

Constructor Detail

IdScanResult

public IdScanResult(@NotNull
                    io.scanbot.sdk.idcardscanner.IdScanResult.RecognitionStatus status,
                    @NotNull
                    io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType documentType,
                    @NotNull
                    java.util.List<io.scanbot.sdk.idcardscanner.IdScanResult.Field> fields,
                    @NotNull
                    java.util.List<io.scanbot.mrzscanner.model.MRZField> mrzFields,
                    @NotNull
                    java.util.List<io.scanbot.mrzscanner.model.MRZCheckDigit> mrzCheckDigits,
                    @Nullable
                    android.graphics.Bitmap croppedImage)

Container for results of interface IdCardScanner

Parameters:

status - Recognition status

documentType - Type of detected document

fields - Contains list of class IdScanResult.Field detected on the imageOtherwise - empty array

mrzFields - Contains list of MRZField detected on the imageOtherwise - empty array

mrzCheckDigits - Contains list of MRZCheckDigit detected on the imageOtherwise - empty array

croppedImage - Contains cropped IdCard image if it was detected (that is whenstatus equals RecognitionStatus.Success or RecognitionStatus.SuccessFound)

See Also:

interface IdCardScanner

Method Detail

getStatus

@NotNull
public io.scanbot.sdk.idcardscanner.IdScanResult.RecognitionStatus getStatus()

Recognition status

getDocumentType

@NotNull
public io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType getDocumentType()

Type of detected document

getFields

@NotNull
public java.util.List<io.scanbot.sdk.idcardscanner.IdScanResult.Field> getFields()

Contains list of

class IdScanResult.Field detected on the imageOtherwise - empty array

See Also:

class IdScanResult.Field

getMrzFields

@NotNull
public java.util.List<io.scanbot.mrzscanner.model.MRZField> getMrzFields()

Contains list of

MRZField detected on the imageOtherwise - empty array

getMrzCheckDigits

@NotNull
public java.util.List<io.scanbot.mrzscanner.model.MRZCheckDigit> getMrzCheckDigits()

Contains list of

MRZCheckDigit detected on the imageOtherwise - empty array

getCroppedImage

@Nullable
public android.graphics.Bitmap getCroppedImage()

Contains cropped IdCard image if it was detected

(that is whenstatus equals RecognitionStatus.Success or RecognitionStatus.SuccessFound)

component1

@NotNull
public io.scanbot.sdk.idcardscanner.IdScanResult.RecognitionStatus component1()

Recognition status

component2

@NotNull
public io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType component2()

Type of detected document

component3

@NotNull
public java.util.List<io.scanbot.sdk.idcardscanner.IdScanResult.Field> component3()

Contains list of

class IdScanResult.Field detected on the imageOtherwise - empty array

See Also:

class IdScanResult.Field

component4

@NotNull
public java.util.List<io.scanbot.mrzscanner.model.MRZField> component4()

Contains list of

MRZField detected on the imageOtherwise - empty array

component5

@NotNull
public java.util.List<io.scanbot.mrzscanner.model.MRZCheckDigit> component5()

Contains list of

MRZCheckDigit detected on the imageOtherwise - empty array

component6

@Nullable
public android.graphics.Bitmap component6()

Contains cropped IdCard image if it was detected

(that is whenstatus equals RecognitionStatus.Success or RecognitionStatus.SuccessFound)

copy

@NotNull
public IdScanResult copy(@NotNull
                                  io.scanbot.sdk.idcardscanner.IdScanResult.RecognitionStatus status,
                                  @NotNull
                                  io.scanbot.sdk.idcardscanner.IdScanResult.DocumentType documentType,
                                  @NotNull
                                  java.util.List<io.scanbot.sdk.idcardscanner.IdScanResult.Field> fields,
                                  @NotNull
                                  java.util.List<io.scanbot.mrzscanner.model.MRZField> mrzFields,
                                  @NotNull
                                  java.util.List<io.scanbot.mrzscanner.model.MRZCheckDigit> mrzCheckDigits,
                                  @Nullable
                                  android.graphics.Bitmap croppedImage)

Container for results of interface IdCardScanner

See Also:

interface IdCardScanner

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)