Konwersacje sterowane zdarzeniami przy użyciu programu obsługi działań

Aby zaimplementować logikę dla tych procedur obsługi, zastąpisz te metody w swoim bocie, na przykład w poniższej sekcji przykładowego obsługiwacza działań. Dla każdego z tych programów obsługi nie ma implementacji podstawowej, więc wystarczy dodać logikę, która ma zostać zastąpiona.

Istnieją pewne sytuacje, w których należy zastąpić podstawową obsługę tury, na przykład zapisanie stanu na końcu tury. W tym celu należy najpierw wywołać metodę await base.OnTurnAsync(turnContext, cancellationToken); , aby upewnić się, że podstawowa implementacja OnTurnAsync programu jest uruchamiana przed dodatkowym kodem. Ta podstawowa implementacja jest między innymi odpowiedzialna za wywoływanie pozostałych modułów obsługujących działania, takich jak OnMessageActivityAsync.

Język JavaScript ActivityHandler używa wzorca emitera zdarzeń i odbiornika. Na przykład, użyj metody onMessage, aby zarejestrować nasłuchiwacz zdarzeń dla komunikatów. Można zarejestrować więcej niż jeden odbiornik. Gdy bot odbiera działanie komunikatu, program obsługi działań będzie widzieć to działanie przychodzące i wysyłać je do każdego z onMessage odbiorników działań w kolejności, w jakiej zostały zarejestrowane.

Podczas tworzenia bota, logika działania bota do obsługi komunikatów i odpowiadania na nie będzie umieszczona w onMessage odbiornikach. Podobnie, logika obsługi członków dodawanych do konwersacji zostanie umieszczona w twoich onMembersAdded odbiornikach, które są wywoływane za każdym razem, gdy członek zostanie dodany do konwersacji. Aby dodać te odbiorniki, zarejestrujesz je w bocie, jak pokazano w poniższej sekcji Logika bota. Dla każdego odbiornika dołącz logikę bota, a następnie pamiętaj o wywołaniu next() na końcu. Wywołując next(), zapewniasz, że następny odbiornik zostanie uruchomiony.

Pamiętaj, aby zapisać stan przed zakończeniem kolei. Można to zrobić, przesłaniając metodę obsługi zdarzeń run i zapisując stan po zakończeniu metody nadrzędnej run.

Nie ma typowych sytuacji, w których należy zastąpić podstawowy moduł obsługi tur, więc bądź ostrożny, jeśli spróbujesz to zrobić. Istnieje specjalny program obsługi o nazwie onDialog. Procedura obsługi onDialog jest uruchamiana na końcu, po uruchomieniu wszystkich pozostałych procedur obsługi, i nie jest powiązana z określonym typem aktywności. Podobnie jak w przypadku wszystkich powyższych obsług, pamiętaj, aby wywołać next(), aby upewnić się, że reszta procesu została zakończona.

Aby zaimplementować logikę dla tych procedur obsługi, zastąpisz te metody w swoim bocie, na przykład w poniższej sekcji przykładowego obsługiwacza działań. Nie ma podstawowej implementacji dla każdego z tych programów obsługi, więc dodaj logikę, którą chcesz zastąpić.

Istnieją pewne sytuacje, w których należy zastąpić podstawową obsługę tury, na przykład zapisanie stanu na końcu tury. W tym celu proszę najpierw wywołać super.onTurn(turnContext);, aby upewnić się, że podstawowa implementacja onTurn jest uruchamiana przed dodatkowym kodem. Ta podstawowa implementacja jest między innymi odpowiedzialna za wywoływanie pozostałych modułów obsługujących działania, takich jak onMessageActivity.

Podczas tworzenia bota logika bota do obsługi i odpowiadania na komunikaty będzie umieszczona w tym on_message_activity handlerze. Podobnie, logika obsługi członków dodawanych do konwersacji znajdzie się w procedurze obsługi on_members_added, która jest wywoływana za każdym razem, gdy członek zostanie dodany do konwersacji.

Jeśli na przykład bot otrzyma aktywność wiadomości, program obsługi kolejki zobaczy aktywność przychodzącą i wyśle ją do on_message_activity programu obsługi aktywności.

Aby zaimplementować logikę dla tych procedur obsługi, zastąpisz te metody w swoim bocie, na przykład w poniższej sekcji przykładowego obsługiwacza działań. Dla każdego z tych programów obsługi nie ma implementacji podstawowej, więc wystarczy dodać logikę, która ma zostać zastąpiona.

Istnieją pewne sytuacje, w których należy zastąpić podstawową obsługę tury, na przykład zapisanie stanu na końcu tury. W tym celu należy najpierw wywołać metodę await super().on_turn(turnContext); , aby upewnić się, że podstawowa implementacja on_turn programu jest uruchamiana przed dodatkowym kodem. Ta podstawowa implementacja jest między innymi odpowiedzialna za wywoływanie pozostałych modułów obsługujących działania, takich jak on_message_activity.

Główna logika bota jest definiowana w kodzie bota. Aby zaimplementować bota jako program obsługi działań, opracuj klasę bota na bazie ActivityHandler, która implementuje interfejs IBot. ActivityHandler definiuje różne procedury obsługi dla różnych typów działań, takich jak OnMessageActivityAsync, i OnMembersAddedAsync. Te metody są chronione, ale można je zastąpić, ponieważ dziedziczymy z ActivityHandler klasy.

Obsługiwacze zdefiniowane w ActivityHandler to:

Te różne programy obsługi mają element turnContext , który zawiera informacje o działaniu przychodzącym, który odpowiada przychodzącemu żądaniu HTTP. Działania mogą mieć różne typy, więc każdy obsługujący zapewnia silnie typizowane działanie w swoim parametrze kontekstu; w większości przypadków OnMessageActivityAsync zawsze będzie obsługiwane i jest na ogół najbardziej powszechne.

Podobnie jak w poprzednich wersjach 4.x tego frameworka, istnieje również opcja implementacji publicznej metody OnTurnAsync. Obecnie podstawowa implementacja tej metody obsługuje sprawdzanie błędów, a następnie wywołuje każde z określonych procedur obsługi (takich jak te, które definiujemy w tym przykładzie) w zależności od typu działania przychodzącego. W większości przypadków można pozostawić tę metodę samodzielnie i użyć poszczególnych procedur obsługi, ale jeśli sytuacja wymaga niestandardowej implementacji OnTurnAsync, nadal jest to opcja.

Główna logika bota jest definiowana w kodzie bota. Aby zaimplementować bota jako program obsługi działań, rozszerz rozszerzenie ActivityHandler. ActivityHandler definiuje różne zdarzenia dla różnych typów działań i można zmodyfikować zachowanie bota, rejestrując odbiorniki zdarzeń, takie jak i onMessageonConversationUpdate.

Użyj tych metod, aby zarejestrować odbiorniki dla każdego typu zdarzenia:

Wywołaj funkcję kontynuacji next z każdej procedury obsługi, aby umożliwić kontynuowanie przetwarzania. Jeśli next nie zostanie wywołana, przetwarzanie działania kończy się.

Główna logika bota jest definiowana w kodzie bota. Aby zaimplementować bota jako program obsługi działań, opracuj klasę bota na bazie ActivityHandler, która implementuje interfejs Bot. ActivityHandler definiuje różne procedury obsługi dla różnych typów działań, takich jak onMessageActivity, i onMembersAdded. Te metody są chronione, ale można je zastąpić, ponieważ dziedziczymy z ActivityHandler klasy.

Obsługiwacze zdefiniowane w ActivityHandler to:

Te różne programy obsługi mają element turnContext , który zawiera informacje o działaniu przychodzącym, który odpowiada przychodzącemu żądaniu HTTP. Działania mogą mieć różne typy, więc każdy obsługujący zapewnia silnie typizowane działanie w swoim parametrze kontekstu; w większości przypadków onMessageActivity zawsze będzie obsługiwane i jest na ogół najbardziej powszechne.

Istnieje również opcja zaimplementowania metody onTurnpublicznej . Obecnie podstawowa implementacja tej metody obsługuje sprawdzanie błędów, a następnie wywołuje każde z określonych procedur obsługi (takich jak te, które definiujemy w tym przykładzie) w zależności od typu działania przychodzącego. W większości przypadków można pozostawić tę metodę samodzielnie i użyć poszczególnych procedur obsługi, ale jeśli sytuacja wymaga niestandardowej implementacji onTurn, nadal jest to opcja.

Główna logika bota jest definiowana w kodzie bota. Aby zaimplementować bota jako program obsługi działań, stwórz klasę bota dziedziczącą po klasie ActivityHandler, która z kolei pochodzi z abstrakcyjnej klasy Bot. ActivityHandler definiuje różne procedury obsługi dla różnych typów działań, takich jak on_message_activity i on_members_added. Te metody są chronione, ale można je zastąpić, ponieważ dziedziczymy z ActivityHandler klasy.

Obsługiwacze zdefiniowane w ActivityHandler to:

Te różne programy obsługi mają element turn_context , który zawiera informacje o działaniu przychodzącym, który odpowiada przychodzącemu żądaniu HTTP. Działania mogą mieć różne typy, więc każdy obsługujący zapewnia silnie typizowane działanie w swoim parametrze kontekstu; w większości przypadków on_message_activity zawsze będzie obsługiwane i jest na ogół najbardziej powszechne.

Podobnie jak w poprzednich wersjach 4.x tego frameworka, istnieje również opcja implementacji publicznej metody on_turn. Obecnie podstawowa implementacja tej metody obsługuje sprawdzanie błędów, a następnie wywołuje każde z określonych procedur obsługi (takich jak te, które definiujemy w tym przykładzie) w zależności od typu działania przychodzącego. W większości przypadków można pozostawić tę metodę samodzielnie i użyć poszczególnych procedur obsługi, ale jeśli sytuacja wymaga niestandardowej implementacji on_turn, nadal jest to opcja.

public class EchoBot : ActivityHandler
{
    protected override async Task OnMessageActivityAsync(ITurnContext<IMessageActivity> turnContext, CancellationToken cancellationToken)
    {
        var replyText = $"Echo: {turnContext.Activity.Text}";
        await turnContext.SendActivityAsync(MessageFactory.Text(replyText, replyText), cancellationToken);
    }

    protected override async Task OnMembersAddedAsync(IList<ChannelAccount> membersAdded, ITurnContext<IConversationUpdateActivity> turnContext, CancellationToken cancellationToken)
    {
        var welcomeText = "Hello and welcome!";
        foreach (var member in membersAdded)
        {
            if (member.Id != turnContext.Activity.Recipient.Id)
            {
                await turnContext.SendActivityAsync(MessageFactory.Text(welcomeText, welcomeText), cancellationToken);
            }
        }
    }
}

const { ActivityHandler, MessageFactory } = require('botbuilder');

class EchoBot extends ActivityHandler {
    constructor() {
        super();
        // See https://aka.ms/about-bot-activity-message to learn more about the message and other activity types.
        this.onMessage(async (context, next) => {
            const replyText = `Echo: ${ context.activity.text }`;
            await context.sendActivity(MessageFactory.text(replyText, replyText));
            // By calling next() you ensure that the next BotHandler is run.
            await next();
        });

        this.onMembersAdded(async (context, next) => {
            const membersAdded = context.activity.membersAdded ?? [];
            const welcomeText = 'Hello and welcome!';
            for (let cnt = 0; cnt < membersAdded.length; ++cnt) {
                if (membersAdded[cnt].id !== context.activity.recipient.id) {
                    await context.sendActivity(MessageFactory.text(welcomeText, welcomeText));
                }
            }
            // By calling next() you ensure that the next BotHandler is run.
            await next();
        });

public class EchoBot extends ActivityHandler {

    @Override
    protected CompletableFuture<Void> onMessageActivity(TurnContext turnContext) {
        return turnContext.sendActivity(
            MessageFactory.text("Echo: " + turnContext.getActivity().getText())
        ).thenApply(sendResult -> null);
    }

    @Override
    protected CompletableFuture<Void> onMembersAdded(
        List<ChannelAccount> membersAdded,
        TurnContext turnContext
    ) {
        String welcomeText = "Hello and welcome!";
        return membersAdded.stream()
            .filter(
                member -> !StringUtils
                    .equals(member.getId(), turnContext.getActivity().getRecipient().getId())
            ).map(channel -> turnContext.sendActivity(MessageFactory.text(welcomeText, welcomeText, null)))
            .collect(CompletableFutures.toFutureList()).thenApply(resourceResponses -> null);
    }
}

class EchoBot(ActivityHandler):
    async def on_members_added_activity(
        self, members_added: [ChannelAccount], turn_context: TurnContext
    ):
        for member in members_added:
            if member.id != turn_context.activity.recipient.id:
                await turn_context.send_activity("Hello and welcome!")

    async def on_message_activity(self, turn_context: TurnContext):
        return await turn_context.send_activity(
            MessageFactory.text(f"Echo: {turn_context.activity.text}")
        )