Share via

ConversationOptions interface

Package:
@microsoft/teamsfx

Warning

This API is now deprecated.

This package will be deprecated by 2026-07. Please use Microsoft 365 Agents SDK instead.

Options to initialize ConversationBot

Properties

adapter

The bot adapter. If not provided, a default adapter will be created:

  • with adapterConfig as constructor parameter.
  • with a default error handler that logs error to console, sends trace activity, and sends error message to user.
adapterConfig

If adapter is not provided, this adapterConfig will be passed to the new CloudAdapter when created internally.
cardAction

The adaptive card action handler part.
command

The command part.
notification

The notification part.
ssoConfig

Configurations for sso command bot

Property Details

adapter

The bot adapter. If not provided, a default adapter will be created:

  • with adapterConfig as constructor parameter.
  • with a default error handler that logs error to console, sends trace activity, and sends error message to user.
adapter?: CloudAdapter

Property Value

CloudAdapter

Remarks

If neither adapter nor adapterConfig is provided, will use BOT_ID and BOT_PASSWORD from environment variables.

adapterConfig

If adapter is not provided, this adapterConfig will be passed to the new CloudAdapter when created internally.

adapterConfig?: AuthConfiguration

Property Value

AuthConfiguration

Remarks

If neither adapter nor adapterConfig is provided, will use BOT_ID and BOT_PASSWORD from environment variables.

cardAction

The adaptive card action handler part.

cardAction?: CardActionOptions & { enabled?: boolean }

Property Value

CardActionOptions & { enabled?: boolean }

command

The command part.

command?: CommandOptions & { enabled?: boolean }

Property Value

CommandOptions & { enabled?: boolean }

notification

The notification part.

notification?: NotificationOptions_2 & { enabled?: boolean }

Property Value

NotificationOptions & { enabled?: boolean }

ssoConfig

Configurations for sso command bot

ssoConfig?: BotSsoConfig

Property Value

BotSsoConfig