ai.tock.bot.engine.event

Class Event

ai.tock.bot.engine.event.Event

Direct Known Subclasses:

Action, EndSessionEvent, GetAppRolesEvent, MarkSeenEvent, OneToOneEvent, StartSessionEvent, TypingOffEvent, TypingOnEvent

public class Event

The base class for all events or actions.

Constructor Detail

Event

public Event(@NotNull
             java.lang.String applicationId,
             @NotNull
             org.litote.kmongo.Id<? extends ai.tock.bot.engine.event.Event> id,
             @NotNull
             java.time.Instant date,
             @NotNull
             EventState state)

The base class for all events or actions.

Parameters:

applicationId - The bot application id.

id - The unique id of the event.

date - The creation date of the event.

state - The state of the event.

Method Detail

hasEntity

public boolean hasEntity(@NotNull
                         java.lang.String role)

Does this event contains specified role entity?

hasEntityPredefinedValue

public boolean hasEntityPredefinedValue(@NotNull
                                        java.lang.String role,
                                        @NotNull
                                        java.lang.String value)

Does this event contains specified predefined value entity?

obfuscate

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

Obfuscate the event - by default this method does nothing.

getApplicationId

@NotNull
public java.lang.String getApplicationId()

The bot application id.

getId

@NotNull
public org.litote.kmongo.Id<? extends ai.tock.bot.engine.event.Event> getId()

The unique id of the event.

getDate

@NotNull
public java.time.Instant getDate()

The creation date of the event.

getState

@NotNull
public EventState getState()

The state of the event.