AgentEndpointExtensions.MapAgentProactiveEndpoints 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.
Overloads
| Name | Description |
|---|---|
| MapAgentProactiveEndpoints<TAgent>(IEndpointRouteBuilder, Boolean, String) |
Maps proactive conversation endpoints using ContinueConversationAttributes on the agent. |
| MapAgentProactiveEndpoints<TAgent>(IEndpointRouteBuilder, IDictionary<String,ContinueConversationRoute<TAgent>>, Boolean, String) |
Maps endpoints for handling proactive messaging operations, such as sending activities to conversations, to the specified route group in the application's endpoint routing pipeline. |
MapAgentProactiveEndpoints<TAgent>(IEndpointRouteBuilder, Boolean, String)
Maps proactive conversation endpoints using ContinueConversationAttributes on the agent.
public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapAgentProactiveEndpoints<TAgent>(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, bool requireAuth = true, string defaultPath = "/proactive") where TAgent : Microsoft.Agents.Builder.App.AgentApplication;static member MapAgentProactiveEndpoints : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * bool * string -> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder (requires 'Agent :> Microsoft.Agents.Builder.App.AgentApplication)<Extension()>
Public Function MapAgentProactiveEndpoints(Of TAgent As AgentApplication) (endpoints As IEndpointRouteBuilder, Optional requireAuth As Boolean = true, Optional defaultPath As String = "/proactive") As IEndpointConventionBuilderType Parameters
- TAgent
The agent application type for which proactive endpoints are mapped. Must inherit from AgentApplication.
Parameters
- endpoints
- IEndpointRouteBuilder
The web application to which the proactive endpoints will be added.
- requireAuth
- Boolean
A value indicating whether authentication is required for the mapped endpoints. Defaults to true.
- defaultPath
- String
The base route path for the proactive endpoints. Defaults to "/proactive".
Returns
An endpoint convention builder that can be used to further configure the mapped endpoints.
Applies to
MapAgentProactiveEndpoints<TAgent>(IEndpointRouteBuilder, IDictionary<String,ContinueConversationRoute<TAgent>>, Boolean, String)
Maps endpoints for handling proactive messaging operations, such as sending activities to conversations, to the specified route group in the application's endpoint routing pipeline.
public static Microsoft.AspNetCore.Builder.IEndpointConventionBuilder MapAgentProactiveEndpoints<TAgent>(this Microsoft.AspNetCore.Routing.IEndpointRouteBuilder endpoints, System.Collections.Generic.IDictionary<string,Microsoft.Agents.Builder.App.Proactive.ContinueConversationRoute<TAgent>> continueRoutes, bool requireAuth = true, string defaultPath = "/proactive") where TAgent : Microsoft.Agents.Builder.App.AgentApplication;static member MapAgentProactiveEndpoints : Microsoft.AspNetCore.Routing.IEndpointRouteBuilder * System.Collections.Generic.IDictionary<string, Microsoft.Agents.Builder.App.Proactive.ContinueConversationRoute<'Agent>> * bool * string -> Microsoft.AspNetCore.Builder.IEndpointConventionBuilder (requires 'Agent :> Microsoft.Agents.Builder.App.AgentApplication)<Extension()>
Public Function MapAgentProactiveEndpoints(Of TAgent As AgentApplication) (endpoints As IEndpointRouteBuilder, continueRoutes As IDictionary(Of String, ContinueConversationRoute(Of TAgent)), Optional requireAuth As Boolean = true, Optional defaultPath As String = "/proactive") As IEndpointConventionBuilderType Parameters
- TAgent
Parameters
- endpoints
- IEndpointRouteBuilder
The WebApplication to which the proactive messaging endpoints are added.
- continueRoutes
- IDictionary<String,ContinueConversationRoute<TAgent>>
- requireAuth
- Boolean
true to require authentication for the mapped endpoints; otherwise, false. The default is true.
- defaultPath
- String
The route pattern under which the proactive messaging endpoints are grouped. The default is "/proactive".
Returns
An endpoint convention builder that can be used to further customize the mapped proactive messaging endpoints.
Remarks
/proactive/sendactivity/{conversationId} - sends an activity to a specific conversation using the conversation ID.
/proactive/sendactivity - sends an activity using a conversation reference record, which includes the necessary information to identify the target conversation.
/proactive/createconversation - creates a new conversation and sends an initial activity to it. The request payload should include the necessary information to create the conversation and the activity to be sent.