ActivityHandler Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Реализация IBot интерфейса , предназначенная для дальнейшего подкласса.
public class ActivityHandler : Microsoft.Bot.Builder.IBot
type ActivityHandler = class
interface IBot
Public Class ActivityHandler
Implements IBot
- Наследование
-
ActivityHandler
- Производный
- Реализации
Комментарии
Наследуйте от этого класса для подключения кода для обработки определенных типов действий. Предварительная и постобработка объектов может быть добавлена Activity путем вызова реализации базового класса из производного класса.
Конструкторы
ActivityHandler() |
Реализация IBot интерфейса , предназначенная для дальнейшего подкласса. |
Методы
CreateInvokeResponse(Object) |
Фабрика InvokeResponse , которая инициализирует текст переданным параметром и состоянием, равным ОК. |
OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken) |
Вызывается при отправке боту действия адаптивной карточки Execute. |
OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) |
Вызывается при получении действия команды при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) . Команды — это запросы на выполнение действия, а получатели обычно отвечают одним или несколькими действиями commandResult. Получатели также должны явно отклонять неподдерживаемые действия команд. |
OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken) |
Вызывается при получении действия CommandResult при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) . Действия CommandResult можно использовать для передачи результата выполнения команды. |
OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken) |
Вызывается при получении действия обновления диалога из канала при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) . Действия по обновлению беседы полезны при реагировании на добавление пользователей в беседу или удаление из нее. Например, бот может ответить на добавление пользователя приветствием пользователя. По умолчанию этот метод вызывается OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) при добавлении пользователей или OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) удалении пользователей. Метод проверяет идентификатор элемента, чтобы он реагировал только на обновления, касающиеся членов, отличных от самого бота. |
OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику EndOfConversation для конкретных действий, таких как логика диалога. |
OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) |
Вызывается при получении действия события от соединителя при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) .
События могут использоваться для передачи множества различных вещей.
По умолчанию этот метод вызывает OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) , если действие имеет |
OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) |
Вызывается при получении события, отличного от |
OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику, относясь к действиям InstallationUpdate . |
OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику, относяскуюся к InstallationUpdate действиям, с параметром "action" (действие), равным "add". |
OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику, относясь к InstallationUpdate действиям, с параметром "action" (действие) с значением "remove". |
OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) |
Вызывается при получении действия вызова от соединителя при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) .
Действия вызова можно использовать для передачи множества различных вещей.
По умолчанию этот метод вызывает OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) , если имя действия — |
OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику, когда участники, отличные от бота, присоединяются к беседе, например логика приветствия бота. |
OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику, когда члены, отличные от бота, покидают беседу, например логика "Прощание" бота. |
OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику Message для конкретных действий, таких как логика диалога. |
OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken) |
Вызывается при получении действия события от соединителя при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) . Реакции на сообщения соответствуют добавлению пользователем "like" или "sad" и т. д. (часто эмодзи) к ранее отправленному действию. Реакции на сообщения поддерживаются только несколькими каналами. Действие, которому соответствует реакция сообщения, указывается в свойстве replyToId. Значение этого свойства является идентификатором ранее отправленного действия, переданного боту в качестве ответа от вызова отправки. |
OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы обеспечить логику при добавлении реакций на предыдущее действие в диалог. |
OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы обеспечить логику при удалении реакций на предыдущее действие из диалога. |
OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken) |
Вызывается, когда боту отправляется действие invoke с именем application/search. |
OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) |
Вызывается при |
OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) |
Вызывается при |
OnTurnAsync(ITurnContext, CancellationToken) |
Вызывается адаптером (например, BotFrameworkAdapter) во время выполнения для обработки входящего Activity. |
OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken) |
Переопределите его в производном классе, чтобы предоставить логику Typing для конкретных действий, таких как логика диалога. |
OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken) |
Вызывается при получении действия, отличного от сообщения, обновления диалога или события при использовании базового поведения OnTurnAsync(ITurnContext, CancellationToken) . Если переопределен, это может потенциально реагировать на любой из других типов действий, таких как ContactRelationUpdate или EndOfConversation. По умолчанию этот метод не выполняет никаких действий. |