Class AgentApplicationOptions

Namespace

Microsoft.Agents.Builder.App

Assembly

Microsoft.Agents.Builder.dll

Options for the AgentApplication class.

public class AgentApplicationOptions

Inheritance

object

AgentApplicationOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AgentApplicationOptions()

public AgentApplicationOptions()

AgentApplicationOptions(IServiceProvider, IConfiguration, IChannelAdapter, IStorage, UserAuthorizationOptions, AdaptiveCardsOptions, ILoggerFactory, IList<IInputFileDownloader>, string)

Creates AgentApplicationOptions from IConfiguration and DI.

public AgentApplicationOptions(IServiceProvider sp, IConfiguration configuration, IChannelAdapter channelAdapter, IStorage storage = null, UserAuthorizationOptions authOptions = null, AdaptiveCardsOptions cardOptions = null, ILoggerFactory loggerFactory = null, IList<IInputFileDownloader> fileDownloaders = null, string configKey = "AgentApplication")

Parameters

sp IServiceProvider

configuration IConfiguration

channelAdapter IChannelAdapter

storage IStorage

The IStorage used by UserAuthorization.

authOptions UserAuthorizationOptions

cardOptions AdaptiveCardsOptions

loggerFactory ILoggerFactory

fileDownloaders IList<IInputFileDownloader>

configKey string

Properties

Adapter

public IChannelAdapter? Adapter { get; set; }

Property Value

IChannelAdapter

AdaptiveCards

Optional. Options used to customize the processing of Adaptive Card requests.

public AdaptiveCardsOptions? AdaptiveCards { get; set; }

Property Value

AdaptiveCardsOptions

FileDownloaders

Optional. Array of input file download plugins to use.

public IList<IInputFileDownloader>? FileDownloaders { get; set; }

Property Value

IList<IInputFileDownloader>

LoggerFactory

Optional. Logger factory that will be used in this application.

public ILoggerFactory? LoggerFactory { get; set; }

Property Value

ILoggerFactory

NormalizeMentions

Optional. If true, the Agent will automatically normalize mentions across channels. Defaults to true.

public bool NormalizeMentions { get; set; }

Property Value

bool

RemoveRecipientMention

Optional. If true, the Agent will automatically remove mentions of the Agents name from incoming messages. Defaults to true.

public bool RemoveRecipientMention { get; set; }

Property Value

bool

StartTypingTimer

Optional. If true, the Agent will automatically start a typing timer when messages are received. This allows the Agent to automatically indicate that it's received the message and is processing the request. Defaults to true.

public bool StartTypingTimer { get; set; }

Property Value

bool

TurnStateFactory

Optional. Factory used to create a custom turn state instance.

public Func<ITurnState>? TurnStateFactory { get; set; }

Property Value

Func<ITurnState>

UserAuthorization

Optional. Options used to enable user authorization for the application.

public UserAuthorizationOptions UserAuthorization { get; set; }

Property Value

UserAuthorizationOptions