All Implemented Interfaces:

ai.tock.bot.api.client.ClientBus , ai.tock.bot.engine.Bus , ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider
```
public final class TockClientBus
 implements ClientBus
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`applicationId`
`private final PlayerId`	`userId`
`private final PlayerId`	`botId`
`private final IntentAware`	`intent`
`private final Boolean`	`test`
`private final Locale`	`userLocale`
`private final UserInterfaceType`	`userInterfaceType`
`private final ConnectorType`	`sourceConnectorType`
`private final ConnectorType`	`targetConnectorType`
`private final String`	`contextId`
`private final Integer`	`currentAnswerIndex`
`private final List<Entity>`	`entities`
`private final UserMessage`	`message`
`private ClientStoryDefinition`	`story`
`private ClientStep`	`step`
`private final String`	`stepName`
`private final ClientBotDefinition`	`botDefinition`
`private final String`	`requestId`
`private final UserRequest`	`request`
`private final Function1<BotResponse, Unit>`	`sendAnswer`
`private final IntentAware`	`currentIntent`

Constructor Summary

Constructors
Constructor	Description
`TockClientBus(ClientBotDefinition botDefinition, RequestData data, Function1<BotResponse, Unit> sendAnswer)`
`TockClientBus(ClientBotDefinition botDefinition, String requestId, UserRequest request, Function1<BotResponse, Unit> sendAnswer)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getApplicationId()`
`PlayerId`	`getUserId()`
`PlayerId`	`getBotId()`
`IntentAware`	`getIntent()`
`Boolean`	`getTest()`
`Locale`	`getUserLocale()`
`UserInterfaceType`	`getUserInterfaceType()`
`ConnectorType`	`getSourceConnectorType()`
`ConnectorType`	`getTargetConnectorType()`
`String`	`getContextId()`
`Integer`	`getCurrentAnswerIndex()`
`List<Entity>`	`getEntities()`	The entity list.
`UserMessage`	`getMessage()`	The user message.
`ClientStoryDefinition`	`getStory()`	The current story.
`Unit`	`setStory(ClientStoryDefinition story)`	The current story.
`ClientStep`	`getStep()`	The current step.
`Unit`	`setStep(ClientStep step)`	The current step.
`String`	`getStepName()`
`ClientBotDefinition`	`getBotDefinition()`	The bot definition.
`final String`	`getRequestId()`
`final UserRequest`	`getRequest()`
`final Function1<BotResponse, Unit>`	`getSendAnswer()`
`Unit`	`handle()`	Handles the current request.
`Long`	`defaultDelay(Integer answerIndex)`
`ClientBus`	`endRawText(CharSequence plainText, Long delay)`
`ClientBus`	`sendRawText(CharSequence plainText, Long delay)`
`ClientBus`	`sendDebugData(String title, Object data)`	Add a debug data message for the test connector only
`ClientBus`	`send(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)`	Sends a text with suggestions.
`ClientBus`	`send(Carousel carousel)`	Sends a Carousel.
`ClientBus`	`send(Card card)`	Sends a Card.
`ClientBus`	`end(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)`	Sends a text with suggestions as last bot answer.
`ClientBus`	`end(Card card)`	Sends a Card as last bot answer.
`ClientBus`	`end(Carousel carousel)`	Sends a [Carousel as last bot answer.
`ClientBus`	`withMessage(ConnectorType connectorType, Function0<ConnectorMessage> messageProvider)`
`ClientBus`	`withMessage(ConnectorType connectorType, String connectorId, Function0<ConnectorMessage> messageProvider)`
`I18nLabelValue`	`i18n(CharSequence defaultLabel, List<Object> args)`

Methods inherited from class ai.tock.bot.engine.Bus
end, end, end, end, getCurrentIntent, send, send, send, send, sendDebug, withMessage
Methods inherited from class ai.tock.bot.api.client.ClientBus
end, entity, entityText, entityValue, isCompatibleWith, newAction, newAttachment, newCard, newCard, newCarousel, newCarousel, removeEntity, removeEntity, send, translate
Methods inherited from class ai.tock.translator.I18nKeyProvider
i18n
Methods inherited from class ai.tock.bot.engine.I18nTranslator
translate, translate, translateAndReturnBlankAsNull
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TockClientBus

TockClientBus(ClientBotDefinition botDefinition, RequestData data, Function1<BotResponse, Unit> sendAnswer)

TockClientBus

TockClientBus(ClientBotDefinition botDefinition, String requestId, UserRequest request, Function1<BotResponse, Unit> sendAnswer)

Method Detail

getApplicationId
```
 String getApplicationId()
```

getUserId
```
 PlayerId getUserId()
```

getBotId
```
 PlayerId getBotId()
```

getIntent
```
 IntentAware getIntent()
```

getTest
```
 Boolean getTest()
```

getUserLocale
```
 Locale getUserLocale()
```

getUserInterfaceType

 UserInterfaceType getUserInterfaceType()

getSourceConnectorType
```
 ConnectorType getSourceConnectorType()
```

getTargetConnectorType
```
 ConnectorType getTargetConnectorType()
```

getContextId
```
 String getContextId()
```

getCurrentAnswerIndex
```
 Integer getCurrentAnswerIndex()
```

getEntities
```
 List<Entity> getEntities()
```
The entity list.

getMessage
```
 UserMessage getMessage()
```
The user message.

getStory
```
 ClientStoryDefinition getStory()
```
The current story.

setStory

 Unit setStory(ClientStoryDefinition story)

The current story.

getStep
```
 ClientStep getStep()
```
The current step.

setStep
```
 Unit setStep(ClientStep step)
```
The current step.

getStepName
```
 String getStepName()
```

getBotDefinition
```
 ClientBotDefinition getBotDefinition()
```
The bot definition.

getRequestId
```
 final String getRequestId()
```

getRequest
```
 final UserRequest getRequest()
```

getSendAnswer

 final Function1<BotResponse, Unit> getSendAnswer()

handle
```
 Unit handle()
```
Handles the current request.

defaultDelay

 Long defaultDelay(Integer answerIndex)

endRawText

 ClientBus endRawText(CharSequence plainText, Long delay)

sendRawText

 ClientBus sendRawText(CharSequence plainText, Long delay)

sendDebugData
```
 ClientBus sendDebugData(String title, Object data)
```
Add a debug data message for the test connector only

Parameters:

title - title of debug message

data - object corresponding to the debugging data

send

 ClientBus send(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)

Sends a text with suggestions.

send
```
 ClientBus send(Carousel carousel)
```
Sends a Carousel.

send
```
 ClientBus send(Card card)
```
Sends a Card.

end

 ClientBus end(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)

Sends a text with suggestions as last bot answer.

end
```
 ClientBus end(Card card)
```
Sends a Card as last bot answer.

end
```
 ClientBus end(Carousel carousel)
```
Sends a [Carousel as last bot answer.

withMessage

 ClientBus withMessage(ConnectorType connectorType, Function0<ConnectorMessage> messageProvider)

withMessage

 ClientBus withMessage(ConnectorType connectorType, String connectorId, Function0<ConnectorMessage> messageProvider)

i18n

 I18nLabelValue i18n(CharSequence defaultLabel, List<Object> args)

Class TockClientBus

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

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

Methods inherited from class ai.tock.bot.api.client.ClientBus

Methods inherited from class ai.tock.translator.I18nKeyProvider

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

Methods inherited from class java.lang.Object

Constructor Detail

TockClientBus

TockClientBus

Method Detail

getApplicationId

getUserId

getBotId

getIntent

getTest

getUserLocale

getUserInterfaceType

getSourceConnectorType

getTargetConnectorType

getContextId

getCurrentAnswerIndex

getEntities

getMessage

getStory

setStory

getStep

setStep

getStepName

getBotDefinition

getRequestId

getRequest

getSendAnswer

handle

defaultDelay

endRawText

sendRawText

sendDebugData

send

send

send

end

end

end

withMessage

withMessage

i18n