EventRouteBuilderBase<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 event activities in an AgentApplication.
public class EventRouteBuilderBase<TBuilder> : Microsoft.Agents.Builder.App.RouteBuilderBase<TBuilder> where TBuilder : EventRouteBuilderBase<TBuilder>
type EventRouteBuilderBase<'Builder (requires 'Builder :> EventRouteBuilderBase<'Builder>)> = class
inherit RouteBuilderBase<'Builder (requires 'Builder :> EventRouteBuilderBase<'Builder>)>
Public Class EventRouteBuilderBase(Of TBuilder)
Inherits RouteBuilderBase(Of TBuilder)
Type Parameters
- TBuilder
The concrete builder type returned from fluent members.
- Inheritance
- Derived
Remarks
Derive from EventRouteBuilderBase<TBuilder> to create specialized event route builders while preserving fluent chaining on the concrete builder type. This base class supplies the shared event matching behavior, including event-name filters, custom selectors, channel constraints, and agentic routing support. If neither WithName(String) nor WithName(Regex) is called, the route matches any event activity regardless of name.
Constructors
| Name | Description |
|---|---|
| EventRouteBuilderBase<TBuilder>() | |
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 builder instance. |
| 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>) |
| WithName(Regex) |
Configures the event route to match event activities whose name satisfies the specified regular expression pattern. |
| WithName(String) |
Configures the route to match event activities with the specified name, using a case-insensitive comparison. |
| 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. |