Ereignisgesteuerte Unterhaltungen mit einem Aktivitätshandler

Um Ihre Logik für diese Handler zu implementieren, überschreiben Sie diese Methoden in Ihrem Bot, wie z. B. im folgenden Beispiel für einen Aktivitätshandler. Da für diese Handler keine Basisimplementierung vorhanden ist, können Sie in Ihrer Überschreibung einfach die gewünschte Logik hinzufügen.

In bestimmten Situationen empfiehlt es sich, den Turn-Basishandler zu überschreiben (etwa beim Speichern des Zustands am Ende eines Turns). Rufen Sie in diesem Fall zunächst await base.OnTurnAsync(turnContext, cancellationToken); auf, um sicherzustellen, dass die Basisimplementierung von OnTurnAsync vor Ihrem zusätzlichen Code ausgeführt wird. Diese Basisimplementierung ist unter anderem dafür zuständig, die restlichen Aktivitätshandler (etwa OnMessageActivityAsync) aufzurufen.

Für das JavaScript-Element ActivityHandler werden ein Ereignisemitter und ein Listenermuster verwendet. Nutzen Sie beispielsweise die onMessage-Methode, um einen Ereignislistener für Nachrichtenaktivitäten zu registrieren. Sie können mehr als einen Listener registrieren. Wenn der Bot eine Nachrichtenaktivität empfängt, sieht der Aktivitätshandler diese eingehende Aktivität und sendet sie an jeden der onMessage-Aktivitätslistener in der Reihenfolge, in der sie registriert wurden.

Bei der Boterstellung muss Ihre Botlogik für die Behandlung von bzw. die Reaktion auf Nachrichten in den onMessage-Listenern platziert werden. Analog dazu muss Ihre Logik für die Behandlung von Mitgliedern, die der Konversation hinzugefügt werden, in Ihren onMembersAdded-Listenern platziert werden. Diese werden aufgerufen, wenn der Konversation ein Mitglied hinzugefügt wird. Um diese Listener hinzuzufügen, registrieren Sie sie in Ihrem Bot (wie unten im Abschnitt Bot-Logik beschrieben). Fügen Sie für jeden Listener Ihre Bot-Logik ein, und rufen Sie am Ende dann next() auf. Durch das Aufrufen von next() stellen Sie sicher, dass der nächste Listener ausgeführt wird.

Stellen Sie sicher, dass der Zustand gespeichert wird, bevor der Zug endet. Hierzu können Sie die Methode run des Aktivitätshandlers überschreiben und den Zustand nach Abschluss der Methode run des übergeordneten Elements speichern.

Es gibt keine Situationen, in denen Sie den Turn-Basishandler überschreiben müssten. Seien Sie daher vorsichtig, wenn Sie es versuchen. Es ist ein spezieller Handler mit dem Namen onDialog vorhanden. Der Handler onDialog wird am Ende ausgeführt, nachdem die restlichen Handler ausgeführt wurden. Er ist nicht an einen bestimmten Aktivitätstyp gebunden. Denken Sie genau wie bei allen anderen oben genannten Handlern daran, next() aufzurufen, um sicherzustellen, dass der restliche Prozess abgeschlossen wird.

Um Ihre Logik für diese Handler zu implementieren, überschreiben Sie diese Methoden in Ihrem Bot, wie z. B. im folgenden Beispiel für einen Aktivitätshandler. Es gibt keine Basisimplementierung für jeden dieser Handler, also fügen Sie die gewünschte Logik in Ihrer Überschreibung hinzu.

In bestimmten Situationen empfiehlt es sich, den Turn-Basishandler zu überschreiben (etwa beim Speichern des Zustands am Ende eines Turns). Rufen Sie in diesem Fall zunächst super.onTurn(turnContext); auf, um sicherzustellen, dass die Basisimplementierung von onTurn vor Ihrem zusätzlichen Code ausgeführt wird. Diese Basisimplementierung ist unter anderem dafür zuständig, die restlichen Aktivitätshandler (etwa onMessageActivity) aufzurufen.

Bei der Erstellung Ihres Bots wird die Logik, die Nachrichten behandelt und darauf reagiert, in diesen Handler (on_message_activity) integriert. Analog dazu muss Ihre Logik für die Behandlung von Mitgliedern, die der Konversation hinzugefügt werden, im Handler on_members_added platziert werden, der aufgerufen wird, wenn der Konversation ein Mitglied hinzugefügt wird.

Wenn der Bot beispielsweise eine Nachrichtenaktivität empfängt, erkennt der Turn-Handler diese eingehende Aktivität und sendet sie an den Aktivitätshandler on_message_activity.

Um Ihre Logik für diese Handler zu implementieren, überschreiben Sie diese Methoden in Ihrem Bot, wie z. B. im folgenden Beispiel für einen Aktivitätshandler. Da für diese Handler keine Basisimplementierung vorhanden ist, können Sie in Ihrer Überschreibung einfach die gewünschte Logik hinzufügen.

In bestimmten Situationen empfiehlt es sich, den Turn-Basishandler zu überschreiben (etwa beim Speichern des Zustands am Ende eines Turns). Rufen Sie in diesem Fall zunächst await super().on_turn(turnContext); auf, um sicherzustellen, dass die Basisimplementierung von on_turn vor Ihrem zusätzlichen Code ausgeführt wird. Diese Basisimplementierung ist unter anderem dafür zuständig, die restlichen Aktivitätshandler (etwa on_message_activity) aufzurufen.

Die Hauptlogik des Bots wird im Botcode definiert. Um einen Bot als Aktivitätshandler zu implementieren, leiten Sie die Bot-Klasse von ActivityHandler ab, der die IBot-Schnittstelle implementiert. ActivityHandler definiert verschiedene Handler für verschiedene Arten von Aktivitäten, beispielsweise OnMessageActivityAsync und OnMembersAddedAsync. Diese Methoden sind zwar geschützt, können aber dank der Ableitung von ActivityHandler überschrieben werden.

In ActivityHandler sind folgende Handler definiert:

Diese verschiedenen Handler verfügen über einen Turn-Kontext (turnContext), der Informationen zur eingehenden Aktivität (der eingehenden HTTP-Anforderung) bereitstellt. Aufgrund der verschiedenen möglichen Arten von Aktivitäten gibt jeder Handler in seinem Turn-Kontextparameter eine stark typisierte Aktivität an. OnMessageActivityAsync wird in den meisten Fällen behandelt und ist generell am gängigsten.

Wie in früheren 4.x-Versionen dieses Frameworks besteht auch die Möglichkeit, die öffentliche Methode OnTurnAsync zu implementieren. Die Basisimplementierung dieser Methode behandelt aktuell die Fehlerüberprüfung und ruft anschließend abhängig von der Art der eingehenden Aktivität die einzelnen spezifischen Handler auf (beispielsweise die beiden, die in diesem Beispiel definiert wurden). In den meisten Fällen können Sie diese Methode ignorieren und die einzelnen Handler verwenden. Falls Sie jedoch eine benutzerdefinierte Implementierung von OnTurnAsync benötigen, ist sie weiterhin eine Option.

Die Hauptlogik des Bots wird im Botcode definiert. Um einen Bot als Aktivitätshandler zu implementieren, erweitern Sie ActivityHandler. Mit ActivityHandler werden verschiedene Ereignisse für verschiedene Arten von Aktivitäten definiert. Sie können das Verhalten des Bots ändern, indem Sie Ereignislistener registrieren (beispielsweise für onMessage und onConversationUpdate).

Verwenden Sie diese Methoden, um Listener für jeden Ereignistyp zu registrieren:

Rufen Sie die Fortsetzungsfunktion next über die einzelnen Handler auf, um die Fortsetzung der Verarbeitung zu ermöglichen. Wird next nicht aufgerufen, wird die Verarbeitung der Aktivität beendet.

Die Hauptlogik des Bots wird im Botcode definiert. Um einen Bot als Aktivitätshandler zu implementieren, leiten Sie die Bot-Klasse von ActivityHandler ab, der die Bot-Schnittstelle implementiert. ActivityHandler definiert verschiedene Handler für verschiedene Arten von Aktivitäten, beispielsweise onMessageActivity und onMembersAdded. Diese Methoden sind zwar geschützt, können aber dank der Ableitung von ActivityHandler überschrieben werden.

In ActivityHandler sind folgende Handler definiert:

Diese verschiedenen Handler verfügen über einen Turn-Kontext (turnContext), der Informationen zur eingehenden Aktivität (der eingehenden HTTP-Anforderung) bereitstellt. Aufgrund der verschiedenen möglichen Arten von Aktivitäten gibt jeder Handler in seinem Turn-Kontextparameter eine stark typisierte Aktivität an. onMessageActivity wird in den meisten Fällen behandelt und ist generell am gängigsten.

Es gibt auch die Möglichkeit, die öffentliche Methode onTurn zu implementieren. Die Basisimplementierung dieser Methode behandelt aktuell die Fehlerüberprüfung und ruft anschließend abhängig von der Art der eingehenden Aktivität die einzelnen spezifischen Handler auf (beispielsweise die beiden, die in diesem Beispiel definiert wurden). In den meisten Fällen können Sie diese Methode ignorieren und die einzelnen Handler verwenden. Falls Sie jedoch eine benutzerdefinierte Implementierung von onTurn benötigen, ist sie weiterhin eine Option.

Die Hauptlogik des Bots wird im Botcode definiert. Um einen Bot als Aktivitätshandler zu implementieren, leiten Sie ihre Botklasse von ActivityHandler ab, der wiederum von der abstrakten Bot-Klasse abgeleitet wird. ActivityHandler definiert verschiedene Handler für verschiedene Arten von Aktivitäten, beispielsweise on_message_activity und on_members_added. Diese Methoden sind zwar geschützt, können aber dank der Ableitung von ActivityHandler überschrieben werden.

In ActivityHandler sind folgende Handler definiert:

Diese verschiedenen Handler verfügen über einen Turn-Kontext (turn_context), der Informationen zur eingehenden Aktivität (der eingehenden HTTP-Anforderung) bereitstellt. Aufgrund der verschiedenen möglichen Arten von Aktivitäten gibt jeder Handler in seinem Turn-Kontextparameter eine stark typisierte Aktivität an. on_message_activity wird in den meisten Fällen behandelt und ist generell am gängigsten.

Wie in früheren 4.x-Versionen dieses Frameworks besteht auch die Möglichkeit, die öffentliche Methode on_turn zu implementieren. Die Basisimplementierung dieser Methode behandelt aktuell die Fehlerüberprüfung und ruft anschließend abhängig von der Art der eingehenden Aktivität die einzelnen spezifischen Handler auf (beispielsweise die beiden, die in diesem Beispiel definiert wurden). In den meisten Fällen können Sie diese Methode ignorieren und die einzelnen Handler verwenden. Falls Sie jedoch eine benutzerdefinierte Implementierung von on_turn benötigen, ist sie weiterhin eine Option.

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}")
        )