InvokeRouteBuilder Class
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.
RouteBuilder for routing Invoke activities in an AgentApplication.
public class InvokeRouteBuilder : Microsoft.Agents.Builder.App.RouteBuilderBase<Microsoft.Agents.Builder.App.InvokeRouteBuilder>type InvokeRouteBuilder = class
inherit RouteBuilderBase<InvokeRouteBuilder>Public Class InvokeRouteBuilder
Inherits RouteBuilderBase(Of InvokeRouteBuilder)- Inheritance
Remarks
Use this builder to define routing logic for activities of type 'invoke', such as those triggered by adaptive cards or other client-initiated operations. The builder allows optionally specifying matching criteria based on the activity's name. If neither WithName(String) nor WithName(Regex) is called, the route will match any invoke activity regardless of name.
Constructors
| Name | Description |
|---|---|
| InvokeRouteBuilder() | |
Fields
| Name | Description |
|---|---|
| _route | (Inherited from RouteBuilderBase<TBuilder>) |
Methods
| Name | Description |
|---|---|
| AsAgentic(Boolean) |
Configures the route to operate in agentic mode, enabling behaviors associated with agentic processing. (Inherited from RouteBuilderBase<TBuilder>) |
| AsInvoke(Boolean) |
Returns the current route builder instance configured for Invoke routing. This method ensures that the route remains set as an Invoke route. |
| AsNonTerminal() |
Marks the current route as non-terminal and returns the updated builder instance. (Inherited from RouteBuilderBase<TBuilder>) |
| Build() |
Builds and returns the configured route instance after validating required components. (Inherited from RouteBuilderBase<TBuilder>) |
| Create() |
Creates a new instance of the InvokeRouteBuilder class for constructing route definitions. |
| PreBuild() | |
| WithChannelId(ChannelId) |
Sets the channel identifier for the route and returns the builder instance for method chaining. (Inherited from RouteBuilderBase<TBuilder>) |
| WithHandler(RouteHandler) |
Assigns the specified route handler to the current route and returns the updated builder instance. |
| WithName(Regex) |
Configures the route to match invoke activities whose name matches the specified regular expression pattern. |
| WithName(String) |
Configures the route to match only invoke activities with the specified name. |
| WithOAuthHandlers(Func<ITurnContext,String[]>) |
Configures OAuth handler functions for the route using the specified delegate. (Inherited from RouteBuilderBase<TBuilder>) |
| WithOAuthHandlers(String) |
Configures the builder to use one or more OAuth authentication handlers specified in a delimited string. (Inherited from RouteBuilderBase<TBuilder>) |
| WithOAuthHandlers(String[]) |
Configures the route to use the specified OAuth authentication handlers. (Inherited from RouteBuilderBase<TBuilder>) |
| WithOrderRank(UInt16) |
Sets the order rank for the route and returns the current builder instance for further configuration. (Inherited from RouteBuilderBase<TBuilder>) |
| WithSelector(RouteSelector) |
Sets a custom route selector used to determine how incoming requests are matched to this route builder. |