BotFrameworkAuthentication class

Пакет:

botframework-connector

Представляет облачную среду, используемую для проверки подлинности сетевых вызовов протокола Bot Framework в этой среде.

Методы

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.

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

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

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