All Implemented Interfaces:

ai.tock.bot.engine.BotBus , ai.tock.bot.engine.Bus , ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider
```
public class BotBusMock
 implements BotBus
                    
```
A Bus mock used in unit tests.
The answers of the bot are available in the answers property.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final List<BotBusMockLog>`	`answers`
`private final BotBusMockLog`	`firstAnswer`
`private final BotBusMockLog`	`secondAnswer`
`private final BotBusMockLog`	`thirdAnswer`
`private final BotBusMockLog`	`lastAnswer`
`private final List<BotBusMockLog>`	`busAnswers`
`private final BotBusMockLog`	`firstBusAnswer`
`private final BotBusMockLog`	`secondBusAnswer`
`private final BotBusMockLog`	`thirdBusAnswer`
`private final BotBusMockLog`	`lastBusAnswer`
`private final Integer`	`currentAnswerIndex`
`private UserTimeline`	`userTimeline`
`private Dialog`	`dialog`
`private final Dialog`	`currentDialog`
`private Story`	`story`
`private BotDefinition`	`botDefinition`
`private I18nKeyProvider`	`i18nProvider`
`private UserInterfaceType`	`userInterfaceType`
`private ConnectorType`	`connectorType`
`private ConnectorData`	`connectorData`
`private final TranslatorEngine`	`translator`
`private final String`	`applicationId`
`private final PlayerId`	`botId`
`private final PlayerId`	`userId`
`private final UserPreferences`	`userPreferences`
`private final Locale`	`userLocale`
`private ConnectorType`	`sourceConnectorType`
`private ConnectorType`	`targetConnectorType`
`private final Connector`	`underlyingConnector`
`private final Map<String, EntityStateValue>`	`entities`
`private IntentAware`	`intent`
`private NextUserActionState`	`nextUserActionState`
`private final BotBusMockContext`	`context`
`private final Action`	`action`
`private final String`	`contextId`
`private final IntentAware`	`currentIntent`
`private StoryStep<out StoryHandlerDefinition>`	`step`
`private final String`	`stepName`
`private final Boolean`	`test`
`private final String`	`userText`

Constructor Summary

Constructors
Constructor	Description
`BotBusMock(BotBusMockContext context, Action action)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<BotBusMockLog>`	`getAnswers()`
`final BotBusMockLog`	`getFirstAnswer()`
`final BotBusMockLog`	`getSecondAnswer()`
`final BotBusMockLog`	`getThirdAnswer()`
`final BotBusMockLog`	`getLastAnswer()`
`final List<BotBusMockLog>`	`getBusAnswers()`
`final BotBusMockLog`	`getFirstBusAnswer()`
`final BotBusMockLog`	`getSecondBusAnswer()`
`final BotBusMockLog`	`getThirdBusAnswer()`
`final BotBusMockLog`	`getLastBusAnswer()`
`Integer`	`getCurrentAnswerIndex()`
`UserTimeline`	`getUserTimeline()`
`Unit`	`setUserTimeline(UserTimeline userTimeline)`
`Dialog`	`getDialog()`
`Unit`	`setDialog(Dialog dialog)`
`Dialog`	`getCurrentDialog()`
`Story`	`getStory()`
`Unit`	`setStory(Story story)`
`BotDefinition`	`getBotDefinition()`
`Unit`	`setBotDefinition(BotDefinition botDefinition)`
`I18nKeyProvider`	`getI18nProvider()`
`Unit`	`setI18nProvider(I18nKeyProvider i18nProvider)`
`UserInterfaceType`	`getUserInterfaceType()`
`Unit`	`setUserInterfaceType(UserInterfaceType userInterfaceType)`
`final ConnectorType`	`getConnectorType()`
`final Unit`	`setConnectorType(ConnectorType connectorType)`
`ConnectorData`	`getConnectorData()`
`Unit`	`setConnectorData(ConnectorData connectorData)`
`final TranslatorEngine`	`getTranslator()`
`String`	`getApplicationId()`
`PlayerId`	`getBotId()`
`PlayerId`	`getUserId()`
`UserPreferences`	`getUserPreferences()`
`Locale`	`getUserLocale()`
`ConnectorType`	`getSourceConnectorType()`
`Unit`	`setSourceConnectorType(ConnectorType sourceConnectorType)`
`ConnectorType`	`getTargetConnectorType()`
`Unit`	`setTargetConnectorType(ConnectorType targetConnectorType)`
`Connector`	`getUnderlyingConnector()`
`Map<String, EntityStateValue>`	`getEntities()`
`IntentAware`	`getIntent()`
`Unit`	`setIntent(IntentAware intent)`
`NextUserActionState`	`getNextUserActionState()`
`Unit`	`setNextUserActionState(NextUserActionState nextUserActionState)`
`final BotBusMockContext`	`getContext()`
`Action`	`getAction()`
`Boolean`	`isCompatibleWith(ConnectorType connectorType)`
`BotBus`	`send(Event event, Long delayInMs)`
`BotBus`	`send(Action action, Long delay)`
`final BotBusMock`	`run()`	Run the StoryHandler of the current story.
`final BotBusMock`	`checkEndCalled()`	Throws an exception if the end() is not called
`final BotBusMock`	`addActionEntity(EntityValue contextValue)`	Add an entity set in the current action.
`final BotBusMock`	`addActionEntity(Entity entity, Value newValue)`	Add an entity set in the current action.
`final BotBusMock`	`addActionEntity(Entity entity, String textContent)`	Simulate an action entity.
`Unit`	`sendAction(Action action, Long delay)`
`<T extends Any> T`	`getBusContextValue(String name)`	Returns the non persistent current value.
`Unit`	`setBusContextValue(String key, Object value)`	Update the non persistent current value.
`BotBus`	`end(Action action, Long delay)`
`final SendSentence`	`createBotSentence(CharSequence plainText)`
`BotBus`	`sendRawText(CharSequence plainText, Long delay)`
`BotBus`	`sendDebugData(String title, Object data)`
`BotBus`	`withPriority(ActionPriority priority)`
`BotBus`	`withNotificationType(ActionNotificationType notificationType)`
`BotBus`	`withVisibility(ActionVisibility visibility)`
`BotBus`	`withMessage(ConnectorType connectorType, Function0<ConnectorMessage> messageProvider)`
`BotBus`	`withMessage(ConnectorType connectorType, String connectorId, Function0<ConnectorMessage> messageProvider)`
`Unit`	`reloadProfile()`
`TranslatedSequence`	`translate(I18nLabelValue key)`
`Unit`	`markAsUnknown()`
`final Action`	`applyBotAnswerInterceptor(Action a)`	Update Action using BotAnswerInterceptor
`final Unit`	`assert(ConnectorMessageProvider messages)`	Assert that logs contains specified messages.

Methods inherited from class ai.tock.bot.engine.BotBus
booleanChoice, changeContextValue, changeContextValue, changeEntityText, changeEntityValue, changeEntityValue, changeEntityValue, choice, contextValue, contextValue, createMetric, defaultDelay, end, end, end, end, end, end, endRawText, entityText, entityText, entityValue, entityValue, entityValueDetails, entityValueDetails, getBusContextValue, getContextId, getCurrentIntent, getStep, getStepName, getTest, getTrackedStoryId, getUserText, handleAndSwitchStory, hasActionEntity, hasActionEntity, hasChoiceValue, i18n, i18nKey, i18nKey, isChoiceAction, isFeatureEnabled, isIntent, nlpStats, removeAllEntityValues, removeEntityValue, removeEntityValue, resetDialogState, send, send, send, send, send, send, setBusContextValue, setStep, skipAnswer, switchStory, withMessage
Methods inherited from class ai.tock.bot.engine.I18nTranslator
translate, translate, translateAndReturnBlankAsNull
Methods inherited from class ai.tock.translator.I18nKeyProvider
i18n
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BotBusMock

BotBusMock(BotBusMockContext context, Action action)

Method Detail

getAnswers
```
 final List<BotBusMockLog> getAnswers()
```

getFirstAnswer
```
 final BotBusMockLog getFirstAnswer()
```

getSecondAnswer
```
 final BotBusMockLog getSecondAnswer()
```

getThirdAnswer
```
 final BotBusMockLog getThirdAnswer()
```

getLastAnswer
```
 final BotBusMockLog getLastAnswer()
```

getBusAnswers

 final List<BotBusMockLog> getBusAnswers()

getFirstBusAnswer

 final BotBusMockLog getFirstBusAnswer()

getSecondBusAnswer

 final BotBusMockLog getSecondBusAnswer()

getThirdBusAnswer

 final BotBusMockLog getThirdBusAnswer()

getLastBusAnswer
```
 final BotBusMockLog getLastBusAnswer()
```

getCurrentAnswerIndex
```
 Integer getCurrentAnswerIndex()
```

getUserTimeline
```
 UserTimeline getUserTimeline()
```

setUserTimeline

 Unit setUserTimeline(UserTimeline userTimeline)

getDialog
```
 Dialog getDialog()
```

setDialog
```
 Unit setDialog(Dialog dialog)
```

getCurrentDialog
```
 Dialog getCurrentDialog()
```

getStory
```
 Story getStory()
```

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

getBotDefinition
```
 BotDefinition getBotDefinition()
```

setBotDefinition

 Unit setBotDefinition(BotDefinition botDefinition)

getI18nProvider
```
 I18nKeyProvider getI18nProvider()
```

setI18nProvider

 Unit setI18nProvider(I18nKeyProvider i18nProvider)

getUserInterfaceType

 UserInterfaceType getUserInterfaceType()

setUserInterfaceType

 Unit setUserInterfaceType(UserInterfaceType userInterfaceType)

getConnectorType
```
 final ConnectorType getConnectorType()
```

setConnectorType

 final Unit setConnectorType(ConnectorType connectorType)

getConnectorData
```
 ConnectorData getConnectorData()
```

setConnectorData

 Unit setConnectorData(ConnectorData connectorData)

getTranslator
```
 final TranslatorEngine getTranslator()
```

getApplicationId
```
 String getApplicationId()
```

getBotId
```
 PlayerId getBotId()
```

getUserId
```
 PlayerId getUserId()
```

getUserPreferences
```
 UserPreferences getUserPreferences()
```

getUserLocale
```
 Locale getUserLocale()
```

getSourceConnectorType
```
 ConnectorType getSourceConnectorType()
```

setSourceConnectorType

 Unit setSourceConnectorType(ConnectorType sourceConnectorType)

getTargetConnectorType
```
 ConnectorType getTargetConnectorType()
```

setTargetConnectorType

 Unit setTargetConnectorType(ConnectorType targetConnectorType)

getUnderlyingConnector
```
 Connector getUnderlyingConnector()
```

getEntities

 Map<String, EntityStateValue> getEntities()

getIntent
```
 IntentAware getIntent()
```

setIntent
```
 Unit setIntent(IntentAware intent)
```

getNextUserActionState

 NextUserActionState getNextUserActionState()

setNextUserActionState

 Unit setNextUserActionState(NextUserActionState nextUserActionState)

getContext
```
 final BotBusMockContext getContext()
```

getAction
```
 Action getAction()
```

isCompatibleWith

 Boolean isCompatibleWith(ConnectorType connectorType)

send

 BotBus send(Event event, Long delayInMs)

send

 BotBus send(Action action, Long delay)

run
```
 final BotBusMock run()
```
Run the StoryHandler of the current story.

checkEndCalled
```
 final BotBusMock checkEndCalled()
```
Throws an exception if the end() is not called

addActionEntity

 final BotBusMock addActionEntity(EntityValue contextValue)

Add an entity set in the current action.

addActionEntity

 final BotBusMock addActionEntity(Entity entity, Value newValue)

Add an entity set in the current action.

addActionEntity

 final BotBusMock addActionEntity(Entity entity, String textContent)

Simulate an action entity.

sendAction

 Unit sendAction(Action action, Long delay)

getBusContextValue
```
 <T extends Any> T getBusContextValue(String name)
```
Returns the non persistent current value.

setBusContextValue

 Unit setBusContextValue(String key, Object value)

Update the non persistent current value.

end

 BotBus end(Action action, Long delay)

createBotSentence

 final SendSentence createBotSentence(CharSequence plainText)

sendRawText

 BotBus sendRawText(CharSequence plainText, Long delay)

sendDebugData

 BotBus sendDebugData(String title, Object data)

withPriority

 BotBus withPriority(ActionPriority priority)

withNotificationType

 BotBus withNotificationType(ActionNotificationType notificationType)

withVisibility

 BotBus withVisibility(ActionVisibility visibility)

withMessage

 BotBus withMessage(ConnectorType connectorType, Function0<ConnectorMessage> messageProvider)

withMessage

 BotBus withMessage(ConnectorType connectorType, String connectorId, Function0<ConnectorMessage> messageProvider)

reloadProfile
```
 Unit reloadProfile()
```

translate

 TranslatedSequence translate(I18nLabelValue key)

markAsUnknown
```
 Unit markAsUnknown()
```

applyBotAnswerInterceptor
```
 final Action applyBotAnswerInterceptor(Action a)
```
Update Action using BotAnswerInterceptor

assert

 final Unit assert(ConnectorMessageProvider messages)

Assert that logs contains specified messages.

Class BotBusMock

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

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

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

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class java.lang.Object

Constructor Detail

BotBusMock

Method Detail

getAnswers

getFirstAnswer

getSecondAnswer

getThirdAnswer

getLastAnswer

getBusAnswers

getFirstBusAnswer

getSecondBusAnswer

getThirdBusAnswer

getLastBusAnswer

getCurrentAnswerIndex

getUserTimeline

setUserTimeline

getDialog

setDialog

getCurrentDialog

getStory

setStory

getBotDefinition

setBotDefinition

getI18nProvider

setI18nProvider

getUserInterfaceType

setUserInterfaceType

getConnectorType

setConnectorType

getConnectorData

setConnectorData

getTranslator

getApplicationId

getBotId

getUserId

getUserPreferences

getUserLocale

getSourceConnectorType

setSourceConnectorType

getTargetConnectorType

setTargetConnectorType

getUnderlyingConnector

getEntities

getIntent

setIntent

getNextUserActionState

setNextUserActionState

getContext

getAction

isCompatibleWith

send

send

run

checkEndCalled

addActionEntity

addActionEntity

addActionEntity

sendAction

getBusContextValue

setBusContextValue

end

createBotSentence

sendRawText

sendDebugData

withPriority

withNotificationType

withVisibility

withMessage

withMessage

reloadProfile