ai.tock.bot.definition

Class StoryHandlerBase<T extends StoryHandlerDefinition>

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

All Implemented Interfaces:

IntentAware, StoryHandler

Direct Known Subclasses:

ConfigurableStoryHandler, SimpleStoryHandlerBase

public class StoryHandlerBase<T extends StoryHandlerDefinition>
implements StoryHandler, IntentAware

Base implementation of interface StoryHandler. Provides also a convenient implementation of I18nKeyProvider to support i18n.

See Also:

interface StoryHandler

Field Detail

Companion

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

Constructor Detail

StoryHandlerBase

public StoryHandlerBase(@Nullable
                        java.lang.String mainIntentName,
                        @NotNull
                        java.lang.String i18nNamespace,
                        long breath)

Base implementation of interface StoryHandler. Provides also a convenient implementation of I18nKeyProvider to support i18n.

Parameters:

mainIntentName - The main intent of the story definition.

i18nNamespace - The namespace for I18nKeyProvider implementation.

breath - Convenient value to wait before next answer sentence.

See Also:

interface StoryHandler

StoryHandlerBase

public StoryHandlerBase()

Base implementation of interface StoryHandler. Provides also a convenient implementation of I18nKeyProvider to support i18n.

See Also:

interface StoryHandler

Method Detail

checkPreconditions

@NotNull
public kotlin.jvm.functions.Function1<ai.tock.bot.engine.BotBus,java.lang.Object> checkPreconditions()

Checks preconditions - if BotBus.end is called, StoryHandlerDefinition.handle is not called and the handling of bot answer is over.

See Also:

BotBus.end, StoryHandlerDefinition.handle

newHandlerDefinition

@NotNull
public T newHandlerDefinition(@NotNull
                                       BotBus bus,
                                       @Nullable
                                       java.lang.Object data)

Instantiates new instance of T.

selectStepFromStoryHandlerAndData

@Nullable
public <T extends StoryHandlerDefinition> StoryStep<?> selectStepFromStoryHandlerAndData(@NotNull
                                                                                                   T def,
                                                                                                   @Nullable
                                                                                                   java.lang.Object data,
                                                                                                   @Nullable
                                                                                                   StoryDefinition storyDefinition)

Selects step from HandlerDef, optional data and interface StoryDefinition.

See Also:

interface StoryDefinition

handle

public void handle(@NotNull
                   BotBus bus)

Receive a message from the bus.

Parameters:

bus - the bus used to get the message and send the answer

support

public double support(@NotNull
                      BotBus bus)

What is the probability of bot support for the current request?

Returns:

a probability between 0.0 (not supported) and 1.0 (supported!)

findStoryDefinition

@Nullable
public StoryDefinition findStoryDefinition(@NotNull
                                                     BotBus bus)

Finds the story definition of this handler.

handleAndSwitchStory

public void handleAndSwitchStory(@NotNull
                                 BotBus bus)

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

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. Current namespace is used for the categorization.

wrappedIntent

@NotNull
public Intent wrappedIntent()

getBreath

public long getBreath()

Convenient value to wait before next answer sentence.