TurnContext Интерфейс

Ссылка

Пакет:: com.microsoft.bot.builder

Артефакт Maven:: com.microsoft.bot:bot-builder:4.14.3

public interface TurnContext

Предоставляет контекст для поворота бота.

Контекст предоставляет сведения, необходимые для обработки входящего действия. Объект контекста создается BotAdapter и сохраняется для длины поворота.

Bot Middleware

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

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

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

Модификатор и тип	Метод и описание
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) Удаляет существующее действие.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) Удаляет существующее действие.
abstract Activity	getActivity() Возвращает действие для этого поворота бота.
abstract BotAdapter	getAdapter() Возвращает адаптер бота, создавший этот объект контекста.
abstract java.lang.String	getLocale() Возвращает языковой стандарт для данного объекта контекста.
abstract boolean	getResponded() Возвращает значение, указывающее, был ли отправлен хотя бы один ответ для текущего поворота.
abstract TurnContextStateCollection	getTurnState() Возвращает коллекцию значений, кэшированных с объектом контекста для времени существования поворота.
abstract TurnContext	onDeleteActivity(DeleteActivityHandler handler) Добавляет обработчик ответа для операций удаления.
abstract TurnContext	onSendActivities(SendActivitiesHandler handler) Добавляет обработчик ответа для операций отправки действий.
abstract TurnContext	onUpdateActivity(UpdateActivityHandler handler) Добавляет обработчик ответа для операций обновления.
default java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(Activity[] activities) Вспомогательный метод для отправки массива действий.
abstract java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) Отправляет список действий отправителю входящего действия.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activity) Отправляет действие отправителю входящего действия.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) Отправляет действие сообщения отправителю входящего действия.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) Отправляет действие сообщения отправителю входящего действия.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) Отправляет действие сообщения отправителю входящего действия.
default java.util.concurrent.CompletableFuture<java.lang.Void>	sendActivityBlind(Activity activity) Отправляет действие отправителю входящего действия, не возвращая ответресурса.
abstract void	setLocale(String withLocale) Задайте языковой стандарт для данного объекта контекста.
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name)
static java.util.concurrent.CompletableFuture<ResourceResponse>	traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label) Отправляет действие трассировки в BotAdapter для ведения журнала.
abstract java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) Заменяет существующее действие.

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

STATE_TURN_LOCALE

public static final String STATE_TURN_LOCALE

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

deleteActivity

public abstract CompletableFuture deleteActivity(ConversationReference conversationReference)

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

Параметры:

conversationReference - Беседа, содержащая действие для удаления.

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

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

deleteActivity

public abstract CompletableFuture deleteActivity(String activityId)

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

Параметры:

activityId - Идентификатор действия для удаления.

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

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

getActivity

public abstract Activity getActivity()

Возвращает действие для этого поворота бота.

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

Действие для этого поворота бота.

getAdapter

public abstract BotAdapter getAdapter()

Возвращает адаптер бота, создавший этот объект контекста.

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

Адаптер бота, создавший этот объект контекста.

getLocale

public abstract String getLocale()

Возвращает языковой стандарт для данного объекта контекста.

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

Строка языкового стандарта в этом объекте контекста.

getResponded

public abstract boolean getResponded()

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

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

true, если по крайней мере один ответ был отправлен для текущего поворота; в противном случае false.

getTurnState

public abstract TurnContextStateCollection getTurnState()

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

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

Коллекция служб, зарегистрированных в этом объекте контекста.

onDeleteActivity

public abstract TurnContext onDeleteActivity(DeleteActivityHandler handler)

Добавляет обработчик ответа для операций удаления.

При вызове deleteActivity(String activityId) контекста адаптер вызывает зарегистрированные обработчики в том порядке, в котором они были добавлены в объект контекста.

Параметры:

handler - Обработчик, добавляемый в объект контекста.

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

Обновленный объект контекста.

onSendActivities

public abstract TurnContext onSendActivities(SendActivitiesHandler handler)

Добавляет обработчик ответа для операций отправки действий.

При вызове методов контекста sendActivity(Activity activity) или sendActivities(List<Activity> activities) адаптер вызывает зарегистрированные обработчики в том порядке, в котором они были добавлены в объект контекста.

Параметры:

handler - Обработчик, добавляемый в объект контекста.

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

Обновленный объект контекста.

onUpdateActivity

public abstract TurnContext onUpdateActivity(UpdateActivityHandler handler)

Добавляет обработчик ответа для операций обновления.

При вызове updateActivity(Activity withActivity) контекста адаптер вызывает зарегистрированные обработчики в том порядке, в котором они были добавлены в объект контекста.

Параметры:

handler - Обработчик, добавляемый в объект контекста.

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

Обновленный объект контекста.

sendActivities

public default CompletableFuture sendActivities(Activity[] activities)

Вспомогательный метод для отправки массива действий. Это вызывает sendActivities(List<Activity> activities).

Параметры:

activities - Массив действий.

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

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

sendActivities

public abstract CompletableFuture sendActivities(List activities)

Отправляет список действий отправителю входящего действия.

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

Параметры:

activities - Действия, которые нужно отправить.

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

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

sendActivity

public abstract CompletableFuture sendActivity(Activity activity)

Отправляет действие отправителю входящего действия.

Параметры:

activity - Действие для отправки.

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

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend)

Отправляет действие сообщения отправителю входящего действия.

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

См. документацию канала по ограничениям, введенным для содержимого textReplyToSend.

Параметры:

textReplyToSend - Текст отправленного сообщения.

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

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak)

Отправляет действие сообщения отправителю входящего действия.

См. документацию канала по ограничениям, введенным для содержимого textReplyToSend.

Чтобы управлять различными характеристиками речи бота, такими как голос, скорость, громкость, произношение и шаг, укажите speak в формате языка разметки синтеза речи (SSML).

Параметры:

textReplyToSend - Текст отправленного сообщения.

speak - Необязательный текст, который будет говорить бот в канале с поддержкой речи.

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

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

sendActivity

public abstract CompletableFuture sendActivity(String textReplyToSend, String speak, InputHints inputHint)

Отправляет действие сообщения отправителю входящего действия.

См. документацию канала по ограничениям, введенным для содержимого textReplyToSend.

Параметры:

textReplyToSend - Текст отправленного сообщения.

speak - Необязательный текст, который будет говорить бот в канале с поддержкой речи.

inputHint - Необязательный параметр указывает, принимает ли бот, ожидает или игнорирует входные данные пользователя после доставки сообщения клиенту. Одно из следующих: "acceptingInput", "ignoringInput" или "expectingInput". Значение по умолчанию — acceptingInput.

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

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

sendActivityBlind

public default CompletableFuture sendActivityBlind(Activity activity)

Отправляет действие отправителю входящего действия без возврата resourceResponse.

Параметры:

activity - Действие для отправки.

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

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

setLocale

public abstract void setLocale(String withLocale)

Задайте языковой стандарт для данного объекта контекста.

Параметры:

withLocale - Строка языкового стандарта в этом объекте контекста.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name)

Параметры:

turnContext - TurnContext.

name - Имя действия.

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

Будущее с resourceReponse.

traceActivity

public static CompletableFuture traceActivity(TurnContext turnContext, String name, Object value, String valueType, String label)

Отправляет действие трассировки в BotAdapter для ведения журнала.

Параметры:

turnContext - Контекст текущего поворота.

name - Значение для назначения свойству Activity#getName действия.

value - Значение для назначения свойству Activity#getValue действия.

valueType - Значение для назначения свойству Activity#getValueType действия.

label - Значение для назначения свойству Activity#getLabel действия.

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

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

updateActivity

public abstract CompletableFuture updateActivity(Activity withActivity)

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

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

Параметры:

withActivity - Новое действие замены.

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

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

TurnContext Интерфейс

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

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

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

STATE_TURN_LOCALE

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

deleteActivity

deleteActivity

getActivity

getAdapter

getLocale

getResponded

getTurnState

onDeleteActivity

onSendActivities

onUpdateActivity

sendActivities

sendActivities

sendActivity

sendActivity

sendActivity

sendActivity

sendActivityBlind

setLocale

traceActivity

traceActivity

updateActivity

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