ActivityHandler Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Implementacja interfejsu IBot , przeznaczona do dalszego podklasowania.
public class ActivityHandler : Microsoft.Bot.Builder.IBot
type ActivityHandler = class
interface IBot
Public Class ActivityHandler
Implements IBot
- Dziedziczenie
-
ActivityHandler
- Pochodne
- Implementuje
Uwagi
Utwórz z tej klasy kod, aby podłączyć kod do obsługi określonych typów działań. Wstępne i postprzetwarzanie obiektów Activity można dodać, wywołując implementację klasy bazowej z klasy pochodnej.
Konstruktory
| Nazwa | Opis |
|---|---|
| ActivityHandler() |
Implementacja interfejsu IBot , przeznaczona do dalszego podklasowania. |
Metody
| Nazwa | Opis |
|---|---|
| CreateInvokeResponse(Object) |
Fabryka InvokeResponse , która inicjalizuje nadwozie do przekazanego parametru i statusu równego OK. |
| OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken) |
Wywoływana, gdy bot jest wysyłany do wykonania akcji karty adaptacyjnej. |
| OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken) |
Wywoływane po otrzymaniu aktywności polecenia, gdy użyto zachowania OnTurnAsync(ITurnContext, CancellationToken) bazowego. Polecenia to żądania wykonania akcji, a odbiorniki zwykle odpowiadają za pomocą co najmniej jednego działania commandResult. Oczekuje się również, że odbiorniki jawnie odrzucają nieobsługiwane działania poleceń. |
| OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken) |
Wywoływane, gdy odebrano aktywność CommandResult podczas używania zachowania bazowego OnTurnAsync(ITurnContext, CancellationToken) . Działania CommandResult mogą służyć do komunikowania wyniku wykonania polecenia. |
| OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken) |
Wywoływane, gdy działanie aktualizacji konwersacji jest odbierane z kanału, gdy jest używane podstawowe zachowanie OnTurnAsync(ITurnContext, CancellationToken). Działania aktualizacji konwersacji są przydatne, jeśli chodzi o reagowanie na użytkowników dodawanych do lub usuwanych z konwersacji. Na przykład bot może odpowiedzieć użytkownikowi dodawanemu przez powitanie użytkownika. Domyślnie ta metoda sprawdza OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) , czy dodano OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) lub usunięto użytkowników. Metoda sprawdza identyfikator elementu członkowskiego, aby odpowiadała tylko na aktualizacje dotyczące elementów członkowskich innych niż sam bot. |
| OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken) |
Nadpisanie tego w klasie pochodnej, aby zapewnić logikę specyficzną dla EndOfConversation aktywności, takich jak logika konwersacyjna. |
| OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) |
Wywoływane, gdy działanie zdarzenia jest odbierane z łącznika, gdy jest używane podstawowe zachowanie OnTurnAsync(ITurnContext, CancellationToken).
Działania zdarzeń mogą służyć do komunikowania się z wieloma różnymi rzeczami.
Domyślnie ta metoda wywoła OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) , czy nazwa aktywności jest lub |
| OnEventAsync(ITurnContext<IEventActivity>, CancellationToken) |
Wywoływane wtedy, gdy zdarzenie inne niż |
| OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken) |
Nadpisuj to w klasie pochodnej, aby zapewnić logikę specyficzną dla InstallationUpdate działań. |
| OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken) |
Nadpisuj to w klasie pochodnej, aby zapewnić logikę specyficzną dla InstallationUpdate aktywności z ustawieniem 'action' na 'add'. |
| OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken) |
Przepisz to w klasie pochodnej, aby zapewnić logikę specyficzną dla InstallationUpdate aktywności z ustawioną 'akcją' na 'usuwanie'. |
| OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) |
Wywoływane, gdy aktywność wywołania jest odbierana z konektora, gdy używane jest podstawowe zachowanie .OnTurnAsync(ITurnContext, CancellationToken)
Wywoływanie działań może służyć do komunikowania się wielu różnych rzeczy.
Domyślnie ta metoda wywoła OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) , jeśli nazwa aktywności to |
| OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) |
Zastąp to w klasie pochodnej, aby zapewnić logikę, gdy elementy członkowskie inne niż bot dołączają do konwersacji, takie jak logika powitalna bota. |
| OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken) |
Zastąp to w klasie pochodnej, aby zapewnić logikę, gdy członkowie inni niż bot opuszczają konwersację, na przykład logikę good-bye bota. |
| OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken) |
Nadpisanie tego w klasie pochodnej, aby zapewnić logikę specyficzną dla Message aktywności, takich jak logika konwersacyjna. |
| OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken) |
Nadpisanie tego w klasie pochodnej, aby zapewnić logikę specyficzną dla MessageDelete aktywności, takich jak logika konwersacyjna. |
| OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken) |
Wywoływane, gdy działanie zdarzenia jest odbierane z łącznika, gdy jest używane podstawowe zachowanie OnTurnAsync(ITurnContext, CancellationToken). Reakcje komunikatów odpowiadają użytkownikowi dodającym wyraz "like" lub "sad" itp. (często emoji) do wcześniej wysłanego działania. Reakcje komunikatów są obsługiwane tylko przez kilka kanałów. Działanie, do którego odnosi się reakcja komunikatu, jest wskazywane we właściwości replyToId. Wartość tej właściwości jest identyfikatorem działania wcześniej wysłanego działania przekazanego z powrotem do bota jako odpowiedzi z wywołania wysyłania. |
| OnMessageUpdateActivityAsync(ITurnContext<IMessageUpdateActivity>, CancellationToken) |
Nadpisanie tego w klasie pochodnej, aby zapewnić logikę specyficzną dla MessageUpdate aktywności, takich jak logika konwersacyjna. |
| OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken) |
Zastąp to w klasie pochodnej, aby zapewnić logikę, gdy reakcje na poprzednie działanie są dodawane do konwersacji. |
| OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken) |
Zastąp to w klasie pochodnej, aby zapewnić logikę, gdy reakcje na poprzednie działanie zostaną usunięte z konwersacji. |
| OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken) |
Wywoływane, gdy bot jest wysyłany do działania "invoke" o nazwie "application/search". |
| OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken) |
Wywoływane, gdy odebrane jest zdarzenie |
| OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken) |
Wywoływane, gdy odebrane jest zdarzenie |
| OnTurnAsync(ITurnContext, CancellationToken) |
Wywoływane przez adapter (na przykład ) BotFrameworkAdapterw czasie działania, aby przetworzyć przychodzące Activity. |
| OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken) |
Nadpisanie tego w klasie pochodnej, aby zapewnić logikę specyficzną dla Typing aktywności, takich jak logika konwersacyjna. |
| OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken) |
Wywoływane, gdy jest odbierane działanie inne niż komunikat, aktualizacja konwersacji lub zdarzenie, gdy jest używane podstawowe zachowanie OnTurnAsync(ITurnContext, CancellationToken). Jeśli zostanie nadpisane, może to potencjalnie reagować na inne typy aktywności, takie jak ContactRelationUpdate lub EndOfConversation. Domyślnie ta metoda nic nie robi. |