ai.tock.bot.engine

Class BotBus.DefaultImpls

ai.tock.bot.engine.BotBus.DefaultImpls

Enclosing interface:

BotBus

public static class BotBus.DefaultImpls

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

DefaultImpls

public DefaultImpls()

Method Detail

getStep

@Nullable
public static StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> getStep(BotBus $this)

setStep

public static void setStep(BotBus $this,
                           @Nullable
                           StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> step)

getStepName

@Nullable
public static java.lang.String getStepName(BotBus $this)

The name of the step if any.

getUserText

@Nullable
public static java.lang.String getUserText(BotBus $this)

The text sent by the user if any.

isIntent

public static boolean isIntent(BotBus $this,
                               @NotNull
                               IntentAware intentOwner)

To know if the current intent is owned by the interface IntentAware.

See Also:

interface IntentAware

nlpStats

@Nullable
public static NlpCallStats nlpStats(BotBus $this)

Returns the NLP call stats if an NLP call has occurred, null either.

isChoiceAction

public static boolean isChoiceAction(BotBus $this)

Is this current action is a class SendChoice?

See Also:

class SendChoice

choice

@Nullable
public static java.lang.String choice(BotBus $this,
                                                @NotNull
                                                ParameterKey key)

Returns the value of the specified choice parameter, null if the user action is not a class SendChoice or if this parameter is not set.

See Also:

class SendChoice

booleanChoice

public static boolean booleanChoice(BotBus $this,
                                    @NotNull
                                    ParameterKey key)

Returns true if the specified choice parameter has the "true" value, false either.

hasChoiceValue

public static boolean hasChoiceValue(BotBus $this,
                                     @NotNull
                                     ParameterKey param,
                                     @NotNull
                                     ParameterKey value)

Checks that the specified choice parameter has the specified value.

hasActionEntity

public static boolean hasActionEntity(BotBus $this,
                                      @NotNull
                                      java.lang.String role)

Returns true if the current action has the specified entity role.

hasActionEntity

public static boolean hasActionEntity(BotBus $this,
                                      @NotNull
                                      ai.tock.nlp.api.client.model.Entity entity)

Returns true if the current action has the specified entity role.

entityValue

@Nullable
public static <T extends Value> T entityValue(BotBus $this,
                                                        @NotNull
                                                        java.lang.String role,
                                                        @NotNull
                                                        kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.dialog.EntityValue,? extends T> valueTransformer)

Returns the current value for the specified entity role.

entityValue

@Nullable
public static <T extends Value> T entityValue(BotBus $this,
                                                        @NotNull
                                                        ai.tock.nlp.api.client.model.Entity entity,
                                                        @NotNull
                                                        kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.dialog.EntityValue,? extends T> valueTransformer)

Returns the current value for the specified entity.

entityText

@Nullable
public static java.lang.String entityText(BotBus $this,
                                                    @NotNull
                                                    ai.tock.nlp.api.client.model.Entity entity)

Returns the current text content for the specified entity.

entityText

@Nullable
public static java.lang.String entityText(BotBus $this,
                                                    @NotNull
                                                    java.lang.String role)

Returns the current text content for the specified entity.

entityValueDetails

@Nullable
public static EntityValue entityValueDetails(BotBus $this,
                                                       @NotNull
                                                       ai.tock.nlp.api.client.model.Entity entity)

Returns the current class EntityValue for the specified entity.

See Also:

class EntityValue

entityValueDetails

@Nullable
public static EntityValue entityValueDetails(BotBus $this,
                                                       @NotNull
                                                       java.lang.String role)

Returns the current class EntityValue for the specified role.

See Also:

class EntityValue

changeEntityValue

public static void changeEntityValue(BotBus $this,
                                     @NotNull
                                     java.lang.String role,
                                     @Nullable
                                     EntityValue newValue)

Updates the current entity value in the dialog.

Parameters:

$this - entity role

role - the new entity value

newValue - the new entity value

changeEntityValue

public static void changeEntityValue(BotBus $this,
                                     @NotNull
                                     ai.tock.nlp.api.client.model.Entity entity,
                                     @Nullable
                                     ai.tock.nlp.entity.Value newValue)

Updates the current entity value in the dialog.

Parameters:

$this - the entity definition

entity - the new entity value

newValue - the new entity value

changeEntityValue

public static void changeEntityValue(BotBus $this,
                                     @NotNull
                                     ai.tock.nlp.api.client.model.Entity entity,
                                     @NotNull
                                     EntityValue newValue)

Updates the current entity value in the dialog.

Parameters:

$this - the entity definition

entity - the new entity value

newValue - the new entity value

changeEntityText

public static void changeEntityText(BotBus $this,
                                    @NotNull
                                    ai.tock.nlp.api.client.model.Entity entity,
                                    @Nullable
                                    java.lang.String textContent)

Updates the current entity text value in the dialog.

Parameters:

$this - the entity definition

entity - the new entity text content

textContent - the new entity text content

removeEntityValue

public static void removeEntityValue(BotBus $this,
                                     @NotNull
                                     java.lang.String role)

Removes entity value for the specified role.

removeEntityValue

public static void removeEntityValue(BotBus $this,
                                     @NotNull
                                     ai.tock.nlp.api.client.model.Entity entity)

Removes entity value for the specified role.

removeAllEntityValues

public static void removeAllEntityValues(BotBus $this)

Removes all current entity values.

resetDialogState

public static void resetDialogState(BotBus $this)

Resets all entity values, context values, ai.tock.bot.engine.dialog.DialogState.userLocation and ai.tock.bot.engine.dialog.DialogState.nextActionState but keep entity values history.

See Also:

ai.tock.bot.engine.dialog.DialogState.resetState

contextValue

@Nullable
public static <T> T contextValue(BotBus $this,
                                           @NotNull
                                           java.lang.String name)

Returns the persistent current context value.

contextValue

@Nullable
public static <T> T contextValue(BotBus $this,
                                           @NotNull
                                           ParameterKey key)

Returns the persistent current context value.

changeContextValue

public static void changeContextValue(BotBus $this,
                                      @NotNull
                                      java.lang.String name,
                                      @Nullable
                                      java.lang.Object value)

Updates persistent context value. Do not store Collection or Map in the context, only plain objects or typed arrays.

changeContextValue

public static void changeContextValue(BotBus $this,
                                      @NotNull
                                      ParameterKey key,
                                      @Nullable
                                      java.lang.Object value)

Updates persistent context value.

getBusContextValue

@Nullable
public static <T> T getBusContextValue(BotBus $this,
                                                 @NotNull
                                                 ParameterKey key)

Returns the non persistent current context value. Bus context values are useful to store a temporary (ie request scoped) state.

setBusContextValue

public static void setBusContextValue(BotBus $this,
                                      @NotNull
                                      ParameterKey key,
                                      @Nullable
                                      java.lang.Object value)

Updates the non persistent current context value. Bus context values are useful to store a temporary (ie request scoped) state.

endRawText

@NotNull
public static BotBus endRawText(BotBus $this,
                                         @Nullable
                                         java.lang.CharSequence plainText,
                                         long delay)

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

end

@NotNull
public static BotBus end(BotBus $this,
                                  @NotNull
                                  Message message,
                                  long delay)

Sends interface Message as last bot answer.

See Also:

interface Message

end

@NotNull
public static BotBus end(BotBus $this,
                                  @NotNull
                                  MessagesList messages,
                                  long initialDelay)

Sends a class MessagesList and end the dialog.

See Also:

class MessagesList

send

@NotNull
public static BotBus send(BotBus $this,
                                   @NotNull
                                   Message message,
                                   long delay)

Sends a interface Message.

See Also:

interface Message

send

@NotNull
public static BotBus send(BotBus $this,
                                   @NotNull
                                   MessagesList messages,
                                   long initialDelay)

Sends a class MessagesList.

See Also:

class MessagesList

switchStory

public static void switchStory(BotBus $this,
                               @NotNull
                               StoryDefinition storyDefinition,
                               @NotNull
                               Intent starterIntent)

Switches the context to the specified story definition (start a new class Story).

See Also:

class Story

handleAndSwitchStory

public static void handleAndSwitchStory(BotBus $this,
                                        @NotNull
                                        StoryDefinition storyDefinition,
                                        @NotNull
                                        Intent starterIntent)

Handles the action and switches the context to the specified story definition.

skipAnswer

public static void skipAnswer(BotBus $this)

Does not send an answer. Synchronous interface Connectors (like Google Assistant or Alexa) usually do not support skipping answer.

See Also:

interface Connector

isFeatureEnabled

public static boolean isFeatureEnabled(BotBus $this,
                                       @NotNull
                                       FeatureType feature,
                                       boolean p)

Is the feature enabled?

Parameters:

$this - the feature to check

feature - the default value if the feature state is unknown

i18n

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

i18nKey

@NotNull
public static ai.tock.translator.I18nLabelValue i18nKey(BotBus $this,
                                                                 @NotNull
                                                                 java.lang.String key,
                                                                 @NotNull
                                                                 java.lang.CharSequence defaultLabel,
                                                                 @NotNull
                                                                 java.lang.Object... args)

Gets an i18n label with the specified key.

getContextId

@Nullable
public static java.lang.String getContextId(BotBus $this)

The current context identifier.

defaultDelay

public static long defaultDelay(BotBus $this,
                                int answerIndex)

Get the default delay between two answers.

getTest

public static boolean getTest(BotBus $this)

Is it a test mode ?

end

@NotNull
public static BotBus end(BotBus $this,
                                  long delay,
                                  @NotNull
                                  kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.BotBus,? 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

send

@NotNull
public static BotBus send(BotBus $this,
                                   long delay,
                                   @NotNull
                                   kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.BotBus,? 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

withMessage

@NotNull
public static BotBus withMessage(BotBus $this,
                                          @NotNull
                                          ConnectorMessage message)

Adds the specified interface ConnectorMessage to the bus context if the targetConnectorType is compatible.

See Also:

interface ConnectorMessage, targetConnectorType

send

@NotNull
public static BotBus send(BotBus $this,
                                   long delay)

Sends previously registered interface ConnectorMessage.

See Also:

interface ConnectorMessage

send

@NotNull
public static BotBus send(BotBus $this,
                                   @NotNull
                                   java.lang.CharSequence i18nText,
                                   long delay,
                                   @NotNull
                                   java.lang.Object... i18nArgs)

Sends i18nText.

send

@NotNull
public static BotBus send(BotBus $this,
                                   @NotNull
                                   java.lang.CharSequence i18nText,
                                   @NotNull
                                   java.lang.Object... i18nArgs)

Sends i18nText.

end

@NotNull
public static BotBus end(BotBus $this,
                                  @NotNull
                                  java.lang.CharSequence i18nText,
                                  long delay,
                                  @NotNull
                                  java.lang.Object... i18nArgs)

Sends i18nText as last bot answer.

end

@NotNull
public static BotBus end(BotBus $this,
                                  @NotNull
                                  java.lang.CharSequence i18nText,
                                  @NotNull
                                  java.lang.Object... i18nArgs)

Sends i18nText as last bot answer.

end

@NotNull
public static BotBus end(BotBus $this,
                                  long delay)

Send previously registered interface ConnectorMessage as last bot answer.

See Also:

interface ConnectorMessage

i18n

@NotNull
public static ai.tock.translator.I18nLabelValue i18n(BotBus $this,
                                                              @NotNull
                                                              java.lang.CharSequence defaultLabel,
                                                              @NotNull
                                                              java.lang.Object... args)

translate

@NotNull
public static ai.tock.translator.TranslatedSequence translate(BotBus $this,
                                                                       @Nullable
                                                                       java.lang.CharSequence text,
                                                                       @NotNull
                                                                       java.lang.Object... args)

Translates and format if needed the text with the optionals args.

translate

@NotNull
public static ai.tock.translator.TranslatedSequence translate(BotBus $this,
                                                                       @Nullable
                                                                       ai.tock.translator.I18nLabelValue key)

Translates the specified key.

translateAndReturnBlankAsNull

@Nullable
public static ai.tock.translator.TranslatedSequence translateAndReturnBlankAsNull(BotBus $this,
                                                                                            @Nullable
                                                                                            java.lang.CharSequence s)

Translates the specified text and return null if the answer is blank.