Dialog.OnPreBubbleEventAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs

Assembly:: Microsoft.Bot.Builder.Dialogs.dll

Package:: Microsoft.Bot.Builder.Dialogs v4.22.7

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Called before an event is bubbled to its parent.

protected virtual System.Threading.Tasks.Task<bool> OnPreBubbleEventAsync (Microsoft.Bot.Builder.Dialogs.DialogContext dc, Microsoft.Bot.Builder.Dialogs.DialogEvent e, System.Threading.CancellationToken cancellationToken);

abstract member OnPreBubbleEventAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * Microsoft.Bot.Builder.Dialogs.DialogEvent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.OnPreBubbleEventAsync : Microsoft.Bot.Builder.Dialogs.DialogContext * Microsoft.Bot.Builder.Dialogs.DialogEvent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Protected Overridable Function OnPreBubbleEventAsync (dc As DialogContext, e As DialogEvent, cancellationToken As CancellationToken) As Task(Of Boolean)

Parameters

dc: DialogContext

The dialog context for the current turn of conversation.

e: DialogEvent

The event being raised.

cancellationToken: CancellationToken

Cancellation token.

Returns

Task<Boolean>

Whether the event is handled by the current dialog and further processing should stop.

Remarks

This is a good place to perform interception of an event as returning `true` will prevent any further bubbling of the event to the dialogs parents and will also prevent any child dialogs from performing their default processing.

Applies to

Jaa