ActivityHandler Klasa

Wywoływana, gdy bot jest wysyłany do wykonania akcji karty adaptacyjnej.

Gdy metoda on_invoke_activity odbiera wywołanie z Activity.name adaptacyjnej karty/akcji , wywołuje tę metodę.

async on_adaptive_card_invoke(turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue) -> AdaptiveCardInvokeResponse

Parametry

Zwraca

Wywoływane, gdy działanie aktualizacji konwersacji jest odbierane z kanału, gdy jest używane podstawowe zachowanie on_turn.

async on_conversation_update_activity(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_turn odbiera działanie aktualizacji konwersacji, wywołuje tę metodę. Też

• Jeśli działanie aktualizacji konwersacji wskazuje, że członkowie inni niż bot dołączyli do konwersacji, wywołuje metodę on_members_added_activity.
• Jeśli działanie aktualizacji konwersacji wskazuje, że członkowie inni niż bot opuścili konwersację, wywołuje metodę on_members_removed_activity.
• W klasie pochodnej zastąp tę metodę, aby dodać logikę, która ma zastosowanie do wszystkich działań aktualizacji konwersacji. Dodaj logikę do zastosowania przed dodaniem lub usunięciem logiki składowej przed wywołaniem tej metody klasy bazowej.

Wywoływane po odebraniu aktywności zakończenia konwersacji z kanału.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parametry

Zwraca

Wywoływane, gdy jest odbierane zdarzenie inne niż tokeny/ odpowiedzi, gdy jest używane podstawowe zachowanie on_event_activity.

async on_event(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_event_activity jest używana, odbiera zdarzenie o nazwie działania innej niż tokeny/odpowiedź, wywołuje tę metodę. Tę metodę można opcjonalnie zastąpić, jeśli bot ma obsługiwać różne zdarzenia.

Wywoływane, gdy działanie zdarzenia jest odbierane z łącznika, gdy jest używane podstawowe zachowanie on_turn.

async on_event_activity(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_turn odbiera działanie zdarzenia, wywołuje tę metodę. Jeśli nazwa działania to tokeny/odpowiedź, wywołuje on_token_response_event; w przeciwnym razie wywołuje on_event.

W klasie pochodnej zastąp tę metodę, aby dodać logikę, która ma zastosowanie do wszystkich działań zdarzeń. Dodaj logikę do zastosowania przed konkretną logiką obsługi zdarzeń przed wywołaniem tej metody klasy bazowej. Dodaj logikę do zastosowania po określonej logice obsługi zdarzeń po wywołaniu tej metody klasy bazowej.

Działania zdarzenia komunikują informacje programowe z klienta lub kanału do bota. Znaczenie działania zdarzenia jest definiowane przez właściwość nazwy działania zdarzenia, która ma znaczenie w zakresie kanału.

Zastąp to w klasie pochodnej, aby zapewnić logikę specyficzną dla działań ActivityTypes.InstallationUpdate.

async on_installation_update(turn_context: TurnContext)

Parametry

Zwraca

Zastąp to w klasie pochodnej, aby zapewnić logikę specyficzną dla działań ActivityTypes.InstallationUpdate z ustawieniem "action" na wartość "add".

async on_installation_update_add(turn_context: TurnContext)

Parametry

Zwraca

Zastąp to w klasie pochodnej, aby zapewnić logikę specyficzną dla działań ActivityTypes.InstallationUpdate z wartością "action" ustawioną na wartość "remove".

async on_installation_update_remove(turn_context: TurnContext)

Parametry

Zwraca

Rejestruje program obsługi zdarzeń działania dla wywołać zdarzenie, emitowane dla każdego przychodzącego działania zdarzenia.

async on_invoke_activity(turn_context: TurnContext) -> InvokeResponse | None

Parametry

Zwraca

Zastąp tę metodę w klasie pochodnej, aby zapewnić logikę, gdy elementy członkowskie inne niż bot dołączają do konwersacji. Możesz dodać logikę powitalną bota.

działanie aktualizacji konwersacji :type members_added: List :p aram turn_context: obiekt kontekstu dla tego turnu:type turn_context: TurnContext

async on_members_added_activity(members_added: List[ChannelAccount], turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_conversation_update_activity odbiera działanie aktualizacji konwersacji, które wskazuje, że co najmniej jeden użytkownik inny niż bot dołącza do konwersacji, wywołuje tę metodę.

Zastąp tę metodę w klasie pochodnej, aby zapewnić logikę, gdy elementy członkowskie inne niż bot opuszczają konwersację. Możesz dodać logikę good-bye bota.

działanie aktualizacji konwersacji :type members_added: List :p aram turn_context: obiekt kontekstu dla tego turnu:type turn_context: TurnContext

async on_members_removed_activity(members_removed: List[ChannelAccount], turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_conversation_update_activity odbiera działanie aktualizacji konwersacji, które wskazuje, że co najmniej jeden użytkownik inny niż bot opuszcza konwersację, wywołuje tę metodę.

Zastąp tę metodę w klasie pochodnej, aby zapewnić logikę specyficzną dla działań, takich jak logika konwersacyjna.

async on_message_activity(turn_context: TurnContext)

Parametry

Zwraca

Wywoływane, gdy działanie zdarzenia jest odbierane z łącznika, gdy jest używane podstawowe zachowanie on_turn.

async on_message_reaction_activity(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

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 Identyfikator odpowiedzi. 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. Gdy metoda on_turn odbiera działanie reakcji komunikatu, wywołuje tę metodę.

• Jeśli reakcja komunikatu wskazuje, że reakcje zostały dodane do komunikatu, wywołuje

<xref:botbuilder.core.ActivityHandler.on_reaction_added>.

• Jeśli reakcja komunikatu wskazuje, że reakcje zostały usunięte z komunikatu, wywołuje <xref:botbuilder.core.ActivityHandler.on_reaction_removed>.

W klasie pochodnej zastąp tę metodę, aby dodać logikę, która ma zastosowanie do wszystkich działań reakcji komunikatów. Dodaj logikę do zastosowania przed dodaniem lub usunięciem logiki reakcji przed wywołaniem tej metody klasy bazowej. Dodaj logikę do zastosowania po dodaniu lub usunięciu logiki po wywołaniu tej metody klasy bazowej.

Zastąp tę metodę w klasie pochodnej, aby zapewnić logikę, gdy reakcje na poprzednie działanie są dodawane do konwersacji.

async on_reactions_added(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Reakcje komunikatów odpowiadają użytkownikowi dodającym komunikat "jak" lub "smutny" itp. (często emoji) do wcześniej wysłanej wiadomości w konwersacji. Reakcje komunikatów są obsługiwane tylko przez kilka kanałów. Działanie, na które komunikat jest w reakcji, jest identyfikowane przez właściwość identyfikatora działania. Wartość tej właściwości to identyfikator działania wcześniej wysłanego działania. Gdy bot wysyła działanie, kanał przypisuje do niego identyfikator, który jest dostępny w identyfikatorze odpowiedzi zasobu wyniku.

Zastąp tę metodę w klasie pochodnej, aby zapewnić logikę, gdy reakcje na poprzednie działanie zostaną usunięte z konwersacji.

async on_reactions_removed(message_reactions: List[MessageReaction], turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Reakcje komunikatów odpowiadają użytkownikowi dodającym komunikat "jak" lub "smutny" itp. (często emoji) do wcześniej wysłanej wiadomości w konwersacji. Reakcje komunikatów są obsługiwane tylko przez kilka kanałów. Działanie, na które komunikat jest w reakcji, jest identyfikowane przez właściwość Id działania. Wartość tej właściwości to identyfikator działania wcześniej wysłanego działania. Gdy bot wysyła działanie, kanał przypisuje do niego identyfikator, który jest dostępny w identyfikatorze odpowiedzi zasobu wyniku.

Wywoływane po odebraniu zdarzenia signin/verifyState lub signin/tokenExchange, gdy jest używane podstawowe zachowanie on_invoke_activity(TurnContext{InvokeActivity}). Jeśli używasz protokołu OAuthPrompt, zastąp tę metodę, aby przekazać to działanie"/ do bieżącego okna dialogowego. Domyślnie ta metoda nic nie robi.

async on_sign_in_invoke(turn_context: TurnContext)

Parametry

Zwraca

Wywoływane, gdy jest odbierane zdarzenie tokenów/odpowiedzi, gdy jest używane podstawowe zachowanie on_event_activity. Jeśli używasz oauth_prompt, przesłoń tę metodę, aby przekazać to działanie do bieżącego okna dialogowego.

async on_token_response_event(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_event odbiera zdarzenie o nazwie działania tokenów/odpowiedzi, wywołuje tę metodę. Jeśli bot używa oauth_prompt, prześlij działanie przychodzące do bieżącego okna dialogowego.

Wywoływana przez adapter (na przykład BotFrameworkAdapter) w czasie wykonywania w celu przetworzenia przychodzącego Activity.

async on_turn(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Wywołuje inne metody w tej klasie na podstawie typu działania do przetwarzania, co umożliwia klasy pochodnej zapewnienie logiki specyficznej dla typu w kontrolowany sposób. W klasie pochodnej zastąp tę metodę, aby dodać logikę, która ma zastosowanie do wszystkich typów działań. Też

• Dodaj logikę do zastosowania przed logiką specyficzną dla typu i przed wywołaniem on_turn.
• Dodaj logikę do zastosowania po logice specyficznej dla typu po wywołaniu on_turn.

Zastąp to w klasie pochodnej, aby zapewnić logikę specyficzną dla działań ActivityTypes.typing, takich jak logika konwersacyjna.

async on_typing_activity(turn_context: TurnContext)

Parametry

Zwraca

Wywoływane, gdy jest odbierane działanie inne niż komunikat, aktualizacja konwersacji lub zdarzenie, gdy jest używane podstawowe zachowanie on_turn. W przypadku zastąpienia ta metoda może potencjalnie reagować na dowolny z innych typów działań.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parametry

Zwraca

Uwagi

Gdy metoda on_turn odbiera działanie, które nie jest komunikatem, aktualizacją konwersacji, reakcją komunikatu lub działaniem zdarzenia, wywołuje tę metodę.