InvokeRouteAttribute Class

Definition

[Microsoft.Agents.Builder.App.RouteHandlerType(typeof(Microsoft.Agents.Builder.App.RouteHandler))]
[System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)]
public class InvokeRouteAttribute : Attribute, Microsoft.Agents.Builder.App.IRouteAttribute

[<Microsoft.Agents.Builder.App.RouteHandlerType(typeof(Microsoft.Agents.Builder.App.RouteHandler))>]
[<System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)>]
type InvokeRouteAttribute = class
    inherit Attribute
    interface IRouteAttribute

Public Class InvokeRouteAttribute
Inherits Attribute
Implements IRouteAttribute

Inheritance

Attribute

InvokeRouteAttribute

Attributes

RouteHandlerTypeAttribute AttributeUsageAttribute

Implements

IRouteAttribute

Remarks

Decorate a method with this attribute to register it as a handler for invoke activities. Provide name for an exact match, nameRegex for a pattern match, or neither to match any invoke. name and nameRegex are mutually exclusive. The method must match the RouteHandler delegate signature.

// Match any invoke
[InvokeRoute]
public async Task OnAnyInvokeAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
    // Handle any invoke activity
}

// Match a specific invoke
[InvokeRoute("myInvoke")]
public async Task OnMyInvokeAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
    // Handle "myInvoke" invoke
}

// Match an invoke name pattern
[InvokeRoute(nameRegex: "my.*Invoke")]
public async Task OnMyInvokePatternAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
    // Handle invokes matching pattern
}