TeamsTaskSubmitRouteAttribute(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 task module submit events. The decorated method must match the TaskSubmitHandler delegate signature — the third parameter must be Microsoft.Teams.Api.TaskModules.Request.
public TeamsTaskSubmitRouteAttribute(string value = default, string key = default, bool isAgenticOnly = false, ushort rank = 32767, string signInHandlers = default);new Microsoft.Agents.Extensions.MSTeams.TaskModules.TeamsTaskSubmitRouteAttribute : string * string * bool * uint16 * string -> Microsoft.Agents.Extensions.MSTeams.TaskModules.TeamsTaskSubmitRouteAttributePublic Sub New (Optional value As String = Nothing, Optional key As String = Nothing, Optional isAgenticOnly As Boolean = false, Optional rank As UShort = 32767, Optional signInHandlers As String = Nothing)Parameters
- value
- String
The task module key value to match. If null, this will match for any submit request.
- key
- String
The JSON field name used to identify the key in the task data. Defaults to "task" if not specified.
- 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 Teams task module submit events.
[TeamsTaskSubmitRoute("myKey")]
public async Task<Microsoft.Teams.Api.TaskModules.Response> OnSubmitAsync(ITeamsTurnContext turnContext, ITurnState turnState, Microsoft.Teams.Api.TaskModules.Request request, CancellationToken cancellationToken)
{
// Handle task module submit event
}
Alternatively, OnSubmit(String, TaskSubmitHandler, String, String[], UInt16) can be used to register the handler via the fluent API.