CreditCardScanner

java.lang.Object

io.scanbot.sdk.creditcard.CreditCardScanner

All Implemented Interfaces:: AutoCloseable

public class CreditCardScanner extends Object implements AutoCloseable

API for credit card scanning. Required licence feature(s): CreditCardScanner.

Constructor Summary

Constructors

Constructor

Description

CreditCardScanner(CreditCardScannerConfiguration configuration)

Constructs CreditCardScanner with the given params.
Method Summary

Modifier and Type

Method

Description

void

clearResult()

Clears the accumulated results.

void

close()

Closes native resources held by the object.

protected void

finalize()

CreditCardScanningResult

run(ImageRef image)

Scan the credit card in the given image.

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

Constructor Details
- CreditCardScanner
  
  public CreditCardScanner(CreditCardScannerConfiguration configuration) throws LicenseException
  
  Constructs CreditCardScanner with the given params.
  
  Parameters:
  
  configuration - The configuration to use for the scanner.
  
  Throws:
  
  LicenseException - If license requirements for the API are not met
Method Details
- run
  
  public CreditCardScanningResult run(ImageRef image) throws InvalidImageRefException, LicenseException
  
  Scan the credit card in the given image.
  
  Parameters:
  
  image - The image to scan.
  
  Returns:
  
  The scanning result.
  
  Throws:
  
  InvalidImageRefException - If an invalid image reference is used
  
  LicenseException - If license requirements for the API are not met
- clearResult
  
  public void clearResult()
  
  Clears the accumulated results. Should be called after a document has been scanned to the customers satisfaction to prevent a poisoned cache.
- close
  
  public void close()
  
  Closes native resources held by the object.
  
  Specified by:
  
  close in interface AutoCloseable
- finalize
  
  protected void finalize() throws Throwable
  
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable