All Implemented Interfaces:: android.os.Parcelable


public final class CreditCardScannerConfiguration
 implements Parcelable

Configuration for the credit card scanner.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`useDocumentDetector`
`private CreditCardScanningMode`	`scanningMode`
`private Boolean`	`requireExpiryDate`
`private Boolean`	`requireCardholderName`
`private ResultAccumulationConfiguration`	`resultAccumulationConfig`
`private Boolean`	`returnCreditCardImage`

Constructor Summary

Constructors
Constructor	Description
`CreditCardScannerConfiguration(Map<String, Object> source)`
`CreditCardScannerConfiguration(JSONObject json)`
`CreditCardScannerConfiguration(Boolean useDocumentDetector, CreditCardScanningMode scanningMode, Boolean requireExpiryDate, Boolean requireCardholderName, ResultAccumulationConfiguration resultAccumulationConfig, Boolean returnCreditCardImage)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getUseDocumentDetector()`	If true, the document detector will be used to find where the credit card is in the input image.
`final Unit`	`setUseDocumentDetector(Boolean useDocumentDetector)`	If true, the document detector will be used to find where the credit card is in the input image.
`final CreditCardScanningMode`	`getScanningMode()`	The scanning mode.
`final Unit`	`setScanningMode(CreditCardScanningMode scanningMode)`	The scanning mode.
`final Boolean`	`getRequireExpiryDate()`	Whether the expiry date is required for a successful scan.
`final Unit`	`setRequireExpiryDate(Boolean requireExpiryDate)`	Whether the expiry date is required for a successful scan.
`final Boolean`	`getRequireCardholderName()`	Whether the cardholder name is required for a successful scan.
`final Unit`	`setRequireCardholderName(Boolean requireCardholderName)`	Whether the cardholder name is required for a successful scan.
`final ResultAccumulationConfiguration`	`getResultAccumulationConfig()`	Configuration for how to accumulate results.
`final Unit`	`setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)`	Configuration for how to accumulate results.
`final Boolean`	`getReturnCreditCardImage()`	If true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
`final Unit`	`setReturnCreditCardImage(Boolean returnCreditCardImage)`	If true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final CreditCardScannerConfiguration`	`clone()`
`final static CreditCardScannerConfiguration`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreditCardScannerConfiguration
```
CreditCardScannerConfiguration(Map<String, Object> source)
```
  - CreditCardScannerConfiguration
```
CreditCardScannerConfiguration(JSONObject json)
```
  - CreditCardScannerConfiguration
```
CreditCardScannerConfiguration(Boolean useDocumentDetector, CreditCardScanningMode scanningMode, Boolean requireExpiryDate, Boolean requireCardholderName, ResultAccumulationConfiguration resultAccumulationConfig, Boolean returnCreditCardImage)
```
- Method Detail
  - getUseDocumentDetector
```
 final Boolean getUseDocumentDetector()
```
    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
  - setUseDocumentDetector
```
 final Unit setUseDocumentDetector(Boolean 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
  - getScanningMode
```
 final CreditCardScanningMode getScanningMode()
```
    The scanning mode.
    Default is LIVE
  - setScanningMode
```
 final Unit setScanningMode(CreditCardScanningMode scanningMode)
```
    The scanning mode.
    Default is LIVE
  - getRequireExpiryDate
```
 final Boolean getRequireExpiryDate()
```
    Whether the expiry date is required for a successful scan.
    Default is true
  - setRequireExpiryDate
```
 final Unit setRequireExpiryDate(Boolean requireExpiryDate)
```
    Whether the expiry date is required for a successful scan.
    Default is true
  - getRequireCardholderName
```
 final Boolean getRequireCardholderName()
```
    Whether the cardholder name is required for a successful scan.
    Default is true
  - setRequireCardholderName
```
 final Unit setRequireCardholderName(Boolean requireCardholderName)
```
    Whether the cardholder name is required for a successful scan.
    Default is true
  - getResultAccumulationConfig
```
 final ResultAccumulationConfiguration getResultAccumulationConfig()
```
    Configuration for how to accumulate results.
  - setResultAccumulationConfig
```
 final Unit setResultAccumulationConfig(ResultAccumulationConfiguration resultAccumulationConfig)
```
    Configuration for how to accumulate results.
  - getReturnCreditCardImage
```
 final Boolean getReturnCreditCardImage()
```
    If true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
    Default is false
  - setReturnCreditCardImage
```
 final Unit setReturnCreditCardImage(Boolean returnCreditCardImage)
```
    If true, the credit card image will be returned in creditCard field of CreditCardScanningResult.
    Default is false
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final CreditCardScannerConfiguration clone()
```
  - default
```
 final static CreditCardScannerConfiguration default()
```

Class CreditCardScannerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreditCardScannerConfiguration

CreditCardScannerConfiguration

CreditCardScannerConfiguration

Method Detail

getUseDocumentDetector

setUseDocumentDetector

getScanningMode

setScanningMode

getRequireExpiryDate

setRequireExpiryDate

getRequireCardholderName

setRequireCardholderName

getResultAccumulationConfig

setResultAccumulationConfig

getReturnCreditCardImage

setReturnCreditCardImage

toJson

clone

default