BotAdapter Класс

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

public abstract class BotAdapter

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

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

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

TurnContext Activity Bot Middleware

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

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

Ключ для хранения удостоверения утверждений бота.
static final java.lang.String OAUTH_CLIENT_KEY

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

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

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

Конструктор Описание
BotAdapter()

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

Модификатор и тип Метод и описание
java.util.concurrent.CompletableFuture<java.lang.Void> continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

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

Отправляет упреждающее сообщение в беседу.
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 botId, Activity continuationActivity, BotCallbackHandler callback)

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

Отправляет упреждающее сообщение в беседу.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> deleteActivity(TurnContext context, ConversationReference reference)

При переопределении в производном классе удаляет существующее действие в беседе.
protected MiddlewareSet getMiddlewareSet()

Возвращает коллекцию ПО промежуточного слоя в конвейере адаптера.
OnTurnErrorHandler getOnTurnError()

Получает обработчик ошибок, который может перехватывать исключения в ПО промежуточного слоя или приложения.
protected java.util.concurrent.CompletableFuture<java.lang.Void> runPipeline(TurnContext context, BotCallbackHandler callback)

Запускает обработку действий для текущего поворота бота.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]> sendActivities(TurnContext context, List<Activity> activities)

При переопределении в производном классе отправляет действия в беседу.
void setOnTurnError(OnTurnErrorHandler withTurnError)

Задает обработчик ошибок, который может перехватывать исключения в ПО промежуточного слоя или приложении.
abstract java.util.concurrent.CompletableFuture<ResourceResponse> updateActivity(TurnContext context, Activity activity)

При переопределении в производном классе заменяет существующее действие в беседе.
BotAdapter use(Middleware middleware)

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

Методы, унаследованные от 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

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

BOT_IDENTITY_KEY

public static final String BOT_IDENTITY_KEY

Ключ для хранения удостоверения утверждений бота.

OAUTH_CLIENT_KEY

public static final String OAUTH_CLIENT_KEY

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

OAUTH_SCOPE_KEY

public static final String OAUTH_SCOPE_KEY

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

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

BotAdapter

public BotAdapter()

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, BotCallbackHandler callback)

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

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

Параметры:

claimsIdentity - Значение ClaimsIdentity для беседы.
continuationActivity - Действие с соответствующим параметром ConversationReference, с которым следует продолжить беседу.
callback - Метод вызова для поворота результирующих ботов.

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

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

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, Activity continuationActivity, String audience, BotCallbackHandler callback)

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

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

Параметры:

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

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

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

continueConversation

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

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

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

Параметры:

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

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

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

continueConversation

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

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

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

Параметры:

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

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

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

continueConversation

public CompletableFuture continueConversation(String botId, Activity continuationActivity, BotCallbackHandler callback)

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

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

Параметры:

botId - Идентификатор приложения бота. Этот параметр игнорируется в одном клиенте адаптеров (консоль, тест и т. д.), но имеет решающее значение для BotFrameworkAdapter, который является мультитенантным.
continuationActivity - Действие с соответствующим параметром ConversationReference, с которым следует продолжить беседу.
callback - Метод вызова для поворота результирующих ботов.

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

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

continueConversation

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

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

Параметры:

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

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

Задача, представляющая выполняемую рабочую очередь. Вызовите этот метод для упреждающего отправки сообщения в беседу. Большинству каналов требуется, чтобы пользователь инициировал беседу с ботом, прежде чем бот сможет отправлять действия пользователю. 
     <xref uid="com.microsoft.bot.builder.BotAdapter.runPipeline(com.microsoft.bot.builder.TurnContext,com.microsoft.bot.builder.BotCallbackHandler)" data-throw-if-not-resolved="false" data-raw-source="#runPipeline(TurnContext, BotCallbackHandler)"></xref>

deleteActivity

public abstract CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

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

Параметры:

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

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

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

getMiddlewareSet

protected MiddlewareSet getMiddlewareSet()

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

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

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

getOnTurnError

public OnTurnErrorHandler getOnTurnError()

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

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

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

runPipeline

protected CompletableFuture runPipeline(TurnContext context, BotCallbackHandler callback)

Запускает обработку действий для текущего поворота бота. Адаптер вызывает ПО промежуточного слоя в том порядке, в котором вы добавили его. Адаптер передает объект контекста для поворота и следующего делегата, а ПО промежуточного слоя вызывает делегат для передачи элемента управления следующему ПО промежуточного слоя в конвейере. Когда элемент управления достигнет конца конвейера, адаптер вызывает метод callback. Если компонент ПО промежуточного слоя не вызывает следующего делегата, адаптер не вызывает ни одного из последующих методов\u2019промежуточного слоя onTurn(TurnContext turnContext, NextDelegate next) или метода обратного вызова, а также короткие цепи конвейера.

Когда поворот инициируется действием пользователя (реактивное обмен сообщениями), метод обратного вызова будет ссылкой на метод onTurn(TurnContext turnContext) бота. Когда поворот инициируется вызовом continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) (упреждающий обмен сообщениями), метод обратного вызова — это метод обратного вызова, предоставленный в вызове.

Параметры:

context - Объект контекста поворота.
callback - Метод обратного вызова, выполняемый в конце конвейера.

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

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

sendActivities

public abstract CompletableFuture sendActivities(TurnContext context, List activities)

При переопределении в производном классе отправляет действия в беседу.

Параметры:

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

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

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

setOnTurnError

public void setOnTurnError(OnTurnErrorHandler withTurnError)

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

Параметры:

withTurnError - Обработчик ошибок, который может перехватывать исключения в ПО промежуточного слоя или приложении.

updateActivity

public abstract CompletableFuture updateActivity(TurnContext context, Activity activity)

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

Параметры:

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

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

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

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

use

public BotAdapter use(Middleware middleware)

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

Параметры:

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

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

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

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