All Implemented Interfaces:

android.os.Parcelable
```
public final class UserGuidanceStates
 implements Parcelable
                    
```
Configure the titles of the user guidance hints for different states.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`noDocumentFound`
`private String`	`badAspectRatio`
`private String`	`badAngles`
`private String`	`textHintOffCenter`
`private String`	`tooSmall`
`private String`	`tooNoisy`
`private String`	`tooDark`
`private String`	`energySaveMode`
`private String`	`readyToCapture`
`private String`	`capturing`
`private String`	`captureManual`

Constructor Summary

Constructors
Constructor	Description
`UserGuidanceStates(Map<String, Object> source)`
`UserGuidanceStates(JSONObject json)`
`UserGuidanceStates(String noDocumentFound, String badAspectRatio, String badAngles, String textHintOffCenter, String tooSmall, String tooNoisy, String tooDark, String energySaveMode, String readyToCapture, String capturing, String captureManual)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getNoDocumentFound()`	The user guidance text displayed when no document is found.
`final Unit`	`setNoDocumentFound(String noDocumentFound)`	The user guidance text displayed when no document is found.
`final String`	`getBadAspectRatio()`	The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).
`final Unit`	`setBadAspectRatio(String badAspectRatio)`	The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa).
`final String`	`getBadAngles()`	The user guidance text displayed when the document pitch/skew angle is unacceptable.
`final Unit`	`setBadAngles(String badAngles)`	The user guidance text displayed when the document pitch/skew angle is unacceptable.
`final String`	`getTextHintOffCenter()`	The user guidance text displayed when the document is not centered in the finder view.
`final Unit`	`setTextHintOffCenter(String textHintOffCenter)`	The user guidance text displayed when the document is not centered in the finder view.
`final String`	`getTooSmall()`	The user guidance text displayed when the document is too far from camera.
`final Unit`	`setTooSmall(String tooSmall)`	The user guidance text displayed when the document is too far from camera.
`final String`	`getTooNoisy()`	The user guidance text displayed when the background is too noisy.
`final Unit`	`setTooNoisy(String tooNoisy)`	The user guidance text displayed when the background is too noisy.
`final String`	`getTooDark()`	The user guidance text displayed when it is too dark to capture an adequate image.
`final Unit`	`setTooDark(String tooDark)`	The user guidance text displayed when it is too dark to capture an adequate image.
`final String`	`getEnergySaveMode()`	The user guidance text displayed when the device is in energy saving mode.
`final Unit`	`setEnergySaveMode(String energySaveMode)`	The user guidance text displayed when the device is in energy saving mode.
`final String`	`getReadyToCapture()`	The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode.
`final Unit`	`setReadyToCapture(String readyToCapture)`	The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode.
`final String`	`getCapturing()`	The user guidance text displayed when the document is being captured and user needs to hold the device still.
`final Unit`	`setCapturing(String capturing)`	The user guidance text displayed when the document is being captured and user needs to hold the device still.
`final String`	`getCaptureManual()`	The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode.
`final Unit`	`setCaptureManual(String captureManual)`	The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode.
`final JSONObject`	`toJson()`
`final static UserGuidanceStates`	`default()`

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

- Constructor Detail
  - UserGuidanceStates
```
UserGuidanceStates(Map<String, Object> source)
```
  - UserGuidanceStates
```
UserGuidanceStates(JSONObject json)
```
  - UserGuidanceStates
```
UserGuidanceStates(String noDocumentFound, String badAspectRatio, String badAngles, String textHintOffCenter, String tooSmall, String tooNoisy, String tooDark, String energySaveMode, String readyToCapture, String capturing, String captureManual)
```
- Method Detail
  - getNoDocumentFound
```
 final String getNoDocumentFound()
```
    The user guidance text displayed when no document is found. Default is "?cameraUserGuidanceNoDocumentFound"
  - setNoDocumentFound
```
 final Unit setNoDocumentFound(String noDocumentFound)
```
    The user guidance text displayed when no document is found. Default is "?cameraUserGuidanceNoDocumentFound"
  - getBadAspectRatio
```
 final String getBadAspectRatio()
```
    The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa). Default is "?cameraUserGuidanceBadAspectRatio"
  - setBadAspectRatio
```
 final Unit setBadAspectRatio(String badAspectRatio)
```
    The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa). Default is "?cameraUserGuidanceBadAspectRatio"
  - getBadAngles
```
 final String getBadAngles()
```
    The user guidance text displayed when the document pitch/skew angle is unacceptable. Default is "?cameraUserGuidanceBadAngles"
  - setBadAngles
```
 final Unit setBadAngles(String badAngles)
```
    The user guidance text displayed when the document pitch/skew angle is unacceptable. Default is "?cameraUserGuidanceBadAngles"
  - getTextHintOffCenter
```
 final String getTextHintOffCenter()
```
    The user guidance text displayed when the document is not centered in the finder view. Default is "?cameraUserGuidanceTextHintOffCenter"
  - setTextHintOffCenter
```
 final Unit setTextHintOffCenter(String textHintOffCenter)
```
    The user guidance text displayed when the document is not centered in the finder view. Default is "?cameraUserGuidanceTextHintOffCenter"
  - getTooSmall
```
 final String getTooSmall()
```
    The user guidance text displayed when the document is too far from camera. Default is "?cameraUserGuidanceTooSmall"
  - setTooSmall
```
 final Unit setTooSmall(String tooSmall)
```
    The user guidance text displayed when the document is too far from camera. Default is "?cameraUserGuidanceTooSmall"
  - getTooNoisy
```
 final String getTooNoisy()
```
    The user guidance text displayed when the background is too noisy. Default is "?cameraUserGuidanceTooNoisy"
  - setTooNoisy
```
 final Unit setTooNoisy(String tooNoisy)
```
    The user guidance text displayed when the background is too noisy. Default is "?cameraUserGuidanceTooNoisy"
  - getTooDark
```
 final String getTooDark()
```
    The user guidance text displayed when it is too dark to capture an adequate image. Default is "?cameraUserGuidanceTooDark"
  - setTooDark
```
 final Unit setTooDark(String tooDark)
```
    The user guidance text displayed when it is too dark to capture an adequate image. Default is "?cameraUserGuidanceTooDark"
  - getEnergySaveMode
```
 final String getEnergySaveMode()
```
    The user guidance text displayed when the device is in energy saving mode. iOS only. Default is "?cameraUserGuidanceEnergySaveMode"
  - setEnergySaveMode
```
 final Unit setEnergySaveMode(String energySaveMode)
```
    The user guidance text displayed when the device is in energy saving mode. iOS only. Default is "?cameraUserGuidanceEnergySaveMode"
  - getReadyToCapture
```
 final String getReadyToCapture()
```
    The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode. Default is "?cameraUserGuidanceReadyToCapture"
  - setReadyToCapture
```
 final Unit setReadyToCapture(String readyToCapture)
```
    The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode. Default is "?cameraUserGuidanceReadyToCapture"
  - getCapturing
```
 final String getCapturing()
```
    The user guidance text displayed when the document is being captured and user needs to hold the device still. Default is "?cameraUserGuidanceReadyToCapture"
  - setCapturing
```
 final Unit setCapturing(String capturing)
```
    The user guidance text displayed when the document is being captured and user needs to hold the device still. Default is "?cameraUserGuidanceReadyToCapture"
  - getCaptureManual
```
 final String getCaptureManual()
```
    The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode. Default is "?cameraUserGuidanceReadyToCaptureManual"
  - setCaptureManual
```
 final Unit setCaptureManual(String captureManual)
```
    The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode. Default is "?cameraUserGuidanceReadyToCaptureManual"
  - toJson
```
 final JSONObject toJson()
```
  - default
```
 final static UserGuidanceStates default()
```

Class UserGuidanceStates

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserGuidanceStates

UserGuidanceStates

UserGuidanceStates

Method Detail

getNoDocumentFound

setNoDocumentFound

getBadAspectRatio

setBadAspectRatio

getBadAngles

setBadAngles

getTextHintOffCenter

setTextHintOffCenter

getTooSmall

setTooSmall

getTooNoisy

setTooNoisy

getTooDark

setTooDark

getEnergySaveMode

setEnergySaveMode

getReadyToCapture

setReadyToCapture

getCapturing

setCapturing

getCaptureManual

setCaptureManual

toJson

default