ai.tock.bot.engine.dialog

Class EventState

ai.tock.bot.engine.dialog.EventState

public class EventState

State in event scope.

Constructor Detail

EventState

public EventState(@NotNull
                  java.util.List<ai.tock.bot.engine.dialog.EntityValue> entityValues,
                  boolean testEvent,
                  @Nullable
                  ConnectorType targetConnectorType,
                  @Nullable
                  ai.tock.translator.UserInterfaceType userInterface,
                  boolean userVerified,
                  @Nullable
                  java.lang.String intent,
                  @Nullable
                  java.lang.String step,
                  boolean notification,
                  @Nullable
                  java.lang.String sourceApplicationId)

State in event scope.

Parameters:

entityValues - The entity values.

testEvent - Is it a "test" event - flag used by automatic tests.

targetConnectorType - The target connector type - usually the source connector but not always.

userInterface - The user interface - if different of default interface of class ConnectorType.

userVerified - The user verification status.

intent - The current intent of the action.

step - The current step.

notification -

If true, this event is not addressed to the bot, but the bot is notified that it has been sent in a multi users/bots conversation.

Default is false.

sourceApplicationId - For notification event, what is the source of the notification if known?

EventState

public EventState()

State in event scope.

Method Detail

getEntity

@NotNull
public java.util.List<ai.tock.bot.engine.dialog.EntityValue> getEntity(@NotNull
                                                                                java.lang.String role)

getEntityValues

@NotNull
public java.util.List<ai.tock.bot.engine.dialog.EntityValue> getEntityValues()

The entity values.

getTestEvent

public boolean getTestEvent()

Is it a

"test" event - flag used by automatic tests.

setTestEvent

public void setTestEvent(boolean p)

Is it a

"test" event - flag used by automatic tests.

Parameters:

p - Is it a "test" event - flag used by automatic tests.

getTargetConnectorType

@Nullable
public ConnectorType getTargetConnectorType()

The target connector type

- usually the source connector but not always.

setTargetConnectorType

public void setTargetConnectorType(@Nullable
                                   ConnectorType p)

The target connector type

- usually the source connector but not always.

Parameters:

p - The target connector type - usually the source connector but not always.

getUserInterface

@Nullable
public ai.tock.translator.UserInterfaceType getUserInterface()

The user interface

- if different of default interface of class ConnectorType.

See Also:

class ConnectorType

setUserInterface

public void setUserInterface(@Nullable
                             ai.tock.translator.UserInterfaceType p)

The user interface

- if different of default interface of class ConnectorType.

Parameters:

p - The user interface - if different of default interface of class ConnectorType.

See Also:

class ConnectorType

getUserVerified

public boolean getUserVerified()

The user verification status.

setUserVerified

public void setUserVerified(boolean p)

The user verification status.

Parameters:

p - The user verification status.

getIntent

@Nullable
public java.lang.String getIntent()

The current intent of the action.

setIntent

public void setIntent(@Nullable
                      java.lang.String p)

The current intent of the action.

Parameters:

p - The current intent of the action.

getStep

@Nullable
public java.lang.String getStep()

The current step.

setStep

public void setStep(@Nullable
                    java.lang.String p)

The current step.

Parameters:

p - The current step.

getNotification

public boolean getNotification()

If true, this event is not addressed to the bot, but the bot is notified that it has been sent in a multi users/bots conversation.

Default is false.

setNotification

public void setNotification(boolean p)

If true, this event is not addressed to the bot, but the bot is notified that it has been sent in a multi users/bots conversation.

Default is false.

Parameters:

p -

If true, this event is not addressed to the bot, but the bot is notified that it has been sent in a multi users/bots conversation.

Default is false.

getSourceApplicationId

@Nullable
public java.lang.String getSourceApplicationId()

For notification event,

what is the source of the notification if known?

setSourceApplicationId

public void setSourceApplicationId(@Nullable
                                   java.lang.String p)

For notification event,

what is the source of the notification if known?

Parameters:

p - For notification event, what is the source of the notification if known?

component1

@NotNull
public java.util.List<ai.tock.bot.engine.dialog.EntityValue> component1()

The entity values.

component2

public boolean component2()

Is it a

"test" event - flag used by automatic tests.

component3

@Nullable
public ConnectorType component3()

The target connector type

- usually the source connector but not always.

component4

@Nullable
public ai.tock.translator.UserInterfaceType component4()

The user interface

- if different of default interface of class ConnectorType.

See Also:

class ConnectorType

component5

public boolean component5()

The user verification status.

component6

@Nullable
public java.lang.String component6()

The current intent of the action.

component7

@Nullable
public java.lang.String component7()

The current step.

component8

public boolean component8()

If true, this event is not addressed to the bot, but the bot is notified that it has been sent in a multi users/bots conversation.

Default is false.

component9

@Nullable
public java.lang.String component9()

For notification event,

what is the source of the notification if known?

copy

@NotNull
public EventState copy(@NotNull
                                java.util.List<ai.tock.bot.engine.dialog.EntityValue> entityValues,
                                boolean testEvent,
                                @Nullable
                                ConnectorType targetConnectorType,
                                @Nullable
                                ai.tock.translator.UserInterfaceType userInterface,
                                boolean userVerified,
                                @Nullable
                                java.lang.String intent,
                                @Nullable
                                java.lang.String step,
                                boolean notification,
                                @Nullable
                                java.lang.String sourceApplicationId)

State in event scope.

toString

@NotNull
public java.lang.String toString()

State in event scope.

hashCode

public int hashCode()

State in event scope.

equals

public boolean equals(@Nullable
                      java.lang.Object p)

State in event scope.