ai.tock.bot.definition

Class StoryHandlerDefinitionBase<T extends ConnectorStoryHandlerBase<?>>

ai.tock.bot.definition.StoryHandlerDefinitionBase<T>

All Implemented Interfaces:

BotBus, Bus<T>, I18nTranslator, StoryHandlerDefinition

public class StoryHandlerDefinitionBase<T extends ConnectorStoryHandlerBase<?>>
implements BotBus, StoryHandlerDefinition

Base implementation of interface StoryHandlerDefinition.

See Also:

interface StoryHandlerDefinition

Field Detail

Companion

public static ai.tock.bot.definition.StoryHandlerDefinitionBase.Companion Companion

Constructor Detail

StoryHandlerDefinitionBase

public StoryHandlerDefinitionBase(@NotNull
                                  BotBus bus)

Base implementation of interface StoryHandlerDefinition.

See Also:

interface StoryHandlerDefinition

Method Detail

answer

public void answer()

The method to implement if there is no interface StoryStep in the interface StoryDefinition or when current interface StoryStep is null

See Also:

interface StoryStep, interface StoryDefinition, interface StoryStep

handle

public void handle()

Default implementation redirect to answer.

getConnectorType

@NotNull
public ConnectorType getConnectorType()

Shortcut for BotBus.targetConnectorType.

findConnector

@Nullable
public T findConnector(@NotNull
                                 ConnectorType connectorType)

Method to override in order to provide interface ConnectorStoryHandler. Default implementation use annotations annotated with @annotationclass ConnectorHandler.

See Also:

interface ConnectorStoryHandler, annotationclass ConnectorHandler

findConnector

@Nullable
public T findConnector(@NotNull
                                 java.lang.String connectorId)

Method to override in order to provide interface ConnectorStoryHandler. Default implementation use annotations annotated with @annotationclass ConnectorIdHandlers.

See Also:

interface ConnectorStoryHandler, annotationclass ConnectorIdHandlers

getConnector

@Nullable
public T getConnector()

Provides the current interface ConnectorStoryHandler using findConnector.

See Also:

interface ConnectorStoryHandler, findConnector

getC

@NotNull
public T getC()

Provides a not null connector. Throws NPE if connector is null.

getBus

@NotNull
public BotBus getBus()

getAction

@NotNull
public Action getAction()

The user action.

getApplicationId

@NotNull
public java.lang.String getApplicationId()

The current application id.

getBotDefinition

@NotNull
public BotDefinition getBotDefinition()

The bot definition of the current bot.

getBotId

@NotNull
public PlayerId getBotId()

The current bot id.

getConnectorData

@NotNull
public ConnectorData getConnectorData()

The data specific to the connector (if any).

getContextId

@Nullable
public java.lang.String getContextId()

The current context identifier.

getCurrentAnswerIndex

public int getCurrentAnswerIndex()

The current answer index of the bot for this action.

getDialog

@NotNull
public Dialog getDialog()

The current dialog history for this user.

getEntities

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

The entities in the dialog state.

getI18nProvider

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

To manage i18n.

setI18nProvider

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

To manage i18n.

getIntent

@Nullable
public IntentAware getIntent()

The current intent.

getNextUserActionState

@Nullable
public NextUserActionState getNextUserActionState()

Qualify the next user action.

setNextUserActionState

public void setNextUserActionState(@Nullable
                                   NextUserActionState p)

Qualify the next user action.

getStep

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

setStep

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

getStepName

@Nullable
public java.lang.String getStepName()

The name of the step if any.

getStory

@NotNull
public Story getStory()

The current story.

setStory

public void setStory(@NotNull
                     Story p)

The current story.

getTargetConnectorType

@NotNull
public ConnectorType getTargetConnectorType()

The class ConnectorType used for the response.

See Also:

class ConnectorType

getTest

public boolean getTest()

Is it a test mode ?

getUnderlyingConnector

@NotNull
public 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

getUserId

@NotNull
public PlayerId getUserId()

The current user id.

getUserInterfaceType

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

The current user interface type.

getUserLocale

@NotNull
public java.util.Locale getUserLocale()

The current user Locale.

See Also:

Locale

getUserPreferences

@NotNull
public UserPreferences getUserPreferences()

User preferences of the current user.

getUserText

@Nullable
public java.lang.String getUserText()

The text sent by the user if any.

getUserTimeline

@NotNull
public UserTimeline getUserTimeline()

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

booleanChoice

public boolean booleanChoice(@NotNull
                             ParameterKey key)

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

changeContextValue

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

Updates persistent context value.

changeContextValue

public 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.

changeEntityText

public 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

changeEntityValue

public 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

changeEntityValue

public 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

public 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

choice

@Nullable
public 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

contextValue

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

Returns the persistent current context value.

contextValue

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

Returns the persistent current context value.

defaultDelay

public long defaultDelay(int answerIndex)

Get the default delay between two answers.

end

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

Sends class Action as last bot answer.

See Also:

class Action

end

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

Sends interface Message as last bot answer.

See Also:

interface Message

end

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

Sends a class MessagesList and end the dialog.

See Also:

class MessagesList

end

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

Sends i18nText as last bot answer.

end

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

Sends i18nText as last bot answer.

end

@NotNull
public BotBus end(long delay)

Send previously registered interface ConnectorMessage as last bot answer.

See Also:

interface ConnectorMessage

end

@NotNull
public 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

endRawText

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

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

entityText

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

Returns the current text content for the specified entity.

entityText

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

Returns the current text content for the specified entity.

entityValue

@Nullable
public <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.

entityValue

@Nullable
public <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.

entityValueDetails

@Nullable
public 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
public EntityValue entityValueDetails(@NotNull
                                                java.lang.String role)

Returns the current class EntityValue for the specified role.

See Also:

class EntityValue

getBusContextValue

@Nullable
public <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.

getBusContextValue

@Nullable
public <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.

handleAndSwitchStory

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

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

hasActionEntity

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

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

hasActionEntity

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

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

hasChoiceValue

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

Checks that the specified choice parameter has the specified value.

i18n

@NotNull
public ai.tock.translator.I18nLabelValue i18n(@NotNull
                                                       java.lang.CharSequence defaultLabel,
                                                       @NotNull
                                                       java.lang.Object... args)

i18n

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

i18nKey

@NotNull
public 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.

isChoiceAction

public boolean isChoiceAction()

Is this current action is a class SendChoice?

See Also:

class SendChoice

isFeatureEnabled

public 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

isIntent

public boolean isIntent(@NotNull
                        IntentAware intentOwner)

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

See Also:

interface IntentAware

markAsUnknown

public void markAsUnknown()

Marks the current as not understood in the nlp model.

nlpStats

@Nullable
public NlpCallStats nlpStats()

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

reloadProfile

public void reloadProfile()

Reloads the user profile.

removeAllEntityValues

public void removeAllEntityValues()

Removes all current entity values.

removeEntityValue

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

Removes entity value for the specified role.

removeEntityValue

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

Removes entity value for the specified role.

resetDialogState

public 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

send

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

Sends an class Action.

See Also:

class Action

send

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

Sends a interface Message.

See Also:

interface Message

send

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

Sends a class MessagesList.

See Also:

class MessagesList

send

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

Sends i18nText.

send

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

Sends i18nText.

send

@NotNull
public BotBus send(long delay)

Sends previously registered interface ConnectorMessage.

See Also:

interface ConnectorMessage

send

@NotNull
public 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

sendRawText

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

Send text that should not be translated.

setBusContextValue

public 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.

setBusContextValue

public 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.

skipAnswer

public 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

switchStory

public 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

translate

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

Translates the specified key.

translate

@NotNull
public ai.tock.translator.TranslatedSequence translate(@Nullable
                                                                java.lang.CharSequence text,
                                                                @NotNull
                                                                java.lang.Object... args)

Translates and format if needed the text with the optionals args.

translateAndReturnBlankAsNull

@Nullable
public ai.tock.translator.TranslatedSequence translateAndReturnBlankAsNull(@Nullable
                                                                                     java.lang.CharSequence s)

Translates the specified text and return null if the answer is blank.

withMessage

@NotNull
public BotBus withMessage(@NotNull
                                   ConnectorMessage message)

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

See Also:

interface ConnectorMessage, targetConnectorType

withMessage

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

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

See Also:

interface ConnectorMessage, targetConnectorType

withMessage

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

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

See Also:

interface ConnectorMessage, targetConnectorType, connectorId

withNotificationType

@NotNull
public BotBus withNotificationType(@NotNull
                                            ActionNotificationType notificationType)

Adds the specified enum ActionNotificationType to the bus context.

See Also:

enum ActionNotificationType

withPriority

@NotNull
public BotBus withPriority(@NotNull
                                    ActionPriority priority)

Adds the specified enum ActionPriority to the bus context.

See Also:

enum ActionPriority

withVisibility

@NotNull
public BotBus withVisibility(@NotNull
                                      ActionVisibility visibility)

Adds the specified enum ActionVisibility to the bus context.

See Also:

enum ActionVisibility