ai.tock.bot.engine

Interface BotBus

All Superinterfaces:

Bus<T>, I18nTranslator

All Known Subinterfaces:

ConnectorStoryHandler<T>, StoryHandlerDefinition

All Known Implementing Classes:

ConnectorStoryHandlerBase, StoryHandlerDefinitionBase

public BotBus
extends Bus<T>

A new bus instance is created for each user request.

The bus is used by bot implementations to reply to the user request.

Field Detail

Companion

static ai.tock.bot.engine.BotBus.Companion Companion

Constructor Detail

BotBus

public BotBus()

Method Detail

getBotDefinition

@NotNull
BotDefinition getBotDefinition()

The bot definition of the current bot.

getUserTimeline

@NotNull
UserTimeline getUserTimeline()

The user timeline. Gets history and data about the user.

getDialog

@NotNull
Dialog getDialog()

The current dialog history for this user.

getStory

@NotNull
Story getStory()

The current story.

setStory

void setStory(@NotNull
              Story p)

The current story.

getAction

@NotNull
Action getAction()

The user action.

getConnectorData

@NotNull
ConnectorData getConnectorData()

The data specific to the connector (if any).

getUserPreferences

@NotNull
UserPreferences getUserPreferences()

User preferences of the current user.

getUnderlyingConnector

@NotNull
Connector getUnderlyingConnector()

The underlying interface Connector used. Please do not use this method as it is exposed for third party libraries only.

See Also:

interface Connector

getEntities

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

The entities in the dialog state.

getI18nProvider

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

To manage i18n.

setI18nProvider

void setI18nProvider(@NotNull
                     ai.tock.translator.I18nKeyProvider p)

To manage i18n.

getNextUserActionState

@Nullable
NextUserActionState getNextUserActionState()

Qualify the next user action.

setNextUserActionState

void setNextUserActionState(@Nullable
                            NextUserActionState p)

Qualify the next user action.

getStep

@Nullable
StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> getStep()

setStep

void setStep(@Nullable
             StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> step)

getStepName

@Nullable
java.lang.String getStepName()

The name of the step if any.

getUserText

@Nullable
java.lang.String getUserText()

The text sent by the user if any.

isIntent

boolean isIntent(@NotNull
                 IntentAware intentOwner)

To know if the current intent is owned by the interface IntentAware.

See Also:

interface IntentAware

nlpStats

@Nullable
NlpCallStats nlpStats()

Returns the NLP call stats if an NLP call has occurred, null either.

isChoiceAction

boolean isChoiceAction()

Is this current action is a class SendChoice?

See Also:

class SendChoice

choice

@Nullable
java.lang.String choice(@NotNull
                                  ParameterKey key)

Returns the value of the specified choice parameter, null if the user action is not a class SendChoice or if this parameter is not set.

See Also:

class SendChoice

booleanChoice

boolean booleanChoice(@NotNull
                      ParameterKey key)

Returns true if the specified choice parameter has the "true" value, false either.

hasChoiceValue

boolean hasChoiceValue(@NotNull
                       ParameterKey param,
                       @NotNull
                       ParameterKey value)

Checks that the specified choice parameter has the specified value.

hasActionEntity

boolean hasActionEntity(@NotNull
                        java.lang.String role)

Returns true if the current action has the specified entity role.

hasActionEntity

boolean hasActionEntity(@NotNull
                        ai.tock.nlp.api.client.model.Entity entity)

Returns true if the current action has the specified entity role.

entityValue

@Nullable
<T extends Value> T entityValue(@NotNull
                                          java.lang.String role,
                                          @NotNull
                                          kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.dialog.EntityValue,? extends T> valueTransformer)

Returns the current value for the specified entity role.

entityValue

@Nullable
<T extends Value> T entityValue(@NotNull
                                          ai.tock.nlp.api.client.model.Entity entity,
                                          @NotNull
                                          kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.dialog.EntityValue,? extends T> valueTransformer)

Returns the current value for the specified entity.

entityText

@Nullable
java.lang.String entityText(@NotNull
                                      ai.tock.nlp.api.client.model.Entity entity)

Returns the current text content for the specified entity.

entityText

@Nullable
java.lang.String entityText(@NotNull
                                      java.lang.String role)

Returns the current text content for the specified entity.

entityValueDetails

@Nullable
EntityValue entityValueDetails(@NotNull
                                         ai.tock.nlp.api.client.model.Entity entity)

Returns the current class EntityValue for the specified entity.

See Also:

class EntityValue

entityValueDetails

@Nullable
EntityValue entityValueDetails(@NotNull
                                         java.lang.String role)

Returns the current class EntityValue for the specified role.

See Also:

class EntityValue

changeEntityValue

void changeEntityValue(@NotNull
                       java.lang.String role,
                       @Nullable
                       EntityValue newValue)

Updates the current entity value in the dialog.

Parameters:

role - entity role

newValue - the new entity value

changeEntityValue

void changeEntityValue(@NotNull
                       ai.tock.nlp.api.client.model.Entity entity,
                       @Nullable
                       ai.tock.nlp.entity.Value newValue)

Updates the current entity value in the dialog.

Parameters:

entity - the entity definition

newValue - the new entity value

changeEntityValue

void changeEntityValue(@NotNull
                       ai.tock.nlp.api.client.model.Entity entity,
                       @NotNull
                       EntityValue newValue)

Updates the current entity value in the dialog.

Parameters:

entity - the entity definition

newValue - the new entity value

changeEntityText

void changeEntityText(@NotNull
                      ai.tock.nlp.api.client.model.Entity entity,
                      @Nullable
                      java.lang.String textContent)

Updates the current entity text value in the dialog.

Parameters:

entity - the entity definition

textContent - the new entity text content

removeEntityValue

void removeEntityValue(@NotNull
                       java.lang.String role)

Removes entity value for the specified role.

removeEntityValue

void removeEntityValue(@NotNull
                       ai.tock.nlp.api.client.model.Entity entity)

Removes entity value for the specified role.

removeAllEntityValues

void removeAllEntityValues()

Removes all current entity values.

resetDialogState

void resetDialogState()

Resets all entity values, context values, ai.tock.bot.engine.dialog.DialogState.userLocation and ai.tock.bot.engine.dialog.DialogState.nextActionState but keep entity values history.

See Also:

ai.tock.bot.engine.dialog.DialogState.resetState

contextValue

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

Returns the persistent current context value.

contextValue

@Nullable
<T> T contextValue(@NotNull
                             ParameterKey key)

Returns the persistent current context value.

changeContextValue

void changeContextValue(@NotNull
                        java.lang.String name,
                        @Nullable
                        java.lang.Object value)

Updates persistent context value. Do not store Collection or Map in the context, only plain objects or typed arrays.

changeContextValue

void changeContextValue(@NotNull
                        ParameterKey key,
                        @Nullable
                        java.lang.Object value)

Updates persistent context value.

getBusContextValue

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

Returns the non persistent current context value. Bus context values are useful to store a temporary (ie request scoped) state.

getBusContextValue

@Nullable
<T> T getBusContextValue(@NotNull
                                   ParameterKey key)

Returns the non persistent current context value. Bus context values are useful to store a temporary (ie request scoped) state.

setBusContextValue

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

Updates the non persistent current context value. Bus context values are useful to store a temporary (ie request scoped) state.

setBusContextValue

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

Updates the non persistent current context value. Bus context values are useful to store a temporary (ie request scoped) state.

endRawText

@NotNull
BotBus endRawText(@Nullable
                           java.lang.CharSequence plainText,
                           long delay)

Sends text that should not be translated as last bot answer.

end

@NotNull
BotBus end(@NotNull
                    Message message,
                    long delay)

Sends interface Message as last bot answer.

See Also:

interface Message

end

@NotNull
BotBus end(@NotNull
                    Action action,
                    long delay)

Sends class Action as last bot answer.

See Also:

class Action

end

@NotNull
BotBus end(@NotNull
                    MessagesList messages,
                    long initialDelay)

Sends a class MessagesList and end the dialog.

See Also:

class MessagesList

send

@NotNull
BotBus send(@NotNull
                     Message message,
                     long delay)

Sends a interface Message.

See Also:

interface Message

send

@NotNull
BotBus send(@NotNull
                     MessagesList messages,
                     long initialDelay)

Sends a class MessagesList.

See Also:

class MessagesList

send

@NotNull
BotBus send(@NotNull
                     Action action,
                     long delay)

Sends an class Action.

See Also:

class Action

withPriority

@NotNull
BotBus withPriority(@NotNull
                             ActionPriority priority)

Adds the specified enum ActionPriority to the bus context.

See Also:

enum ActionPriority

withNotificationType

@NotNull
BotBus withNotificationType(@NotNull
                                     ActionNotificationType notificationType)

Adds the specified enum ActionNotificationType to the bus context.

See Also:

enum ActionNotificationType

withVisibility

@NotNull
BotBus withVisibility(@NotNull
                               ActionVisibility visibility)

Adds the specified enum ActionVisibility to the bus context.

See Also:

enum ActionVisibility

reloadProfile

void reloadProfile()

Reloads the user profile.

switchStory

void switchStory(@NotNull
                 StoryDefinition storyDefinition,
                 @NotNull
                 Intent starterIntent)

Switches the context to the specified story definition (start a new class Story).

See Also:

class Story

handleAndSwitchStory

void handleAndSwitchStory(@NotNull
                          StoryDefinition storyDefinition,
                          @NotNull
                          Intent starterIntent)

Handles the action and switches the context to the specified story definition.

skipAnswer

void skipAnswer()

Does not send an answer. Synchronous interface Connectors (like Google Assistant or Alexa) usually do not support skipping answer.

See Also:

interface Connector

isFeatureEnabled

boolean isFeatureEnabled(@NotNull
                         FeatureType feature,
                         boolean p)

Is the feature enabled?

Parameters:

feature - the feature to check

p - the default value if the feature state is unknown

markAsUnknown

void markAsUnknown()

Marks the current as not understood in the nlp model.

i18n

@NotNull
ai.tock.translator.I18nLabelValue i18n(@NotNull
                                                java.lang.CharSequence defaultLabel,
                                                @NotNull
                                                java.util.List<? extends java.lang.Object> args)

i18nKey

@NotNull
ai.tock.translator.I18nLabelValue i18nKey(@NotNull
                                                   java.lang.String key,
                                                   @NotNull
                                                   java.lang.CharSequence defaultLabel,
                                                   @NotNull
                                                   java.lang.Object... args)

Gets an i18n label with the specified key.

getContextId

@Nullable
java.lang.String getContextId()

The current context identifier.

defaultDelay

long defaultDelay(int answerIndex)

Get the default delay between two answers.

getTest

boolean getTest()

Is it a test mode ?

end

@NotNull
BotBus end(long delay,
                    @NotNull
                    kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.BotBus,? extends java.lang.Object> messageProvider)

Sends messages provided by messageProvider as last bot answer. if messageProvider returns a CharSequence send it as text. Else call simply end().

See Also:

messageProvider, messageProvider, CharSequence

send

@NotNull
BotBus send(long delay,
                     @NotNull
                     kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.BotBus,? extends java.lang.Object> messageProvider)

Sends messages provided by messageProvider. if messageProvider returns a CharSequence send it as text. Else call simply send().

See Also:

messageProvider, messageProvider, CharSequence

withMessage

@NotNull
BotBus withMessage(@NotNull
                            ConnectorMessage message)

Adds the specified interface ConnectorMessage to the bus context if the targetConnectorType is compatible.

See Also:

interface ConnectorMessage, targetConnectorType

send

@NotNull
BotBus send(long delay)

Sends previously registered interface ConnectorMessage.

See Also:

interface ConnectorMessage

send

@NotNull
BotBus send(@NotNull
                     java.lang.CharSequence i18nText,
                     long delay,
                     @NotNull
                     java.lang.Object... i18nArgs)

Sends i18nText.

send

@NotNull
BotBus send(@NotNull
                     java.lang.CharSequence i18nText,
                     @NotNull
                     java.lang.Object... i18nArgs)

Sends i18nText.

end

@NotNull
BotBus end(@NotNull
                    java.lang.CharSequence i18nText,
                    long delay,
                    @NotNull
                    java.lang.Object... i18nArgs)

Sends i18nText as last bot answer.

end

@NotNull
BotBus end(@NotNull
                    java.lang.CharSequence i18nText,
                    @NotNull
                    java.lang.Object... i18nArgs)

Sends i18nText as last bot answer.

end

@NotNull
BotBus end(long delay)

Send previously registered interface ConnectorMessage as last bot answer.

See Also:

interface ConnectorMessage