Package io.scanbot.sdk.creditcard

Class CreditCardScannerConfiguration

java.lang.Object

io.scanbot.sdk.creditcard.CreditCardScannerConfiguration

public class CreditCardScannerConfiguration
extends Object

Configuration for the credit card scanner.

Constructor Summary

Constructors

Constructor	Description
CreditCardScannerConfiguration()	Constructs CreditCardScannerConfiguration with default parameters.
CreditCardScannerConfiguration(boolean useDocumentDetector, boolean requireExpiryDate, boolean requireCardholderName, ResultAccumulationConfiguration resultAccumulationConfig, boolean returnCreditCardImage, ProcessingMode processingMode)	Constructs CreditCardScannerConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
ProcessingMode	getProcessingMode()	Getter for processingMode field.
boolean	getRequireCardholderName()	Getter for requireCardholderName field.
boolean	getRequireExpiryDate()	Getter for requireExpiryDate field.
ResultAccumulationConfiguration	getResultAccumulationConfig()	Getter for resultAccumulationConfig field.
boolean	getReturnCreditCardImage()	Getter for returnCreditCardImage field.
boolean	getUseDocumentDetector()	Getter for useDocumentDetector field.
void	setProcessingMode(ProcessingMode processingMode)	Setter for processingMode field.
void	setRequireCardholderName(boolean requireCardholderName)	Setter for requireCardholderName field.
void	setRequireExpiryDate(boolean requireExpiryDate)	Setter for requireExpiryDate field.
void	setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)	Setter for resultAccumulationConfig field.
void	setReturnCreditCardImage(boolean returnCreditCardImage)	Setter for returnCreditCardImage field.
void	setUseDocumentDetector(boolean useDocumentDetector)	Setter for useDocumentDetector field.

Methods inherited from class java.lang.Object

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

Constructor Details

CreditCardScannerConfiguration

public CreditCardScannerConfiguration(boolean useDocumentDetector,
 boolean requireExpiryDate,
 boolean requireCardholderName,
 ResultAccumulationConfiguration resultAccumulationConfig,
 boolean returnCreditCardImage,
 ProcessingMode processingMode)

Constructs CreditCardScannerConfiguration with the given params.

Parameters:

useDocumentDetector - If true, the document detector will be used to find where the credit card is in the input image. If false, the scanner will assume that the credit card has been pre-cropped and takes the entirety of the input image. Default is `true`.

requireExpiryDate - Whether the expiry date is required for a successful scan. Default is `true`.

requireCardholderName - Whether the cardholder name is required for a successful scan. Default is `true`.

resultAccumulationConfig - Configuration for how to accumulate results.

returnCreditCardImage - If true, the credit card image will be returned in creditCard field of CreditCardScanningResult. Default is `false`.

processingMode - Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it. On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject. Default is `AUTO`.

CreditCardScannerConfiguration

public CreditCardScannerConfiguration()

Constructs CreditCardScannerConfiguration with default parameters.

Method Details

getUseDocumentDetector

public boolean getUseDocumentDetector()

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

Returns:

useDocumentDetector

setUseDocumentDetector

public void setUseDocumentDetector(boolean useDocumentDetector)

Setter for useDocumentDetector field. See constructor documentation for more information about the field.

Parameters:

useDocumentDetector - Value to set.

getRequireExpiryDate

public boolean getRequireExpiryDate()

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

Returns:

requireExpiryDate

setRequireExpiryDate

public void setRequireExpiryDate(boolean requireExpiryDate)

Setter for requireExpiryDate field. See constructor documentation for more information about the field.

Parameters:

requireExpiryDate - Value to set.

getRequireCardholderName

public boolean getRequireCardholderName()

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

Returns:

requireCardholderName

setRequireCardholderName

public void setRequireCardholderName(boolean requireCardholderName)

Setter for requireCardholderName field. See constructor documentation for more information about the field.

Parameters:

requireCardholderName - Value to set.

getResultAccumulationConfig

public ResultAccumulationConfiguration getResultAccumulationConfig()

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

Returns:

resultAccumulationConfig

setResultAccumulationConfig

public void setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)

Setter for resultAccumulationConfig field. See constructor documentation for more information about the field.

Parameters:

resultAccumulationConfig - Value to set.

getReturnCreditCardImage

public boolean getReturnCreditCardImage()

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

Returns:

returnCreditCardImage

setReturnCreditCardImage

public void setReturnCreditCardImage(boolean returnCreditCardImage)

Setter for returnCreditCardImage field. See constructor documentation for more information about the field.

Parameters:

returnCreditCardImage - Value to set.

getProcessingMode

public ProcessingMode getProcessingMode()

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

Returns:

processingMode

setProcessingMode

public void setProcessingMode(ProcessingMode processingMode)

Setter for processingMode field. See constructor documentation for more information about the field.

Parameters:

processingMode - Value to set.