BlinkCardOverlaySettings class
Class for setting up BlinkCard overlay. BlinkCard overlay is best suited for scanning payment cards.
- Inheritance
-
- Object
- OverlaySettings
- BlinkCardOverlaySettings
- Annotations
-
- @JsonSerializable.new()
Constructors
- BlinkCardOverlaySettings()
-
BlinkCardOverlaySettings.fromJson(Map<
String, dynamic> json) -
factory
Properties
- country ↔ String?
-
Used with language variable, it defines the country locale
getter/setter pairoverride
- enableBeep ↔ bool
-
whether beep sound will be played on successful scan
false by default
getter/setter pairinherited
- errorCardTooCloseToEdge ↔ String?
-
String: Instructions for the user to move the document from the edge
getter/setter pair
- errorMoveCloser ↔ String?
-
String: Instructions for the user to move the document closer
getter/setter pair
- errorMoveFarther ↔ String?
-
String: Instructions for the user to move the document farther
getter/setter pair
- firstSideInstructions ↔ String?
-
String: user instructions that are shown above camera preview while the first side of the
document is being scanned.
If null, default value will be used.
getter/setter pair
- flipCardInstructions ↔ String?
-
String: user instructions that are shown above camera preview while the second side of the
document is being scanned.
If null, default value will be used.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- language ↔ String?
-
Language of the UI.
If default overlay contains textual information, text will be localized to this language. Otherwise device langauge will be used
example: "en"
getter/setter pairoverride
- onboardingButtonTooltipDelay ↔ int
-
Option to configure when the onboarding help tooltip will appear.
getter/setter pair
- overlaySettingsType ↔ String?
-
type of the overlay settings object
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scanningWrongSideMessage ↔ String?
-
String: Instructions for the user when wrong side is being scanned.
getter/setter pair
- showFlashlightWarning ↔ bool
-
Defines whether glare warning will be displayed when user turn on a flashlight
Default true
getter/setter pair
- showIntroductionDialog ↔ bool
-
Defines whether button for presenting onboarding screens will be present on screen
getter/setter pair
- showOnboardingInfo ↔ bool
-
Defines whether button for presenting onboarding screens will be present on screen
getter/setter pair
- useFrontCamera ↔ bool
-
whether front camera should be used instead of the default camera
false by default
getter/setter pairinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited