ai.tock.bot.api.client

Interface ClientBus

All Known Implementing Classes:

TockClientBus

public ClientBus

A new bus instance is created for each user request.

The bus is used by bot implementations to reply to the user request.

Constructor Detail

ClientBus

public ClientBus()

Method Detail

getBotDefinition

@NotNull
ClientBotDefinition getBotDefinition()

The bot definition.

getEntities

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

The entity list.

getMessage

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

The user message.

getStory

@NotNull
ClientStoryDefinition getStory()

The current story.

setStory

void setStory(@NotNull
              ClientStoryDefinition p)

The current story.

getStep

@Nullable
ClientStep getStep()

The current step.

setStep

void setStep(@Nullable
             ClientStep p)

The current step.

handle

void handle()

Handles the current request.

send

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

Sends a Card.

end

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

Sends a Card as last bot answer.

send

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

Sends a Carousel.

end

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

Sends a [Carousel as last bot answer.

send

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

send

@NotNull
ClientBus send(@NotNull
                        java.lang.CharSequence i18nText,
                        @NotNull
                        java.util.List<? extends java.lang.CharSequence> suggestions)

Sends a text with suggestions.

end

@NotNull
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
ClientBus end(@NotNull
                       java.lang.CharSequence i18nText,
                       @NotNull
                       java.util.List<? extends java.lang.CharSequence> suggestions)

Sends a text with suggestions as last bot answer.

entity

@Nullable
ai.tock.bot.api.model.context.Entity entity(@NotNull
                                                      java.lang.String role)

Finds the Entity from the specified entity role.

entityText

@Nullable
java.lang.String entityText(@NotNull
                                      java.lang.String role)

Returns the Entity text content from the specified entity role.

entityValue

@Nullable
<T extends Value> T entityValue(@NotNull
                                          java.lang.String role)

Returns the corresponding Entity from the specified entity role.

removeEntity

boolean removeEntity(@NotNull
                     java.lang.String role)

Removes the entity of the specified role.

removeEntity

boolean removeEntity(@NotNull
                     ai.tock.bot.api.model.context.Entity entity)

Remove the specified entity.

translate

@NotNull
ai.tock.bot.api.model.message.bot.I18nText translate(@Nullable
                                                              java.lang.CharSequence text,
                                                              @NotNull
                                                              java.lang.Object... args)

newCard

@NotNull
ai.tock.bot.api.model.message.bot.Card newCard(@Nullable
                                                        java.lang.CharSequence title,
                                                        @Nullable
                                                        java.lang.CharSequence subTitle,
                                                        @Nullable
                                                        ai.tock.bot.api.model.message.bot.Attachment attachment,
                                                        @NotNull
                                                        java.util.List<ai.tock.bot.api.model.message.bot.Action> actions,
                                                        long delay)

Creates a new Card.

newCarousel

@NotNull
ai.tock.bot.api.model.message.bot.Carousel newCarousel(@NotNull
                                                                java.util.List<ai.tock.bot.api.model.message.bot.Card> cards,
                                                                long delay)

Creates a new Carousel.

newCarousel

@NotNull
ai.tock.bot.api.model.message.bot.Carousel newCarousel(@NotNull
                                                                ai.tock.bot.api.model.message.bot.Card[] cards,
                                                                long delay)

Creates a new Carousel.

newCard

@NotNull
ai.tock.bot.api.model.message.bot.Card newCard(@Nullable
                                                        java.lang.CharSequence title,
                                                        @Nullable
                                                        java.lang.CharSequence subTitle,
                                                        @Nullable
                                                        ai.tock.bot.api.model.message.bot.Attachment attachment,
                                                        @NotNull
                                                        ai.tock.bot.api.model.message.bot.Action[] actions,
                                                        long delay)

Creates a new Card.

newAction

@NotNull
ai.tock.bot.api.model.message.bot.Action newAction(@NotNull
                                                            java.lang.CharSequence title,
                                                            @Nullable
                                                            java.lang.String url)

Creates a new Action.

newAttachment

@NotNull
ai.tock.bot.api.model.message.bot.Attachment newAttachment(@NotNull
                                                                    java.lang.String url,
                                                                    @Nullable
                                                                    ai.tock.bot.api.model.message.bot.AttachmentType type)

Creates a new Attachment.