io.scanbot.idcardscanner

Class IdScanResult

io.scanbot.idcardscanner.IdScanResult

public class IdScanResult

Container for result of recognition attempt

Constructor Detail

IdScanResult

public IdScanResult(@NotNull
                    io.scanbot.idcardscanner.IdScanResult.RecognitionStatus status,
                    @NotNull
                    io.scanbot.idcardscanner.IdScanResult.DocumentType documentType,
                    @NotNull
                    java.util.List<io.scanbot.idcardscanner.IdScanResult.Field> fields,
                    @Nullable
                    android.graphics.Bitmap croppedImage,
                    @Nullable
                    io.scanbot.genericdocument.entity.GenericDocument document)

Container for result of recognition attempt

Parameters:

fields - Contains list of class IdScanResult.Fields when explicitly requested to detect and recognize themOtherwise - empty array

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

document - Generic document object containing the recognized document

Method Detail

getStatus

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

getDocumentType

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

getFields

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

Contains list of

class IdScanResult.Fields when explicitly requested to detect and recognize themOtherwise - empty array

See Also:

class IdScanResult.Field

getCroppedImage

@Nullable
public android.graphics.Bitmap getCroppedImage()

Contains cropped IdCard image if it was detected

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

getDocument

@Nullable
public io.scanbot.genericdocument.entity.GenericDocument getDocument()

Generic document object containing the recognized document

component1

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

component2

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

component3

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

Contains list of

class IdScanResult.Fields when explicitly requested to detect and recognize themOtherwise - empty array

See Also:

class IdScanResult.Field

component4

@Nullable
public android.graphics.Bitmap component4()

Contains cropped IdCard image if it was detected

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

component5

@Nullable
public io.scanbot.genericdocument.entity.GenericDocument component5()

Generic document object containing the recognized document

copy

@NotNull
public IdScanResult copy(@NotNull
                                  io.scanbot.idcardscanner.IdScanResult.RecognitionStatus status,
                                  @NotNull
                                  io.scanbot.idcardscanner.IdScanResult.DocumentType documentType,
                                  @NotNull
                                  java.util.List<io.scanbot.idcardscanner.IdScanResult.Field> fields,
                                  @Nullable
                                  android.graphics.Bitmap croppedImage,
                                  @Nullable
                                  io.scanbot.genericdocument.entity.GenericDocument document)

Container for result of recognition attempt

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

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