DialogEvent Class

Package:
com.microsoft.bot.dialogs
Maven Artifact:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.DialogEvent

public class DialogEvent

Represents an event related to the "lifecycle" of the dialog.

Constructor Summary

Constructor Description
DialogEvent()

Method Summary

Modifier and Type Method and Description
java.lang.String getName()

Gets name of the event being raised.
java.lang.Object getValue()

Gets optional value associated with the event.
void setBubble(boolean withBubble)

Sets whether the event will be bubbled to the parent `DialogContext` if not handled by the current dialog.
void setName(String withName)

Sets name of the event being raised.
void setValue(Object withValue)

Sets optional value associated with the event.
boolean shouldBubble()

Indicates whether the event will be bubbled to the parent `DialogContext` if not handled by the current dialog.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

DialogEvent

public DialogEvent()

Method Details

getName

public String getName()

Gets name of the event being raised.

Returns:

Name of the event being raised.

getValue

public Object getValue()

Gets optional value associated with the event.

Returns:

Optional value associated with the event.

setBubble

public void setBubble(boolean withBubble)

Sets whether the event will be bubbled to the parent `DialogContext` if not handled by the current dialog.

Parameters:

withBubble - Whether the event can be bubbled to the parent DialogContext.

setName

public void setName(String withName)

Sets name of the event being raised.

Parameters:

withName - Name of the event being raised.

setValue

public void setValue(Object withValue)

Sets optional value associated with the event.

Parameters:

withValue - Optional value associated with the event.

shouldBubble

public boolean shouldBubble()

Indicates whether the event will be bubbled to the parent `DialogContext` if not handled by the current dialog.

Returns:

Whether the event can be bubbled to the parent DialogContext.

Applies to