MessageRouteBuilderBase<TBuilder> 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.
Provides the generic base builder for routing message activities in an AgentApplication.
public abstract class MessageRouteBuilderBase<TBuilder> : Microsoft.Agents.Builder.App.RouteBuilderBase<TBuilder> where TBuilder : MessageRouteBuilderBase<TBuilder>type MessageRouteBuilderBase<'Builder (requires 'Builder :> MessageRouteBuilderBase<'Builder>)> = class
inherit RouteBuilderBase<'Builder (requires 'Builder :> MessageRouteBuilderBase<'Builder>)>Public MustInherit Class MessageRouteBuilderBase(Of TBuilder)
Inherits RouteBuilderBase(Of TBuilder)Type Parameters
- TBuilder
The concrete builder type returned from fluent members.
- Inheritance
- Derived
Remarks
Derive from MessageRouteBuilderBase<TBuilder> to create specialized message route builders while preserving fluent chaining on the concrete builder type. This base class supplies the shared message matching behavior, including message-only routing, optional text filters, custom selectors, channel constraints, and agentic routing support.
Constructors
| Name | Description |
|---|---|
| MessageRouteBuilderBase<TBuilder>() | |
Fields
| Name | Description |
|---|---|
| _route | (Inherited from RouteBuilderBase<TBuilder>) |
| _text | |
| _textPattern | |
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) |
For message routes, the invoke flag is ignored to prevent misconfiguration. |
| 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>) |
| PreBuild() | |
| WithChannelId(ChannelId) |
Sets the channel identifier for the route and returns the builder instance for method chaining. (Inherited from RouteBuilderBase<TBuilder>) |
| 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. |
| WithText(Regex) |
Adds a text pattern selector to the route, matching incoming message activities whose text satisfies the specified regular expression. |
| WithText(String) |
Adds a selector to the route that matches incoming message activities with text equal to the specified value, ignoring case. |