HandoffRouteAttribute(Boolean, UInt16, String) Constructor

Definition

Attribute to define a route that handles handoff action invoke activities.

public HandoffRouteAttribute(bool isAgenticOnly = false, ushort rank = 32767, string autoSignInHandlers = default);
new Microsoft.Agents.Builder.App.HandoffRouteAttribute : bool * uint16 * string -> Microsoft.Agents.Builder.App.HandoffRouteAttribute
Public Sub New (Optional isAgenticOnly As Boolean = false, Optional rank As UShort = 32767, Optional autoSignInHandlers As String = Nothing)

Parameters

isAgenticOnly
Boolean

When true, the route only fires for agentic turns. Defaults to false.

rank
UInt16

Route evaluation order. Lower values run first. Defaults to Unspecified.

autoSignInHandlers
String

A comma/space/semicolon-delimited list of OAuth sign-in handler names, or the name of an instance or static method on the agent class matching Func<ITurnContext, string[]>.

Remarks

Decorate a method with this attribute to register it as a handler for handoff/action invoke activities. The method must match the HandoffHandler delegate signature.

[HandoffRoute]
public async Task OnHandoffAsync(ITurnContext turnContext, ITurnState turnState, string continuation, CancellationToken cancellationToken)
{
    // Handle handoff action
}

Applies to