
public final class DialogState

The Dialog state.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`DialogState.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private Intent`	`currentIntent`
`private final Map<String, EntityStateValue>`	`entityValues`
`private final Map<String, Object>`	`context`
`private UserLocation`	`userLocation`
`private NextUserActionState`	`nextActionState`

Constructor Summary

Constructors
Constructor	Description
`DialogState(Intent currentIntent, Map<String, EntityStateValue> entityValues, Map<String, Object> context, UserLocation userLocation, NextUserActionState nextActionState)`

Method Summary

Modifier and Type	Method	Description
`final Unit`	`setContextValue(String name, Object value)`	Updates persistent context value.
`final Unit`	`setValue(String role, EntityValue value)`	Set a new entity value.
`final Unit`	`setValue(Entity entity, Value value)`	Set a new entity value.
`final Unit`	`changeValue(Entity entity, Value newValue)`	Change an entity value.
`final Unit`	`changeValue(EntityValue newValue)`	Change an entity value.
`final Unit`	`changeValue(String role, EntityValue newValue)`	Change an entity value.
`final Unit`	`resetAllEntityValues()`	Reset all entity values.
`final Unit`	`resetValue(String role)`	Reset the value of an entity.
`final Unit`	`cleanupState()`	Same than resetState but remove also entity values history.
`final Unit`	`resetState()`	Reset all entity values, context values, userLocation and nextActionState but keep entity values history.
`final Boolean`	`hasEntity(String role)`
`final Boolean`	`hasEntityPredefinedValue(String role, String value)`	Does this event contains specified predefined value entity?
`final Intent`	`component1()`
`final Map<String, EntityStateValue>`	`component2()`
`final Map<String, Object>`	`component3()`
`final UserLocation`	`component4()`
`final NextUserActionState`	`component5()`
`final DialogState`	`copy(Intent currentIntent, Map<String, EntityStateValue> entityValues, Map<String, Object> context, UserLocation userLocation, NextUserActionState nextActionState)`
`final Intent`	`getCurrentIntent()`	The current Intent of the dialog, can be null.
`final Map<String, EntityStateValue>`	`getEntityValues()`	The current entity values (with their history).
`final Map<String, Object>`	`getContext()`	The context of the dialog, a versatile map.
`final UserLocation`	`getUserLocation()`	The current UserLocation if any.
`final NextUserActionState`	`getNextActionState()`	The NextUserActionState if any.
`final Unit`	`setCurrentIntent(Intent currentIntent)`	The current Intent of the dialog, can be null.
`final Unit`	`setUserLocation(UserLocation userLocation)`	The current UserLocation if any.
`final Unit`	`setNextActionState(NextUserActionState nextActionState)`	The NextUserActionState if any.

Methods inherited from class ai.tock.bot.engine.dialog.DialogState
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DialogState

DialogState(Intent currentIntent, Map<String, EntityStateValue> entityValues, Map<String, Object> context, UserLocation userLocation, NextUserActionState nextActionState)

Method Detail
- setContextValue
```
 final Unit setContextValue(String name, Object value)
```
  Updates persistent context value. Do not store Collection or Map in the context, only plain objects or typed arrays.
- setValue
```
 final Unit setValue(String role, EntityValue value)
```
  Set a new entity value. Remove previous entity values history.
- setValue
```
 final Unit setValue(Entity entity, Value value)
```
  Set a new entity value. Remove previous entity values history.
- changeValue
```
 final Unit changeValue(Entity entity, Value newValue)
```
  Change an entity value. Keep previous entity values history.
- changeValue
```
 final Unit changeValue(EntityValue newValue)
```
  Change an entity value. Keep previous entity values history.
- changeValue
```
 final Unit changeValue(String role, EntityValue newValue)
```
  Change an entity value. Keep previous entity values history.
- resetAllEntityValues
```
 final Unit resetAllEntityValues()
```
  Reset all entity values. Keep entity values history.
- resetValue
```
 final Unit resetValue(String role)
```
  Reset the value of an entity. Keep entity values history.
- cleanupState
```
 final Unit cleanupState()
```
  Same than resetState but remove also entity values history.
- resetState
```
 final Unit resetState()
```
  Reset all entity values, context values, userLocation and nextActionState but keep entity values history.
- hasEntity
```
 final Boolean hasEntity(String role)
```
- hasEntityPredefinedValue
```
 final Boolean hasEntityPredefinedValue(String role, String value)
```
  Does this event contains specified predefined value entity?
- component1
```
 final Intent component1()
```
- component2
```
 final Map<String, EntityStateValue> component2()
```
- component3
```
 final Map<String, Object> component3()
```
- component4
```
 final UserLocation component4()
```
- component5
```
 final NextUserActionState component5()
```
- copy
```
 final DialogState copy(Intent currentIntent, Map<String, EntityStateValue> entityValues, Map<String, Object> context, UserLocation userLocation, NextUserActionState nextActionState)
```
- getCurrentIntent
```
 final Intent getCurrentIntent()
```
  The current Intent of the dialog, can be null.
- getEntityValues
```
 final Map<String, EntityStateValue> getEntityValues()
```
  The current entity values (with their history).
- getContext
```
 final Map<String, Object> getContext()
```
  The context of the dialog, a versatile map.
- getUserLocation
```
 final UserLocation getUserLocation()
```
  The current UserLocation if any.
- getNextActionState
```
 final NextUserActionState getNextActionState()
```
  The NextUserActionState if any. If not null, it will be applied to the next user action, with NLP custom qualifiers.
- setCurrentIntent
```
 final Unit setCurrentIntent(Intent currentIntent)
```
  The current Intent of the dialog, can be null.
- setUserLocation
```
 final Unit setUserLocation(UserLocation userLocation)
```
  The current UserLocation if any.
- setNextActionState
```
 final Unit setNextActionState(NextUserActionState nextActionState)
```
  The NextUserActionState if any. If not null, it will be applied to the next user action, with NLP custom qualifiers.

Class DialogState

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ai.tock.bot.engine.dialog.DialogState

Methods inherited from class java.lang.Object

Constructor Detail

DialogState

Method Detail

setContextValue

setValue

setValue

changeValue

changeValue

changeValue

resetAllEntityValues

resetValue

cleanupState

resetState

hasEntity

hasEntityPredefinedValue

component1

component2

component3

component4

component5

copy

getCurrentIntent

getEntityValues

getContext

getUserLocation

getNextActionState

setCurrentIntent

setUserLocation

setNextActionState