ai.tock.bot.definition

Interface StoryDataStep<T extends StoryHandlerDefinition,TD,D>

Type Parameters:

T -

StoryDef

TD -

the data of the StoryDef

D -

the data of the step

All Superinterfaces:

StoryStep<T>

All Known Implementing Classes:

StoryDataStepBase

public StoryDataStep<T extends StoryHandlerDefinition,TD,D>
extends StoryStep<T>

A step that can have specific preconditions and can use input data object in handler.

Constructor Detail

StoryDataStep

public StoryDataStep()

Method Detail

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.

selectFromBusAndData

@NotNull
kotlin.jvm.functions.Function2<T,TD,java.lang.Boolean> selectFromBusAndData()

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

checkPreconditions

@NotNull
kotlin.jvm.functions.Function2<T,TD,D> checkPreconditions()

Checks preconditions - if BotBus.end is called, StoryHandlerDefinition.handle is not called and the handling of bot answer is over. Returned data is used in subsequent call of handler if not null

• else StoryHandlerBase.checkPreconditions returned data is used.

See Also:

BotBus.end, StoryHandlerDefinition.handle, handler, StoryHandlerBase.checkPreconditions

handler

@NotNull
kotlin.jvm.functions.Function2<T,D,java.lang.Object> handler()

The custom handler 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.