ActivityHandler Osztály

Definíció

A IBot felület implementálása, amely további alosztályozásra szolgál.

public class ActivityHandler : Microsoft.Bot.Builder.IBot
type ActivityHandler = class
    interface IBot
Public Class ActivityHandler
Implements IBot
Öröklődés
ActivityHandler
Származtatott
Megvalósítás

Megjegyzések

Ebből az osztályból származtathatja a kód beépülő modulját az adott tevékenységtípusok kezeléséhez. A Activity objektumok elő- és utófeldolgozása hozzáadható az alaposztály implementációjának a származtatott osztályból való meghívásával.

Konstruktorok

ActivityHandler()

A IBot felület implementálása, amely további alosztályozásra szolgál.

Metódusok

CreateInvokeResponse(Object)

Egy InvokeResponse gyár, amely inicializálja a törzset az átadott paraméterhez, és az állapota ok.

OnAdaptiveCardInvokeAsync(ITurnContext<IInvokeActivity>, AdaptiveCardInvokeValue, CancellationToken)

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

OnCommandActivityAsync(ITurnContext<ICommandActivity>, CancellationToken)

A parancstevékenységek fogadása a OnTurnAsync(ITurnContext, CancellationToken) alapműveletének használatakor történik. A parancsok olyan kérések, amelyek egy műveletet hajtanak végre, és a fogadók általában egy vagy több commandResult tevékenységgel válaszolnak. A fogadóknak kifejezetten el kell utasítaniuk a nem támogatott parancstevékenységeket is.

OnCommandResultActivityAsync(ITurnContext<ICommandResultActivity>, CancellationToken)

Parancsresult-tevékenység fogadásakor a rendszer meghívja a OnTurnAsync(ITurnContext, CancellationToken) alapszintű viselkedését. A CommandResult-tevékenységek a parancsvégrehajtás eredményének közlésére használhatók.

OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken)

Akkor hívható meg, amikor beszélgetésfrissítési tevékenység érkezik a csatornáról, amikor a OnTurnAsync(ITurnContext, CancellationToken) alapszintű viselkedését használja. A beszélgetésfrissítési tevékenységek akkor hasznosak, ha válaszolnak a beszélgetésbe felvett vagy eltávolított felhasználókra. Egy robot például a felhasználó üdvözlésével válaszolhat a hozzáadott felhasználóra. Alapértelmezés szerint ez a metódus meghívja OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken), ha bármely felhasználót hozzáadtak, vagy OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken), ha a felhasználókat eltávolították. A módszer ellenőrzi a tagazonosítót, hogy csak a roboton kívüli tagokra vonatkozó frissítésekre válaszoljon.

OnEndOfConversationActivityAsync(ITurnContext<IEndOfConversationActivity>, CancellationToken)

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

OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken)

Akkor hívható meg, ha eseménytevékenység érkezik az összekötőtől a OnTurnAsync(ITurnContext, CancellationToken) alapszintű viselkedésének használatakor. Az eseménytevékenységek számos különböző dolog közlésére használhatók. Alapértelmezés szerint ez a metódus meghívja OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken), ha a tevékenység neve tokens/response vagy más OnEventAsync(ITurnContext<IEventActivity>, CancellationToken). Egy tokens/response eseményt egy OAuthCardaktiválhat.

OnEventAsync(ITurnContext<IEventActivity>, CancellationToken)

Az tokens/response kívüli esemény meghívása a OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) alapszintű viselkedésének használatakor. Ez a módszer felülbírálható, ha a robot más események kezelésére szolgál. Alapértelmezés szerint ez a metódus nem tesz semmit.

OnInstallationUpdateActivityAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

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

OnInstallationUpdateAddAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

Felülbírálja ezt egy származtatott osztályban, hogy InstallationUpdate tevékenységekhez tartozó logikát adjon meg a "hozzáadás" beállítású "művelet" beállítással.

OnInstallationUpdateRemoveAsync(ITurnContext<IInstallationUpdateActivity>, CancellationToken)

Felülbírálja ezt egy származtatott osztályban, hogy az InstallationUpdate tevékenységekre jellemző logikát biztosítson az "eltávolítás" beállítású "művelettel".

OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken)

Meghívható, amikor egy meghívási tevékenység érkezik az összekötőtől, amikor a OnTurnAsync(ITurnContext, CancellationToken) alapszintű viselkedését használja. A meghívási tevékenységek számos különböző dolog közlésére használhatók. Alapértelmezés szerint ez a metódus meghívja OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken), ha a tevékenység neve signin/verifyState vagy signin/tokenExchange. Egy signin/verifyState vagy signin/tokenExchange meghívást egy OAuthCardindíthat el.

OnMembersAddedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)

Felülbírálja ezt egy származtatott osztályban, hogy logikát biztosítson arra az esetben, ha a roboton kívüli tagok csatlakoznak a beszélgetéshez, például a robot üdvözlő logikáját.

OnMembersRemovedAsync(IList<ChannelAccount>, ITurnContext<IConversationUpdateActivity>, CancellationToken)

Ezt felülbírálhatja egy származtatott osztályban, hogy logikát biztosítson arra az esetben, ha a roboton kívüli tagok elhagyják a beszélgetést, például a robot búcsúlogikája.

OnMessageActivityAsync(ITurnContext<IMessageActivity>, CancellationToken)

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

OnMessageDeleteActivityAsync(ITurnContext<IMessageDeleteActivity>, CancellationToken)

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

OnMessageReactionActivityAsync(ITurnContext<IMessageReactionActivity>, CancellationToken)

Akkor hívható meg, ha eseménytevékenység érkezik az összekötőtől a OnTurnAsync(ITurnContext, CancellationToken) alapszintű viselkedésének használatakor. 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 üzenetválasznak megfelelő tevékenység a replyToId tulajdonságban 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.

OnMessageUpdateActivityAsync(ITurnContext<IMessageUpdateActivity>, CancellationToken)

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

OnReactionsAddedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)

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

OnReactionsRemovedAsync(IList<MessageReaction>, ITurnContext<IMessageReactionActivity>, CancellationToken)

Felülbírálhatja ezt 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.

OnSearchInvokeAsync(ITurnContext<IInvokeActivity>, SearchInvokeValue, CancellationToken)

Akkor lesz meghívva, amikor a robot "meghívási" tevékenységet küld, amelynek neve "application/search".

OnSignInInvokeAsync(ITurnContext<IInvokeActivity>, CancellationToken)

signin/verifyState vagy signin/tokenExchange esemény akkor hívható meg, amikor a OnInvokeActivityAsync(ITurnContext<IInvokeActivity>, CancellationToken) alapszintű viselkedését használja. Ha OAuthPrompthasznál, írja felül ezt a metódust, hogy a Activity továbbíthassa az aktuális párbeszédpanelre. Alapértelmezés szerint ez a metódus nem tesz semmit.

OnTokenResponseEventAsync(ITurnContext<IEventActivity>, CancellationToken)

A OnEventActivityAsync(ITurnContext<IEventActivity>, CancellationToken) alapszintű viselkedésének használatakor tokens/response esemény fogadásakor hívható meg. Ha OAuthPrompthasznál, írja felül ezt a metódust, hogy a Activity továbbíthassa az aktuális párbeszédpanelre. Alapértelmezés szerint ez a metódus nem tesz semmit.

OnTurnAsync(ITurnContext, CancellationToken)

Az adapter meghívja (például egy BotFrameworkAdapter) futásidőben, hogy feldolgozhasson egy bejövő Activity.

OnTypingActivityAsync(ITurnContext<ITypingActivity>, CancellationToken)

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

OnUnrecognizedActivityTypeAsync(ITurnContext, CancellationToken)

Akkor hívható meg, ha nem üzenet, beszélgetés frissítése vagy esemény érkezik, amikor a OnTurnAsync(ITurnContext, CancellationToken) alapszintű viselkedését használják. Felülírás esetén ez bármely más tevékenységtípusra, például ContactRelationUpdate vagy EndOfConversationreagálhat. Alapértelmezés szerint ez a metódus nem tesz semmit.

A következőre érvényes: