ai.tock.bot.definition

Class StoryHandlerDefinition.DefaultImpls

ai.tock.bot.definition.StoryHandlerDefinition.DefaultImpls

Enclosing interface:

StoryHandlerDefinition

public static class StoryHandlerDefinition.DefaultImpls

Story handler definitions are used in interface StoryHandler to provide custom context and to manage specific connector behaviour.

Implementations should usually use class StoryHandlerDefinitionBase.

See Also:

interface StoryHandler, class StoryHandlerDefinitionBase

Constructor Detail

DefaultImpls

public DefaultImpls()

Method Detail

getConnector

@Nullable
public static ConnectorStoryHandler<?> getConnector(StoryHandlerDefinition $this)

The interface ConnectorStoryHandler provided for the current BotBus.targetConnectorType - null if it does not exist.

See Also:

interface ConnectorStoryHandler

answerWith

public static void answerWith(StoryHandlerDefinition $this,
                              @Nullable
                              java.lang.CharSequence p,
                              @NotNull
                              kotlin.jvm.functions.Function0<? extends java.lang.Object> messageProvider)

Answers with the specified parameters.

Parameters:

$this - used if messageProvider returns null

p - provides the answer - a message or a list of messages

messageProvider - provides the answer - a message or a list of messages

getStep

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

setStep

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

getStepName

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

The name of the step if any.

getUserText

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

The text sent by the user if any.

isIntent

public static boolean isIntent(StoryHandlerDefinition $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(StoryHandlerDefinition $this)

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

isChoiceAction

public static boolean isChoiceAction(StoryHandlerDefinition $this)

Is this current action is a class SendChoice?

See Also:

class SendChoice

choice

@Nullable
public static java.lang.String choice(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                    @NotNull
                                    ParameterKey key)

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

hasChoiceValue

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

Checks that the specified choice parameter has the specified value.

hasActionEntity

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

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

hasActionEntity

public static boolean hasActionEntity(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                                    @NotNull
                                                    java.lang.String role)

Returns the current text content for the specified entity.

entityValueDetails

@Nullable
public static EntityValue entityValueDetails(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                                       @NotNull
                                                       java.lang.String role)

Returns the current class EntityValue for the specified role.

See Also:

class EntityValue

changeEntityValue

public static void changeEntityValue(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                     @NotNull
                                     java.lang.String role)

Removes entity value for the specified role.

removeEntityValue

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

Removes entity value for the specified role.

removeAllEntityValues

public static void removeAllEntityValues(StoryHandlerDefinition $this)

Removes all current entity values.

resetDialogState

public static void resetDialogState(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                           @NotNull
                                           java.lang.String name)

Returns the persistent current context value.

contextValue

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

Returns the persistent current context value.

changeContextValue

public static void changeContextValue(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                      @NotNull
                                      ParameterKey key,
                                      @Nullable
                                      java.lang.Object value)

Updates persistent context value.

getBusContextValue

@Nullable
public static <T> T getBusContextValue(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                  @NotNull
                                  Message message,
                                  long delay)

Sends interface Message as last bot answer.

See Also:

interface Message

end

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

Sends a class MessagesList and end the dialog.

See Also:

class MessagesList

end

@NotNull
public static BotBus end(StoryHandlerDefinition $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

end

@NotNull
public static BotBus end(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                  @NotNull
                                  java.lang.CharSequence i18nText,
                                  @NotNull
                                  java.lang.Object... i18nArgs)

Sends i18nText as last bot answer.

end

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

Send previously registered interface ConnectorMessage as last bot answer.

See Also:

interface ConnectorMessage

send

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

Sends a interface Message.

See Also:

interface Message

send

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

Sends a class MessagesList.

See Also:

class MessagesList

send

@NotNull
public static BotBus send(StoryHandlerDefinition $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

send

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

Sends previously registered interface ConnectorMessage.

See Also:

interface ConnectorMessage

send

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

Sends i18nText.

send

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

Sends i18nText.

switchStory

public static void switchStory(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                        @NotNull
                                        StoryDefinition storyDefinition,
                                        @NotNull
                                        Intent starterIntent)

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

skipAnswer

public static void skipAnswer(StoryHandlerDefinition $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(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                                              @NotNull
                                                              java.lang.CharSequence defaultLabel,
                                                              @NotNull
                                                              java.util.List<? extends java.lang.Object> args)

i18n

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

i18nKey

@NotNull
public static ai.tock.translator.I18nLabelValue i18nKey(StoryHandlerDefinition $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(StoryHandlerDefinition $this)

The current context identifier.

defaultDelay

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

Get the default delay between two answers.

getTest

public static boolean getTest(StoryHandlerDefinition $this)

Is it a test mode ?

withMessage

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

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

See Also:

interface ConnectorMessage, targetConnectorType

translate

@NotNull
public static ai.tock.translator.TranslatedSequence translate(StoryHandlerDefinition $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(StoryHandlerDefinition $this,
                                                                       @Nullable
                                                                       ai.tock.translator.I18nLabelValue key)

Translates the specified key.

translateAndReturnBlankAsNull

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

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