ActivityHandler Класс

public ActivityHandler()

protected InvokeResponse createInvokeResponse(Object body)

Создает успешное выполнение InvokeResponse с указанным текстом.

Параметры:

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

protected CompletableFuture onAdaptiveCardInvoke(TurnContext turnContext, AdaptiveCardInvokeValue invokeValue)

Вызывается при отправке ботом действия адаптивной карточки.

Параметры:

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

protected CompletableFuture onCommandActivity(TurnContext turnContext)

Вызывается при получении действия команды при использовании базового поведения onTurn(TurnContext turnContext). Команды — это запросы на выполнение действия и получателей обычно отвечают на одно или несколько действий commandResult. Получатели также должны явно отклонять неподдерживаемые действия команд.

Параметры:

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

protected CompletableFuture onCommandResultActivity(TurnContext turnContext)

Вызывается при получении действия CommandResult при использовании базового поведения onTurn(TurnContext turnContext). Действия CommandResult можно использовать для обмена данными о результатах выполнения команды.

Параметры:

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

protected CompletableFuture onConversationUpdateActivity(TurnContext turnContext)

Вызывается при получении действия обновления беседы из канала при использовании базового поведения onTurn(TurnContext turnContext).

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

Например, бот может отвечать на добавление пользователя, приветствуя пользователя. По умолчанию этот метод вызывает onMembersAdded(List<ChannelAccount> membersAdded, TurnContext turnContext), если какие-либо пользователи были добавлены или onMembersRemoved(List<ChannelAccount> membersRemoved, TurnContext turnContext), если какие-либо пользователи были удалены. Метод проверяет идентификатор члена таким образом, чтобы он ответил только на обновления, касающиеся членов, отличных от самого бота.

Параметры:

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

protected CompletableFuture onEndOfConversationActivity(TurnContext turnContext)

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

Параметры:

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

protected CompletableFuture onEvent(TurnContext turnContext)

Вызывается при получении события, отличного от маркеров или ответа, при использовании базового поведения onEventActivity(TurnContext turnContext).

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

По умолчанию этот метод ничего не делает.

Когда метод onEventActivity(TurnContext turnContext) получает событие с Activity#getName(), отличной от "token/response", он вызывает этот метод.

Параметры:

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

protected CompletableFuture onEventActivity(TurnContext turnContext)

Вызывается при получении действия события из соединителя при использовании базового поведения onTurn(TurnContext turnContext).

Действия событий можно использовать для взаимодействия с различными вещами.

По умолчанию этот метод вызывает onTokenResponseEvent(TurnContext turnContext), если имя действия — "token/response" или onEvent(TurnContext turnContext) в противном случае. Событие "token/response" может быть активировано com.microsoft.bot.schema.OAuthCard.

Когда метод onTurn(TurnContext turnContext) получает действие события, он вызывает этот метод.

Если событие Activity#getName имеет значение "token/response", оно вызывает onTokenResponseEvent(TurnContext turnContext) в противном случае вызывает onEvent(TurnContext turnContext).

В производном классе переопределите этот метод, чтобы добавить логику, которая применяется ко всем действиям события. Добавьте логику для применения перед конкретной логикой обработки событий перед вызовом метода базового класса. Добавьте логику для применения после конкретной логики обработки событий после вызова метода базового класса.

Действия событий передают программные сведения от клиента или канала боту. Значение действия события определяется свойством Activity#getName, которое имеет смысл в пределах области канала. Событие "token/response" может быть активировано com.microsoft.bot.schema.OAuthCard или запросом OAuth.

Параметры:

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

protected CompletableFuture onInstallationUpdate(TurnContext turnContext)

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

Параметры:

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

protected CompletableFuture onInstallationUpdateAdd(TurnContext turnContext)

Переопределите это в производном классе, чтобы предоставить логику, относясь к действиям ActivityTypes.InstallationUpdate, с помощью действия "action", заданного как "add".

Параметры:

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

protected CompletableFuture onInstallationUpdateRemove(TurnContext turnContext)

Переопределите это в производном классе, чтобы предоставить логику, относясь к действиям ActivityTypes.InstallationUpdate, с помощью действия action, заданного как remove.

Параметры:

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

protected CompletableFuture onInvokeActivity(TurnContext turnContext)

Вызывается при получении действия вызова из соединителя при использовании базового поведения onTurn.

Вызов действий можно использовать для взаимодействия с различными вещами. По умолчанию этот метод вызовет onSignInvokeAsync, если имя действия — signin/verifyState или signin/tokenExchange.

Вызов signin/verifyState или signin/tokenExchange можно активировать с помощью OAuthCard.

Параметры:

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

protected CompletableFuture onMembersAdded(List membersAdded, TurnContext turnContext)

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

Когда метод onConversationUpdateActivity(TurnContext turnContext) получает действие обновления беседы, указывающее, что один или несколько пользователей, отличных от присоединения к беседе, вызывает этот метод.

Параметры:

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

protected CompletableFuture onMembersRemoved(List membersRemoved, TurnContext turnContext)

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

Когда метод onConversationUpdateActivity(TurnContext turnContext) получает действие обновления беседы, указывающее, что один или несколько пользователей, отличных от бота, покидают беседу, вызывает этот метод.

Параметры:

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

protected CompletableFuture onMessageActivity(TurnContext turnContext)

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

Когда метод onTurn(TurnContext turnContext) получает действие сообщения, он вызывает этот метод.

Параметры:

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

protected CompletableFuture onMessageReactionActivity(TurnContext turnContext)

Вызывается при получении действия события из соединителя при использовании базового поведения onTurn(TurnContext turnContext).

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

Действие, которое соответствует реакции сообщения, указано в свойстве replyToId. Значение этого свойства — это идентификатор действия ранее отправленного действия, возвращаемого боту в качестве ответа от вызова отправки.

Когда метод onTurn(TurnContext turnContext) получает действие реакции сообщения, он вызывает этот метод. Если реакция сообщения указывает на то, что реакции были добавлены в сообщение, он вызывает onReactionsAdded(List<MessageReaction> messageReactions, TurnContext turnContext). Если реакция сообщения указывает на то, что реакции были удалены из сообщения, он вызывает onReactionsRemoved(List<MessageReaction> messageReactions, TurnContext turnContext).

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

Параметры:

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

protected CompletableFuture onReactionsAdded(List messageReactions, TurnContext turnContext)

Переопределите это в производном классе, чтобы обеспечить логику при добавлении реакций на предыдущее действие в беседу.

Реакции на сообщения соответствуют пользователю, добавляя "нравится" или "грустный" и т. д. (часто эмодзи) в ранее отправленное сообщение в беседе. Реакции на сообщения поддерживаются только несколькими каналами. Действие, на которое сообщение реагирует, определяется свойством Activity#getReplyToId() действия. Значение этого свойства — это идентификатор действия ранее отправленного действия. Когда бот отправляет действие, канал назначает ему идентификатор, который доступен в com.microsoft.bot.schema.ResourceResponse#getId результата.

Параметры:

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

protected CompletableFuture onReactionsRemoved(List messageReactions, TurnContext turnContext)

Переопределите это в производном классе, чтобы обеспечить логику при удалении реакций на предыдущее действие из беседы.

Реакции на сообщения соответствуют пользователю, добавляя "нравится" или "грустный" и т. д. (часто эмодзи) в ранее отправленное сообщение в беседе. Реакции на сообщения поддерживаются только несколькими каналами. Действие, на которое сообщение реагирует, определяется свойством Activity#getReplyToId() действия. Значение этого свойства — это идентификатор действия ранее отправленного действия. Когда бот отправляет действие, канал назначает ему идентификатор, который доступен в com.microsoft.bot.schema.ResourceResponse#getId результата.

Параметры:

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

protected CompletableFuture onSignInInvoke(TurnContext turnContext)

Вызывается при получении события signin/verifyState или signin/tokenExchange, когда используется базовое поведение onInvokeActivity.

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

Когда метод onInvokeActivity получает вызов с именем token/response, он вызывает этот метод.

Если бот использует OAuthPrompt, перенаправьте входящее действие в текущее диалоговое окно.

Параметры:

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

protected CompletableFuture onTokenResponseEvent(TurnContext turnContext)

Вызывается при получении события "token/response" при использовании базового поведения onEventActivity(TurnContext turnContext).

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

По умолчанию этот метод ничего не делает.

Когда метод onEventActivity(TurnContext turnContext) получает событие с Activity#getName() "token/response", он вызывает этот метод.

Параметры:

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

public CompletableFuture onTurn(TurnContext turnContext)

Вызывается адаптером (например, BotFrameworkAdapter) во время выполнения для обработки входящего Activity.

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

В производном классе переопределите этот метод, чтобы добавить логику, которая применяется ко всем типам действий. Добавьте логику, применяемую перед логикой для конкретного типа перед вызовом метода базового класса onTurn(TurnContext turnContext). Добавьте логику, применяемую после логики для конкретного типа после вызова метода базового класса onTurn(TurnContext turnContext).

Параметры:

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

protected CompletableFuture onTypingActivity(TurnContext turnContext)

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

Параметры:

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

protected CompletableFuture onUnrecognizedActivityType(TurnContext turnContext)

Вызывается при получении действия, отличного от сообщения, обновления беседы или события при использовании базового поведения onTurn(TurnContext turnContext).

При переопределении это может реагировать на любой из других типов действий, таких как com.microsoft.bot.schema.ActivityTypes#CONTACT_RELATION_UPDATE или com.microsoft.bot.schema.ActivityTypes#END_OF_CONVERSATION.

По умолчанию этот метод ничего не делает.

Когда метод onTurn(TurnContext turnContext) получает действие, которое не является сообщением, обновлением беседы, реакцией сообщения или действием события, он вызывает этот метод.

Параметры:

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