ai.tock.bot.engine.action

Class Action

Event

ai.tock.bot.engine.action.Action

Direct Known Subclasses:

SendAttachment, SendChoice, SendLocation, SendSentence

public class Action
extends Event

A user (or bot) action.

Constructor Detail

Action

public Action(@NotNull
              PlayerId playerId,
              @NotNull
              PlayerId recipientId,
              @NotNull
              java.lang.String applicationId,
              @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 (or bot) action.

Method Detail

toMessage

@NotNull
public Message toMessage()

obfuscate

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

Obfuscate the event - by default this method does nothing.

obfuscate

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

toActionId

@NotNull
public org.litote.kmongo.Id<ai.tock.bot.engine.action.Action> toActionId()

choice

@Nullable
public java.lang.String choice(@NotNull
                                         ParameterKey key)

Returns the value of the specified choice parameter, null if the user action is not a class SendChoice or if this parameter is not set.

See Also:

class SendChoice

booleanChoice

public boolean booleanChoice(@NotNull
                             ParameterKey key)

Returns true if the specified choice as the "true" value, false either.

getPlayerId

@NotNull
public PlayerId getPlayerId()

getRecipientId

@NotNull
public PlayerId getRecipientId()

getMetadata

@NotNull
public ActionMetadata getMetadata()