Language

SettingRouteBuilder Class

Definition

Provides a builder for configuring settings routes in an AgentApplication.

public class SettingRouteBuilder : Microsoft.Agents.Builder.App.RouteBuilderBase<Microsoft.Agents.Extensions.MSTeams.MessageExtensions.SettingRouteBuilder>
type SettingRouteBuilder = class
    inherit RouteBuilderBase<SettingRouteBuilder>
Public Class SettingRouteBuilder
Inherits RouteBuilderBase(Of SettingRouteBuilder)
Inheritance

Remarks

Use SettingRouteBuilder to create and configure routes that respond to Activity Type of Invoke with a name of Microsoft.Teams.Api.Activities.Invokes.Name.MessageExtensions.Setting.

Constructors

Name Description
SettingRouteBuilder()

Fields

Name Description
_route (Inherited from RouteBuilderBase<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.

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 SettingRouteBuilder class for constructing route definitions.

PreBuild()
WithChannelId(ChannelId)

Sets the channel identifier for the route and returns the builder instance for method chaining.

(Inherited from RouteBuilderBase<TBuilder>)
WithHandler(SettingHandler)

Configures the route to use the specified asynchronous handler for processing configure settings.

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>)

Applies to