ai.tock.bot.connector

Class Connector.DefaultImpls

ai.tock.bot.connector.Connector.DefaultImpls

Enclosing interface:

Connector

public static class Connector.DefaultImpls

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

There is one Connector for each user front-end application. See ai.tock.bot.connector.messenger.MessengerConnector or ai.tock.bot.connector.ga.GAConnector for examples of interface Connector implementations.

See Also:

ai.tock.bot.connector.messenger.MessengerConnector, ai.tock.bot.connector.ga.GAConnector, interface Connector

Constructor Detail

DefaultImpls

public DefaultImpls()

Method Detail

unregister

public static void unregister(Connector $this,
                              @NotNull
                              ConnectorController controller)

Unregisters the connector.

notify

public static void notify(Connector $this,
                          @NotNull
                          ConnectorController controller,
                          @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,
                          @Nullable
                          ActionNotificationType notificationType,
                          @NotNull
                          kotlin.jvm.functions.Function1<? super java.lang.Throwable,kotlin.Unit> errorListener)

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

Parameters:

$this - the connector controller

controller - the recipient identifier

recipientId - the notification intent

intent - the optional step target

step - the optional parameters

parameters - notification type if any

notificationType - called when a message has not been delivered

errorListener - called when a message has not been delivered

See Also:

interface BotBus

loadProfile

@Nullable
public static UserPreferences loadProfile(Connector $this,
                                                    @NotNull
                                                    ConnectorCallback callback,
                                                    @NotNull
                                                    PlayerId userId)

Load user preferences - default implementation returns null.

refreshProfile

@Nullable
public static UserPreferences refreshProfile(Connector $this,
                                                       @NotNull
                                                       ConnectorCallback callback,
                                                       @NotNull
                                                       PlayerId userId)

Refresh user preferences - default implementation returns null. Only not null values are taken into account.

addSuggestions

@NotNull
public static kotlin.jvm.functions.Function1<ai.tock.bot.engine.BotBus,ai.tock.bot.connector.ConnectorMessage> addSuggestions(Connector $this,
                                                                                                                                       @NotNull
                                                                                                                                       java.lang.CharSequence text,
                                                                                                                                       @NotNull
                                                                                                                                       java.util.List<? extends java.lang.CharSequence> suggestions)

Returns a interface ConnectorMessage with the specified list of suggestions. If the connector does not support suggestions, returns null.

See Also:

interface ConnectorMessage

addSuggestions

@NotNull
public static kotlin.jvm.functions.Function1<ai.tock.bot.engine.BotBus,ai.tock.bot.connector.ConnectorMessage> addSuggestions(Connector $this,
                                                                                                                                       @NotNull
                                                                                                                                       ConnectorMessage message,
                                                                                                                                       @NotNull
                                                                                                                                       java.util.List<? extends java.lang.CharSequence> suggestions)

Updates a interface ConnectorMessage with the specified list of suggestions. Default returns message unmodified.

See Also:

interface ConnectorMessage, message

toConnectorMessage

@NotNull
public static kotlin.jvm.functions.Function1<ai.tock.bot.engine.BotBus,java.util.List> toConnectorMessage(Connector $this,
                                                                                                                   @NotNull
                                                                                                                   MediaMessage message)

Maps a interface MediaMessage into a interface ConnectorMessage. If toConnectorMessage returns an empty list, the mapping is not supported for this connector. Default returns an empty list.

See Also:

interface MediaMessage, interface ConnectorMessage, toConnectorMessage