All Implemented Interfaces:

ai.tock.bot.definition.StoryHandlerDefinition , ai.tock.bot.engine.BotBus , ai.tock.bot.engine.Bus , ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider
```
public abstract class StoryHandlerDefinitionBase<T extends ConnectorStoryHandlerBase<?>>
 implements BotBus, StoryHandlerDefinition
                    
```
Base implementation of StoryHandlerDefinition.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`private final ConnectorType`	`connectorType`
`private final T`	`connector`
`private final T`	`c`
`private final BotBus`	`bus`
`private final BotDefinition`	`botDefinition`
`private final UserTimeline`	`userTimeline`
`private final Dialog`	`dialog`
`private final Dialog`	`currentDialog`
`private final IntentAware`	`currentIntent`
`private Story`	`story`
`private final Action`	`action`
`private final ConnectorData`	`connectorData`
`private final UserPreferences`	`userPreferences`
`private final Connector`	`underlyingConnector`
`private final Map<String, EntityStateValue>`	`entities`
`private I18nKeyProvider`	`i18nProvider`
`private NextUserActionState`	`nextUserActionState`
`private StoryStep<out StoryHandlerDefinition>`	`step`
`private final String`	`stepName`
`private final String`	`userText`
`private final String`	`contextId`
`private final Boolean`	`test`
`private final String`	`applicationId`
`private final PlayerId`	`botId`
`private final PlayerId`	`userId`
`private final IntentAware`	`intent`
`private final Integer`	`currentAnswerIndex`
`private final Locale`	`userLocale`
`private final UserInterfaceType`	`userInterfaceType`
`private final ConnectorType`	`targetConnectorType`

Constructor Summary

Constructors
Constructor	Description
`StoryHandlerDefinitionBase(BotBus bus)`

Method Summary

Modifier and Type	Method	Description
`Unit`	`answer()`	The method to implement if there is no StoryStep in the StoryDefinition or when current StoryStep is null
`Unit`	`handle()`	Default implementation redirect to answer.
`T`	`findConnector(ConnectorType connectorType)`	Method to override in order to provide ConnectorStoryHandler.
`T`	`findConnector(String connectorId)`	Method to override in order to provide ConnectorStoryHandler.
`final ConnectorType`	`getConnectorType()`	Shortcut for BotBus.targetConnectorType.
`T`	`getConnector()`
`final T`	`getC()`
`final BotBus`	`getBus()`
`BotDefinition`	`getBotDefinition()`
`UserTimeline`	`getUserTimeline()`
`Dialog`	`getDialog()`
`Dialog`	`getCurrentDialog()`
`IntentAware`	`getCurrentIntent()`
`Story`	`getStory()`
`Action`	`getAction()`
`ConnectorData`	`getConnectorData()`
`UserPreferences`	`getUserPreferences()`
`Connector`	`getUnderlyingConnector()`
`Map<String, EntityStateValue>`	`getEntities()`
`I18nKeyProvider`	`getI18nProvider()`
`NextUserActionState`	`getNextUserActionState()`
`StoryStep<out StoryHandlerDefinition>`	`getStep()`
`String`	`getStepName()`
`String`	`getUserText()`
`String`	`getContextId()`
`Boolean`	`getTest()`
`String`	`getApplicationId()`
`PlayerId`	`getBotId()`
`PlayerId`	`getUserId()`
`IntentAware`	`getIntent()`
`Integer`	`getCurrentAnswerIndex()`
`Locale`	`getUserLocale()`
`UserInterfaceType`	`getUserInterfaceType()`
`ConnectorType`	`getTargetConnectorType()`
`Unit`	`setStory(Story story)`
`Unit`	`setI18nProvider(I18nKeyProvider i18nProvider)`
`Unit`	`setNextUserActionState(NextUserActionState nextUserActionState)`
`Unit`	`setStep(StoryStep<out StoryHandlerDefinition> step)`

Methods inherited from class ai.tock.bot.definition.StoryHandlerDefinitionBase
answerWith, 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

Constructor Detail
- StoryHandlerDefinitionBase
```
StoryHandlerDefinitionBase(BotBus bus)
```

Method Detail

answer
```
 Unit answer()
```
The method to implement if there is no StoryStep in the StoryDefinition or when current StoryStep is null

handle
```
 Unit handle()
```
Default implementation redirect to answer.

findConnector
```
 T findConnector(ConnectorType connectorType)
```
Method to override in order to provide ConnectorStoryHandler. Default implementation use annotations annotated with @ConnectorHandler.

findConnector
```
 T findConnector(String connectorId)
```
Method to override in order to provide ConnectorStoryHandler. Default implementation use annotations annotated with @ConnectorIdHandlers.

getConnectorType
```
 final ConnectorType getConnectorType()
```
Shortcut for BotBus.targetConnectorType.

getConnector
```
 T getConnector()
```

getC
```
 final T getC()
```

getBus
```
 final BotBus getBus()
```

getBotDefinition
```
 BotDefinition getBotDefinition()
```

getUserTimeline
```
 UserTimeline getUserTimeline()
```

getDialog
```
 Dialog getDialog()
```

getCurrentDialog
```
 Dialog getCurrentDialog()
```

getCurrentIntent
```
 IntentAware getCurrentIntent()
```

getStory
```
 Story getStory()
```

getAction
```
 Action getAction()
```

getConnectorData
```
 ConnectorData getConnectorData()
```

getUserPreferences
```
 UserPreferences getUserPreferences()
```

getUnderlyingConnector
```
 Connector getUnderlyingConnector()
```

getEntities

 Map<String, EntityStateValue> getEntities()

getI18nProvider
```
 I18nKeyProvider getI18nProvider()
```

getNextUserActionState

 NextUserActionState getNextUserActionState()

getStep

 StoryStep<out StoryHandlerDefinition> getStep()

getStepName
```
 String getStepName()
```

getUserText
```
 String getUserText()
```

getContextId
```
 String getContextId()
```

getTest
```
 Boolean getTest()
```

getApplicationId
```
 String getApplicationId()
```

getBotId
```
 PlayerId getBotId()
```

getUserId
```
 PlayerId getUserId()
```

getIntent
```
 IntentAware getIntent()
```

getCurrentAnswerIndex
```
 Integer getCurrentAnswerIndex()
```

getUserLocale
```
 Locale getUserLocale()
```

getUserInterfaceType

 UserInterfaceType getUserInterfaceType()

getTargetConnectorType
```
 ConnectorType getTargetConnectorType()
```

setStory
```
 Unit setStory(Story story)
```

setI18nProvider

 Unit setI18nProvider(I18nKeyProvider i18nProvider)

setNextUserActionState

 Unit setNextUserActionState(NextUserActionState nextUserActionState)

setStep

 Unit setStep(StoryStep<out StoryHandlerDefinition> step)

Class StoryHandlerDefinitionBase

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

Constructor Detail

StoryHandlerDefinitionBase

Method Detail

answer

handle

findConnector

findConnector

getConnectorType

getConnector

getC

getBus

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