ai.tock.bot.api.client

Class TockClientBus

ai.tock.bot.api.client.TockClientBus

All Implemented Interfaces:

ClientBus

public class TockClientBus
implements ClientBus

Field Detail

story

@NotNull
public ClientStoryDefinition story

The current story.

Constructor Detail

TockClientBus

public TockClientBus(@NotNull
                     ClientBotDefinition botDefinition,
                     @NotNull
                     java.lang.String requestId,
                     @NotNull
                     ai.tock.bot.api.model.UserRequest request,
                     @NotNull
                     kotlin.jvm.functions.Function1<? super ai.tock.bot.api.model.BotResponse,kotlin.Unit> sendAnswer)

Parameters:

botDefinition - The bot definition.

TockClientBus

public TockClientBus(@NotNull
                     ClientBotDefinition botDefinition,
                     @NotNull
                     ai.tock.bot.api.model.websocket.RequestData data,
                     @NotNull
                     kotlin.jvm.functions.Function1<? super ai.tock.bot.api.model.BotResponse,kotlin.Unit> sendAnswer)

Method Detail

getApplicationId

@NotNull
public java.lang.String getApplicationId()

getUserId

@NotNull
public ai.tock.bot.engine.user.PlayerId getUserId()

getBotId

@NotNull
public ai.tock.bot.engine.user.PlayerId getBotId()

getIntent

@Nullable
public ai.tock.bot.definition.IntentAware getIntent()

getTest

public boolean getTest()

getUserLocale

@NotNull
public java.util.Locale getUserLocale()

getUserInterfaceType

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

getTargetConnectorType

@NotNull
public ai.tock.bot.connector.ConnectorType getTargetConnectorType()

getContextId

@Nullable
public java.lang.String getContextId()

getCurrentAnswerIndex

public int getCurrentAnswerIndex()

getEntities

@NotNull
public java.util.List<ai.tock.bot.api.model.context.Entity> getEntities()

The entity list.

getMessage

@NotNull
public ai.tock.bot.api.model.message.user.UserMessage getMessage()

The user message.

getStory

@NotNull
public ClientStoryDefinition getStory()

The current story.

setStory

public void setStory(@NotNull
                     ClientStoryDefinition p)

The current story.

getStep

@Nullable
public ClientStep getStep()

The current step.

setStep

public void setStep(@Nullable
                    ClientStep p)

The current step.

getStepName

@Nullable
public java.lang.String getStepName()

handle

public void handle()

Handles the current request.

defaultDelay

public long defaultDelay(int answerIndex)

endRawText

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

sendRawText

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

send

@NotNull
public ClientBus send(@NotNull
                               java.lang.CharSequence i18nText,
                               @NotNull
                               java.util.List<ai.tock.bot.api.model.message.bot.Suggestion> suggestions,
                               long delay,
                               @NotNull
                               java.lang.Object... i18nArgs)

Sends a text with suggestions.

end

@NotNull
public ClientBus end(@NotNull
                              java.lang.CharSequence i18nText,
                              @NotNull
                              java.util.List<ai.tock.bot.api.model.message.bot.Suggestion> suggestions,
                              long delay,
                              @NotNull
                              java.lang.Object... i18nArgs)

Sends a text with suggestions as last bot answer.

end

@NotNull
public ClientBus end(@NotNull
                              ai.tock.bot.api.model.message.bot.Card card)

Sends a Card as last bot answer.

end

@NotNull
public ClientBus end(@NotNull
                              ai.tock.bot.api.model.message.bot.Carousel carousel)

Sends a [Carousel as last bot answer.

send

@NotNull
public ClientBus send(@NotNull
                               ai.tock.bot.api.model.message.bot.Carousel carousel)

Sends a Carousel.

send

@NotNull
public ClientBus send(@NotNull
                               ai.tock.bot.api.model.message.bot.Card card)

Sends a Card.

withMessage

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

withMessage

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

i18n

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

getBotDefinition

@NotNull
public ClientBotDefinition getBotDefinition()

The bot definition.

getRequestId

@NotNull
public java.lang.String getRequestId()

getRequest

@NotNull
public ai.tock.bot.api.model.UserRequest getRequest()

getSendAnswer

@NotNull
public kotlin.jvm.functions.Function1<ai.tock.bot.api.model.BotResponse,kotlin.Unit> getSendAnswer()