tock / ai.tock.bot.connector

Package ai.tock.bot.connector

Contains classes used to define a new Connector

Types

Connector

A connector connects bots to users via a dedicated interface (like Messenger, Google Assistant, Slack... ).

interface Connector

ConnectorBase

Base implementation of Connector. Connector implementations should usually extend this class.

abstract class ConnectorBase : Connector

ConnectorCallback

Used by connector implementations to check lifecycle of an user event.

interface ConnectorCallback

ConnectorCallbackBase

Base implementation of ConnectorCallback - add logging and RequestTimer monitoring.

open class ConnectorCallbackBase : ConnectorCallback

ConnectorConfiguration

Configuration parameters used by a ConnectorProvider to create a new Connector instance.

data class ConnectorConfiguration

ConnectorData

The connector data that connector sends to the ConnectorController

open class ConnectorData

ConnectorFeature

Dedicated features supported by Connector.

enum class ConnectorFeature

ConnectorMessage

Connector specific message format.

interface ConnectorMessage : ConnectorMessageProvider

ConnectorMessageProvider

Provides a ConnectorMessage. Used mainly to allow nice expressions with Bus.end{} and Bus.send{}.

interface ConnectorMessageProvider

ConnectorProvider

To provide a new Connector from a ConnectorConfiguration. The implementation is loaded at runtime to list all available connectors, using the java java.util.ServiceLoader

interface ConnectorProvider

ConnectorQueue

A Queue to ensure the calls from the same user id are sent sequentially.

class ConnectorQueue

ConnectorService

Ability from any module to add a service to a ConnectorController Need to be registered using ai.tock.bot.engine.BotRepository.registerConnectorService.

interface ConnectorService

ConnectorType

A connector identifier.

data class ConnectorType

ConnectorTypeConfiguration

A connector type configuration definition.

data class ConnectorTypeConfiguration

ConnectorTypeConfigurationField

Custom parameter for a ConnectorTypeConfiguration.

data class ConnectorTypeConfigurationField

NotifyBotStateModifier

Manage bot state and notifications.

enum class NotifyBotStateModifier

SerializableConnectorMessage

A json serializable ConnectorMessage. For a Connector implementation, implementing this interface for all of its ConnectorMessage types is prerequisite in order to support bot orchestration.

interface SerializableConnectorMessage : ConnectorMessage

Annotations

ConnectorHandler

Annotation used to annotate StoryHandlerDefinitionBase implementation, in order to provide ConnectorStoryHandler for each connector. Used only by connector implementation.

annotation class ConnectorHandler

ConnectorIdHandler

Annotation used to configure ConnectorIdHandlers, in order to provide ConnectorStoryHandler for each connector id.

annotation class ConnectorIdHandler

ConnectorIdHandlers

Annotation used to annotate StoryHandlerDefinitionBase implementation, in order to provide ConnectorStoryHandler for each connector id. Used only by connector implementation.

annotation class ConnectorIdHandlers

Exceptions

ConnectorException

Thrown when an occurs in a Connector.

class ConnectorException : Exception