IAgentHost.SendToAgent Method
Definition
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.
Sends an activity to an Agent.
public System.Threading.Tasks.Task SendToAgent(Microsoft.Agents.Builder.ITurnContext turnContext, string agentName, string agentConversationId, Microsoft.Agents.Core.Models.IActivity activity, System.Threading.CancellationToken cancellationToken = default);abstract member SendToAgent : Microsoft.Agents.Builder.ITurnContext * string * string * Microsoft.Agents.Core.Models.IActivity * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function SendToAgent (turnContext As ITurnContext, agentName As String, agentConversationId As String, activity As IActivity, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- turnContext
- ITurnContext
Context for a turn of the Agent.
- agentName
- String
An Agent name from configuration.
- agentConversationId
- String
An Agent conversation identifier. More info: GetOrCreateConversationAsync(ITurnContext, String, CancellationToken) or GetConversation(ITurnContext, String, CancellationToken)
- activity
- IActivity
The activity to send.
- cancellationToken
- CancellationToken
Cancellation token.
Returns
Exceptions
If the specified agentName is null or not found.
Remarks
This is used for Activity.DeliverMode == 'normal'. In order to get the asynchronous replies from the Agent, the OnAgentReply(AgentResponseHandler, UInt16) handler must be set on the AgentApplication.