
public final class SendChoice
extends Action

A user choice (click on a button or direct action).

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`SendChoice.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`referralParameter`
`private final String`	`intentName`
`private final Map<String, String>`	`parameters`
`private final PlayerId`	`playerId`
`private final PlayerId`	`recipientId`
`private final ActionMetadata`	`metadata`
`private final String`	`applicationId`
`private final Id<out Event>`	`id`
`private final Instant`	`date`
`private final EventState`	`state`

Constructor Summary

Constructors
Constructor	Description
`SendChoice(PlayerId playerId, String applicationId, PlayerId recipientId, String intentName, StoryStep<out StoryHandlerDefinition> step, Map<String, String> parameters, Id<Action> id, Instant date, EventState state, ActionMetadata metadata)`
`SendChoice(PlayerId playerId, String applicationId, PlayerId recipientId, String intentName, Map<String, String> parameters, Id<Action> id, Instant date, EventState state, ActionMetadata metadata)`

Method Summary

Modifier and Type	Method	Description
`Message`	`toMessage()`
`final String`	`step()`	The step of this choice (when applicable).
`final String`	`sourceAppId()`	The source application id (if any) ie the creator of the choice.
`final String`	`toEncodedId()`	Provides the id used by connectors.
`String`	`toString()`
`final String`	`getReferralParameter()`
`final String`	`getIntentName()`
`final Map<String, String>`	`getParameters()`
`final PlayerId`	`getPlayerId()`
`final PlayerId`	`getRecipientId()`
`final ActionMetadata`	`getMetadata()`
`final String`	`getApplicationId()`	The bot application id.
`final Id<out Event>`	`getId()`	The unique id of the event.
`final Instant`	`getDate()`	The creation date of the event.
`final EventState`	`getState()`	The state of the event.

Methods inherited from class ai.tock.bot.engine.action.SendChoice
booleanChoice, choice, jsonChoice, toActionId
Methods inherited from class ai.tock.bot.engine.action.Action
hasEntity, hasEntityPredefinedValue
Methods inherited from class ai.tock.bot.engine.event.Event
equals, hashCode
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SendChoice

SendChoice(PlayerId playerId, String applicationId, PlayerId recipientId, String intentName, StoryStep<out StoryHandlerDefinition> step, Map<String, String> parameters, Id<Action> id, Instant date, EventState state, ActionMetadata metadata)

SendChoice

SendChoice(PlayerId playerId, String applicationId, PlayerId recipientId, String intentName, Map<String, String> parameters, Id<Action> id, Instant date, EventState state, ActionMetadata metadata)

Method Detail

toMessage
```
 Message toMessage()
```

step
```
 final String step()
```
The step of this choice (when applicable).

sourceAppId
```
 final String sourceAppId()
```
The source application id (if any) ie the creator of the choice.

toEncodedId
```
 final String toEncodedId()
```
Provides the id used by connectors.

toString
```
 String toString()
```

getReferralParameter
```
 final String getReferralParameter()
```

getIntentName
```
 final String getIntentName()
```

getParameters

 final Map<String, String> getParameters()

getPlayerId
```
 final PlayerId getPlayerId()
```

getRecipientId
```
 final PlayerId getRecipientId()
```

getMetadata
```
 final ActionMetadata getMetadata()
```

getApplicationId
```
 final String getApplicationId()
```
The bot application id.

getId
```
 final Id<out Event> getId()
```
The unique id of the event.

getDate
```
 final Instant getDate()
```
The creation date of the event.

getState
```
 final EventState getState()
```
The state of the event.

Class SendChoice

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class ai.tock.bot.engine.action.SendChoice

Methods inherited from class ai.tock.bot.engine.action.Action

Methods inherited from class ai.tock.bot.engine.event.Event

Methods inherited from class java.lang.Object

Constructor Detail

SendChoice

SendChoice

Method Detail

toMessage

step

sourceAppId

toEncodedId

toString

getReferralParameter

getIntentName

getParameters

getPlayerId

getRecipientId

getMetadata

getApplicationId

getId

getDate

getState