ai.tock.bot.engine

Class BotRepository

ai.tock.bot.engine.BotRepository

public class BotRepository

Advanced bot configuration.

ai.tock.bot.registerAndInstallBot method is the preferred way to start a bot in most use cases.

See Also:

ai.tock.bot.registerAndInstallBot

Field Detail

INSTANCE

public static BotRepository INSTANCE

Advanced bot configuration.

ai.tock.bot.registerAndInstallBot method is the preferred way to start a bot in most use cases.

See Also:

ai.tock.bot.registerAndInstallBot

Method Detail

getRequestTimer

@NotNull
public RequestTimer getRequestTimer()

Request timer for connectors.

setRequestTimer

public void setRequestTimer(@NotNull
                            RequestTimer p)

Request timer for connectors.

getHealthcheckHandler

@NotNull
public kotlin.jvm.functions.Function1<io.vertx.ext.web.RoutingContext,kotlin.Unit> getHealthcheckHandler()

healthcheck handler to answer to GET /healthcheck.

setHealthcheckHandler

public void setHealthcheckHandler(@NotNull
                                  kotlin.jvm.functions.Function1<? super io.vertx.ext.web.RoutingContext,kotlin.Unit> h)

healthcheck handler to answer to GET /healthcheck.

forEachNlpListener

public void forEachNlpListener(@NotNull
                               kotlin.jvm.functions.Function1<? super ai.tock.bot.engine.nlp.NlpListener,kotlin.Unit> action)

Calls the specified action for each registered interface NlpListener.

See Also:

action, interface NlpListener

notify

public void notify(@NotNull
                   java.lang.String applicationId,
                   @NotNull
                   PlayerId recipientId,
                   @NotNull
                   IntentAware intent,
                   @Nullable
                   StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> step,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.String> parameters,
                   @NotNull
                   NotifyBotStateModifier stateModifier,
                   @Nullable
                   ActionNotificationType notificationType,
                   @NotNull
                   kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> errorListener)

Sends a notification to the connector. A interface Bus is created and the corresponding story is called.

Parameters:

applicationId - the configuration connector id

recipientId - the recipient identifier

intent - the notification intent

step - the optional step target

parameters - the optional parameters

stateModifier - allow the notification to bypass current user state

notificationType - the notification type if any

errorListener - called when a message has not been delivered

See Also:

interface Bus

registerBotProvider

public void registerBotProvider(@NotNull
                                BotProvider bot)

Registers a new interface BotProvider.

See Also:

interface BotProvider

registerBuiltInStoryDefinitions

public void registerBuiltInStoryDefinitions(@NotNull
                                            BotProvider botProvider)

Register built-in story definitions.

registerStoryHandlerListener

public void registerStoryHandlerListener(@NotNull
                                         StoryHandlerListener listener)

Registers a new interface StoryHandlerListener.

See Also:

interface StoryHandlerListener

registerBotAnswerInterceptor

public void registerBotAnswerInterceptor(@NotNull
                                         BotAnswerInterceptor botAnswerInterceptor)

Registers a new interface BotAnswerInterceptor.

See Also:

interface BotAnswerInterceptor

registerNlpListener

public void registerNlpListener(@NotNull
                                NlpListener listener)

Registers an new interface NlpListener.

See Also:

interface NlpListener

getController

@Nullable
public ConnectorController getController(@NotNull
                                                   kotlin.jvm.functions.Function1<? super ai.tock.bot.admin.bot.BotApplicationConfiguration,java.lang.Boolean> predicate)

Returns the current interface ConnectorController for a given predicate.

See Also:

interface ConnectorController

installBots

public void installBots(@NotNull
                        java.util.List<? extends kotlin.jvm.functions.Function1<? super io.vertx.ext.web.Router,? extends java.lang.Object>> routerHandlers,
                        boolean createApplicationIfNotExists,
                        @Nullable
                        java.util.concurrent.locks.Lock startupLock)

Installs the bot(s).

Parameters:

routerHandlers - the additional router handlers

createApplicationIfNotExists - create an nlp application if not exists

startupLock - if not null, wait do listen until the lock is released

findConnectorProvider

@Nullable
public ConnectorProvider findConnectorProvider(@NotNull
                                                         ConnectorType connectorType)

Returns the interface ConnectorProvider for the specified class ConnectorType.

See Also:

interface ConnectorProvider, class ConnectorType

checkBotConfigurations

@Synchronized
public void checkBotConfigurations(boolean startup)

Checks that configurations are synchronized with the database.