QueryRouteBuilder Class
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.
Provides a builder for configuring query routes in an AgentApplication.
public class QueryRouteBuilder : Microsoft.Agents.Extensions.MSTeams.MessageExtensions.CommandRouteBuilderBase<Microsoft.Agents.Extensions.MSTeams.MessageExtensions.QueryRouteBuilder>type QueryRouteBuilder = class
inherit CommandRouteBuilderBase<QueryRouteBuilder>Public Class QueryRouteBuilder
Inherits CommandRouteBuilderBase(Of QueryRouteBuilder)- Inheritance
Remarks
Use QueryRouteBuilder to create and configure routes that respond to Activity Type of Invoke with a name of Microsoft.Teams.Api.Activities.Invokes.Name.MessageExtensions.Query, optionally filtered by command ID via WithCommand(String).
Constructors
| Name | Description |
|---|---|
| QueryRouteBuilder() | |
Fields
| Name | Description |
|---|---|
| _route | (Inherited from RouteBuilderBase<TBuilder>) |
Properties
| Name | Description |
|---|---|
| InvokeName | (Inherited from CommandRouteBuilderBase<TBuilder>) |
| PreviewAction | (Inherited from CommandRouteBuilderBase<TBuilder>) |
Methods
| Name | Description |
|---|---|
| AsAgentic(Boolean) |
Configures the route to operate in agentic mode, enabling behaviors associated with agentic processing. (Inherited from RouteBuilderBase<TBuilder>) |
| AsInvoke(Boolean) |
Returns the current route builder instance configured for Invoke routing. This method ensures that the route remains set as an Invoke route. (Inherited from CommandRouteBuilderBase<TBuilder>) |
| AsNonTerminal() |
Marks the current route as non-terminal and returns the updated builder instance. (Inherited from RouteBuilderBase<TBuilder>) |
| Build() |
Builds and returns the configured route instance after validating required components. (Inherited from RouteBuilderBase<TBuilder>) |
| Create() |
Creates a new instance of the QueryRouteBuilder class for constructing route definitions. |
| PreBuild() | (Inherited from CommandRouteBuilderBase<TBuilder>) |
| WithChannelId(ChannelId) |
Sets the channel identifier for the route and returns the builder instance for method chaining. (Inherited from RouteBuilderBase<TBuilder>) |
| WithCommand(Regex) |
Match a specific command name pattern. (Inherited from CommandRouteBuilderBase<TBuilder>) |
| WithCommand(String) |
Match a specific command name. (Inherited from CommandRouteBuilderBase<TBuilder>) |
| WithHandler(QueryHandler) |
Configures the route to use the specified asynchronous handler for processing query. |
| WithOAuthHandlers(Func<ITurnContext,String[]>) |
Configures OAuth handler functions for the route using the specified delegate. (Inherited from RouteBuilderBase<TBuilder>) |
| WithOAuthHandlers(String) |
Configures the builder to use one or more OAuth authentication handlers specified in a delimited string. (Inherited from RouteBuilderBase<TBuilder>) |
| WithOAuthHandlers(String[]) |
Configures the route to use the specified OAuth authentication handlers. (Inherited from RouteBuilderBase<TBuilder>) |
| WithOrderRank(UInt16) |
Sets the order rank for the route and returns the current builder instance for further configuration. (Inherited from RouteBuilderBase<TBuilder>) |
| WithSelector(RouteSelector) |
Sets the route selector used to determine how incoming requests are matched to this route builder. (Inherited from RouteBuilderBase<TBuilder>) |