-
-
Method Summary
Modifier and Type Method Description abstract Unithandle()Handles the current request. abstract ClientBussend(Card card)Sends a Card. abstract ClientBussend(Carousel carousel)Sends a Carousel. abstract ClientBussend(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)Sends a text with suggestions. ClientBussend(CharSequence i18nText, List<CharSequence> suggestions)Sends a text with suggestions. abstract ClientBusend(Card card)Sends a Card as last bot answer. abstract ClientBusend(Carousel carousel)Sends a [Carousel as last bot answer. abstract ClientBusend(CharSequence i18nText, List<Suggestion> suggestions, Long delay, Object i18nArgs)Sends a text with suggestions as last bot answer. ClientBusend(CharSequence i18nText, List<CharSequence> suggestions)Sends a text with suggestions as last bot answer. Entityentity(String role)Finds the Entity from the specified entity role. StringentityText(String role)Returns the Entity text content from the specified entity role. <T extends Value> TentityValue(String role)Returns the corresponding Entity from the specified entity role. BooleanremoveEntity(String role)Removes the entity of the specified role. BooleanremoveEntity(Entity entity)Remove the specified entity. I18nTexttranslate(CharSequence text, Object args)CardnewCard(CharSequence title, CharSequence subTitle, Attachment attachment, List<Action> actions, Long delay)Creates a new Card. CardnewCard(CharSequence title, CharSequence subTitle, Attachment attachment, Action actions, Long delay)Creates a new Card. CarouselnewCarousel(List<Card> cards, Long delay)Creates a new Carousel. CarouselnewCarousel(Card cards, Long delay)Creates a new Carousel. ActionnewAction(CharSequence title, String url)Creates a new Action. AttachmentnewAttachment(String url, AttachmentType type)Creates a new Attachment. abstract ClientBotDefinitiongetBotDefinition()The bot definition. abstract List<Entity>getEntities()The entity list. abstract UserMessagegetMessage()The user message. abstract ClientStoryDefinitiongetStory()The current story. abstract ClientStepgetStep()The current step. abstract StringgetApplicationId()abstract PlayerIdgetBotId()abstract StringgetContextId()abstract IntegergetCurrentAnswerIndex()abstract IntentAwaregetIntent()abstract StringgetStepName()abstract ConnectorTypegetTargetConnectorType()abstract BooleangetTest()abstract PlayerIdgetUserId()abstract UserInterfaceTypegetUserInterfaceType()abstract LocalegetUserLocale()abstract UnitsetStory(ClientStoryDefinition story)The current story. abstract UnitsetStep(ClientStep step)The current step. -
Methods inherited from class ai.tock.bot.api.client.ClientBus
defaultDelay, end, end, end, end, endRawText, send, send, send, send, sendRawText, withMessage, withMessage, withMessage -
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 ai.tock.bot.engine.I18nTranslator
i18n, i18n -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
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(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.
-
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.
-
getStep
abstract ClientStep getStep()
The current step.
-
getApplicationId
abstract String getApplicationId()
-
getBotId
abstract PlayerId getBotId()
-
getContextId
abstract String getContextId()
-
getCurrentAnswerIndex
abstract Integer getCurrentAnswerIndex()
-
getIntent
abstract IntentAware getIntent()
-
getStepName
abstract String getStepName()
-
getTargetConnectorType
abstract ConnectorType getTargetConnectorType()
-
getUserId
abstract PlayerId getUserId()
-
getUserInterfaceType
abstract UserInterfaceType getUserInterfaceType()
-
getUserLocale
abstract Locale getUserLocale()
-
setStory
abstract Unit setStory(ClientStoryDefinition story)
The current story.
-
setStep
abstract Unit setStep(ClientStep step)
The current step.
-
-
-
-