Package io.scanbot.sdk.creditcard

Class CreditCardScanningResult

java.lang.Object

io.scanbot.sdk.creditcard.CreditCardScanningResult

All Implemented Interfaces:

java.lang.AutoCloseable

public class CreditCardScanningResult
extends java.lang.Object
implements java.lang.AutoCloseable

Contains the result of running the credit card scanner.

Constructor Summary

Constructors

Constructor	Description
CreditCardScanningResult(DocumentDetectionStatus detectionStatus, CreditCardScanningStatus scanningStatus, GenericDocument creditCard, java.util.List<Point> quad, java.util.List<PointF> quadNormalized)	Constructs CreditCardScanningResult with the given params.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes native resources (images) held by the object.
GenericDocument	getCreditCard()	Getter for creditCard field.
DocumentDetectionStatus	getDetectionStatus()	Getter for detectionStatus field.
java.util.List<Point>	getQuad()	Getter for quad field.
java.util.List<PointF>	getQuadNormalized()	Getter for quadNormalized field.
CreditCardScanningStatus	getScanningStatus()	Getter for scanningStatus field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreditCardScanningResult

public CreditCardScanningResult(DocumentDetectionStatus detectionStatus,
                                CreditCardScanningStatus scanningStatus,
                                GenericDocument creditCard,
                                java.util.List<Point> quad,
                                java.util.List<PointF> quadNormalized)

Constructs CreditCardScanningResult with the given params.

Parameters:

detectionStatus - The status of the credit card detection step.

scanningStatus - The status of the credit card scanning step.

creditCard - Generic document containing credit card data. Not present, if status is FAIL.

quad - Coordinates of the detected credit card in the input image (clockwise from top-left).

quadNormalized - Coordinates of the detected credit card in the input image (clockwise from top-left), normalized to the range [0, 1].

Method Detail

getDetectionStatus

public DocumentDetectionStatus getDetectionStatus()

Getter for detectionStatus field. See constructor documentation for more information about the field.

Returns:

detectionStatus

getScanningStatus

public CreditCardScanningStatus getScanningStatus()

Getter for scanningStatus field. See constructor documentation for more information about the field.

Returns:

scanningStatus

getCreditCard

public GenericDocument getCreditCard()

Getter for creditCard field. See constructor documentation for more information about the field.

Returns:

creditCard

getQuad

public java.util.List<Point> getQuad()

Getter for quad field. See constructor documentation for more information about the field.

Returns:

quad

getQuadNormalized

public java.util.List<PointF> getQuadNormalized()

Getter for quadNormalized field. See constructor documentation for more information about the field.

Returns:

quadNormalized

close

public void close()

Closes native resources (images) held by the object.

Specified by:

close in interface java.lang.AutoCloseable