ai.tock.bot.test

Class BotBusMock

ai.tock.bot.test.BotBusMock

public class BotBusMock

A Bus mock used in unit tests.

The answers of the bot are available in the answers property.

See Also:

answers

Field Detail

Companion

public static ai.tock.bot.test.BotBusMock.Companion Companion

Constructor Detail

BotBusMock

public BotBusMock(@NotNull
                  BotBusMockContext context,
                  @NotNull
                  ai.tock.bot.engine.action.Action action)

A Bus mock used in unit tests.

The answers of the bot are available in the answers property.

See Also:

answers

Method Detail

getAnswers

@NotNull
public java.util.List<ai.tock.bot.test.BotBusMockLog> getAnswers()

The list of all bot answers recorded.

getFirstAnswer

@NotNull
public BotBusMockLog getFirstAnswer()

The first answer recorded.

getSecondAnswer

@NotNull
public BotBusMockLog getSecondAnswer()

The second answer recorded.

getThirdAnswer

@NotNull
public BotBusMockLog getThirdAnswer()

The third answer recorded.

getLastAnswer

@NotNull
public BotBusMockLog getLastAnswer()

The last answer recorded.

getBusAnswers

@NotNull
public java.util.List<ai.tock.bot.test.BotBusMockLog> getBusAnswers()

The list of bot answers for this bus.

getFirstBusAnswer

@NotNull
public BotBusMockLog getFirstBusAnswer()

The first answer for this bus.

getSecondBusAnswer

@NotNull
public BotBusMockLog getSecondBusAnswer()

The second answer for this bus.

getThirdBusAnswer

@NotNull
public BotBusMockLog getThirdBusAnswer()

The third answer for this bus.

getLastBusAnswer

@NotNull
public BotBusMockLog getLastBusAnswer()

The last answer for this bus.

getCurrentAnswerIndex

public int getCurrentAnswerIndex()

run

@NotNull
public BotBusMock run()

Run the StoryHandler of the current story.

See Also:

StoryHandler, story

checkEndCalled

@NotNull
public BotBusMock checkEndCalled()

Throws an exception if the end() is not called

addActionEntity

@NotNull
public BotBusMock addActionEntity(@NotNull
                                           ai.tock.bot.engine.dialog.EntityValue contextValue)

Add an entity set in the current action.

addActionEntity

@NotNull
public BotBusMock addActionEntity(@NotNull
                                           ai.tock.nlp.api.client.model.Entity entity,
                                           @Nullable
                                           ai.tock.nlp.entity.Value newValue)

Add an entity set in the current action.

addActionEntity

@NotNull
public BotBusMock addActionEntity(@NotNull
                                           ai.tock.nlp.api.client.model.Entity entity,
                                           @NotNull
                                           java.lang.String textContent)

Simulate an action entity.

getUserTimeline

@NotNull
public ai.tock.bot.engine.user.UserTimeline getUserTimeline()

setUserTimeline

public void setUserTimeline(@NotNull
                            ai.tock.bot.engine.user.UserTimeline value)

getDialog

@NotNull
public ai.tock.bot.engine.dialog.Dialog getDialog()

setDialog

public void setDialog(@NotNull
                      ai.tock.bot.engine.dialog.Dialog value)

getStory

@NotNull
public ai.tock.bot.engine.dialog.Story getStory()

setStory

public void setStory(@NotNull
                     ai.tock.bot.engine.dialog.Story value)

getBotDefinition

@NotNull
public ai.tock.bot.definition.BotDefinition getBotDefinition()

setBotDefinition

public void setBotDefinition(@NotNull
                             ai.tock.bot.definition.BotDefinition value)

getI18nProvider

@NotNull
public ai.tock.translator.I18nKeyProvider getI18nProvider()

setI18nProvider

public void setI18nProvider(@NotNull
                            ai.tock.translator.I18nKeyProvider value)

getUserInterfaceType

@NotNull
public ai.tock.translator.UserInterfaceType getUserInterfaceType()

setUserInterfaceType

public void setUserInterfaceType(@NotNull
                                 ai.tock.translator.UserInterfaceType value)

getConnectorType

@NotNull
public ai.tock.bot.connector.ConnectorType getConnectorType()

setConnectorType

public void setConnectorType(@NotNull
                             ai.tock.bot.connector.ConnectorType value)

getConnectorData

@NotNull
public ai.tock.bot.connector.ConnectorData getConnectorData()

setConnectorData

public void setConnectorData(@NotNull
                             ai.tock.bot.connector.ConnectorData p)

getTranslator

@NotNull
public ai.tock.translator.TranslatorEngine getTranslator()

The translator used to translate labels - default is NoOp.

getApplicationId

@NotNull
public java.lang.String getApplicationId()

getBotId

@NotNull
public ai.tock.bot.engine.user.PlayerId getBotId()

getUserId

@NotNull
public ai.tock.bot.engine.user.PlayerId getUserId()

getUserPreferences

@NotNull
public ai.tock.bot.engine.user.UserPreferences getUserPreferences()

getUserLocale

@NotNull
public java.util.Locale getUserLocale()

getTargetConnectorType

@NotNull
public ai.tock.bot.connector.ConnectorType getTargetConnectorType()

setTargetConnectorType

public void setTargetConnectorType(@NotNull
                                   ai.tock.bot.connector.ConnectorType value)

getUnderlyingConnector

@NotNull
public ai.tock.bot.connector.Connector getUnderlyingConnector()

getEntities

@NotNull
public java.util.Map<java.lang.String,ai.tock.bot.engine.dialog.EntityStateValue> getEntities()

getIntent

@Nullable
public ai.tock.bot.definition.IntentAware getIntent()

setIntent

public void setIntent(@Nullable
                      ai.tock.bot.definition.IntentAware value)

getNextUserActionState

@Nullable
public ai.tock.bot.engine.dialog.NextUserActionState getNextUserActionState()

setNextUserActionState

public void setNextUserActionState(@Nullable
                                   ai.tock.bot.engine.dialog.NextUserActionState value)

sendAction

public void sendAction(@NotNull
                       ai.tock.bot.engine.action.Action action,
                       long delay)

getBusContextValue

@Nullable
public <T> T getBusContextValue(@NotNull
                                          java.lang.String name)

Returns the non persistent current value.

setBusContextValue

public void setBusContextValue(@NotNull
                               java.lang.String key,
                               @Nullable
                               java.lang.Object value)

Update the non persistent current value.

end

@NotNull
public ai.tock.bot.engine.BotBus end(@NotNull
                                              ai.tock.bot.engine.action.Action action,
                                              long delay)

createBotSentence

@NotNull
public ai.tock.bot.engine.action.SendSentence createBotSentence(@Nullable
                                                                         java.lang.CharSequence plainText)

sendRawText

@NotNull
public ai.tock.bot.engine.BotBus sendRawText(@Nullable
                                                      java.lang.CharSequence plainText,
                                                      long delay)

send

@NotNull
public ai.tock.bot.engine.BotBus send(@NotNull
                                               ai.tock.bot.engine.action.Action action,
                                               long delay)

withPriority

@NotNull
public ai.tock.bot.engine.BotBus withPriority(@NotNull
                                                       ai.tock.bot.engine.action.ActionPriority priority)

withNotificationType

@NotNull
public ai.tock.bot.engine.BotBus withNotificationType(@NotNull
                                                               ai.tock.bot.engine.action.ActionNotificationType notificationType)

withVisibility

@NotNull
public ai.tock.bot.engine.BotBus withVisibility(@NotNull
                                                         ai.tock.bot.engine.action.ActionVisibility visibility)

withMessage

@NotNull
public ai.tock.bot.engine.BotBus withMessage(@NotNull
                                                      ai.tock.bot.connector.ConnectorType connectorType,
                                                      @NotNull
                                                      kotlin.jvm.functions.Function0<? extends ai.tock.bot.connector.ConnectorMessage> messageProvider)

withMessage

@NotNull
public ai.tock.bot.engine.BotBus withMessage(@NotNull
                                                      ai.tock.bot.connector.ConnectorType connectorType,
                                                      @NotNull
                                                      java.lang.String connectorId,
                                                      @NotNull
                                                      kotlin.jvm.functions.Function0<? extends ai.tock.bot.connector.ConnectorMessage> messageProvider)

reloadProfile

public void reloadProfile()

translate

@NotNull
public ai.tock.translator.TranslatedSequence translate(@Nullable
                                                                ai.tock.translator.I18nLabelValue key)

markAsUnknown

public void markAsUnknown()

applyBotAnswerInterceptor

@NotNull
public ai.tock.bot.engine.action.Action applyBotAnswerInterceptor(@NotNull
                                                                           ai.tock.bot.engine.action.Action a)

Update Action using BotAnswerInterceptor

getContext

@NotNull
public BotBusMockContext getContext()

getAction

@NotNull
public ai.tock.bot.engine.action.Action getAction()