BotFrameworkAdapterSettings interface

Package:

botbuilder

Warning

This API is now deprecated.

Use CloudAdapter with ConfigurationBotFrameworkAuthentication instead to configure bot runtime. Contains settings used to configure a BotFrameworkAdapter instance.

Properties

appId	The ID assigned to your bot in the Bot Framework Portal.
appPassword	The password assigned to your bot in the Bot Framework Portal.
authConfig	Optional. Used to require specific endorsements and verify claims. Recommended for Skills.
certificatePrivateKey	Optional. Certificate key to authenticate the appId against AAD.
certificateThumbprint	Optional. Certificate thumbprint to authenticate the appId against AAD.
channelAuthTenant	Optional. The tenant to acquire the bot-to-channel token from.
channelService	Optional. The channel service option for this bot to validate connections from Azure or other channel locations.
clientOptions	Optional. Used when creating new ConnectorClients.
oAuthEndpoint	Optional. The OAuth API endpoint for your bot to use.
openIdMetadata	Optional. The OpenID Metadata endpoint for your bot to use.
webSocketFactory	Optional. Used to pass in a NodeWebSocketFactoryBase instance.

Property Details

appId

The ID assigned to your bot in the Bot Framework Portal.

appId: string

Property Value

string

appPassword

The password assigned to your bot in the Bot Framework Portal.

appPassword: string

Property Value

string

authConfig

Optional. Used to require specific endorsements and verify claims. Recommended for Skills.

authConfig?: AuthenticationConfiguration

Property Value

AuthenticationConfiguration

certificatePrivateKey

Optional. Certificate key to authenticate the appId against AAD.

certificatePrivateKey?: string

Property Value

string

certificateThumbprint

Optional. Certificate thumbprint to authenticate the appId against AAD.

certificateThumbprint?: string

Property Value

string

channelAuthTenant

Optional. The tenant to acquire the bot-to-channel token from.

channelAuthTenant?: string

Property Value

string

channelService

Optional. The channel service option for this bot to validate connections from Azure or other channel locations.

channelService?: string

Property Value

string

clientOptions

Optional. Used when creating new ConnectorClients.

clientOptions?: ConnectorClientOptions

Property Value

ConnectorClientOptions

oAuthEndpoint

Optional. The OAuth API endpoint for your bot to use.

oAuthEndpoint?: string

Property Value

string

openIdMetadata

Optional. The OpenID Metadata endpoint for your bot to use.

openIdMetadata?: string

Property Value

string

webSocketFactory

Optional. Used to pass in a NodeWebSocketFactoryBase instance.

webSocketFactory?: NodeWebSocketFactoryBase

Property Value

NodeWebSocketFactoryBase