Package io.scanbot.sdk.check
Class CheckScanningResult
-
- All Implemented Interfaces:
-
android.os.Parcelable
,java.lang.AutoCloseable
public final class CheckScanningResult implements AutoCloseable, Parcelable
The result of check scanning.
-
-
Field Summary
Fields Modifier and Type Field Description private final CheckMagneticInkStripScanningStatus
status
private final GenericDocument
check
private final DocumentDetectionResult
documentDetectionResult
private final ImageRef
croppedImage
-
Constructor Summary
Constructors Constructor Description CheckScanningResult(Map<String, Object> source)
CheckScanningResult(JSONObject json)
CheckScanningResult(CheckMagneticInkStripScanningStatus status, GenericDocument check, DocumentDetectionResult documentDetectionResult, ImageRef croppedImage)
-
Method Summary
Modifier and Type Method Description final CheckMagneticInkStripScanningStatus
getStatus()
Magnetic ink strip scanning status. final GenericDocument
getCheck()
Generic document containing check data. final DocumentDetectionResult
getDocumentDetectionResult()
The result of document detection. final ImageRef
getCroppedImage()
Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. final JSONObject
toJson(ToJsonConfiguration config)
final CheckScanningResult
clone()
Unit
close()
-
-
Constructor Detail
-
CheckScanningResult
CheckScanningResult(JSONObject json)
-
CheckScanningResult
CheckScanningResult(CheckMagneticInkStripScanningStatus status, GenericDocument check, DocumentDetectionResult documentDetectionResult, ImageRef croppedImage)
-
-
Method Detail
-
getStatus
final CheckMagneticInkStripScanningStatus getStatus()
Magnetic ink strip scanning status.
Default is ERROR_NOTHING_FOUND
-
getCheck
final GenericDocument getCheck()
Generic document containing check data. Not present, if status is FAIL.
-
getDocumentDetectionResult
final DocumentDetectionResult getDocumentDetectionResult()
The result of document detection. Will be set only if detectDocument in the configuration is set to true. Check scanning may still succeed even if the whole document is not visible in the input image and the complete document could not be located.
-
getCroppedImage
final ImageRef getCroppedImage()
Crop of the check if documentDetectionMode is set to DETECT_AND_CROP_DOCUMENT. Will be non-empty, only if check recognition succeeded.
-
toJson
final JSONObject toJson(ToJsonConfiguration config)
-
clone
final CheckScanningResult clone()
-
-
-
-