HandoffRouteBuilder Class

Definition

Provides a concrete builder for routing handoff invoke activities in an AgentApplication.

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

Remarks

Use HandoffRouteBuilder when you need a handoff route that uses the standard HandoffHandler delegate. This type inherits the shared handoff selection behavior from HandoffRouteBuilderBase<TBuilder>.

Constructors

Name Description
HandoffRouteBuilder()

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 HandoffRouteBuilderBase<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 HandoffRouteBuilder class for constructing route definitions.

PreBuild() (Inherited from RouteBuilderBase<TBuilder>)
WithChannelId(ChannelId)

Sets the channel identifier for the route and returns the builder instance for method chaining.

(Inherited from RouteBuilderBase<TBuilder>)
WithHandler(HandoffHandler)

Configures the route to handle handoff actions using the specified handler.

WithHandlerCore(HandoffHandler)

Configures the route to handle handoff actions using the specified handler.

(Inherited from HandoffRouteBuilderBase<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 the route selector used to determine how incoming requests are matched to this route builder.

(Inherited from RouteBuilderBase<TBuilder>)

Applies to