Was ist die Teams JavaScript-Clientbibliothek?

  • 2 Minuten

Die Teams-Entwicklungsplattform bietet die Teams JavaScript-Clientbibliothek als JavaScript-Bibliothek für Ihre Clientanwendungen an. Die Bibliothek ist eine Sammlung von JavaScript-Funktionen, über die Sie die Teams-API verwenden können, um Features und Funktionen in Ihre Teams-Anwendungen zu integrieren. Die Features und Funktionen werden im Teams-Client als nativ angezeigt. Die Bibliothek stellt sicher, dass Anwendungen, die Sie mit ihr erstellen, eine konsistente und benutzerfreundliche Oberfläche für Teams-Benutzer haben.

In dieser Lerneinheit erfahren Sie, wie Sie die Bibliothek in einer Anwendung verwenden.

Abrufen der Bibliothek in Ihre App

Sehen wir uns verschiedene Möglichkeiten an, wie Sie die Bibliothek in einer Anwendung installieren können.

Sie können die LTS-Version der Teams JavaScript-Clientbibliothek mithilfe von npm oder yarn installieren.

So installieren Sie die Bibliothek mithilfe von npm:

npm install --save @microsoft/teams-js

So installieren Sie die Bibliothek mithilfe von Yarn:

yarn add @microsoft/teams-js

Wenn Sie Web-Apps erstellen, ohne einen Bundler zu verwenden, können Sie die Bibliothek direkt aus dem Content Delivery Network laden. Fügen Sie Ihrer Web-App den folgenden Codeausschnitt hinzu:

<script src="https://res.cdn.office.net/teams-js/2.7.1/js/MicrosoftTeams.min.js "></script>

Verwenden der Bibliothek

Die Teams JavaScript-Clientbibliothek verfügt über APIs, die logisch in Funktionen gruppiert sind. Diese Funktionen sind Namespaces innerhalb der Bibliothek. Die Namespace-App der obersten Ebene enthält alle APIs, die Sie für die gesamte App-Nutzung benötigen.

Sie können die Bibliothek mit app.Initialize()initialisieren. Nachdem die Bibliothek initialisiert wurde, können Sie mit der Verwendung des Namespace auf alle APIs und Funktionen zugreifen, die in der Bibliothek enthalten sind. Um die grundlegenden Kontextinformationen Ihrer App abzurufen, rufen Sie auf app.getContext(). Um einen kopierbaren Link zu Informationen zu generieren und anzuzeigen, die der Benutzer freigeben soll, rufen Sie auf pages.shareDeepLink().

Führen Sie den folgenden Code aus, um die Kontextinformationen der App abzurufen:

await app.initialize(); 
const context = await app.getContext();

Das Abrufen von Kontextinformationen zu Microsoft Teams hilft Ihrer Teams-App, benutzern eine bessere und maßgeschneidertere Erfahrung zu bieten. Mit den Kontextinformationen kann Ihre App beispielsweise die spezifische Umgebung verstehen, in der sie ausgeführt wird, z. B. in Teams, in einem Browser, Team oder Kanal oder sogar den Benutzer, mit dem Ihre App interagiert. Diese Erkenntnisse sind nützlich, um zu bestimmen, wie relevante und angepasste Funktionen oder Funktionen für den Benutzer ordnungsgemäß konfiguriert und angezeigt werden.

Funktionen

Die APIs im SDK werden logisch gruppiert und als Funktionen bezeichnet. Beispiele für Funktionen sind Chat, Dialog und Authentifizierung. Jede Funktion verfügt über eigene Namespaces. z. B. Chat, Dialog oder Seite.

Hinweis

Mit der Microsoft Teams JavaScript-Clientbibliothek Version 2.0.0 und höher können Teams-Apps in anderen Host-Apps wie Outlook und Office.com ausgeführt werden. Diese Erweiterbarkeitsfeatures befinden sich derzeit in der Vorschauphase für diese Apps.

Stellen Sie sich Microsoft Teams als aktuellen Host für Ihre App vor. Der Host verfügt über einige Funktionen, die in Ihre App integriert werden können. Ihre App kann beispielsweise einen neuen Chat initiieren, indem sie die chat.openChat() Funktion der Microsoft Teams-Chatfunktion aufruft. Dadurch wird ein neuer 1:1-Chat mit einem Benutzer geöffnet.

Sie können die Funktion für jede Funktion verwenden <the-capability>.isSupported() , um zu überprüfen, ob die Funktion vom Host unterstützt wird. Vor dem Aufruf chat.openChat()von können Sie beispielsweise überprüfen, ob der Chat in der Host-App unterstützt wird, in der Ihre App ausgeführt wird. Um dies zu überprüfen, rufen Sie die Funktion chat.isSupported()auf. Es wird zurückgegeben true , wenn der Chat unterstützt wird und false wenn der Chat nicht unterstützt wird. Diese Überprüfung ermöglicht es Ihrer App, nur Funktionen auszuführen, die in den Host-Apps unterstützt werden, sodass Benutzer auf jedem Host eine natürlichere Erfahrung haben.