MessageExtension.OnSetting(SettingHandler, String[], UInt16) Method
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.
Registers a handler that processes the configure settings event for a Message Extension.
public Microsoft.Agents.Extensions.MSTeams.MessageExtensions.MessageExtension OnSetting(Microsoft.Agents.Extensions.MSTeams.MessageExtensions.SettingHandler handler, string[] autoSignInHandlers = default, ushort rank = 32767);member this.OnSetting : Microsoft.Agents.Extensions.MSTeams.MessageExtensions.SettingHandler * string[] * uint16 -> Microsoft.Agents.Extensions.MSTeams.MessageExtensions.MessageExtensionPublic Function OnSetting (handler As SettingHandler, Optional autoSignInHandlers As String() = Nothing, Optional rank As UShort = 32767) As MessageExtensionParameters
- handler
- SettingHandler
A delegate that processes the settings event. The handler receives the turn context, turn state, deserialized settings data of type Microsoft.Teams.Api.MessageExtensions.Query, and a cancellation token. Cannot be null.
- autoSignInHandlers
- String[]
OAuth sign-in handler names for automatic sign-in before the route handler is invoked. Specify null to skip automatic sign-in.
- rank
- UInt16
Route evaluation order. Lower values run first. Defaults to Unspecified.
Returns
The current MessageExtension instance for method chaining.
Remarks
``` TeamsExtension.MessageExtensions.OnSetting((ctx, state, query, ct) => { var setting = query.Parameters.FirstOrDefault()?.Value ?? string.Empty; _settingsStore.Save(ctx.Activity.From.Id, setting); return Task.FromResult(new Response { ComposeExtension = new Result { Type = ResultType.Config } }); }); ``` Alternatively, the TeamsSettingRouteAttribute can be used to decorate a SettingHandler method for the same purpose.