BotFrameworkAuthenticationFactory class

  • Reference
Package:
botframework-connector

A factory for BotFrameworkAuthentication which encapsulates the environment specific Bot Framework Protocol auth code.

Methods

create()

Creates a new BotFrameworkAuthentication instance for anonymous testing scenarios.
create(string, boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Creates the appropriate BotFrameworkAuthentication instance.

Method Details

create()

Creates a new BotFrameworkAuthentication instance for anonymous testing scenarios.

static function create(): BotFrameworkAuthentication

Returns

BotFrameworkAuthentication

A new BotFrameworkAuthentication instance.

create(string, boolean, string, string, string, string, string, string, string, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Creates the appropriate BotFrameworkAuthentication instance.

static function create(channelService: string, validateAuthority: boolean, toChannelFromBotLoginUrl: string, toChannelFromBotOAuthScope: string, toBotFromChannelTokenIssuer: string, oAuthUrl: string, toBotFromChannelOpenIdMetadataUrl: string, toBotFromEmulatorOpenIdMetadataUrl: string, callerId: string, credentialFactory: ServiceClientCredentialsFactory, authConfiguration: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication

Parameters

channelService

string

The Channel Service.

validateAuthority

boolean

The validate authority value to use.

toChannelFromBotLoginUrl

string

The to Channel from bot login url.

toChannelFromBotOAuthScope

string

The to Channel from bot oauth scope.

toBotFromChannelTokenIssuer

string

The to bot from Channel Token Issuer.

oAuthUrl

string

The OAuth url.

toBotFromChannelOpenIdMetadataUrl

string

The to bot from Channel Open Id Metadata url.

toBotFromEmulatorOpenIdMetadataUrl

string

The to bot from Emulator Open Id Metadata url.

callerId

string

The callerId set on on authenticated Activities.

credentialFactory
ServiceClientCredentialsFactory

The ServiceClientCredentialsFactory to use to create credentials.

authConfiguration
AuthenticationConfiguration

The AuthenticationConfiguration to use.

botFrameworkClientFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

The fetch to use in BotFrameworkClient.

connectorClientOptions
ConnectorClientOptions

The ConnectorClientOptions to use when creating ConnectorClients.

Returns

BotFrameworkAuthentication