All Implemented Interfaces:

ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider
```
public interface Bus<T extends Bus<T>>
 implements I18nTranslator
                    
```
A new bus instance is created for each user request.
The bus is used by bot implementations to reply to the user request.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Long`	`defaultDelay(Integer answerIndex)`	Get the default delay between two answers.
`abstract Boolean`	`isCompatibleWith(ConnectorType connectorType)`	Is the targetConnectorType compatible with connectorType
`T`	`withMessage(ConnectorMessage message)`	Adds the specified ConnectorMessage to the bus context if the targetConnectorType is compatible.
`abstract T`	`withMessage(ConnectorType connectorType, Function0<ConnectorMessage> messageProvider)`	Adds the specified ConnectorMessage to the bus context if the targetConnectorType is compatible.
`abstract T`	`withMessage(ConnectorType connectorType, String connectorId, Function0<ConnectorMessage> messageProvider)`	Adds the specified ConnectorMessage to the bus context if the targetConnectorType and connectorId is compatible.
`T`	`send(Long delay)`	Sends previously registered ConnectorMessage.
`T`	`send(CharSequence i18nText, Long delay, Object i18nArgs)`	Sends i18nText.
`T`	`send(CharSequence i18nText, Object i18nArgs)`	Sends i18nText.
`T`	`send(Long delay, Function1<T, Object> messageProvider)`	Sends messages provided by messageProvider.
`abstract T`	`sendRawText(CharSequence plainText, Long delay)`	Send text that should not be translated.
`abstract T`	`sendDebugData(String title, Object data)`	Send debug data.
`T`	`end(CharSequence i18nText, Long delay, Object i18nArgs)`	Sends i18nText as last bot answer.
`T`	`end(CharSequence i18nText, Object i18nArgs)`	Sends i18nText as last bot answer.
`T`	`end(Long delay)`	Send previously registered ConnectorMessage as last bot answer.
`T`	`end(Long delay, Function1<T, Object> messageProvider)`	Sends messages provided by messageProvider as last bot answer.
`abstract T`	`endRawText(CharSequence plainText, Long delay)`	Sends text that should not be translated as last bot answer.
`abstract String`	`getApplicationId()`	The current application id.
`abstract PlayerId`	`getBotId()`	The current bot id.
`abstract PlayerId`	`getUserId()`	The current user id.
`abstract IntentAware`	`getIntent()`	The current intent of the dialog at Bus (ie request) initialization.
`IntentAware`	`getCurrentIntent()`
`abstract String`	`getStepName()`	The name of the step if any.
`abstract Integer`	`getCurrentAnswerIndex()`	The current answer index of the bot for this action.
`abstract Boolean`	`getTest()`	Is it a test mode ?

Methods inherited from class ai.tock.bot.engine.I18nTranslator
getContextId, getSourceConnectorType, getTargetConnectorType, getUserInterfaceType, getUserLocale, translate, translate, translate, translateAndReturnBlankAsNull
Methods inherited from class ai.tock.translator.I18nKeyProvider
i18n, i18n
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - defaultDelay
```
 abstract Long defaultDelay(Integer answerIndex)
```
    Get the default delay between two answers.
  - isCompatibleWith
```
 abstract Boolean isCompatibleWith(ConnectorType connectorType)
```
    Is the targetConnectorType compatible with connectorType
  - withMessage
```
 T withMessage(ConnectorMessage message)
```
    Adds the specified ConnectorMessage to the bus context if the targetConnectorType is compatible.
  - withMessage
```
 abstract T withMessage(ConnectorType connectorType, Function0<ConnectorMessage> messageProvider)
```
    Adds the specified ConnectorMessage to the bus context if the targetConnectorType is compatible.
  - withMessage
```
 abstract T withMessage(ConnectorType connectorType, String connectorId, Function0<ConnectorMessage> messageProvider)
```
    Adds the specified ConnectorMessage to the bus context if the targetConnectorType and connectorId is compatible.
  - send
```
 T send(Long delay)
```
    Sends previously registered ConnectorMessage.
  - send
```
 T send(CharSequence i18nText, Long delay, Object i18nArgs)
```
    Sends i18nText.
  - send
```
 T send(CharSequence i18nText, Object i18nArgs)
```
    Sends i18nText.
  - send
```
 T send(Long delay, Function1<T, Object> messageProvider)
```
    Sends messages provided by messageProvider. if messageProvider returns a CharSequence send it as text. Else call simply send().
  - sendRawText
```
 abstract T sendRawText(CharSequence plainText, Long delay)
```
    Send text that should not be translated.
  - sendDebugData
```
 abstract T sendDebugData(String title, Object data)
```
    Send debug data.
  - end
```
 T end(CharSequence i18nText, Long delay, Object i18nArgs)
```
    Sends i18nText as last bot answer.
  - end
```
 T end(CharSequence i18nText, Object i18nArgs)
```
    Sends i18nText as last bot answer.
  - end
```
 T end(Long delay)
```
    Send previously registered ConnectorMessage as last bot answer.
  - end
```
 T end(Long delay, Function1<T, Object> messageProvider)
```
    Sends messages provided by messageProvider as last bot answer. if messageProvider returns a CharSequence send it as text. Else call simply end().
  - endRawText
```
 abstract T endRawText(CharSequence plainText, Long delay)
```
    Sends text that should not be translated as last bot answer.
  - getApplicationId
```
 abstract String getApplicationId()
```
    The current application id.
  - getBotId
```
 abstract PlayerId getBotId()
```
    The current bot id.
  - getUserId
```
 abstract PlayerId getUserId()
```
    The current user id.
  - getIntent
```
 abstract IntentAware getIntent()
```
    The current intent of the dialog at Bus (ie request) initialization.
  - getCurrentIntent
```
 IntentAware getCurrentIntent()
```
  - getStepName
```
 abstract String getStepName()
```
    The name of the step if any.
  - getCurrentAnswerIndex
```
 abstract Integer getCurrentAnswerIndex()
```
    The current answer index of the bot for this action.
  - getTest
```
 abstract Boolean getTest()
```
    Is it a test mode ?

Interface Bus

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.tock.bot.engine.I18nTranslator

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

defaultDelay

isCompatibleWith

withMessage

withMessage

withMessage

send

send

send

send

sendRawText

sendDebugData

end

end

end

end

endRawText

getApplicationId

getBotId

getUserId

getIntent

getCurrentIntent

getStepName

getCurrentAnswerIndex

getTest