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
                    
```

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`	`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`

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)`

Method Summary

Modifier and Type	Method	Description
`Unit`	`handle()`	Handles the current request.
`Long`	`defaultDelay(Integer answerIndex)`
`ClientBus`	`endRawText(CharSequence plainText, Long delay)`
`ClientBus`	`sendRawText(CharSequence plainText, Long delay)`
`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)`
`String`	`getApplicationId()`
`PlayerId`	`getUserId()`
`PlayerId`	`getBotId()`
`IntentAware`	`getIntent()`
`Boolean`	`getTest()`
`Locale`	`getUserLocale()`
`UserInterfaceType`	`getUserInterfaceType()`
`ConnectorType`	`getTargetConnectorType()`
`String`	`getContextId()`
`Integer`	`getCurrentAnswerIndex()`
`List<Entity>`	`getEntities()`	The entity list.
`UserMessage`	`getMessage()`	The user message.
`ClientStoryDefinition`	`getStory()`	The current story.
`ClientStep`	`getStep()`	The current step.
`String`	`getStepName()`
`ClientBotDefinition`	`getBotDefinition()`	The bot definition.
`final String`	`getRequestId()`
`final UserRequest`	`getRequest()`
`final Function1<BotResponse, Unit>`	`getSendAnswer()`
`Unit`	`setStory(ClientStoryDefinition story)`	The current story.
`Unit`	`setStep(ClientStep step)`	The current step.

Methods inherited from class ai.tock.bot.api.client.TockClientBus
end, entity, entityText, entityValue, newAction, newAttachment, newCard, newCard, newCarousel, newCarousel, removeEntity, removeEntity, send, translate
Methods inherited from class ai.tock.bot.api.client.ClientBus
end, end, end, end, send, send, send, send, withMessage
Methods inherited from class ai.tock.bot.engine.I18nTranslator
i18n
Methods inherited from class ai.tock.bot.engine.Bus
translate, translate, translateAndReturnBlankAsNull
Methods inherited from class ai.tock.translator.I18nKeyProvider
equals, hashCode, toString
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

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)

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)

getApplicationId
```
 String getApplicationId()
```

getUserId
```
 PlayerId getUserId()
```

getBotId
```
 PlayerId getBotId()
```

getIntent
```
 IntentAware getIntent()
```

getTest
```
 Boolean getTest()
```

getUserLocale
```
 Locale getUserLocale()
```

getUserInterfaceType

 UserInterfaceType getUserInterfaceType()

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.

getStep
```
 ClientStep getStep()
```
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()

setStory

 Unit setStory(ClientStoryDefinition story)

The current story.

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

Class TockClientBus

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class java.lang.Object

Constructor Detail

TockClientBus

TockClientBus

Method Detail

handle

defaultDelay

endRawText

sendRawText

send

send

send

end

end

end

withMessage

withMessage

i18n

getApplicationId

getUserId

getBotId

getIntent

getTest

getUserLocale

getUserInterfaceType

getTargetConnectorType

getContextId

getCurrentAnswerIndex

getEntities

getMessage

getStory

getStep

getStepName

getBotDefinition

getRequestId

getRequest

getSendAnswer

setStory

setStep