MessageRouteAttribute Class

Definition

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

[<System.AttributeUsage(System.AttributeTargets.Method, Inherited=true)>]
type MessageRouteAttribute = class
    inherit Attribute
    interface IRouteAttribute

Public Class MessageRouteAttribute
Inherits Attribute
Implements IRouteAttribute

Inheritance

Attribute

MessageRouteAttribute

Attributes

AttributeUsageAttribute

Implements

IRouteAttribute

Remarks

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

// Match any message
[MessageRoute]
public async Task OnMessageAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
    // Handle any message
}

// Match a specific message
[MessageRoute("hello")]
public async Task OnHelloAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
    // Handle "hello" message
}

// Match a text pattern
[MessageRoute(textRegex: "he.*o")]
public async Task OnHelloPatternAsync(ITurnContext turnContext, ITurnState turnState, CancellationToken cancellationToken)
{
    // Handle messages matching pattern
}