EventRouteBuilder Class

Definition

Provides a concrete builder for routing event activities in an AgentApplication.

public class EventRouteBuilder : Microsoft.Agents.Builder.App.EventRouteBuilderBase<Microsoft.Agents.Builder.App.EventRouteBuilder>
type EventRouteBuilder = class
    inherit EventRouteBuilderBase<EventRouteBuilder>
Public Class EventRouteBuilder
Inherits EventRouteBuilderBase(Of EventRouteBuilder)
Inheritance

Remarks

Use EventRouteBuilder when you need an event route that uses the standard RouteHandler delegate. This type inherits the shared event matching behavior from EventRouteBuilderBase<TBuilder>, including event-name filters, custom selectors, channel constraints, and agentic routing support.

Constructors

Name Description
EventRouteBuilder()

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.

(Inherited from EventRouteBuilderBase<TBuilder>)
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 EventRouteBuilder class.

PreBuild() (Inherited from EventRouteBuilderBase<TBuilder>)
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 event route to match event activities whose name satisfies the specified regular expression pattern.

(Inherited from EventRouteBuilderBase<TBuilder>)
WithName(String)

Configures the route to match event activities with the specified name, using a case-insensitive comparison.

(Inherited from EventRouteBuilderBase<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.

(Inherited from EventRouteBuilderBase<TBuilder>)

Applies to