ITurnContext Interface

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.18.1

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.

Provides context for a turn of a bot.

public interface ITurnContext

type ITurnContext = interface

Public Interface ITurnContext

Derived: Microsoft.Bot.Builder.DelegatingTurnContext<T>

Microsoft.Bot.Builder.ITurnContext<T>

Microsoft.Bot.Builder.TurnContext

Remarks

Context provides information needed to process an incoming activity. The context object is created by a BotAdapter and persists for the length of the turn.

Properties

Activity	Gets the activity for this turn of the bot.
Adapter	Gets the bot adapter that created this context object.
Responded	Gets a value indicating whether at least one response was sent for the current turn.
TurnState	Gets the collection of values cached with the context object for the lifetime of the turn.

Methods

DeleteActivityAsync(ConversationReference, CancellationToken)	Deletes an existing activity.
DeleteActivityAsync(String, CancellationToken)	Deletes an existing activity.
OnDeleteActivity(DeleteActivityHandler)	Adds a response handler for delete activity operations.
OnSendActivities(SendActivitiesHandler)	Adds a response handler for send activity operations.
OnUpdateActivity(UpdateActivityHandler)	Adds a response handler for update activity operations.
SendActivitiesAsync(IActivity[], CancellationToken)	Sends a set of activities to the sender of the incoming activity.
SendActivityAsync(IActivity, CancellationToken)	Sends an activity to the sender of the incoming activity.
SendActivityAsync(String, String, String, CancellationToken)	Sends a message activity to the sender of the incoming activity.
UpdateActivityAsync(IActivity, CancellationToken)	Replaces an existing activity.

Extension Methods

GetDebugger(ITurnContext)	Extension method to get IDialogDebugger from TurnContext.
TraceActivityAsync(ITurnContext, String, Object, String, String, CancellationToken)	Sends a trace activity to the BotAdapter for logging purposes.

Applies to