ConfigurationServiceClientCredentialFactory class

Package:

botbuilder-core

ServiceClientCredentialsFactory that uses a ConfigurationServiceClientCredentialFactoryOptions or a Configuration instance to build ServiceClientCredentials with an AppId and App Password.

Extends

PasswordServiceClientCredentialFactory

Constructors

ConfigurationServiceClientCredentialFactory(ConfigurationServiceClientCredentialFactoryOptions)

Initializes a new instance of the ConfigurationServiceClientCredentialFactory class.

Inherited Properties

appId	The app ID for this credential.
password	The app password for this credential.
tenantId	The tenant ID of the Azure AD tenant where the bot is created.

Methods

createCredentials(string, string, string, boolean)
isAuthenticationDisabled()
isValidAppId(string)

Constructor Details

ConfigurationServiceClientCredentialFactory(ConfigurationServiceClientCredentialFactoryOptions)

Initializes a new instance of the ConfigurationServiceClientCredentialFactory class.

new ConfigurationServiceClientCredentialFactory(factoryOptions?: ConfigurationServiceClientCredentialFactoryOptions)

Parameters

factoryOptions

ConfigurationServiceClientCredentialFactoryOptions

A ConfigurationServiceClientCredentialFactoryOptions object.

Inherited Property Details

appId

The app ID for this credential.

appId: string | null

Property Value

string | null

Inherited From PasswordServiceClientCredentialFactory.appId

password

The app password for this credential.

password: string | null

Property Value

string | null

Inherited From PasswordServiceClientCredentialFactory.password

tenantId

The tenant ID of the Azure AD tenant where the bot is created.

tenantId: string | null

Property Value

string | null

Inherited From PasswordServiceClientCredentialFactory.tenantId

Method Details

createCredentials(string, string, string, boolean)

function createCredentials(microsoftAppId: string, audience: string, loginEndpoint: string, validateAuthority: boolean): Promise<ServiceClientCredentials>

Parameters

microsoftAppId

string

audience

string

loginEndpoint

string

validateAuthority

boolean

Returns

Promise<ServiceClientCredentials>

isAuthenticationDisabled()

function isAuthenticationDisabled(): Promise<boolean>

Returns

Promise<boolean>

isValidAppId(string)

function isValidAppId(microsoftAppId: string): Promise<boolean>

Parameters

microsoftAppId

string

Returns

Promise<boolean>