ApplicationOptions interface

  • Reference
Package:
@microsoft/teams-ai

Options for the Application class.

Properties

adapter

Optional. Options used to initialize your BotAdapter
adaptiveCards

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

Optional. AI options to use. When provided, a new instance of the AI system will be created.
authentication

Optional. OAuth prompt settings to use for authentication.
botAppId

Optional. Application ID of the bot.
fileDownloaders

Optional. Array of input file download plugins to use.
longRunningMessages

Optional. If true, the bot supports long running messages that can take longer then the 10 - 15 second timeout imposed by most channels. Defaults to false.
removeRecipientMention

Optional. If true, the bot will automatically remove mentions of the bot's name from incoming messages. Defaults to true.
startTypingTimer

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

Optional. Storage provider to use for the application.
taskModules

Optional. Options used to customize the processing of task module requests.
turnStateFactory

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

Property Details

adapter

Optional. Options used to initialize your BotAdapter

adapter?: TeamsAdapter

Property Value

TeamsAdapter

adaptiveCards

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

adaptiveCards?: AdaptiveCardsOptions

Property Value

AdaptiveCardsOptions

ai

Optional. AI options to use. When provided, a new instance of the AI system will be created.

ai?: AIOptions<TState>

Property Value

AIOptions<TState>

authentication

Optional. OAuth prompt settings to use for authentication.

authentication?: AuthenticationOptions

Property Value

AuthenticationOptions

botAppId

Optional. Application ID of the bot.

botAppId?: string

Property Value

string

Remarks

If using the longRunningMessages option or calling the continueConversationAsync() method, this property is required.

fileDownloaders

Optional. Array of input file download plugins to use.

fileDownloaders?: InputFileDownloader<TState>[]

Property Value

InputFileDownloader<TState>[]

longRunningMessages

Optional. If true, the bot supports long running messages that can take longer then the 10 - 15 second timeout imposed by most channels. Defaults to false.

longRunningMessages: boolean

Property Value

boolean

Remarks

This works by immediately converting the incoming request to a proactive conversation. Care should be used for bots that operate in a shared hosting environment. The incoming request is immediately completed and many shared hosting environments will mark the bot's process as idle and shut it down.

removeRecipientMention

Optional. If true, the bot will automatically remove mentions of the bot's name from incoming messages. Defaults to true.

removeRecipientMention: boolean

Property Value

boolean

startTypingTimer

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

startTypingTimer: boolean

Property Value

boolean

storage

Optional. Storage provider to use for the application.

storage?: Storage

Property Value

Storage

taskModules

Optional. Options used to customize the processing of task module requests.

taskModules?: TaskModulesOptions

Property Value

TaskModulesOptions

turnStateFactory

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

turnStateFactory: () => TState

Property Value

() => TState