IDialogContext Interface

Reference

Definition

Namespace:: Microsoft.Bot.Builder.Dialogs

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v3.30.0

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.

The context for the execution of a dialog's conversational process.

public interface IDialogContext : Microsoft.Bot.Builder.Dialogs.IBotContext, Microsoft.Bot.Builder.Dialogs.Internals.IDialogStack

type IDialogContext = interface
    interface IDialogStack
    interface IBotContext
    interface IBotData
    interface IBotToUser

Public Interface IDialogContext
Implements IBotContext, IDialogStack

Derived: Microsoft.Bot.Builder.Dialogs.Internals.DialogContext

Implements: IBotContext IBotData IBotToUser IDialogStack

Properties

Activity	The activity posted to bot. (Inherited from IBotContext)
CancellationToken	(Inherited from IBotContext)
ConversationData	Private bot data associated with a conversation. (Inherited from IBotData)
Frames	The dialog frames active on the stack. (Inherited from IDialogStack)
PrivateConversationData	Private bot data associated with a user in a conversation. (Inherited from IBotData)
UserData	Private bot data associated with a user (across all channels and conversations). (Inherited from IBotData)

Methods

Call<R>(IDialog<R>, ResumeAfter<R>)	Call a child dialog and add it to the top of the stack. (Inherited from IDialogStack)
Done<R>(R)	Complete the current dialog and return a result to the parent dialog. (Inherited from IDialogStack)
Fail(Exception)	Fail the current dialog and return an exception to the parent dialog. (Inherited from IDialogStack)
FlushAsync(CancellationToken)	Flushes the bot data to IBotDataStore<T> (Inherited from IBotData)
Forward<R,T>(IDialog<R>, ResumeAfter<R>, T, CancellationToken)	Call a child dialog, add it to the top of the stack and post the item to the child dialog. (Inherited from IDialogStack)
LoadAsync(CancellationToken)	Loads the bot data from IBotDataStore<T> (Inherited from IBotData)
MakeMessage()	Make a message. (Inherited from IBotToUser)
Post<E>(E, ResumeAfter<E>)	Post an internal event to the queue. (Inherited from IDialogStack)
PostAsync(IMessageActivity, CancellationToken)	Post a message to be sent to the user. (Inherited from IBotToUser)
Reset()	Resets the stack. (Inherited from IDialogStack)
Wait<R>(ResumeAfter<R>)	Suspend the current dialog until an external event has been sent to the bot. (Inherited from IDialogStack)

Extension Methods

EndConversation(IDialogContext, String)	Initiate an EndConversationEvent to reset the conversation's state and stack and send an EndOfConversation to the Connector.
Forward<R>(IDialogStack, IDialog<R>, ResumeAfter<R>, IMessageActivity, CancellationToken)	Call a child dialog, add it to the top of the stack and post the message to the child dialog.
GetSignInUrlAsync(IDialogContext, String)
GetUserTokenAsync(IDialogContext, String, String)
GetUserTokenAsync(IDialogContext, String)
PostAsync(IBotToUser, String, String, CancellationToken)	Post a message to be sent to the user, using previous messages to establish a conversation context.
SayAsync(IBotToUser, String, String, MessageOptions, String, CancellationToken)	Post a message and optional SSML to be sent to the user, using previous messages to establish a conversation context.
SignOutUserAsync(IDialogContext, String)
Wait(IDialogStack, ResumeAfter<IMessageActivity>)	Suspend the current dialog until the user has sent a message to the bot.

Applies to

Jaa