ai.tock.bot.definition

Interface StoryStep<T extends StoryHandlerDefinition>

All Known Subinterfaces:

SimpleStoryStep, StoryDataStep<T,TD,D>

All Known Implementing Classes:

StoryDataStepBase

public StoryStep<T extends StoryHandlerDefinition>

A step (the implementation is usually an enum) is a part of a interface StoryDefinition. Used to manage workflow in a interface StoryHandler.

See Also:

interface StoryDefinition, interface StoryHandler

Constructor Detail

StoryStep

public StoryStep()

Method Detail

getName

@NotNull
java.lang.String getName()

The name of the step. usually automatically defined by the enum field.

answer

@NotNull
kotlin.jvm.functions.Function1<T,java.lang.Object> answer()

The custom answer for this step. When returning a null value, it means that the step is not able to answer to the current request.

Default implementation returns null.

getBaseIntent

@NotNull
IntentAware getBaseIntent()

Returns intent or the StoryDefinition.mainIntent if intent is null.

See Also:

intent, StoryDefinition.mainIntent, intent

getIntent

@Nullable
IntentAware getIntent()

The main intent of the step. If not null and if the current intent is equals to intent, this step will be automatically selected to be the current step.

See Also:

intent

getOtherStarterIntents

@NotNull
java.util.Set<ai.tock.bot.definition.IntentAware> getOtherStarterIntents()

Same behaviour than intent in the rare case when the step handle more than one intent.

See Also:

intent

getSecondaryIntents

@NotNull
java.util.Set<ai.tock.bot.definition.IntentAware> getSecondaryIntents()

The secondary intents of this step. If detected and if the current step is this step, the current step remains this step.

selectFromBus

@NotNull
kotlin.jvm.functions.Function1<ai.tock.bot.engine.BotBus,java.lang.Boolean> selectFromBus()

Does this Step has to be selected from the Bus? This method is called if StoryHandlerBase.checkPreconditions does not call BotBus.end. If this functions returns true, the step is selected and remaining steps are not tested.

See Also:

StoryHandlerBase.checkPreconditions, BotBus.end

selectFromAction

boolean selectFromAction(@NotNull
                         UserTimeline userTimeline,
                         @NotNull
                         Dialog dialog,
                         @NotNull
                         Action action,
                         @Nullable
                         Intent intent)

Does this Step has to be automatically selected? if returns true, the step is selected.

selectFromEntityStepSelection

@Nullable
java.lang.Boolean selectFromEntityStepSelection(@NotNull
                                                          Action action,
                                                          @Nullable
                                                          Intent intent)

Does this step hast to be selected from its entityStepSelection? Returns null if there is no entityStepSelection.

See Also:

entityStepSelection, entityStepSelection

supportStarterIntent

boolean supportStarterIntent(@NotNull
                             Intent i)

Does this step support this intent as starter intent?

supportIntent

boolean supportIntent(@NotNull
                      Intent i)

Does this step support this intent?

getChildren

@NotNull
java.util.Set<ai.tock.bot.definition.StoryStep> getChildren()

The optional children of the step.

getEntityStepSelection

@Nullable
EntityStepSelection getEntityStepSelection()

If not null, entity has to be set in the current action to trigger the step.