UserGuidanceStates class

Configure the titles of the user guidance hints for different states.

Constructors

UserGuidanceStates.new({String noDocumentFound = "?cameraUserGuidanceNoDocumentFound", String badAspectRatio = "?cameraUserGuidanceBadAspectRatio", String badAngles = "?cameraUserGuidanceBadAngles", String textHintOffCenter = "?cameraUserGuidanceTextHintOffCenter", String tooSmall = "?cameraUserGuidanceTooSmall", String tooNoisy = "?cameraUserGuidanceTooNoisy", String tooDark = "?cameraUserGuidanceTooDark", String energySaveMode = "?cameraUserGuidanceEnergySaveMode", String readyToCapture = "?cameraUserGuidanceReadyToCapture", String capturing = "?cameraUserGuidanceReadyToCapture", String captureManual = "?cameraUserGuidanceReadyToCaptureManual"})
UserGuidanceStates.fromJson(Map<String, dynamic> json)
factory

Properties

badAngles String
The user guidance text displayed when the document pitch/skew angle is unacceptable. Default is "?cameraUserGuidanceBadAngles"
getter/setter pair
badAspectRatio String
The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa). Default is "?cameraUserGuidanceBadAspectRatio"
getter/setter pair
captureManual String
The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode. Default is "?cameraUserGuidanceReadyToCaptureManual"
getter/setter pair
capturing String
The user guidance text displayed when the document is being captured and user needs to hold the device still. Default is "?cameraUserGuidanceReadyToCapture"
getter/setter pair
energySaveMode String
The user guidance text displayed when the device is in energy saving mode. iOS only. Default is "?cameraUserGuidanceEnergySaveMode"
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
noDocumentFound String
The user guidance text displayed when no document is found. Default is "?cameraUserGuidanceNoDocumentFound"
getter/setter pair
readyToCapture String
The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode. Default is "?cameraUserGuidanceReadyToCapture"
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
textHintOffCenter String
The user guidance text displayed when the document is not centered in the finder view. Default is "?cameraUserGuidanceTextHintOffCenter"
getter/setter pair
tooDark String
The user guidance text displayed when it is too dark to capture an adequate image. Default is "?cameraUserGuidanceTooDark"
getter/setter pair
tooNoisy String
The user guidance text displayed when the background is too noisy. Default is "?cameraUserGuidanceTooNoisy"
getter/setter pair
tooSmall String
The user guidance text displayed when the document is too far from camera. Default is "?cameraUserGuidanceTooSmall"
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