ai.tock.bot.engine

Interface Bus<T extends Bus<T>>

All Superinterfaces:

I18nTranslator

All Known Subinterfaces:

BotBus, ConnectorStoryHandler<T>, StoryHandlerDefinition

All Known Implementing Classes:

ConnectorStoryHandlerBase, StoryHandlerDefinitionBase

public Bus<T extends Bus<T>>
extends I18nTranslator

Base methods for the bus.

Constructor Detail

Bus

public Bus()

Method Detail

getApplicationId

@NotNull
java.lang.String getApplicationId()

The current application id.

getBotId

@NotNull
PlayerId getBotId()

The current bot id.

getUserId

@NotNull
PlayerId getUserId()

The current user id.

getIntent

@Nullable
IntentAware getIntent()

The current intent.

getStepName

@Nullable
java.lang.String getStepName()

The name of the step if any.

getCurrentAnswerIndex

int getCurrentAnswerIndex()

The current answer index of the bot for this action.

getTest

boolean getTest()

Is it a test mode ?

defaultDelay

long defaultDelay(int answerIndex)

Get the default delay between two answers.

withMessage

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

send

@NotNull
T send(long delay)

Sends previously registered interface ConnectorMessage.

See Also:

interface ConnectorMessage

send

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

Sends i18nText.

send

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

Sends i18nText.

send

@NotNull
T send(long delay,
                @NotNull
                kotlin.jvm.functions.Function1<? super T,? 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
T sendRawText(@Nullable
                       java.lang.CharSequence plainText,
                       long delay)

Send text that should not be translated.

end

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

Sends i18nText as last bot answer.

end

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

Sends i18nText as last bot answer.

end

@NotNull
T end(long delay)

Send previously registered interface ConnectorMessage as last bot answer.

See Also:

interface ConnectorMessage

end

@NotNull
T end(long delay,
               @NotNull
               kotlin.jvm.functions.Function1<? super T,? 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
T endRawText(@Nullable
                      java.lang.CharSequence plainText,
                      long delay)

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