All Implemented Interfaces:

ai.tock.bot.engine.Bus , ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider
```
public interface ClientBus
 implements Bus<ClientBus>
                    
```
Bus implementation for Tock Bot API mode.

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 Unit`	`handle()`	Handles the current request.
`Boolean`	`isCompatibleWith(ConnectorType connectorType)`
`abstract ClientBus`	`send(Card card)`	Sends a Card.
`abstract ClientBus`	`send(Carousel carousel)`	Sends a Carousel.
`abstract ClientBus`	`send(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)`	Sends a text with suggestions.
`ClientBus`	`send(CharSequence i18nText, List<CharSequence> suggestions)`	Sends a text with suggestions.
`abstract ClientBus`	`end(Card card)`	Sends a Card as last bot answer.
`abstract ClientBus`	`end(Carousel carousel)`	Sends a [Carousel as last bot answer.
`abstract ClientBus`	`end(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)`	Sends a text with suggestions as last bot answer.
`ClientBus`	`end(CharSequence i18nText, List<CharSequence> suggestions)`	Sends a text with suggestions as last bot answer.
`Entity`	`entity(String role)`	Finds the Entity from the specified entity role.
`String`	`entityText(String role)`	Returns the Entity text content from the specified entity role.
`<T extends Value> T`	`entityValue(String role)`	Returns the corresponding Entity from the specified entity role.
`Boolean`	`removeEntity(String role)`	Removes the entity of the specified role.
`Boolean`	`removeEntity(Entity entity)`	Remove the specified entity.
`I18nText`	`translate(CharSequence text, Object args)`
`Card`	`newCard(CharSequence title, CharSequence subTitle, Attachment attachment, List<Action> actions, Long delay)`	Creates a new Card.
`Card`	`newCard(CharSequence title, CharSequence subTitle, Attachment attachment, Action actions, Long delay)`	Creates a new Card.
`Carousel`	`newCarousel(List<Card> cards, Long delay)`	Creates a new Carousel.
`Carousel`	`newCarousel(Card cards, Long delay)`	Creates a new Carousel.
`Action`	`newAction(CharSequence title, String url)`	Creates a new Action.
`Attachment`	`newAttachment(String url, AttachmentType type)`	Creates a new Attachment.
`abstract ClientBotDefinition`	`getBotDefinition()`	The bot definition.
`abstract List<Entity>`	`getEntities()`	The entity list.
`abstract UserMessage`	`getMessage()`	The user message.
`abstract ClientStoryDefinition`	`getStory()`	The current story.
`abstract Unit`	`setStory(ClientStoryDefinition story)`	The current story.
`abstract ClientStep`	`getStep()`	The current step.
`abstract Unit`	`setStep(ClientStep step)`	The current step.

Methods inherited from class ai.tock.bot.engine.Bus
defaultDelay, end, end, end, end, endRawText, getApplicationId, getBotId, getCurrentAnswerIndex, getCurrentIntent, getIntent, getStepName, getTest, getUserId, send, send, send, send, sendDebug, sendDebugData, sendRawText, withMessage, withMessage, withMessage
Methods inherited from class ai.tock.bot.engine.I18nTranslator
getContextId, getSourceConnectorType, getTargetConnectorType, getUserInterfaceType, getUserLocale, 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

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

isCompatibleWith

 Boolean isCompatibleWith(ConnectorType connectorType)

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

send

 abstract ClientBus send(Carousel carousel)

Sends a Carousel.

send

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

Sends a text with suggestions.

send

 ClientBus send(CharSequence i18nText, List<CharSequence> suggestions)

Sends a text with suggestions.

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

end

 abstract ClientBus end(Carousel carousel)

Sends a [Carousel as last bot answer.

end

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

Sends a text with suggestions as last bot answer.

end

 ClientBus end(CharSequence i18nText, List<CharSequence> suggestions)

Sends a text with suggestions as last bot answer.

entity
```
 Entity entity(String role)
```
Finds the Entity from the specified entity role.

entityText
```
 String entityText(String role)
```
Returns the Entity text content from the specified entity role.

entityValue
```
 <T extends Value> T entityValue(String role)
```
Returns the corresponding Entity from the specified entity role.

removeEntity
```
 Boolean removeEntity(String role)
```
Removes the entity of the specified role.

removeEntity
```
 Boolean removeEntity(Entity entity)
```
Remove the specified entity.

translate

 I18nText translate(CharSequence text, Object args)

newCard

 Card newCard(CharSequence title, CharSequence subTitle, Attachment attachment, List<Action> actions, Long delay)

Creates a new Card.

newCard

 Card newCard(CharSequence title, CharSequence subTitle, Attachment attachment, Action actions, Long delay)

Creates a new Card.

newCarousel

 Carousel newCarousel(List<Card> cards, Long delay)

Creates a new Carousel.

newCarousel

 Carousel newCarousel(Card cards, Long delay)

Creates a new Carousel.

newAction

 Action newAction(CharSequence title, String url)

Creates a new Action.

newAttachment

 Attachment newAttachment(String url, AttachmentType type)

Creates a new Attachment.

getBotDefinition

 abstract ClientBotDefinition getBotDefinition()

The bot definition.

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

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

getStory

 abstract ClientStoryDefinition getStory()

The current story.

setStory

 abstract Unit setStory(ClientStoryDefinition story)

The current story.

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

setStep

 abstract Unit setStep(ClientStep step)

The current step.

Interface ClientBus

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.engine.I18nTranslator

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

handle

isCompatibleWith

send

send

send

send

end

end

end

end

entity

entityText

entityValue

removeEntity

removeEntity

translate

newCard

newCard

newCarousel

newCarousel

newAction

newAttachment

getBotDefinition

getEntities

getMessage

getStory

setStory

getStep

setStep