ScanOptions class
Constructors
-
ScanOptions({bool scanExpiryDate = true, bool scanCardHolderName = true, int initialScansToDrop = 1, int validCardsToScanBeforeFinishingScan = 1, List<
String> cardHolderNameBlackListedWords = const [], bool considerPastDatesInExpiryDateScan = false, int maxCardHolderNameLength = 26, bool enableLuhnCheck = true, bool enableDebugLogs = false, int cardScannerTimeOut = 0, List<CardHolderPosition> possibleCardHolderNamePositions = const [CardHolderPosition.belowCardNumber]}) -
const
Properties
-
cardHolderNameBlackListedWords
→ List<
String> -
Additional list of words that needs to be ignored when performing card holder name scan
since card holder name scan can have many false positives. (There is no proper way to verify if a word is a name or not)
By default words in
CardHolderNameConstants.defaultBlackListedWords
are used for blacklisting. This cardHolderNameBlackListedWords defaults to an empty set. If this parameter is set, then these words are added to the default blacklisted wordsfinal - cardScannerTimeOut → int
-
Timeout duration after which card scanner will just return the current optimal scan result which may contain false positives
Timeout is useful when lighting conditions are bad and only few frames capture the card details.
Once timeout happens, whatever the details captured till that time will be returned which can even be
null
Defaults to 0 or no-timeoutfinal - considerPastDatesInExpiryDateScan → bool
-
setting this to true, will consider past dates also in expiry date scan.
If a scanned date in the frame is before the current date, then that date is dropped.
Defaults to
false
final - enableDebugLogs → bool
-
final
- enableLuhnCheck → bool
-
Scanned card numbers are put to "Luhn" algorithm check. Only if it passes the check , then its considered as a valid credit/debit card.
Defaults to true since all real cards must pass
Luhn
algorithmfinal - hashCode → int
-
The hash code for this object.
no setterinherited
- initialScansToDrop → int
-
This parameter is used so that some valid initial scan results containing false positives are dropped
final
-
map
→ Map<
String, String> -
no setter
- maxCardHolderNameLength → int
-
Defaults to
26
final -
possibleCardHolderNamePositions
→ List<
CardHolderPosition> -
indicates possible positions are the expected positions for the card holder name with respect to the card number
defaults to CardHolderPosition.belowCardNumber
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scanCardHolderName → bool
-
final
- scanExpiryDate → bool
-
final
- validCardsToScanBeforeFinishingScan → int
-
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited