UxSettings class
Various Capture UX settings. Defines the presence of various UI elements, timers, and screen options.
- Annotations
-
- @JsonSerializable()
Constructors
- UxSettings.new()
- Various Capture UX settings. Defines the presence of various UI elements, timers, and screen options.
-
UxSettings.fromJson(Map<
String, dynamic> json) -
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- keepScreenOn ↔ bool?
-
Defines whether the screen will always be ON while the capture screen is in the foreground.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showCaptureHelpTooltip ↔ bool?
-
Defines whether to show the tooltip above the help button.
getter/setter pair
- showHelpTooltipTimeIntervalMs ↔ double?
-
Sets the time in milliseconds that needs to pass before the help tooltip is displayed.
getter/setter pair
- showIntroductionDialog ↔ bool?
-
Defines whether the introduction dialog will be displayed on capture start.
getter/setter pair
- showOnboardingInfo ↔ bool?
-
Defines whether onboarding (help) screens will be displayed.
If onboarding is disabled, the help button and tooltip won't be displayed.
getter/setter pair
- sideCaptureTimeoutMs ↔ double?
-
Duration in milliseconds that needs to pass since scanning of the current document side has begun in order to finish side capture.
The timeout timer is restarted on the document side flip.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited