Definieren von Aktionsbefehlen für Nachrichtenerweiterungen

Bevor Sie den Aktionsbefehl erstellen, müssen Sie die folgenden Faktoren festlegen:

1. Von wo kann der Aktionsbefehl ausgelöst werden?
2. Wie wird das Dialogfeld (in TeamsJS v1.x als Aufgabenmodul bezeichnet) erstellt?
3. Wird die endgültige Nachricht oder Karte von einem Bot an den Kanal gesendet, oder wird die Nachricht oder Karte in den Nachrichtenerstellungsbereich eingefügt, damit der Benutzer sie übermitteln kann?

Im folgenden Video erfahren Sie, wie Sie Aktionsbefehle für nachrichtenerweiterungen definieren:

Auswählen von Speicherorten zum Aufrufen von Aktionsbefehlen

Zuerst müssen Sie den Speicherort festlegen, von dem aus der Aktionsbefehl aufgerufen werden muss. Wenn Sie die context Eigenschaft in Ihrem App-Manifest angeben (zuvor teams-App-Manifest genannt), kann Ihr Befehl von einem oder mehreren der folgenden Speicherorte aufgerufen werden:

• Bereich zum Verfassen von Nachrichten: die Schaltflächen am unteren Rand des Bereichs zum Verfassen von Nachrichten.

  Befehlskontext = compose

• Befehlsfeld: Mit / im Befehlsfeld. Beispiel: /your-app-name. Wenn Sie das klassische Teams verwenden, wird der Aktionsbefehl von @mentioning im Befehlsfeld aufgerufen. Beispiel: @your-app-name.

  Befehlskontext = commandBox

  Hinweis

  Wenn eine Nachrichtenerweiterung über das Befehlsfeld aufgerufen wird, können Sie nicht mit einer Botnachricht antworten, die direkt in die Konversation eingefügt wurde.

• Nachricht: direkt aus einer vorhandenen Nachricht über das ... Überlaufmenü einer Nachricht.

  Befehlskontext = message

  Hinweis

  • Der anfängliche Aufruf des Bots enthält ein JSON-Objekt, das die Nachricht enthält, aus der er aufgerufen wurde. Sie können die Nachricht vor dem Anzeigen eines Dialogs verarbeiten.

  • Wenn der Benutzer aus den Auslassungspunkten ... auswählt, wird ein Überlaufmenü angezeigt. Nachrichtenaktionen für Apps, die Sie für Ihre organization oder Apps von Drittanbietern erstellt haben, werden jedoch standardmäßig nicht angezeigt. Nachdem der Benutzer Weitere Aktionen ausgewählt hat, kann er die Nachrichtenaktionen anzeigen und die erforderliche Option auswählen. Die entsprechende Meldungsaktion wird im Überlaufmenü angezeigt. Im Überlaufmenü werden die drei letzten Nachrichtenaktionen angezeigt. Sie können die anzuzeigende Meldungsaktion nicht anheften.

In der folgenden Abbildung werden die Speicherorte angezeigt, von denen der Aktionsbefehl aufgerufen wird:

Auswählen der Erstellung des Dialogfelds

Zusätzlich zur Auswahl, wo der Befehl aufgerufen werden kann, müssen Sie auch auswählen, wie das Formular im Dialogfeld für Ihre Benutzer aufgefüllt werden soll. Sie haben die folgenden drei Optionen zum Erstellen des Formulars, das im Dialogfeld gerendert wird:

• Statische Parameterliste: Dies ist die einfachste Methode. Sie können eine Liste von Parametern in Ihrem App-Manifest definieren, die der Teams-Client rendert, aber in diesem Fall nicht die Formatierung steuern.
• Adaptive Karte: Sie können eine adaptive Karte verwenden, die eine bessere Kontrolle über die Benutzeroberfläche bietet, Sie aber weiterhin auf die verfügbaren Steuerelemente und Formatierungsoptionen beschränkt.
• Eingebettete Webansicht: Sie können eine benutzerdefinierte Webansicht in das Dialogfeld einbetten, um eine vollständige Kontrolle über die Benutzeroberfläche und steuerelemente zu erhalten.

Wenn Sie das Dialogfeld mit einer statischen Liste von Parametern erstellen und wenn der Benutzer den Dialog übermittelt, wird die Nachrichtenerweiterung aufgerufen. Wenn Sie eine eingebettete Webansicht oder eine adaptive Karte verwenden, muss Ihre Nachrichtenerweiterung ein anfängliches Aufrufereignis vom Benutzer behandeln, das Dialogfeld erstellen und es an den Client zurückgeben.

Auswählen, wie die endgültige Nachricht gesendet wird

In den meisten Fällen führt der Aktionsbefehl dazu, dass eine Karte in das Feld zum Verfassen von Nachrichten eingefügt wird. Der Benutzer kann sie in den Kanal oder Chat senden. In diesem Fall stammt die Nachricht vom Benutzer, und der Bot kann die Karte nicht weiter bearbeiten oder aktualisieren.

Wenn die Nachrichtenerweiterung über das Feld zum Verfassen oder direkt aus einer Nachricht aufgerufen wird, kann Ihr Webdienst die endgültige Antwort direkt in den Kanal oder Chat einfügen. In diesem Fall stammt die adaptive Karte vom Bot, der Bot aktualisiert sie und antwortet bei Bedarf auf den Unterhaltungsthread. Sie müssen das bot -Objekt dem App-Manifest hinzufügen, indem Sie dieselbe ID verwenden und die entsprechenden Bereiche definieren.

Befehl "Aktion erstellen" mithilfe des Entwicklerportals

Sie können einen Aktionsbefehl mithilfe des Teams-Toolkits und des Entwicklerportals für Teams erstellen.

Teams Toolkit

Führen Sie die folgenden Schritte aus, um mithilfe des Teams Toolkits eine aktionsbasierte Nachrichtenerweiterung zu erstellen:

1. Öffnen Sie Visual Studio Code.
2. Wählen Sie im linken Bereich Teams Toolkit aus.
3. Wählen Sie Neue App erstellen aus.
4. Wählen Sie Nachrichtenerweiterung aus.
5. Wählen Sie Aus Eingaben sammeln und Daten verarbeiten aus.
6. Wählen Sie eine Programmiersprache aus.
7. Wählen Sie Standardordner aus.
8. Geben Sie den Namen Ihrer App ein, und drücken Sie die EINGABETASTE.

Teams Toolkit erstellt ein Gerüst für Ihr Projekt und erstellt eine Erweiterung für Aktionsnachrichten.

Entwicklerportal für Teams

Führen Sie die folgenden Schritte aus, um mithilfe des Entwicklerportals für Teams eine aktionsbasierte Nachrichtenerweiterung zu erstellen:

1. Wechseln Sie zum Entwicklerportal für Teams.

2. Wechseln Sie zu Apps.

3. Wählen Sie Neue App erstellen aus.

4. Wählen Sie unter Konfigurieren die Option App-Features aus.

5. Wählen Sie Messaging-Erweiterung aus.

   

6. Wählen Sie unter Nachrichtenerweiterungstyp die Option Bot aus.

   1. Wenn Sie einen Haftungsausschluss erhalten, der besagt, dass die API-Nachrichtenerweiterung bereits von Benutzern verwendet wird. Möchten Sie den Nachrichtenerweiterungstyp in bot ändern?. Wählen Sie Ja, ändern aus.

   

7. Wenn Sie noch keinen Bot haben, wählen Sie Vorhandenen Bot aus, oder wenn Sie über eine Bot-ID verfügen, wählen Sie Bot-ID eingeben aus.

   1. Wenn Sie über keine Bot-ID verfügen, wählen Sie Bot erstellen aus, um einen neuen Bot zu erstellen, und geben Sie die Bot-ID des neuen Bots ein, den Sie erstellt haben.

8. Wählen Sie die erforderlichen Bereiche aus.

9. Wählen Sie unter Befehldie Option + Befehl hinzufügen aus.

   Eine Befehlsdetailseite wird angezeigt.

10. Wählen Sie auf der Seite Befehlsdetails die Option Aktion und dann parametertyp aus.

11. Wählen Sie Aktion als Befehlstyp aus, und aktualisieren Sie die folgenden Felder:

    • Befehls-ID
    • Befehlstitel
    • Befehlsbeschreibung
    • Kontext, in dem der Befehl funktioniert
    • Parametername
    • Parametertitel
    • Parameterbeschreibung
    • Parameterbeschreibungstyp

12. Wählen Sie unter Vorschaulinksdie Option Domäne hinzufügen aus.

13. Geben Sie eine gültige Domäne ein, und wählen Sie dann Hinzufügen aus.

    

14. Klicken Sie auf Speichern.

    

So fügen Sie zusätzliche Parameter hinzu

1. Wählen Sie unter dem Befehl das Symbol mit den Auslassungspunkten (...) und dann Parameter bearbeiten aus.

   

2. Wählen Sie Parameter hinzufügen aus, und aktualisieren Sie die Parameterdetails.

   

3. Wählen Sie Speichern aus.

Eine botbasierte Aktionsnachrichtenerweiterung wird erstellt.

Codeausschnitte

Der folgende Code enthält ein Beispiel für aktionsbasierte Nachrichtenerweiterungen:

C#

• SDK-Referenz
• Beispielcodereferenz

protected override Task<MessagingExtensionActionResponse> OnTeamsMessagingExtensionFetchTaskAsync(ITurnContext<IInvokeActivity> turnContext, MessagingExtensionAction action, CancellationToken cancellationToken)
        {
            // Handle different actions using switch.
            switch (action.CommandId)
            {
                case "HTML":
                    return new MessagingExtensionActionResponse
                    {
                        Task = new TaskModuleContinueResponse
                        {
                            Value = new TaskModuleTaskInfo
                            {
                                Height = 200,
                                Width = 400,
                                Title = "Task Module HTML Page",
                                Url = baseUrl + "/htmlpage.html",
                            },
                        },
                    };
                default:
                    string memberName = "";
                    var member = await TeamsInfo.GetMemberAsync(turnContext, turnContext.Activity.From.Id, cancellationToken);
                    memberName = member.Name;
                    return new MessagingExtensionActionResponse
                    {
                        Task = new TaskModuleContinueResponse
                        {
                            Value = new TaskModuleTaskInfo
                            {
                                Card = <<AdaptiveAction card json>>,
                                Height = 200,
                                Width = 400,
                                Title = $"Welcome {memberName}",
                            },
                        },
                    };
            }
        }

Node.js

• Beispielcodereferenz

// Invoked when a Messaging Extension Fetch activity is received from the connector.
    async handleTeamsMessagingExtensionFetchTask(context, action) {
        switch (action.commandId) {
            case 'Static HTML':
                return staticHtmlPage();
        }
    }

    staticHtmlPage(){
        return {
            task: {
                type: 'continue',
                value: {
                    width: 450,
                    height: 125,
                    title: 'Dialog Static HTML',
                    url: `${baseurl}/StaticPage.html`
                }
            }
        };
    }

Codebeispiel

Beispielname	Beschreibung	.NET	Node.js	Manifest
Teams-Nachrichtenerweiterungen – Aktion	In diesem Beispiel wird gezeigt, wie Sie Aktionsbefehle definieren, einen Dialog erstellen und auf die Aktion "Dialog übermitteln" reagieren.	View	View	Anzeigen
Vorschau der Aktion "Nachrichtenerweiterung"	In diesem Beispiel wird gezeigt, wie Sie die Aktionsvorschau in Messagingerweiterungen mit Bot Framework v4 verwenden.	View	View	View

Schrittweise Anleitung

Befolgen Sie die Schritt-für-Schritt-Anleitung , um eine aktionsbasierte Nachrichtenerweiterung für Teams zu erstellen.

Nächster Schritt

Wenn Sie eine adaptive Karte oder eine eingebettete Webansicht ohne Objekt taskInfo verwenden, besteht der nächste Schritt darin:

Dialogfeld "Erstellen und Senden"

Wenn Sie die Parameter oder eine eingebettete Webansicht mit einem taskInfo -Objekt verwenden, besteht der nächste Schritt darin:

Reagieren auf die Aktion "Senden" des Dialogfelds

Siehe auch

• Entwicklerportal für Teams
• Nachrichtenerweiterungen