ActivityHandler Klass

Anropas när roboten skickas en åtgärd för adaptivt kort kör.

När metoden on_invoke_activity tar emot en Invoke med en Activity.name av adaptiveCard/actionanropas den här metoden.

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

Parametrar

Returer

Anropas när en konversationsuppdateringsaktivitet tas emot från kanalen när basbeteendet för on_turn används.

async on_conversation_update_activity(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

När on_turn-metoden tar emot en konversationsuppdateringsaktivitet anropas den här metoden. Också

• Om konversationsuppdateringsaktiviteten anger att andra medlemmar än roboten anslöt till konversationen anropas metoden on_members_added_activity.
• Om konversationsuppdateringsaktiviteten anger att andra medlemmar än roboten lämnade konversationen anropas metoden on_members_removed_activity.
• I en härledd klass åsidosätter du den här metoden för att lägga till logik som gäller för alla konversationsuppdateringsaktiviteter. Lägg till logik som ska tillämpas innan medlemmen lade till eller tog bort logiken före anropet till den här basklassmetoden.

Anropas när en konversationsslutaktivitet tas emot från kanalen.

async on_end_of_conversation_activity(turn_context: TurnContext)

Parametrar

Returer

Anropas när en annan händelse än tokens/svar tas emot när grundbeteendet för on_event_activity används.

async on_event(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

När metoden on_event_activity används tar den emot en händelse med ett annat aktivitetsnamn än tokens/svaranropas den här metoden. Den här metoden kan också åsidosättas om roboten är avsedd att hantera diverse händelser.

Anropas när en händelseaktivitet tas emot från anslutningsappen när basbeteendet för on_turn används.

async on_event_activity(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

När metoden on_turn tar emot en händelseaktivitet anropas den här metoden. Om aktivitetsnamnet är token/svaranropas on_token_response_event. annars anropas on_event.

I en härledd klass åsidosätter du den här metoden för att lägga till logik som gäller för alla händelseaktiviteter. Lägg till logik som ska tillämpas före den specifika händelsehanteringslogik som ska användas före anropet till den här basklassmetoden. Lägg till logik som ska tillämpas efter den specifika händelsehanteringslogik efter anropet till den här basklassmetoden.

Händelseaktiviteter kommunicerar programmatisk information från en klient eller kanal till en robot. Innebörden av en händelseaktivitet definieras av egenskapen händelseaktivitetsnamn, som är meningsfull inom omfånget för en kanal.

Åsidosätt detta i en härledd klass för att tillhandahålla logik som är specifik för ActivityTypes.InstallationUpdate-aktiviteter.

async on_installation_update(turn_context: TurnContext)

Parametrar

Returer

Åsidosätt detta i en härledd klass för att ange logik som är specifik för ActivityTypes.InstallationUpdate-aktiviteter med "åtgärd" inställt på "lägg till".

async on_installation_update_add(turn_context: TurnContext)

Parametrar

Returer

Åsidosätt detta i en härledd klass för att ange logik som är specifik för ActivityTypes.InstallationUpdate-aktiviteter med "åtgärd" inställt på "ta bort".

async on_installation_update_remove(turn_context: TurnContext)

Parametrar

Returer

Registrerar en aktivitetshändelsehanterare för anropar händelse som genereras för varje inkommande händelseaktivitet.

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

Parametrar

Returer

Åsidosätt den här metoden i en härledd klass för att tillhandahålla logik för när andra medlemmar än roboten ansluter till konversationen. Du kan lägga till robotens välkomstlogik.

konversationsuppdateringsaktivitet:skriv members_added: List :p aram turn_context: Kontextobjektet för den här svängen:skriv turn_context: TurnContext

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

Parametrar

Returer

Kommentarer

När on_conversation_update_activity-metoden tar emot en konversationsuppdateringsaktivitet som anger att en eller flera andra användare än roboten ansluter till konversationen anropas den här metoden.

Åsidosätt den här metoden i en härledd klass för att ange logik för när andra medlemmar än roboten lämnar konversationen. Du kan lägga till robotens "good-bye"-logik.

konversationsuppdateringsaktivitet:skriv members_added: List :p aram turn_context: Kontextobjektet för den här svängen:skriv turn_context: TurnContext

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

Parametrar

Returer

Kommentarer

När on_conversation_update_activity-metoden tar emot en konversationsuppdateringsaktivitet som anger att en eller flera andra användare än roboten lämnar konversationen anropas den här metoden.

Åsidosätt den här metoden i en härledd klass för att tillhandahålla logik som är specifik för aktiviteter, till exempel konversationslogik.

async on_message_activity(turn_context: TurnContext)

Parametrar

Returer

Anropas när en händelseaktivitet tas emot från anslutningsappen när basbeteendet för on_turn används.

async on_message_reaction_activity(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

Meddelandereaktioner motsvarar att användaren lägger till en "like" eller "sad" osv. (ofta en emoji) till en tidigare skickad aktivitet.

Meddelandereaktioner stöds bara av några få kanaler. Den aktivitet som meddelandereaktionen motsvarar anges i egenskapen svara på ID. Värdet för den här egenskapen är aktivitets-ID för en aktivitet som tidigare skickats tillbaka till roboten som svar från ett sändningsanrop. När metoden on_turn tar emot en meddelandereaktionsaktivitet anropas den här metoden.

• Om meddelandereaktionen indikerar att reaktioner har lagts till i ett meddelande anropas

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

• Om meddelandereaktionen anger att reaktioner har tagits bort från ett meddelande anropas <xref:botbuilder.core.ActivityHandler.on_reaction_removed>.

I en härledd klass åsidosätter du den här metoden för att lägga till logik som gäller för alla meddelandereaktionsaktiviteter. Lägg till logik som ska tillämpas innan reaktionerna har lagts till eller tagits bort innan anropet till den här basklassmetoden. Lägg till logik som ska tillämpas efter att reaktionerna lagt till eller tagit bort logiken efter anropet till den här basklassmetoden.

Åsidosätt den här metoden i en härledd klass för att ange logik för när reaktioner på en tidigare aktivitet läggs till i konversationen.

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

Parametrar

Returer

Kommentarer

Meddelandereaktioner motsvarar att användaren lägger till en "like" eller "sad" osv. (ofta en emoji) i ett tidigare skickat meddelande i konversationen. Meddelandereaktioner stöds bara av några få kanaler. Aktiviteten som meddelandet reagerar på identifieras av aktivitetens svar på ID-egenskapen. Värdet för den här egenskapen är aktivitets-ID för en tidigare skickad aktivitet. När roboten skickar en aktivitet tilldelar kanalen ett ID till den, som är tillgänglig i resurssvars-ID:t för resultatet.

Åsidosätt den här metoden i en härledd klass för att ange logik för när reaktioner på en tidigare aktivitet tas bort från konversationen.

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

Parametrar

Returer

Kommentarer

Meddelandereaktioner motsvarar att användaren lägger till en "like" eller "sad" osv. (ofta en emoji) i ett tidigare skickat meddelande i konversationen. Meddelandereaktioner stöds bara av några få kanaler. Aktiviteten som meddelandet reagerar på identifieras av aktivitetens svar på ID-egenskapen. Värdet för den här egenskapen är aktivitets-ID för en tidigare skickad aktivitet. När roboten skickar en aktivitet tilldelar kanalen ett ID till den, som är tillgänglig i resurssvars-ID:t för resultatet.

Anropas när en signin/verifyState- eller signin/tokenExchange-händelse tas emot när basbeteendet för on_invoke_activity(TurnContext{InvokeActivity}) används. Om du använder en OAuthPrompt åsidosätter du den här metoden för att vidarebefordra den här aktiviteten"/ till den aktuella dialogrutan. Som standard gör den här metoden ingenting.

async on_sign_in_invoke(turn_context: TurnContext)

Parametrar

Returer

Anropas när en token/svar händelse tas emot när grundbeteendet för on_event_activity används. Om du använder en oauth_promptåsidosätter du den här metoden för att vidarebefordra den här aktiviteten till den aktuella dialogrutan.

async on_token_response_event(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

När metoden on_event tar emot en händelse med aktivitetsnamnet tokens/svaranropas den här metoden. Om roboten använder en oauth_promptvidarebefordrar du den inkommande aktiviteten till den aktuella dialogrutan.

Anropas av adaptern (till exempel BotFrameworkAdapter) vid körning för att bearbeta en inkommande Activity.

async on_turn(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

Den anropar andra metoder i den här klassen baserat på vilken typ av aktivitet som ska bearbetas, vilket gör att en härledd klass kan tillhandahålla typspecifik logik på ett kontrollerat sätt. I en härledd klass åsidosätter du den här metoden för att lägga till logik som gäller för alla aktivitetstyper. Också

• Lägg till logik som ska tillämpas före den typspecifika logiken och innan du anropar on_turn.
• Lägg till logik som ska tillämpas efter den typspecifika logiken när du har anropat on_turn.

Åsidosätt detta i en härledd klass för att ange logik som är specifik för aktiviteter som ActivityTypes.typeing, till exempel konversationslogik.

async on_typing_activity(turn_context: TurnContext)

Parametrar

Returer

Anropas när en annan aktivitet än ett meddelande, en konversationsuppdatering eller en händelse tas emot när grundbeteendet för on_turn används. Om den åsidosätts kan den här metoden eventuellt svara på någon av de andra aktivitetstyperna.

async on_unrecognized_activity_type(turn_context: TurnContext)

Parametrar

Returer

Kommentarer

När metoden on_turn tar emot en aktivitet som inte är ett meddelande, en konversationsuppdatering, en meddelandereaktion eller en händelseaktivitet anropas den här metoden.