TurnContextImpl Класс

Ссылка

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

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

java.lang.Object
- com.microsoft.bot.builder.TurnContextImpl

Реализации

TurnContext java.lang.AutoCloseable

public class TurnContextImpl
implements TurnContext, java.lang.AutoCloseable

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

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

Конструктор	Описание
TurnContextImpl(BotAdapter withAdapter, Activity withActivity)	Создает объект контекста.

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

Модификатор и тип	Метод и описание
void	close() АвтоClosable#close.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(ConversationReference conversationReference) Удаляет существующее действие.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(String activityId) Удаляет существующее действие.
void	finalize() Автоматический вызов #close.
Activity	getActivity() Возвращает действие, связанное с этим поворотом; или `null` при обработке упреждающего сообщения.
BotAdapter	getAdapter() Возвращает адаптер бота, создавший этот объект контекста.
java.util.List<Activity>	getBufferedReplyActivities() Возвращает список действий для отправки при "контексте". действие.режим доставки== "ожидаетответов".
java.lang.String	getLocale() Возвращает языковой стандарт для данного объекта контекста.
boolean	getResponded() Указывает, был ли отправлен хотя бы один ответ для текущего поворота.
TurnContextStateCollection	getTurnState() Возвращает службы, зарегистрированные в этом объекте контекста.
TurnContext	onDeleteActivity(DeleteActivityHandler handler) Добавляет обработчик ответа для операций удаления.
TurnContext	onSendActivities(SendActivitiesHandler handler) Добавляет обработчик ответа для операций отправки действий.
TurnContext	onUpdateActivity(UpdateActivityHandler handler) Добавляет обработчик ответа для операций обновления.
java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(List<Activity> activities) Отправляет набор действий отправителю входящего действия.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(Activity activityToSend) Отправляет действие отправителю входящего действия.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend) Отправляет действие сообщения отправителю входящего действия.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak) Отправляет действие сообщения отправителю входящего действия.
java.util.concurrent.CompletableFuture<ResourceResponse>	sendActivity(String textReplyToSend, String speak, InputHints inputHint) Отправляет действие сообщения отправителю входящего действия.
void	setLocale(String withLocale) Задайте языковой стандарт для данного объекта контекста.
java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(Activity withActivity) Заменяет существующее действие.

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

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

TurnContextImpl

public TurnContextImpl(BotAdapter withAdapter, Activity withActivity)

Создает объект контекста.

Параметры:

withAdapter - Адаптер создает контекст.

withActivity - Входящее действие для поворота; или null для упреждающего сообщения.

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

close

public void close()

AutoClosable#close.

Активизирует исключение:

java.lang.Exception - Значение TurnContextStateCollection.

deleteActivity

public CompletableFuture deleteActivity(ConversationReference conversationReference)

Удаляет существующее действие. Ссылка на беседу ConversationReference#getActivityId указывает действие в беседе для удаления.

Параметры:

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

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

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

deleteActivity

public CompletableFuture deleteActivity(String activityId)

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

Параметры:

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

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

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

finalize

public void finalize()

Автоматический вызов #close.

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

TurnContextImpl.finalize()

getActivity

public Activity getActivity()

Возвращает действие, связанное с этим поворотом; или null при обработке упреждающего сообщения.

getAdapter

public BotAdapter getAdapter()

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

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

BotAdaptor для этого поворота.

getBufferedReplyActivities

public List getBufferedReplyActivities()

Возвращает список действий для отправки при "контексте". Activity.DeliveryMode == "expectReplies".

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

Список действий.

getLocale

public String getLocale()

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

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

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

getResponded

public boolean getResponded()

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

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

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

getTurnState

public TurnContextStateCollection getTurnState()

Возвращает службы, зарегистрированные в этом объекте контекста.

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

TurnContextStateCollection для этого поворота.

onDeleteActivity

public TurnContext onDeleteActivity(DeleteActivityHandler handler)

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

Параметры:

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

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

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

onSendActivities

public TurnContext onSendActivities(SendActivitiesHandler handler)

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

Параметры:

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

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

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

onUpdateActivity

public TurnContext onUpdateActivity(UpdateActivityHandler handler)

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

Параметры:

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

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

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

sendActivities

public CompletableFuture sendActivities(List activities)

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

Параметры:

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

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

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

sendActivity

public CompletableFuture sendActivity(Activity activityToSend)

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

Параметры:

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

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

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend)

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

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

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

Параметры:

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

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

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

sendActivity

public CompletableFuture sendActivity(String textReplyToSend, String speak)

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

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

Параметры:

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

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

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

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

sendActivity

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

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

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

Параметры:

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

inputHint - (Необязательно) Подсказка ввода.

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

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

setLocale

public void setLocale(String withLocale)

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

Параметры:

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

updateActivity

public CompletableFuture updateActivity(Activity withActivity)

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

Параметры:

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

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

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

TurnContextImpl Класс

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

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

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

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

TurnContextImpl

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

close

deleteActivity

deleteActivity

finalize

getActivity

getAdapter

getBufferedReplyActivities

getLocale

getResponded

getTurnState

onDeleteActivity

onSendActivities

onUpdateActivity

sendActivities

sendActivity

sendActivity

sendActivity

sendActivity

setLocale

updateActivity

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