ActivityHandler Osztály

Kezeli a tevékenységeket, és alosztályozottnak kell lennie.

Konstruktor

ActivityHandler()

Megjegyzések

Ebből az osztályból származtathatja az adott tevékenységtípusokat. A Yon hozzáadhatja a tevékenységek előzetes és utólagos feldolgozását úgy, hogy meghívja az alaposztályt a származtatott osztályban.

Metódusok

on_adaptive_card_invoke

A rendszer meghívja a robotot egy adaptív kártyaművelet végrehajtásakor.

Amikor a on_invoke_activity metódus Activity.name adaptívcard/műveletkap meghívást, ezt a metódust hívja meg.

on_conversation_update_activity

Akkor hívható meg, amikor beszélgetésfrissítési tevékenység érkezik a csatornáról, amikor a on_turn alapszintű viselkedését használja.

on_end_of_conversation_activity

Akkor hívható meg, ha a csatorna egy beszélgetés végtevékenységet fogad.

on_event

Akkor hívható meg, ha a rendszer nem jogkivonatokat/választ fogad, amikor az on_event_activity alapszintű viselkedését használja.

on_event_activity

Akkor hívható meg, ha eseménytevékenység érkezik az összekötőtől a on_turn alapszintű viselkedésének használatakor.

on_installation_update

Ezt felülbírálhatja egy származtatott osztályban, hogy az ActivityTypes.InstallationUpdate tevékenységekre jellemző logikát biztosítson.

on_installation_update_add

Ezt felülbírálhatja egy származtatott osztályban, hogy az ActivityTypes.InstallationUpdate tevékenységekhez tartozó logikát adjon meg "hozzáadás" értékre állított "művelettel".

on_installation_update_remove

Ezt felülbírálhatja egy származtatott osztályban, hogy az ActivityTypes.InstallationUpdate tevékenységekhez tartozó logikát "remove" értékre állítsa.

on_invoke_activity

Regisztrál egy tevékenységesemény-kezelőt a meghívja eseményt, amely minden bejövő eseménytevékenységhez ki van adva.

on_members_added_activity

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra vonatkozóan, hogy a roboton kívüli tagok mikor csatlakoznak a beszélgetéshez. Hozzáadhatja a robot üdvözlő logikáját.

beszélgetésfrissítési tevékenység :type members_added: List :p aram turn_context: Az ehhez a turnhöz tartozó környezeti objektum :type turn_context: TurnContext

on_members_removed_activity

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra az esetben, ha a robottól eltérő tagok elhagyják a beszélgetést. Hozzáadhatja a robot búcsúlogikát.

beszélgetésfrissítési tevékenység :type members_added: List :p aram turn_context: Az ehhez a turnhöz tartozó környezeti objektum :type turn_context: TurnContext

on_message_activity

Felülbírálja ezt a metódust egy származtatott osztályban, hogy a tevékenységekre, például a beszélgetési logikára jellemző logikát biztosítson.

on_message_reaction_activity

Akkor hívható meg, ha eseménytevékenység érkezik az összekötőtől a on_turn alapszintű viselkedésének használatakor.

on_reactions_added

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra vonatkozóan, hogy egy korábbi tevékenységre adott reakciók mikor lesznek hozzáadva a beszélgetéshez.

on_reactions_removed

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra az esetre, ha egy korábbi tevékenységre adott reakciók törlődnek a beszélgetésből.

on_sign_in_invoke

Akkor hívható meg, ha egy bejelentkezési/ellenőrzőState vagy signin/tokenExchange esemény érkezik on_invoke_activity (TurnContext{InvokeActivity}) alapműveletének használatakor. OAuthPrompt használata esetén felülbírálja ezt a metódust a tevékenység továbbításához"/ az aktuális párbeszédpanelre. Alapértelmezés szerint ez a metódus nem tesz semmit.

on_token_response_event

jogkivonatok/válasz esemény fogadása on_event_activity alapszintű viselkedésének használatakor. Ha oauth_prompthasznál, felülbírálhatja ezt a metódust, hogy továbbítsa ezt a tevékenységet az aktuális párbeszédpanelre.

on_turn

Az adapter meghívja (például <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) futásidőben, hogy feldolgozhasson egy bejövő Activity.

on_typing_activity

Felülbírálhatja ezt egy származtatott osztályban, hogy az ActivityTypes.type tevékenységekre, például a beszélgetési logikára vonatkozó logikát biztosítson.

on_unrecognized_activity_type

Akkor hívható meg, ha nem üzenet, beszélgetés frissítése vagy esemény érkezik, amikor a on_turn alapszintű viselkedését használják. Ha felül van bírálva, ez a módszer bármely más tevékenységtípusra reagálhat.

on_adaptive_card_invoke

A rendszer meghívja a robotot egy adaptív kártyaművelet végrehajtásakor.

Amikor a on_invoke_activity metódus Activity.name adaptívcard/műveletkap meghívást, ezt a metódust hívja meg.

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

Paraméterek

Name Description
turn_context
Kötelező

Egy környezeti objektum ehhez a sorhoz.

invoke_value
Kötelező
<xref:botframework.schema.models.AdaptiveCardInvokeValue>

Sztring típusú objektum a bejövő tevékenység értékéből.

Válaszok

Típus Description

A HealthCheckResponse objektum

on_conversation_update_activity

Akkor hívható meg, amikor beszélgetésfrissítési tevékenység érkezik a csatornáról, amikor a on_turn alapszintű viselkedését használja.

async on_conversation_update_activity(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Amikor a on_turn metódus beszélgetésfrissítési tevékenységet kap, ezt a metódust hívja meg. Is

  • Ha a beszélgetésfrissítési tevékenység azt jelzi, hogy a robottól eltérő tagok csatlakoztak a beszélgetéshez, meghívja a on_members_added_activity metódust.
  • Ha a beszélgetésfrissítési tevékenység azt jelzi, hogy a roboton kívüli tagok kilépnek a beszélgetésből, meghívja a on_members_removed_activity metódust.
  • Származtatott osztályban felülbírálhatja ezt a metódust, hogy minden beszélgetésfrissítési tevékenységre vonatkozó logikát adjon hozzá. Adjon hozzá logikát az alaposztály metódushoz való hívás előtt, mielőtt a tag hozzáadta vagy eltávolította a logikát.

on_end_of_conversation_activity

Akkor hívható meg, ha a csatorna egy beszélgetés végtevékenységet fogad.

async on_end_of_conversation_activity(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_event

Akkor hívható meg, ha a rendszer nem jogkivonatokat/választ fogad, amikor az on_event_activity alapszintű viselkedését használja.

async on_event(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Ha a on_event_activity metódus nem jogkivonatok/válasz, akkor ezt a metódust hívja meg. Ez a módszer felülbírálható, ha a robot más események kezelésére szolgál.

on_event_activity

Akkor hívható meg, ha eseménytevékenység érkezik az összekötőtől a on_turn alapszintű viselkedésének használatakor.

async on_event_activity(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Amikor a on_turn metódus eseménytevékenységet kap, ezt a metódust hívja meg. Ha a tevékenység neve jogkivonat/válasz, meghívja on_token_response_event; ellenkező esetben meghívja on_event.

Származtatott osztályban felülbírálja ezt a metódust az összes eseménytevékenységre vonatkozó logika hozzáadásához. Adjon hozzá logikát, amely az adott eseménykezelési logika előtt alkalmazható az alaposztály-metódus hívása előtt. Adja hozzá az adott eseménykezelési logika után alkalmazandó logikát az alaposztály metódusának meghívása után.

Az eseménytevékenységek programozott információkat közölnek egy ügyfélről vagy csatornáról egy robottal. Az eseménytevékenységek jelentését az eseménytevékenység neve tulajdonság határozza meg, amely a csatorna hatókörén belül értelmezhető.

on_installation_update

Ezt felülbírálhatja egy származtatott osztályban, hogy az ActivityTypes.InstallationUpdate tevékenységekre jellemző logikát biztosítson.

async on_installation_update(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_installation_update_add

Ezt felülbírálhatja egy származtatott osztályban, hogy az ActivityTypes.InstallationUpdate tevékenységekhez tartozó logikát adjon meg "hozzáadás" értékre állított "művelettel".

async on_installation_update_add(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_installation_update_remove

Ezt felülbírálhatja egy származtatott osztályban, hogy az ActivityTypes.InstallationUpdate tevékenységekhez tartozó logikát "remove" értékre állítsa.

async on_installation_update_remove(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_invoke_activity

Regisztrál egy tevékenységesemény-kezelőt a meghívja eseményt, amely minden bejövő eseménytevékenységhez ki van adva.

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

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_members_added_activity

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra vonatkozóan, hogy a roboton kívüli tagok mikor csatlakoznak a beszélgetéshez. Hozzáadhatja a robot üdvözlő logikáját.

beszélgetésfrissítési tevékenység :type members_added: List :p aram turn_context: Az ehhez a turnhöz tartozó környezeti objektum :type turn_context: TurnContext

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

Paraméterek

Name Description
members_added
Kötelező
turn_context
Kötelező

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Amikor a on_conversation_update_activity metódus olyan beszélgetésfrissítési tevékenységet kap, amely azt jelzi, hogy a roboton kívül egy vagy több felhasználó csatlakozik a beszélgetéshez, ezt a metódust hívja meg.

on_members_removed_activity

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra az esetben, ha a robottól eltérő tagok elhagyják a beszélgetést. Hozzáadhatja a robot búcsúlogikát.

beszélgetésfrissítési tevékenység :type members_added: List :p aram turn_context: Az ehhez a turnhöz tartozó környezeti objektum :type turn_context: TurnContext

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

Paraméterek

Name Description
members_removed
Kötelező
turn_context
Kötelező

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Amikor a on_conversation_update_activity metódus olyan beszélgetésfrissítési tevékenységet kap, amely azt jelzi, hogy a roboton kívül egy vagy több felhasználó elhagyja a beszélgetést, ezt a metódust hívja meg.

on_message_activity

Felülbírálja ezt a metódust egy származtatott osztályban, hogy a tevékenységekre, például a beszélgetési logikára jellemző logikát biztosítson.

async on_message_activity(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_message_reaction_activity

Akkor hívható meg, ha eseménytevékenység érkezik az összekötőtől a on_turn alapszintű viselkedésének használatakor.

async on_message_reaction_activity(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Az üzenetválaszok megegyeznek azzal, hogy a felhasználó hozzáad egy "tetszik" vagy "szomorú" stb. (gyakran emoji) elemet egy korábban elküldött tevékenységhez.

Az üzenetválaszokat csak néhány csatorna támogatja. Az üzenet reakciójának megfelelő tevékenység az Azonosító válasz tulajdonságában van feltüntetve. Ennek a tulajdonságnak az értéke egy korábban elküldött tevékenység tevékenységazonosítója, amelyet egy küldési hívás válaszaként ad vissza a robotnak. Amikor a on_turn metódus üzenetet reagáló tevékenységet kap, ezt a metódust hívja meg.

  • Ha az üzenet reakciója azt jelzi, hogy a reakciókat hozzáadták egy üzenethez,

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

  • Ha az üzenet reakciója azt jelzi, hogy a reakciókat eltávolították egy üzenetből, meghívja <xref:botbuilder.core.activity_handler.ActivityHandler.on_reaction_removed>.

Egy származtatott osztályban felülbírálja ezt a metódust, hogy minden üzenetreakciós tevékenységre vonatkozó logikát adjon hozzá. Adjon hozzá logikát az alaposztály metódushoz való hívás előtt hozzáadott vagy eltávolított reakciók előtt alkalmazandó logikához. Adjon hozzá logikát az alaposztály metódushoz való meghívás után hozzáadott vagy eltávolított reakciók után alkalmazandó logikához.

on_reactions_added

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra vonatkozóan, hogy egy korábbi tevékenységre adott reakciók mikor lesznek hozzáadva a beszélgetéshez.

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

Paraméterek

Name Description
message_reactions
Kötelező

A hozzáadott reakciók listája

turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Az üzenetválaszok megegyeznek azzal, hogy a felhasználó hozzáad egy "tetszik" vagy "szomorú" stb. (gyakran emoji) üzenetet a beszélgetésben korábban elküldött üzenethez. Az üzenetreakciókat csak néhány csatorna támogatja. Azt a tevékenységet, amelyre az üzenet reagál, a tevékenység id tulajdonságára adott válasza azonosítja. Ennek a tulajdonságnak az értéke egy korábban elküldött tevékenység tevékenységazonosítója. Amikor a robot egy tevékenységet küld, a csatorna egy azonosítót rendel hozzá, amely az eredmény erőforrás-válaszazonosítójában érhető el.

on_reactions_removed

Felülbírálja ezt a metódust egy származtatott osztályban, hogy logikát biztosítson arra az esetre, ha egy korábbi tevékenységre adott reakciók törlődnek a beszélgetésből.

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

Paraméterek

Name Description
message_reactions
Kötelező

Az eltávolított reakciók listája

turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Az üzenetválaszok megegyeznek azzal, hogy a felhasználó hozzáad egy "tetszik" vagy "szomorú" stb. (gyakran emoji) üzenetet a beszélgetésben korábban elküldött üzenethez. Az üzenetreakciókat csak néhány csatorna támogatja. Azt a tevékenységet, amelyre az üzenet reagál, a tevékenység Id tulajdonságára adott válasza azonosítja. Ennek a tulajdonságnak az értéke egy korábban elküldött tevékenység tevékenységazonosítója. Amikor a robot egy tevékenységet küld, a csatorna egy azonosítót rendel hozzá, amely az eredmény erőforrás-válaszazonosítójában érhető el.

on_sign_in_invoke

Akkor hívható meg, ha egy bejelentkezési/ellenőrzőState vagy signin/tokenExchange esemény érkezik on_invoke_activity (TurnContext{InvokeActivity}) alapműveletének használatakor. OAuthPrompt használata esetén felülbírálja ezt a metódust a tevékenység továbbításához"/ az aktuális párbeszédpanelre. Alapértelmezés szerint ez a metódus nem tesz semmit.

async on_sign_in_invoke(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_token_response_event

jogkivonatok/válasz esemény fogadása on_event_activity alapszintű viselkedésének használatakor. Ha oauth_prompthasznál, felülbírálhatja ezt a metódust, hogy továbbítsa ezt a tevékenységet az aktuális párbeszédpanelre.

async on_token_response_event(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Amikor a on_event metódus tokenek/választevékenységnevű eseményt kap, ezt a metódust hívja meg. Ha a robot egy oauth_prompthasznál, továbbítsa a bejövő tevékenységet az aktuális párbeszédpanelre.

on_turn

Az adapter meghívja (például <xref:botbuilder.core.activity_handler.BotFrameworkAdapter>) futásidőben, hogy feldolgozhasson egy bejövő Activity.

async on_turn(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Az osztály más metódusait is meghívja a feldolgozandó tevékenység típusa alapján, ami lehetővé teszi, hogy a származtatott osztály szabályozott módon adja meg a típusspecifikus logikát. Származtatott osztályban felülbírálja ezt a metódust, hogy minden tevékenységtípusra érvényes logikát adjon hozzá. Is

  • Adja hozzá a típusspecifikus logika előtt és a on_turnmeghívása előtt alkalmazandó logikát.
  • Adja hozzá az on_turnmeghívása után alkalmazandó logikát a típusspecifikus logika után.

on_typing_activity

Felülbírálhatja ezt egy származtatott osztályban, hogy az ActivityTypes.type tevékenységekre, például a beszélgetési logikára vonatkozó logikát biztosítson.

async on_typing_activity(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

on_unrecognized_activity_type

Akkor hívható meg, ha nem üzenet, beszélgetés frissítése vagy esemény érkezik, amikor a on_turn alapszintű viselkedését használják. Ha felül van bírálva, ez a módszer bármely más tevékenységtípusra reagálhat.

async on_unrecognized_activity_type(turn_context: TurnContext)

Paraméterek

Name Description
turn_context
Kötelező

A turn környezeti objektuma

Válaszok

Típus Description

Egy feladat, amely a végrehajtásra váró munkasort jelöli

Megjegyzések

Amikor a on_turn metódus olyan tevékenységet kap, amely nem üzenet, beszélgetés frissítése, üzenetreakció vagy eseménytevékenység, ezt a metódust hívja meg.