All Implemented Interfaces:: ai.tock.bot.definition.StoryHandlerDefinition , ai.tock.bot.engine.BotBus , ai.tock.bot.engine.Bus , ai.tock.bot.engine.I18nTranslator , ai.tock.translator.I18nKeyProvider

@GAHandler(value = GASearchConnector.class)@MessengerHandler(value = MessengerSearchConnector.class) 
public final class SearchDef
extends StoryHandlerDefinitionBase<SearchConnector>

The search handler definition.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`SearchDef.SearchParameter`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Action`	`action`
`private final String`	`applicationId`
`private final BotDefinition`	`botDefinition`
`private final PlayerId`	`botId`
`private final BotBus`	`bus`
`private final SearchConnector`	`c`
`private final SearchConnector`	`connector`
`private final ConnectorData`	`connectorData`
`private final ConnectorType`	`connectorType`
`private final String`	`contextId`
`private final Integer`	`currentAnswerIndex`
`private final Dialog`	`currentDialog`
`private final IntentAware`	`currentIntent`
`private final Dialog`	`dialog`
`private final Map<String, EntityStateValue>`	`entities`
`private I18nKeyProvider`	`i18nProvider`
`private final IntentAware`	`intent`
`private NextUserActionState`	`nextUserActionState`
`private StoryStep<out StoryHandlerDefinition>`	`step`
`private final String`	`stepName`
`private Story`	`story`
`private final ConnectorType`	`targetConnectorType`
`private final Boolean`	`test`
`private final Connector`	`underlyingConnector`
`private final PlayerId`	`userId`
`private final UserInterfaceType`	`userInterfaceType`
`private final Locale`	`userLocale`
`private final UserPreferences`	`userPreferences`
`private final String`	`userText`
`private final UserTimeline`	`userTimeline`

Constructor Summary

Constructors
Constructor	Description
`SearchDef(BotBus bus)`

Method Summary

Modifier and Type	Method	Description
`Unit`	`answer()`
`Action`	`getAction()`
`String`	`getApplicationId()`
`BotDefinition`	`getBotDefinition()`
`PlayerId`	`getBotId()`
`final BotBus`	`getBus()`
`final SearchConnector`	`getC()`
`SearchConnector`	`getConnector()`
`ConnectorData`	`getConnectorData()`
`final ConnectorType`	`getConnectorType()`
`String`	`getContextId()`
`Integer`	`getCurrentAnswerIndex()`
`Dialog`	`getCurrentDialog()`
`IntentAware`	`getCurrentIntent()`
`Dialog`	`getDialog()`
`Map<String, EntityStateValue>`	`getEntities()`
`I18nKeyProvider`	`getI18nProvider()`
`IntentAware`	`getIntent()`
`NextUserActionState`	`getNextUserActionState()`
`StoryStep<out StoryHandlerDefinition>`	`getStep()`
`String`	`getStepName()`
`Story`	`getStory()`
`ConnectorType`	`getTargetConnectorType()`
`Boolean`	`getTest()`
`Connector`	`getUnderlyingConnector()`
`PlayerId`	`getUserId()`
`UserInterfaceType`	`getUserInterfaceType()`
`Locale`	`getUserLocale()`
`UserPreferences`	`getUserPreferences()`
`String`	`getUserText()`
`UserTimeline`	`getUserTimeline()`
`Unit`	`setI18nProvider(I18nKeyProvider i18nProvider)`
`Unit`	`setNextUserActionState(NextUserActionState nextUserActionState)`
`Unit`	`setStep(StoryStep<out StoryHandlerDefinition> step)`
`Unit`	`setStory(Story story)`

Methods inherited from class ai.tock.bot.definition.StoryHandlerDefinitionBase
answerWith, booleanChoice, changeContextValue, changeContextValue, changeEntityText, changeEntityValue, changeEntityValue, changeEntityValue, choice, contextValue, contextValue, defaultDelay, end, end, end, end, end, end, end, endRawText, entityText, entityText, entityValue, entityValue, entityValueDetails, entityValueDetails, getBusContextValue, getBusContextValue, handleAndSwitchStory, hasActionEntity, hasActionEntity, hasChoiceValue, i18n, i18nKey, isChoiceAction, isFeatureEnabled, isIntent, markAsUnknown, nlpStats, reloadProfile, removeAllEntityValues, removeEntityValue, removeEntityValue, resetDialogState, send, send, send, send, send, send, send, setBusContextValue, setBusContextValue, skipAnswer, switchStory, withMessage, withNotificationType, withPriority, withVisibility
Methods inherited from class ai.tock.translator.I18nKeyProvider
equals, hashCode, toString
Methods inherited from class ai.tock.bot.open.data.story.SearchDef
findConnector, findConnector, handle
Methods inherited from class ai.tock.bot.engine.I18nTranslator
i18n
Methods inherited from class ai.tock.bot.engine.BotBus
sendRawText, withMessage, withMessage
Methods inherited from class ai.tock.bot.engine.Bus
translate, translate, translate, translateAndReturnBlankAsNull
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SearchDef
```
SearchDef(BotBus bus)
```

Method Detail

answer
```
 Unit answer()
```

getAction
```
 Action getAction()
```

getApplicationId
```
 String getApplicationId()
```

getBotDefinition
```
 BotDefinition getBotDefinition()
```

getBotId
```
 PlayerId getBotId()
```

getBus
```
 final BotBus getBus()
```

getC
```
 final SearchConnector getC()
```

getConnector
```
 SearchConnector getConnector()
```

getConnectorData
```
 ConnectorData getConnectorData()
```

getConnectorType
```
 final ConnectorType getConnectorType()
```

getContextId
```
 String getContextId()
```

getCurrentAnswerIndex
```
 Integer getCurrentAnswerIndex()
```

getCurrentDialog
```
 Dialog getCurrentDialog()
```

getCurrentIntent
```
 IntentAware getCurrentIntent()
```

getDialog
```
 Dialog getDialog()
```

getEntities

 Map<String, EntityStateValue> getEntities()

getI18nProvider
```
 I18nKeyProvider getI18nProvider()
```

getIntent
```
 IntentAware getIntent()
```

getNextUserActionState

 NextUserActionState getNextUserActionState()

getStep

 StoryStep<out StoryHandlerDefinition> getStep()

getStepName
```
 String getStepName()
```

getStory
```
 Story getStory()
```

getTargetConnectorType
```
 ConnectorType getTargetConnectorType()
```

getTest
```
 Boolean getTest()
```

getUnderlyingConnector
```
 Connector getUnderlyingConnector()
```

getUserId
```
 PlayerId getUserId()
```

getUserInterfaceType

 UserInterfaceType getUserInterfaceType()

getUserLocale
```
 Locale getUserLocale()
```

getUserPreferences
```
 UserPreferences getUserPreferences()
```

getUserText
```
 String getUserText()
```

getUserTimeline
```
 UserTimeline getUserTimeline()
```

setI18nProvider

 Unit setI18nProvider(I18nKeyProvider i18nProvider)

setNextUserActionState

 Unit setNextUserActionState(NextUserActionState nextUserActionState)

setStep

 Unit setStep(StoryStep<out StoryHandlerDefinition> step)

setStory
```
 Unit setStory(Story story)
```

Class SearchDef

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ai.tock.bot.definition.StoryHandlerDefinitionBase

Methods inherited from class ai.tock.translator.I18nKeyProvider

Methods inherited from class ai.tock.bot.open.data.story.SearchDef

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

SearchDef

Method Detail

answer

getAction

getApplicationId

getBotDefinition

getBotId

getBus

getC

getConnector

getConnectorData

getConnectorType

getContextId

getCurrentAnswerIndex

getCurrentDialog

getCurrentIntent

getDialog

getEntities

getI18nProvider

getIntent

getNextUserActionState

getStep

getStepName

getStory

getTargetConnectorType

getTest

getUnderlyingConnector

getUserId

getUserInterfaceType

getUserLocale

getUserPreferences

getUserText

getUserTimeline

setI18nProvider

setNextUserActionState

setStep

setStory