BotFrameworkAdapter Класс

  • Ссылка
Пакет:
com.microsoft.bot.builder
Артефакт Maven:
com.microsoft.bot:bot-builder:4.14.3

Реализации

ConnectorClientBuilder UserTokenProvider AdapterIntegration

public class BotFrameworkAdapter
extends BotAdapter
implements AdapterIntegration, UserTokenProvider, ConnectorClientBuilder

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

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

TurnContext Activity Bot Middleware

Сводка по полю

Модификатор и тип Поле и описание
static final java.lang.String CONNECTOR_CLIENT_KEY

Ключ для храненияклиента соединителя.
static final java.lang.String INVOKE_RESPONSE_KEY

Ключ для хранения ответа на вызов.
static final java.lang.String TEAMSCONNECTOR_CLIENT_KEY

Ключ для хранениясоединителя Teamsклиента.

Сводка по конструктору

Конструктор Описание
BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.
BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.
BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.
BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.

Сводка по методу

Модификатор и тип Метод и описание
protected void addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client)

Вставляет клиент соединителяв кэш.
protected java.util.concurrent.CompletableFuture<AppCredentials> buildAppCredentials(String appId, String scope)

Создает объект AppCredentials для указанного идентификатора и областиприложения.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Отправляет упреждающее сообщение в беседу.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Отправляет упреждающее сообщение в беседу.
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Отправляет упреждающее сообщение от бота в беседу.
java.util.concurrent.CompletableFuture<ConnectorClient> createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience)

Создает клиент соединителя асинхронно.
java.util.concurrent.CompletableFuture<java.lang.Void> createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback)

Создает беседу на указанном канале.
java.util.concurrent.CompletableFuture<java.lang.Void> createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference)

Создает беседу на указанном канале.
protected java.util.concurrent.CompletableFuture<OAuthClient> createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Создает клиент OAuth для бота.
java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

Удаляет существующее действие в беседе.
java.util.concurrent.CompletableFuture<java.lang.Void> deleteConversationMember(TurnContextImpl context, String memberId)

Удаляет члена из текущей беседы.
java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.
java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении с помощью настраиваемых учетных данных приложения.
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getActivityMembers(TurnContextImpl context)

Выводит список членов заданного действия.
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getActivityMembers(TurnContextImpl context, String activityId)

Выводит список членов заданного действия.
protected java.util.Map<java.lang.String,ConnectorClient> getConnectorClientCache()

Получите кэш клиентасоединителя.
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>> getConversationMembers(TurnContextImpl context)

Выводит список членов текущей беседы.
java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(TurnContextImpl context)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов.
java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(TurnContextImpl context, String continuationToken)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов.
java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов.
java.util.concurrent.CompletableFuture<ConversationsResult> getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов.
protected java.util.Map<java.lang.String,AppCredentials> getCredentialsCache()

Получите кэш учетных данных приложения.
java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения, используя настраиваемые учетные данные приложения.
java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Получите ссылку необработанного входа, которую нужно отправить пользователю для входа для имени подключения с помощью учетных данных приложения ботаучетных данных.
java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext context, String connectionName)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
protected java.util.concurrent.CompletableFuture<ConnectorClient> getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Возвращает клиент соединителяиз кэша или только что созданного.
java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью настраиваемых учетных данных приложения.
java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, String userId, String includeFilter)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.
java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Пытается получить маркер для пользователя, который находится в потоке входа, используя настраиваемые учетные данные приложения.
java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext context, String connectionName, String magicCode)

Пытается получить маркер для пользователя, который находится в потоке входа.
protected static java.lang.String keyForAppCredentials(String appId, String scope)

Создает ключ для доступа к кэшу учетных данных приложения.
protected static java.lang.String keyForConnectorClient(String serviceUrl, String appId, String scope)

Создает ключ для доступа к кэшу клиента соединителя.
java.util.concurrent.CompletableFuture<InvokeResponse> processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback)

Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.
java.util.concurrent.CompletableFuture<InvokeResponse> processActivity(String authHeader, Activity activity, BotCallbackHandler callback)

Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.
java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

Отправляет действия в беседу.
java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Подписывает пользователя с помощью сервера маркеров с помощью настраиваемых учетных данных приложения.
java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext context, String connectionName, String userId)

Подписывает пользователя с помощью сервера токенов.
java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

Заменяет существующее действие в беседе.
BotFrameworkAdapter use(Middleware middleware)

Добавляет ПО промежуточного слоя в конвейер адаптера.

Методы, унаследованные от BotAdapter

continueConversation continueConversation continueConversation continueConversation continueConversation continueConversation deleteActivity getMiddlewareSet getOnTurnError runPipeline sendActivities setOnTurnError updateActivity use

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Сведения о полях

CONNECTOR_CLIENT_KEY

public static final String CONNECTOR_CLIENT_KEY

Ключ для хранения ConnectorClient.

INVOKE_RESPONSE_KEY

public static final String INVOKE_RESPONSE_KEY

Ключ для хранения InvokeResponse.

TEAMSCONNECTOR_CLIENT_KEY

public static final String TEAMSCONNECTOR_CLIENT_KEY

Ключ для хранения TeamsConnectorClient. Только для тестирования.

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

BotFrameworkAdapter

public BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.

Параметры:

withCredentials - Используемые учетные данные.
withAuthConfig - Конфигурация проверки подлинности.
withChannelProvider - Поставщик каналов.
withRetryStrategy - Политика повторных попыток для повторных операций HTTP.
withMiddleware - ПО промежуточного слоя, который изначально добавляется в адаптер.

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.

Параметры:

withCredentialProvider - Поставщик учетных данных.

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.

Параметры:

withCredentialProvider - Поставщик учетных данных.
withAuthConfig - Конфигурация проверки подлинности.
withChannelProvider - Поставщик каналов.
withRetryStrategy - Политика повторных попыток для повторных операций HTTP.
withMiddleware - ПО промежуточного слоя, который изначально добавляется в адаптер.

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Инициализирует новый экземпляр класса BotFrameworkAdapter с помощью поставщика учетных данных.

Параметры:

withCredentialProvider - Поставщик учетных данных.
withChannelProvider - Поставщик каналов.
withRetryStrategy - Политика повторных попыток для повторных операций HTTP.
withMiddleware - ПО промежуточного слоя, который изначально добавляется в адаптер.

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

addConnectorClientToCache

protected void addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client)

Вставляет connectorClient в кэш. ТОЛЬКО ДЛЯ МОДУЛЬНОГО ТЕСТИРОВАНИЯ.

Параметры:

serviceUrl - URL-адрес службы
appId - Приложение сделал
scope - Область
client - Объект ConnectorClient для вставки.

buildAppCredentials

protected CompletableFuture buildAppCredentials(String appId, String scope)

Создает объект AppCredentials для указанного идентификатора приложения и области.

Параметры:

appId - Идентификатор приложения.
scope - Область.

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

Объект AppCredentials.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Отправляет упреждающее сообщение в беседу.

Вызовите этот метод для упреждающего отправки сообщения в беседу. Большинству каналов требуется, чтобы пользователь инициировал беседу с ботом, прежде чем бот сможет отправлять действия пользователю.

Переопределения:

BotFrameworkAdapter.continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Параметры:

claimsIdentity - Справочник по ClaimsIdentity для беседы.
reference - Ссылка на беседу для продолжения.
callback - Метод вызова для поворота результирующих ботов.

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

Задача, представляющая выполняемую рабочую очередь.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Отправляет упреждающее сообщение в беседу.

Вызовите этот метод для упреждающего отправки сообщения в беседу. Большинству каналов требуется, чтобы пользователь инициировал беседу с ботом, прежде чем бот сможет отправлять действия пользователю.

Переопределения:

BotFrameworkAdapter.continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Параметры:

claimsIdentity - Справочник по ClaimsIdentity для беседы.
reference - Ссылка на беседу для продолжения.
audience - Значение, указывающее получателя упреждающего сообщения.
callback - Метод вызова для поворота результирующих ботов.

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

Задача, представляющая выполняемую рабочую очередь.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Отправляет упреждающее сообщение от бота в беседу.

Вызовите этот метод для упреждающего отправки сообщения в беседу. Большинству каналов требуется, чтобы пользователь инициировал беседу с ботом, прежде чем бот сможет отправлять действия пользователю.

Эта перегрузка отличается от реализации Node, требуя передать BotId. Код .NET позволяет размещать несколько ботов в одном адаптере, который не поддерживается node.

processActivity(String authHeader, Activity activity, BotCallbackHandler callback) runPipeline(TurnContext context, BotCallbackHandler callback)

Переопределения:

BotFrameworkAdapter.continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Параметры:

botAppId - Идентификатор приложения бота. Это идентификатор приложения, возвращаемый регистрацией портала, и обычно находится в параметре MicrosoftAppId в appSettings.json.
reference - Ссылка на беседу для продолжения.
callback - Метод для вызова результирующего бота.

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

Задача, представляющая выполняемую рабочую очередь.

createConnectorClient

public CompletableFuture createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience)

Создает клиент соединителя асинхронно.

Параметры:

serviceUrl - URL-адрес службы.
claimsIdentity - Удостоверение утверждений.
audience - Целевая аудитория соединителя.

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

Экземпляр ConnectorClient.

createConversation

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback)

Создает беседу на указанном канале. Чтобы начать беседу, бот должен знать сведения о своей учетной записи и сведения об учетной записи пользователя в этом канале. Большинство каналов поддерживают только инициирование прямой беседы (негрупповой).

Адаптер пытается создать новую беседу на канале, а затем отправляет действие conversationUpdate через конвейер ПО промежуточного слоя в метод callback.

Если беседа установлена с указанными пользователями, идентификатор Activity#getConversation действия будет содержать идентификатор нового диалога.

Параметры:

channelId - Идентификатор канала.
serviceUrl - Конечная точка URL-адреса службы канала.
credentials - Учетные данные приложения для бота.
conversationParameters - Сведения о беседе, используемые для создания беседы.
callback - Метод для вызова результирующего бота.

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

Задача, представляющая выполняемую рабочую очередь.

createConversation


public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference)

Создает беседу на указанном канале. Чтобы начать беседу, бот должен знать сведения о своей учетной записи и сведения об учетной записи пользователя в этом канале. Большинство каналов поддерживают только инициирование прямой беседы (негрупповой).

Адаптер пытается создать новую беседу на канале, а затем отправляет действие conversationUpdate через конвейер ПО промежуточного слоя в метод callback.

Если беседа установлена с указанными пользователями, идентификатор Activity#getConversation действия будет содержать идентификатор нового диалога.

Параметры:

channelId - Идентификатор канала.
serviceUrl - Конечная точка URL-адреса службы канала.
credentials - Учетные данные приложения для бота.
conversationParameters - Сведения о беседе, используемые для создания беседы.
callback - Метод для вызова результирующего бота.
reference - Ссылка на беседу, содержащая клиент.

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

Задача, представляющая выполняемую рабочую очередь.

createOAuthAPIClient

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Создает клиент OAuth для бота.

Примечание. Это защищено в первую очередь таким образом, чтобы модульные тесты могли переопределить для предоставления макета OAuthClient.

Параметры:

turnContext - Объект контекста для текущего поворота.
oAuthAppCredentials - Учетные данные, используемые при создании клиента. Если значение NULL, будут использоваться учетные данные по умолчанию.

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

Клиент OAuth для бота.

deleteActivity

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Удаляет существующее действие в беседе.

Переопределения:

BotFrameworkAdapter.deleteActivity(TurnContext context, ConversationReference reference)

Параметры:

context - Объект контекста для поворота.
reference - Ссылка на беседу для удаления действия.

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

Задача, представляющая выполняемую рабочую очередь. onDeleteActivity(DeleteActivityHandler handler)

deleteConversationMember

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Удаляет члена из текущей беседы.

Параметры:

context - Объект контекста для поворота.
memberId - Идентификатор участника для удаления из беседы

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

Задача, представляющая выполняемую рабочую очередь.

exchangeToken

public CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя, связанный с токеном..
exchangeRequest - Сведения о запросе на обмен, маркер для обмена или URI для обмена.

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

Если задача завершится, возвращается маркер обмена.

exchangeToken

public CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя, связанный с токеном..
exchangeRequest - Сведения о запросе на обмен, маркер для обмена или URI для обмена.

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

Если задача завершится, возвращается маркер обмена.

getAadTokens

public CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении с помощью настраиваемых appCredentials.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
connectionName - Имя подключения Azure Active Directory, настроенного с помощью этого бота.
resourceUrls - Список URL-адресов ресурсов для получения маркеров.
userId - Идентификатор пользователя, для которого извлекаются маркеры. При передаче значения NULL идентификатор пользователя берется из действия в TurnContext.

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

Словарь resourceUrl для соответствующего TokenResponse.

getAadTokens

public CompletableFuture> getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
connectionName - Имя подключения Azure Active Directory, настроенного с помощью этого бота.
resourceUrls - Список URL-адресов ресурсов для получения маркеров.
userId - Идентификатор пользователя, для которого извлекаются маркеры. При передаче значения NULL идентификатор пользователя берется из действия в TurnContext.

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

Сопоставление resourceUrl с соответствующим TokenResponse.

getActivityMembers

public CompletableFuture> getActivityMembers(TurnContextImpl context)

Выводит список членов заданного действия.

Параметры:

context - Объект контекста для поворота.

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

Список членов действия

getActivityMembers

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

Выводит список членов заданного действия.

Параметры:

context - Объект контекста для поворота.
activityId - (Необязательно) Идентификатор действия для перечисления. Если не указан идентификатор текущей активности, будет использоваться.

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

Список членов действия

getConnectorClientCache

protected Map getConnectorClientCache()

Получите кэш ConnectorClient. ДЛЯ МОДУЛЬНОГО ТЕСТИРОВАНИЯ.

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

Кэш ConnectorClient.

getConversationMembers

public CompletableFuture> getConversationMembers(TurnContextImpl context)

Выводит список членов текущей беседы.

Параметры:

context - Объект контекста для поворота.

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

Список участников текущей беседы

getConversations

public CompletableFuture getConversations(TurnContextImpl context)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов. Сервер канала возвращает результаты на страницах, и каждая страница будет содержать "продолжениеToken", который можно использовать для получения следующей страницы результатов с сервера. Эта перегрузка может вызываться во время стандартной обработки действий, в которой будет использоваться URL-адрес службы Бота и учетные данные, которые являются частью текущего конвейера обработки действий.

Параметры:

context - Объект контекста для поворота.

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

Список участников текущей беседы

getConversations

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов. Сервер канала возвращает результаты на страницах, и каждая страница будет содержать "продолжениеToken", который можно использовать для получения следующей страницы результатов с сервера. Эта перегрузка может вызываться во время стандартной обработки действий, в которой будет использоваться URL-адрес службы Бота и учетные данные, которые являются частью текущего конвейера обработки действий.

Параметры:

context - Объект контекста для поворота.
continuationToken - Маркер продолжения из предыдущей страницы результатов.

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

Список участников текущей беседы

getConversations

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов. Сервер канала возвращает результаты на страницах, и каждая страница будет содержать "продолжениеToken", который можно использовать для получения следующей страницы результатов с сервера.

Параметры:

serviceUrl - URL-адрес сервера канала для запроса. Это можно получить из context.activity.serviceUrl.
credentials - Учетные данные, необходимые для подключения бота к.services().

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

Список участников текущей беседы

Эта перегрузка может вызываться извне контекста беседы, так как требуются только serviceUrl бота и учетные данные.

getConversations

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken)

Выводит список бесед, в которых этот бот принимал участие для заданного сервера каналов. Сервер канала возвращает результаты на страницах, и каждая страница будет содержать "продолжениеToken", который можно использовать для получения следующей страницы результатов с сервера. Эта перегрузка может вызываться извне контекста беседы, так как требуются только serviceUrl бота и учетные данные.

Параметры:

serviceUrl - URL-адрес сервера канала для запроса. Это можно получить из context.activity.serviceUrl.
credentials - Учетные данные, необходимые для подключения бота к.services().
continuationToken - Маркер продолжения из предыдущей страницы результатов.

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

Список участников текущей беседы

getCredentialsCache

protected Map getCredentialsCache()

Получите кэш AppCredentials. Для модульного тестирования.

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

Кэш AppCredentials.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName)

Получите ссылку необработанного входа, отправляемую пользователю для входа для имени подключения с помощью настроенных AppCredentials.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
connectionName - Имя используемого подключения проверки подлинности.

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

Задача, представляющая выполняемую рабочую очередь. 
     If the task completes successfully, the result contains the raw
     signin link.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Получите ссылку необработанного входа, которую нужно отправить пользователю для входа для имени подключения с помощью appCredentials бота.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя, связанный с маркером.
finalRedirect - Окончательный URL-адрес, на который будет перенаправлен поток OAuth.

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

Задача, представляющая выполняемую рабочую очередь. 
     If the task completes successfully, the result contains the raw
     signin link.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.

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

Задача, представляющая выполняемую рабочую очередь.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя, связанный с маркером.
finalRedirect - Окончательный URL-адрес, на который будет перенаправлен поток OAuth.

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

Задача, представляющая выполняемую рабочую очередь.

getOrCreateConnectorClient

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Возвращает connectorClient либо из кэша, либо из только что созданного кэша.

Примечание. Это защищено в первую очередь, чтобы разрешить модульным тестам переопределить это, чтобы предоставить mock ConnectorClient

Параметры:

serviceUrl - URL-адрес службы для клиента.
usingAppCredentials - (Необязательно) Используемые приложенияCredentials.

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

Задача, возвращающая СоединительClient.

getSignInResource

public CompletableFuture getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя, связанный с маркером.
finalRedirect - Окончательный URL-адрес, на который будет перенаправлен поток OAuth.

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

Задача, представляющая выполняемую рабочую очередь. 
     If the task completes successfully, the result contains the raw
     signin link.

getSignInResource

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.

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

Задача, представляющая выполняемую рабочую очередь. 
     If the task completes successfully, the result contains the raw
     signin link.

getSignInResource

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя, связанный с маркером.
finalRedirect - Окончательный URL-адрес, на который будет перенаправлен поток OAuth.

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

Задача, представляющая выполняемую рабочую очередь. 
     If the task completes successfully, the result contains the raw
     signin link.

getTokenStatus

public CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью настраиваемых appCredentials.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
userId - Идентификатор пользователя, для которого извлекается состояние маркера.
includeFilter - Необязательный список разделенных запятыми для включения. Пустой возвращает состояние маркера для всех настроенных подключений.

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

Список TokenStatus.

getTokenStatus

public CompletableFuture> getTokenStatus(TurnContext context, String userId, String includeFilter)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
userId - Идентификатор пользователя, для которого извлекается состояние маркера.
includeFilter - Необязательный список разделенных запятыми для включения. Пустой возвращает состояние маркера для всех настроенных подключений.

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

Массив TokenStatus.

getUserToken

public CompletableFuture getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
connectionName - Имя используемого подключения проверки подлинности.
magicCode - (Необязательно) Необязательный введенный пользователем код для проверки.

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

Ответ токена.

getUserToken

public CompletableFuture getUserToken(TurnContext context, String connectionName, String magicCode)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.
magicCode - (Необязательно) Необязательный введенный пользователем код для проверки.

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

Ответ маркера

keyForAppCredentials

protected static String keyForAppCredentials(String appId, String scope)

Создает ключ для доступа к кэшу учетных данных приложения.

Параметры:

appId - Идентификатор приложения
scope - Область.

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

Ключ кэша

keyForConnectorClient

protected static String keyForConnectorClient(String serviceUrl, String appId, String scope)

Создает ключ для доступа к кэшу клиента соединителя.

Параметры:

serviceUrl - URL-адрес службы
appId - Приложение сделал
scope - Область

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

Ключ кэша.

processActivity

public CompletableFuture processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback)

Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.

Параметры:

identity - ClaimsIdentity запроса.
activity - Входящее действие.
callback - Код, выполняемый в конце конвейера по промежуточного слоя адаптера.

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

Задача, представляющая выполняемую рабочую очередь. Если тип действия был "Invoke" и был найден соответствующий ключ (channelId + activityId), возвращается значение InvokeResponse, в противном случае возвращается значение NULL.

processActivity

public CompletableFuture processActivity(String authHeader, Activity activity, BotCallbackHandler callback)

Создает контекст поворота и запускает конвейер ПО промежуточного слоя для входящего действия.

Параметры:

authHeader - Заголовок проверки подлинности HTTP запроса.
activity - Входящее действие.
callback - Код, выполняемый в конце конвейера по промежуточного слоя адаптера.

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

Задача, представляющая выполняемую рабочую очередь. Если тип действия был "Invoke" и был найден соответствующий ключ (channelId + activityId), возвращается значение InvokeResponse, в противном случае возвращается значение NULL.

sendActivities

public CompletableFuture sendActivities(TurnContext context, List activities)

Отправляет действия в беседу.

Переопределения:

BotFrameworkAdapter.sendActivities(TurnContext context, List<Activity> activities)

Параметры:

context - Объект контекста для поворота.
activities - Действия, которые нужно отправить.

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

Задача, представляющая выполняемую рабочую очередь. Если действия успешно отправлены, результат задачи содержит массив объектов ResourceResponse, содержащих идентификаторы, назначенные принимающему каналу действия. 
     <xref uid="com.microsoft.bot.builder.TurnContext.onSendActivities(com.microsoft.bot.builder.SendActivitiesHandler)" data-throw-if-not-resolved="false" data-raw-source="TurnContext#onSendActivities(SendActivitiesHandler)"></xref>

signOutUser

public CompletableFuture signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Подписывает пользователя с помощью сервера токенов с помощью настраиваемых appCredentials.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
oAuthAppCredentials - AppCredentials для OAuth.
connectionName - Имя используемого подключения проверки подлинности.
userId - Идентификатор пользователя для выхода.

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

Задача, представляющая выполняемую рабочую очередь.

signOutUser

public CompletableFuture signOutUser(TurnContext context, String connectionName, String userId)

Подписывает пользователя с помощью сервера токенов.

Параметры:

context - Контекст для текущего шага беседы с пользователем.
connectionName - Имя используемого подключения проверки подлинности.
userId

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

Задача, представляющая выполняемую рабочую очередь.

updateActivity

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Заменяет существующее действие в беседе.

Переопределения:

BotFrameworkAdapter.updateActivity(TurnContext context, Activity activity)

Параметры:

context - Объект контекста для поворота.
activity - Новое действие замены.

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

Задача, представляющая выполняемую рабочую очередь. Если действие успешно отправлено, результат задачи содержит объект ResourceResponse, содержащий идентификатор, назначенный принимающему каналу действия.

Перед вызовом задайте идентификатор действия замены идентификатору действия для замены. onUpdateActivity(UpdateActivityHandler handler)

use

public BotFrameworkAdapter use(Middleware middleware)

Добавляет ПО промежуточного слоя в конвейер адаптера. ПО промежуточного слоя добавляется в адаптер во время инициализации. Для каждого поворота адаптер вызывает ПО промежуточного слоя в том порядке, в котором вы добавили его.

Переопределения:

BotFrameworkAdapter.use(Middleware middleware)

Параметры:

middleware - По промежуточного слоя, добавляемого.

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

Обновленный объект адаптера.

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