BotFrameworkAdapter Класс

Ссылка

Определение

Пространство имен:: Microsoft.Bot.Builder

Сборка:: Microsoft.Bot.Builder.dll

Пакет:: Microsoft.Bot.Builder v4.22.7

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Адаптер бота, который может подключить бота к конечной точке службы.

public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder

type BotFrameworkAdapter = class
    inherit BotAdapter
    interface IAdapterIntegration
    interface IExtendedUserTokenProvider
    interface IUserTokenProvider
    interface IConnectorClientBuilder

Public Class BotFrameworkAdapter
Inherits BotAdapter
Implements IAdapterIntegration, IConnectorClientBuilder, IExtendedUserTokenProvider

Наследование: Object

BotAdapter
BotFrameworkAdapter

Производный: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Реализации: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

BotFrameworkAdapter по-прежнему поддерживается, но рекомендуемый адаптер — CloudAdapter. Адаптер бота инкапсулирует процессы проверки подлинности и отправляет действия и получает действия из службы Соединителя Бота. Когда бот получает действие, адаптер создает объект контекста, передает его логике приложения бота и отправляет ответы обратно в канал пользователя.

Используйте Use(IMiddleware) для добавления объектов IMiddleware в коллекцию ПО промежуточного слоя адаптера. Адаптер обрабатывает и направляет входящие действия через конвейер ПО промежуточного слоя бота в логику бота, а затем снова возвращается. По мере того как каждое действие выполняется в боте, каждый элемент ПО промежуточного слоя может проверять или действовать в действии как до, так и после выполнения логики бота.

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

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.

Поля

BotIdentityKey	Строковое значение ключа удостоверения бота. (Унаследовано от BotAdapter)
InvokeResponseKey	Значение ключа для любого invokeResponseActivity, которое будет находиться в TurnState. (Унаследовано от BotAdapter)
OAuthScopeKey	Строковое значение ключа области OAuth. (Унаследовано от BotAdapter)

Свойства

AppCredentialMap	Получает карту приложений для AppCredentials для этого адаптера.
ChannelProvider	Возвращает поставщика каналов для этого адаптера.
CredentialProvider	Возвращает поставщик учетных данных для этого адаптера.
HttpClient	Возвращает пользовательский HttpClient для этого адаптера, если он указан.
Logger	Возвращает средство ведения журнала для этого адаптера.
MiddlewareSet	Возвращает коллекцию ПО промежуточного слоя в конвейере адаптера. (Унаследовано от BotAdapter)
OnTurnError	Возвращает или задает обработчик ошибок, который может перехватывать исключения в по промежуточном слоях или приложении. (Унаследовано от BotAdapter)

Методы

BuildCredentialsAsync(String, String)	Логика создания объекта AppCredentials для получения маркеров для этого HttpClient.
CanProcessOutgoingActivity(Activity)	Возможность для подклассов принять участие в обработке исходящего действия.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Отправляет упреждающее сообщение в беседу. (Унаследовано от BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Отправляет упреждающее сообщение в беседу. (Унаследовано от BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Отправляет упреждающее сообщение от бота в беседу.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Отправляет упреждающее сообщение от бота в беседу.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Отправляет упреждающее сообщение в беседу. (Унаследовано от BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Отправляет упреждающее сообщение от бота в беседу.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Создает беседу на указанном канале.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Устаревшие.. Создает беседу на указанном канале. Перегрузка получает ConversationReference, включая клиент.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Создает беседу на указанном канале.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Устаревшие.. Создает беседу на указанном канале. Перегрузка получает ConversationReference, включая клиент.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Создает беседу на указанном канале. (Унаследовано от BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Создает клиент OAuth для бота.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Создает клиент OAuth для бота с учетными данными.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Удаляет существующее действие в беседе.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Удаляет члена из текущей беседы.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Выполняет операцию обмена маркерами, например для единого входа.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Выполняет операцию обмена маркерами, например для единого входа.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении с помощью настраиваемых appCredentials.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении с помощью appCredentials бота.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Выводит список членов заданного действия.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Выводит список членов текущей беседы.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов. Сервер каналов возвращает результаты на страницах, и каждая страница будет включать `continuationToken`, которые можно использовать для получения следующей страницы результатов с сервера.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов. Сервер каналов возвращает результаты на страницах, и каждая страница будет включать `continuationToken`, которые можно использовать для получения следующей страницы результатов с сервера.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Получите ссылку необработанного входа, отправляемую пользователю для входа для имени подключения с помощью настроенных AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Получите ссылку необработанного входа, отправляемую пользователю для входа для имени подключения с помощью настроенных AppCredentials.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Получите ссылку необработанного входа, которую нужно отправить пользователю для входа для имени подключения с помощью appCredentials бота.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Получите ссылку необработанного входа, которую нужно отправить пользователю для входа для имени подключения с помощью appCredentials бота.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью настраиваемых appCredentials.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью appCredentials бота.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Пытается получить маркер для пользователя, который находится в потоке входа, с помощью настраиваемых AppCredentials.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Пытается получить маркер для пользователя, который находится в потоке входа, с помощью appCredentials бота.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Пользовательская логика для отправки исходящего действия. Подклассы могут переопределить этот метод вместе с CanProcessOutgoingActivity, чтобы иметь пользовательскую логику для обработки исходящего действия.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Запускает обработку действий для текущего поворота бота. (Унаследовано от BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Отправляет действия в беседу.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Подписывает пользователя с помощью сервера токенов с помощью настраиваемых appCredentials.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Подписывает пользователя с помощью сервера маркеров с помощью appCredentials бота.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Заменяет существующее действие в беседе.
Use(IMiddleware)	Добавляет ПО промежуточного слоя в конвейер адаптера.

Явные реализации интерфейса

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)

Адаптер бота, который может подключить бота к конечной точке службы.

Методы расширения

UseBotState(BotAdapter, BotState[])	Добавляет ПО промежуточного слоя в адаптер для регистрации одного или нескольких объектов BotState в контексте включения. ПО промежуточного слоя регистрирует объекты состояния в контексте поворота в начале каждого шага.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Устаревшие.. Регистрирует объекты состояния пользователя и беседы с адаптером. Эти объекты будут доступны через TurnStateконтекста поворота. методGet<T>().
UseStorage(BotAdapter, IStorage)	Добавляет ПО промежуточного слоя в адаптер, чтобы зарегистрировать объект IStorage в контексте поворота. ПО промежуточного слоя регистрирует объекты состояния в контексте поворота в начале каждого шага.

Применяется к

Поделиться через