ConfigurationBotFrameworkAuthentication class

Пакет:

botbuilder-core

Создает экземпляр BotFrameworkAuthentication из объекта со значениями проверки подлинности или экземпляром configuration.

Extends

BotFrameworkAuthentication

Конструкторы

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Инициализирует новый экземпляр класса ConfigurationBotFrameworkAuthentication.

Методы

authenticateChannelRequest(string)	Проверка подлинности запросов протокола Bot Framework к навыкам.
authenticateRequest(Activity, string)	Проверьте запросы протокола Bot Framework.
authenticateStreamingRequest(string, string)	Проверьте запросы протокола Bot Framework.
createBotFrameworkClient()	Создает BotFrameworkClient для вызова навыков.
createConnectorFactory(ClaimsIdentity)	Создает connectorFactory, который можно использовать для создания соединителейClients, которые могут использовать учетные данные из этой конкретной облачной среды.
createUserTokenClient(ClaimsIdentity)	Создает соответствующий экземпляр UserTokenClient.

Наследуемые методы

getOriginatingAudience()

Возвращает исходную аудиторию из области бота OAuth.

Сведения о конструкторе

ConfigurationBotFrameworkAuthentication(ConfigurationBotFrameworkAuthenticationOptions, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Инициализирует новый экземпляр класса ConfigurationBotFrameworkAuthentication.

new ConfigurationBotFrameworkAuthentication(botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions)

Параметры

botFrameworkAuthConfig

ConfigurationBotFrameworkAuthenticationOptions

Объект ConfigurationBotFrameworkAuthenticationOptions.

credentialsFactory

ServiceClientCredentialsFactory

Экземпляр ServiceClientCredentialsFactory.

authConfiguration

AuthenticationConfiguration

Объект configuration.

botFrameworkClientFetch

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

Пользовательская реализация получения, используемая в BotFrameworkClient.

connectorClientOptions

ConnectorClientOptions

Объект connectorClientOptions .

Сведения о методе

authenticateChannelRequest(string)

Проверка подлинности запросов протокола Bot Framework к навыкам.

function authenticateChannelRequest(authHeader: string): Promise<ClaimsIdentity>

Параметры

authHeader

string

Заголовок проверки подлинности http, полученный в запросе навыка.

Возвращаемое значение

Promise<ClaimsIdentity>

ClaimsIdentity.

authenticateRequest(Activity, string)

Проверьте запросы протокола Bot Framework.

function authenticateRequest(activity: Activity, authHeader: string): Promise<AuthenticateRequestResult>

Параметры

activity

Activity

Входящее действие.

authHeader

string

Заголовок проверки подлинности HTTP.

Возвращаемое значение

Promise<AuthenticateRequestResult>

АутентификацияRequestResult.

authenticateStreamingRequest(string, string)

Проверьте запросы протокола Bot Framework.

function authenticateStreamingRequest(authHeader: string, channelIdHeader: string): Promise<AuthenticateRequestResult>

Параметры

authHeader

string

Заголовок проверки подлинности HTTP.

channelIdHeader

string

Заголовок HTTP идентификатора канала.

Возвращаемое значение

Promise<AuthenticateRequestResult>

АутентификацияRequestResult.

createBotFrameworkClient()

Создает BotFrameworkClient для вызова навыков.

function createBotFrameworkClient(): BotFrameworkClient

Возвращаемое значение

BotFrameworkClient

BotFrameworkClient.

createConnectorFactory(ClaimsIdentity)

Создает connectorFactory, который можно использовать для создания соединителейClients, которые могут использовать учетные данные из этой конкретной облачной среды.

function createConnectorFactory(claimsIdentity: ClaimsIdentity): ConnectorFactory

Параметры

claimsIdentity

ClaimsIdentity

Свойство ClaimsIdentity входящего действия.

Возвращаемое значение

ConnectorFactory

соединителя .

createUserTokenClient(ClaimsIdentity)

Создает соответствующий экземпляр UserTokenClient.

function createUserTokenClient(claimsIdentity: ClaimsIdentity): Promise<UserTokenClient>

Параметры

claimsIdentity

ClaimsIdentity

Свойство ClaimsIdentity входящего действия.

Возвращаемое значение

Promise<UserTokenClient>

userTokenClient .

Сведения о наследуемом методе

getOriginatingAudience()

Возвращает исходную аудиторию из области бота OAuth.

function getOriginatingAudience(): string

Возвращаемое значение

string

Исходная аудитория.

унаследовано от BotFrameworkAuthentication.getOriginatingAudience