ai.tock.bot.definition

Class BotDefinition.DefaultImpls

ai.tock.bot.definition.BotDefinition.DefaultImpls

Enclosing interface:

BotDefinition

public static class BotDefinition.DefaultImpls

The main interface used to define the behaviour of the bot.

New bots should usually not directly extend this class, but instead extend class BotDefinitionBase.

See Also:

class BotDefinitionBase

Constructor Detail

DefaultImpls

public DefaultImpls()

Method Detail

findIntent

@NotNull
public static Intent findIntent(BotDefinition $this,
                                         @NotNull
                                         java.lang.String intent)

Finds an class Intent from an intent name.

See Also:

class Intent

findStoryDefinition

@NotNull
public static StoryDefinition findStoryDefinition(BotDefinition $this,
                                                           @Nullable
                                                           IntentAware intent)

Finds a interface StoryDefinition from an class Intent.

See Also:

interface StoryDefinition, class Intent

findStoryDefinition

@NotNull
public static StoryDefinition findStoryDefinition(BotDefinition $this,
                                                           @Nullable
                                                           java.lang.String intent,
                                                           @Nullable
                                                           java.lang.String applicationId)

Finds a interface StoryDefinition from an intent name.

Parameters:

$this - the intent name

intent - the optional applicationId

applicationId - the optional applicationId

See Also:

interface StoryDefinition

errorAction

@NotNull
public static Action errorAction(BotDefinition $this,
                                          @NotNull
                                          PlayerId playerId,
                                          @NotNull
                                          java.lang.String applicationId,
                                          @NotNull
                                          PlayerId recipientId)

Called when error occurs. By default send "technical error".

disableBot

public static boolean disableBot(BotDefinition $this,
                                 @NotNull
                                 UserTimeline timeline,
                                 @NotNull
                                 Dialog dialog,
                                 @NotNull
                                 Action action)

Does this action trigger bot deactivation ?

enableBot

public static boolean enableBot(BotDefinition $this,
                                @NotNull
                                UserTimeline timeline,
                                @NotNull
                                Dialog dialog,
                                @NotNull
                                Action action)

Does this action trigger bot activation ?

getBotEnabledListener

@NotNull
public static kotlin.jvm.functions.Function1<ai.tock.bot.engine.action.Action,kotlin.Unit> getBotEnabledListener(BotDefinition $this)

Listener invoked when bot is enabled.

hasToPersistAction

public static boolean hasToPersistAction(BotDefinition $this,
                                         @NotNull
                                         UserTimeline timeline,
                                         @NotNull
                                         Action action)

If this method returns true, the action will be added in the stored history.

By default, actions where the bot is not only ai.tock.bot.engine.dialog.EventState.notification are added in the bot history.

getTestBehaviour

@NotNull
public static TestBehaviour getTestBehaviour(BotDefinition $this)

Returns a interface TestBehaviour. Used in Integration Tests.

See Also:

interface TestBehaviour

i18n

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

entity

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

Returns the entity with the specified name and optional role.

i18nTranslator

@NotNull
public static I18nTranslator i18nTranslator(BotDefinition $this,
                                                     @NotNull
                                                     java.util.Locale userLocale,
                                                     @NotNull
                                                     ConnectorType connectorType,
                                                     @NotNull
                                                     ai.tock.translator.UserInterfaceType userInterfaceType,
                                                     @Nullable
                                                     java.lang.String contextId)

Returns an interface I18nTranslator for the specified userLocale and connectorType.

See Also:

interface I18nTranslator, userLocale, connectorType

defaultDelay

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

Get the default delay between two answers.

getFlowDefinition

@Nullable
public static DialogFlowDefinition getFlowDefinition(BotDefinition $this)

i18n

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