Share via

TurnContext Class

Definition

Namespace:
Microsoft.Agents.Builder
Assembly:
Microsoft.Agents.Builder.dll
Package:
Microsoft.Agents.Builder v1.2.41

Provides context for a turn of an Agent.

public class TurnContext : IDisposable, Microsoft.Agents.Builder.ITurnContext
type TurnContext = class
    interface ITurnContext
    interface IDisposable
Public Class TurnContext
Implements IDisposable, ITurnContext
Inheritance
Object
TurnContext
Implements
ITurnContext IDisposable

Remarks

Context provides information needed to process an incoming activity. The context object is created by a IChannelAdapter and persists for the length of the turn. TurnContext cannot be used after the turn is complete.

Constructors

TurnContext(IChannelAdapter, IActivity)

Initializes a new instance of the TurnContext class.
TurnContext(ITurnContext, IActivity)

Initializes a new instance of the ITurnContext class from another TurnContext class to target an alternate Activity.

Properties

Activity

Gets the activity associated with this turn; or null when processing a proactive message.
Adapter

Gets the Adapter that created this context object.
Identity
Responded

Gets a value indicating whether at least one response was sent for the current turn.
Services

Gets the services registered on this context object.
StackState
StreamingResponse

Provides access to the IStreamingResponse to allow streaming of chunked messages (for example, via streaming AI responses).

Methods

DeleteActivityAsync(ConversationReference, CancellationToken)

Deletes an existing activity.
DeleteActivityAsync(String, CancellationToken)

Deletes an existing activity.
Dispose()

Frees resources.
Dispose(Boolean)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
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.
TraceActivityAsync(String, Object, String, String, CancellationToken)

Sends a trace activity to the IChannelAdapter for logging purposes.
UpdateActivityAsync(IActivity, CancellationToken)

Replaces an existing activity.

Extension Methods

GetDebugger(ITurnContext)

Extension method to get IDialogDebugger from TurnContext.

Applies to

See also