TeamsQueryRouteAttribute(String, String, Boolean, UInt16, String) Constructor
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Attribute to define a route that handles Teams message extension query events for a specific command.
public TeamsQueryRouteAttribute(string commandId = default, string commandIdPattern = default, bool isAgenticOnly = false, ushort rank = 32767, string signInHandlers = default);new Microsoft.Agents.Extensions.MSTeams.MessageExtensions.TeamsQueryRouteAttribute : string * string * bool * uint16 * string -> Microsoft.Agents.Extensions.MSTeams.MessageExtensions.TeamsQueryRouteAttributePublic Sub New (Optional commandId As String = Nothing, Optional commandIdPattern As String = Nothing, Optional isAgenticOnly As Boolean = false, Optional rank As UShort = 32767, Optional signInHandlers As String = Nothing)Parameters
- commandId
- String
The message extension command ID to match. Mutually exclusive with commandIdPattern.
- commandIdPattern
- String
The regular expression pattern to match the message extension command ID. Mutually exclusive with commandId.
- 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.
- signInHandlers
- String
A comma/space/semicolon-delimited list of OAuth sign-in handler names, or the name of an instance method on the agent class matching Func<ITurnContext, string[]>.
Remarks
Decorate a method with this attribute to register it as a handler for message extension query events in Teams. The method must match the QueryHandler delegate signature.
[TeamsQueryRoute("searchProducts")]
public async Task<Response> OnSearchProductsAsync(ITeamsTurnContext turnContext, ITurnState turnState, Microsoft.Teams.Api.MessageExtensions.Query query, CancellationToken cancellationToken)
{
var keyword = query.Parameters.FirstOrDefault()?.Value ?? string.Empty;
var items = await _catalog.SearchAsync(keyword, cancellationToken);
var attachments = items.Select(i => i.ToHeroCard().ToMessagingExtensionAttachment()).ToList();
return new Response { ComposeExtension = new Result { Type = ResultType.List, Attachments = attachments } };
}
Alternatively, OnQuery(String, QueryHandler, String[], UInt16) can be used to register the handler via the fluent API.