Microsoft.Bot.Builder.Dialogs.IBotContext Interface Reference

The context for the bot. More...

Inheritance diagram for Microsoft.Bot.Builder.Dialogs.IBotContext:

Public Member Functions

Task FlushAsync (CancellationToken cancellationToken)
 Flushes the bot data to IBotDataStore<T> More...
 
Task LoadAsync (CancellationToken cancellationToken)
 Loads the bot data from IBotDataStore<T> More...
 
IMessageActivity MakeMessage ()
 Make a message. More...
 
Task PostAsync (IMessageActivity message, CancellationToken cancellationToken=default(CancellationToken))
 Post a message to be sent to the user. More...
 

Properties

IActivity Activity [get]
 The activity posted to bot. More...
 
CancellationToken CancellationToken [get]
 
IBotDataBag ConversationData [get]
 Private bot data associated with a conversation. More...
 
IBotDataBag PrivateConversationData [get]
 Private bot data associated with a user in a conversation. More...
 
IBotDataBag UserData [get]
 Private bot data associated with a user (across all channels and conversations). More...
 

Detailed Description

The context for the bot.

Definition at line 64 of file IDialogContext.cs.

Member Function Documentation

Task Microsoft.Bot.Builder.Dialogs.Internals.IBotData.FlushAsync ( CancellationToken  cancellationToken)
inherited

Flushes the bot data to IBotDataStore<T>

Parameters
cancellationTokenThe cancellation token.

Implemented in Microsoft.Bot.Builder.Dialogs.Internals.BotDataBase< T >, and Microsoft.Bot.Builder.Dialogs.Internals.DialogTaskManagerBotDataLoader.

Task Microsoft.Bot.Builder.Dialogs.Internals.IBotData.LoadAsync ( CancellationToken  cancellationToken)
inherited

Loads the bot data from IBotDataStore<T>

Parameters
cancellationTokenThe cancellation token.

Implemented in Microsoft.Bot.Builder.Dialogs.Internals.BotDataBase< T >, and Microsoft.Bot.Builder.Dialogs.Internals.DialogTaskManagerBotDataLoader.

IMessageActivity Microsoft.Bot.Builder.Dialogs.Internals.IBotToUser.MakeMessage ( )
inherited

Make a message.

Returns
The new message.

Implemented in Microsoft.Bot.Builder.Dialogs.Internals.MapToChannelData_BotToUser.

Task Microsoft.Bot.Builder.Dialogs.Internals.IBotToUser.PostAsync ( IMessageActivity  message,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inherited

Post a message to be sent to the user.

Parameters
messageThe message for the user.
cancellationTokenThe cancellation token.
Returns
A task that represents the post operation.

Implemented in Microsoft.Bot.Builder.Dialogs.Internals.MapToChannelData_BotToUser.

Property Documentation

IActivity Microsoft.Bot.Builder.Dialogs.IBotContext.Activity
get

The activity posted to bot.

This is the incoming activity in reactive cases. for proactive case, i.e. Conversation.ResumeAsync code path, it will be the IMessageActivity returned by ConversationReference.GetPostToBotMessage.

Definition at line 75 of file IDialogContext.cs.

CancellationToken Microsoft.Bot.Builder.Dialogs.IBotContext.CancellationToken
get

Definition at line 66 of file IDialogContext.cs.

IBotDataBag Microsoft.Bot.Builder.Dialogs.Internals.IBotData.ConversationData
getinherited

Private bot data associated with a conversation.

Definition at line 52 of file IBotData.cs.

IBotDataBag Microsoft.Bot.Builder.Dialogs.Internals.IBotData.PrivateConversationData
getinherited

Private bot data associated with a user in a conversation.

Definition at line 57 of file IBotData.cs.

IBotDataBag Microsoft.Bot.Builder.Dialogs.Internals.IBotData.UserData
getinherited

Private bot data associated with a user (across all channels and conversations).

Definition at line 47 of file IBotData.cs.


The documentation for this interface was generated from the following file: