ai.tock.bot.engine.action

Class SendChoice

Event

Action

ai.tock.bot.engine.action.SendChoice

public class SendChoice
extends Action

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

Field Detail

TITLE_PARAMETER

@NotNull
public static java.lang.String TITLE_PARAMETER

See Also:

Constant Field Values

URL_PARAMETER

@NotNull
public static java.lang.String URL_PARAMETER

See Also:

Constant Field Values

IMAGE_PARAMETER

@NotNull
public static java.lang.String IMAGE_PARAMETER

See Also:

Constant Field Values

EXIT_INTENT

@NotNull
public static java.lang.String EXIT_INTENT

See Also:

Constant Field Values

PHONE_CALL_INTENT

@NotNull
public static java.lang.String PHONE_CALL_INTENT

See Also:

Constant Field Values

LOGIN_INTENT

@NotNull
public static java.lang.String LOGIN_INTENT

See Also:

Constant Field Values

LOGOUT_INTENT

@NotNull
public static java.lang.String LOGOUT_INTENT

See Also:

Constant Field Values

STEP_PARAMETER

@NotNull
public static java.lang.String STEP_PARAMETER

See Also:

Constant Field Values

PREVIOUS_INTENT_PARAMETER

@NotNull
public static java.lang.String PREVIOUS_INTENT_PARAMETER

See Also:

Constant Field Values

NLP

@NotNull
public static java.lang.String NLP

See Also:

Constant Field Values

SOURCE_APP_ID

@NotNull
public static java.lang.String SOURCE_APP_ID

See Also:

Constant Field Values

REFERRAL_PARAMETER

@NotNull
public static java.lang.String REFERRAL_PARAMETER

See Also:

Constant Field Values

Companion

public static ai.tock.bot.engine.action.SendChoice.Companion Companion

Constructor Detail

SendChoice

public SendChoice(@NotNull
                  PlayerId playerId,
                  @NotNull
                  java.lang.String applicationId,
                  @NotNull
                  PlayerId recipientId,
                  @NotNull
                  java.lang.String intentName,
                  @NotNull
                  java.util.Map<java.lang.String,java.lang.String> parameters,
                  @NotNull
                  org.litote.kmongo.Id<ai.tock.bot.engine.action.Action> id,
                  @NotNull
                  java.time.Instant date,
                  @NotNull
                  EventState state,
                  @NotNull
                  ActionMetadata metadata)

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

SendChoice

public SendChoice(@NotNull
                  PlayerId playerId,
                  @NotNull
                  java.lang.String applicationId,
                  @NotNull
                  PlayerId recipientId,
                  @NotNull
                  java.lang.String intentName,
                  @Nullable
                  StoryStep<? extends ai.tock.bot.definition.StoryHandlerDefinition> step,
                  @NotNull
                  java.util.Map<java.lang.String,java.lang.String> parameters,
                  @NotNull
                  org.litote.kmongo.Id<ai.tock.bot.engine.action.Action> id,
                  @NotNull
                  java.time.Instant date,
                  @NotNull
                  EventState state,
                  @NotNull
                  ActionMetadata metadata)

Method Detail

toMessage

@NotNull
public Message toMessage()

obfuscate

@NotNull
public Event obfuscate(@NotNull
                                ai.tock.shared.security.StringObfuscatorMode mode,
                                @NotNull
                                PlayerId playerId)

step

@Nullable
public java.lang.String step()

The step of this choice (when applicable).

sourceAppId

@Nullable
public java.lang.String sourceAppId()

The source application id (if any) ie the creator of the choice.

toEncodedId

@NotNull
public java.lang.String toEncodedId()

Provides the id used by connectors.

getReferralParameter

@Nullable
public java.lang.String getReferralParameter()

Returns the referral parameter if any.

toString

@NotNull
public java.lang.String toString()

getIntentName

@NotNull
public java.lang.String getIntentName()

getParameters

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getParameters()