Constructor Detail

Method Detail

• hasFeature

   Boolean hasFeature(ConnectorFeature feature, ConnectorType targetConnectorType)

  Is this feature supported ?

• register

   abstract Unit register(ConnectorController controller)

  Registers the connector for the specified controller.

• unregister

   Unit unregister(ConnectorController controller)

  Unregisters the connector.

• send

   abstract Unit send(Event event, ConnectorCallback callback, Long delayInMs)

  Send an event with this connector for the specified delay. End the conversation when event.metadata.lastAnswer is activated If the connector implements the proactive conversation functions, the end must take account the start of the proactive conversation

  Parameters:

  event - the event to send

  callback - the initial connector callback

  delayInMs - the optional delay

• startProactiveConversation

   Boolean startProactiveConversation(ConnectorCallback callback, BotBus botBus)

  Start a proactive conversation

  Parameters:

  callback - the initial connector callback

  botBus - the bot bus

• flushProactiveConversation

   Unit flushProactiveConversation(ConnectorCallback callback, Map<String, String> parameters)

  Proactively send messages to connector

  Parameters:

  callback - the initial connector callback

  parameters - the parameters to be used for a proactive response

• endProactiveConversation

   Unit endProactiveConversation(ConnectorCallback callback, Map<String, String> parameters)

  End the proactive conversation

  Parameters:

  callback - the initial connector callback

  parameters - the parameters to be used for a proactive response

• notify

   Unit notify(ConnectorController controller, PlayerId recipientId, IntentAware intent, StoryStep<out StoryHandlerDefinition> step, Map<String, String> parameters, ActionNotificationType notificationType, Function1<Throwable, Unit> errorListener)

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

  Parameters:

  controller - the connector controller

  recipientId - the recipient identifier

  intent - the notification intent

  step - the optional step target

  parameters - the optional parameters

  notificationType - notification type if any

  errorListener - called when a message has not been delivered

• loadProfile

   UserPreferences loadProfile(ConnectorCallback callback, PlayerId userId)

  Load user preferences - default implementation returns null.

• refreshProfile

   UserPreferences refreshProfile(ConnectorCallback callback, PlayerId userId)

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

• addSuggestions

   Function1<BotBus, ConnectorMessage> addSuggestions(CharSequence text, List<CharSequence> suggestions)

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

• addSuggestions

   Function1<BotBus, ConnectorMessage> addSuggestions(ConnectorMessage message, List<CharSequence> suggestions)

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

• toConnectorMessage

   Function1<BotBus, List<ConnectorMessage>> toConnectorMessage(MediaMessage message)

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

• canHandleMessageFor

   Boolean canHandleMessageFor(ConnectorType otherConnectorType)

  Determines if this connector can handle other connector messages.

• getConnectorType

   abstract ConnectorType getConnectorType()

  The type of the connector.

• getSupportedFeatures

   Set<ConnectorFeature> getSupportedFeatures()

• getPersistProfileLoaded

   Boolean getPersistProfileLoaded()