All Implemented Interfaces:

ai.tock.bot.engine.BotBus , ai.tock.bot.engine.Bus , ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider
```
public interface StoryHandlerDefinition
 implements BotBus
                    
```
Story handler definitions are used in StoryHandler to provide custom context and to manage specific connector behaviour.
Implementations should usually use StoryHandlerDefinitionBase.

Method Summary

Modifier and Type	Method	Description
`abstract Unit`	`handle()`	The main method to implement.
`Unit`	`answerWith(CharSequence default, Function0<Object> messageProvider)`	Answers with the specified parameters.
`ConnectorStoryHandler<?>`	`getConnector()`
`abstract BotDefinition`	`getBotDefinition()`	The bot definition of the current bot.
`abstract UserTimeline`	`getUserTimeline()`	The user timeline.
`abstract Dialog`	`getDialog()`	The initial dialog for this user.
`abstract Dialog`	`getCurrentDialog()`	The current dialog for this user (may be different from the initial dialog).
`IntentAware`	`getCurrentIntent()`
`abstract Story`	`getStory()`	The current story.
`abstract Action`	`getAction()`	The user action.
`abstract ConnectorData`	`getConnectorData()`	The data specific to the connector (if any).
`abstract UserPreferences`	`getUserPreferences()`	User preferences of the current user.
`abstract Connector`	`getUnderlyingConnector()`	The underlying Connector used.
`abstract Map<String, EntityStateValue>`	`getEntities()`	The entities in the dialog state.
`abstract I18nKeyProvider`	`getI18nProvider()`	To manage i18n.
`abstract NextUserActionState`	`getNextUserActionState()`	Qualify the next user action.
`StoryStep<out StoryHandlerDefinition>`	`getStep()`
`String`	`getStepName()`
`String`	`getUserText()`
`String`	`getContextId()`
`Boolean`	`getTest()`
`abstract String`	`getApplicationId()`	The current application id.
`abstract PlayerId`	`getBotId()`	The current bot id.
`abstract PlayerId`	`getUserId()`	The current user id.
`abstract IntentAware`	`getIntent()`	The current intent of the dialog at Bus (ie request) initialization.
`abstract Integer`	`getCurrentAnswerIndex()`	The current answer index of the bot for this action.
`abstract Locale`	`getUserLocale()`	The current user Locale.
`abstract UserInterfaceType`	`getUserInterfaceType()`	The current user interface type.
`abstract ConnectorType`	`getTargetConnectorType()`	The ConnectorType used for the response.
`abstract Unit`	`setStory(Story story)`	The current story.
`abstract Unit`	`setI18nProvider(I18nKeyProvider i18nProvider)`	To manage i18n.
`abstract Unit`	`setNextUserActionState(NextUserActionState nextUserActionState)`	Qualify the next user action.
`Unit`	`setStep(StoryStep<out StoryHandlerDefinition> step)`

Methods inherited from class ai.tock.bot.definition.StoryHandlerDefinition
booleanChoice, changeContextValue, changeContextValue, changeEntityText, changeEntityValue, changeEntityValue, changeEntityValue, choice, contextValue, contextValue, defaultDelay, end, end, end, end, end, end, end, endRawText, entityText, entityText, entityValue, entityValue, entityValueDetails, entityValueDetails, getBusContextValue, getBusContextValue, handleAndSwitchStory, hasActionEntity, hasActionEntity, hasChoiceValue, i18n, i18nKey, isChoiceAction, isFeatureEnabled, isIntent, markAsUnknown, nlpStats, reloadProfile, removeAllEntityValues, removeEntityValue, removeEntityValue, resetDialogState, send, send, send, send, send, send, send, send, setBusContextValue, setBusContextValue, skipAnswer, switchStory, withMessage, withNotificationType, withPriority, withVisibility
Methods inherited from class ai.tock.bot.engine.I18nTranslator
i18n
Methods inherited from class ai.tock.bot.engine.BotBus
sendRawText, withMessage, withMessage
Methods inherited from class ai.tock.bot.engine.Bus
translate, translate, translate, translateAndReturnBlankAsNull
Methods inherited from class ai.tock.translator.I18nKeyProvider
equals, hashCode, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - handle
```
 abstract Unit handle()
```
    The main method to implement.
  - answerWith
```
 Unit answerWith(CharSequence default, Function0<Object> messageProvider)
```
    Answers with the specified parameters.
    
    Parameters:
    
    default - used if messageProvider returns null
    
    messageProvider - provides the answer - a message or a list of messages
  - getConnector
```
 ConnectorStoryHandler<?> getConnector()
```
  - getBotDefinition
```
 abstract BotDefinition getBotDefinition()
```
    The bot definition of the current bot.
  - getUserTimeline
```
 abstract UserTimeline getUserTimeline()
```
    The user timeline. Gets history and data about the user.
  - getDialog
```
 abstract Dialog getDialog()
```
    The initial dialog for this user.
  - getCurrentDialog
```
 abstract Dialog getCurrentDialog()
```
    The current dialog for this user (may be different from the initial dialog).
  - getCurrentIntent
```
 IntentAware getCurrentIntent()
```
  - getStory
```
 abstract Story getStory()
```
    The current story.
  - getAction
```
 abstract Action getAction()
```
    The user action.
  - getConnectorData
```
 abstract ConnectorData getConnectorData()
```
    The data specific to the connector (if any).
  - getUserPreferences
```
 abstract UserPreferences getUserPreferences()
```
    User preferences of the current user.
  - getUnderlyingConnector
```
 abstract Connector getUnderlyingConnector()
```
    The underlying Connector used. Please do not use this method as it is exposed for third party libraries only.
  - getEntities
```
 abstract Map<String, EntityStateValue> getEntities()
```
    The entities in the dialog state.
  - getI18nProvider
```
 abstract I18nKeyProvider getI18nProvider()
```
    To manage i18n.
  - getNextUserActionState
```
 abstract NextUserActionState getNextUserActionState()
```
    Qualify the next user action.
  - getStep
```
 StoryStep<out StoryHandlerDefinition> getStep()
```
  - getStepName
```
 String getStepName()
```
  - getUserText
```
 String getUserText()
```
  - getContextId
```
 String getContextId()
```
  - getTest
```
 Boolean getTest()
```
  - getApplicationId
```
 abstract String getApplicationId()
```
    The current application id.
  - getBotId
```
 abstract PlayerId getBotId()
```
    The current bot id.
  - getUserId
```
 abstract PlayerId getUserId()
```
    The current user id.
  - getIntent
```
 abstract IntentAware getIntent()
```
    The current intent of the dialog at Bus (ie request) initialization.
  - getCurrentAnswerIndex
```
 abstract Integer getCurrentAnswerIndex()
```
    The current answer index of the bot for this action.
  - getUserLocale
```
 abstract Locale getUserLocale()
```
    The current user Locale.
  - getUserInterfaceType
```
 abstract UserInterfaceType getUserInterfaceType()
```
    The current user interface type.
  - getTargetConnectorType
```
 abstract ConnectorType getTargetConnectorType()
```
    The ConnectorType used for the response.
  - setStory
```
 abstract Unit setStory(Story story)
```
    The current story.
  - setI18nProvider
```
 abstract Unit setI18nProvider(I18nKeyProvider i18nProvider)
```
    To manage i18n.
  - setNextUserActionState
```
 abstract Unit setNextUserActionState(NextUserActionState nextUserActionState)
```
    Qualify the next user action.
  - setStep
```
 Unit setStep(StoryStep<out StoryHandlerDefinition> step)
```

Interface StoryHandlerDefinition

Method Summary

Methods inherited from class ai.tock.bot.definition.StoryHandlerDefinition

Methods inherited from class ai.tock.bot.engine.I18nTranslator

Methods inherited from class ai.tock.bot.engine.BotBus

Methods inherited from class ai.tock.bot.engine.Bus

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class java.lang.Object

Method Detail

handle

answerWith

getConnector

getBotDefinition

getUserTimeline

getDialog

getCurrentDialog

getCurrentIntent

getStory

getAction

getConnectorData

getUserPreferences

getUnderlyingConnector

getEntities

getI18nProvider

getNextUserActionState

getStep

getStepName

getUserText

getContextId

getTest

getApplicationId

getBotId

getUserId

getIntent

getCurrentAnswerIndex

getUserLocale

getUserInterfaceType

getTargetConnectorType

setStory

setI18nProvider

setNextUserActionState

setStep