Erstellen von Registerkarten und anderen gehosteten Erfahrungen mit dem Microsoft Teams JavaScript-Client-SDK

Das Microsoft Teams JavaScript-Client-SDK kann Ihnen helfen, gehostete Erfahrungen in Teams zu erstellen, was bedeutet, dass Ihre App-Inhalte in einem iframe angezeigt werden.

Das SDK ist hilfreich für die Entwicklung von Apps mit einer der folgenden Teams Funktionen:

Das SDK kann ihre Registerkarte beispielsweise dazu bringen, auf Designänderungen zu reagieren, die Ihre Benutzer im Teams-Client vornehmen.

Erste Schritte

Führen Sie je nach Ihren Entwicklungseinstellungen eine der folgenden Aktionen aus:

Allgemeine SDK-Funktionen

In den folgenden Tabellen finden Sie Informationen zu häufig verwendeten SDK-Funktionen. Die SDK-Referenzdokumentation enthält umfassendere Informationen.

Grundlegende Funktionen

Funktion Beschreibung Dokumentation
microsoftTeams.initialize() Initialisiert das SDK. Diese Funktion muss vor allen anderen SDK-Aufrufen aufgerufen werden. function
microsoftTeams.getContext(callback: (context: Context) Ruft den aktuellen Status ab, in dem die Seite ausgeführt wird. Der Rückruf ruft das Context-Objekt ab. function
Kontext-Obj
microsoftTeams.initializeWithContext({contentUrl: string, websiteUrl: string}) Initialisiert die Teams-Bibliothek und legt den Framekontext der Registerkarte abhängig von contentUrl und websiteUrl fest. Dadurch wird sichergestellt, dass die Go-to-Website/Reload-Funktion unter der richtigen URL ausgeführt wird. function
microsoftTeams.setFrameContext({contentUrl: string, websiteUrl: string}) Legt den Framekontext der Registerkarte abhängig von contentUrl und websiteUrl fest. Dadurch wird sichergestellt, dass die Go-to-Website/Reload-Funktion unter der richtigen URL ausgeführt wird. function
microsoftTeams.registerFullScreenHandler(handler: (isFullScreen: boolean) Der Handler, der registriert wird, wenn der Benutzer die Vollbild-/Fensteransicht einer Registerkarte umschaltet. function
boolean
microsoftTeams.registerChangeSettingsHandler() Der Handler, der registriert wird, wenn der Benutzer die aktivierte Einstellungen-Schaltfläche auswählt, um eine Registerkarte neu zu konfigurieren. function
microsoftTeams.getTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters,) Ruft die Registerkarten ab, die der App gehören. Der Rückruf ruft das TabInformation -Objekt ab. Das TabInstanceParameters -Objekt ist ein optionaler Parameter. function
tabInfo obj
microsoftTeams.getMruTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters) Ruft die zuletzt verwendeten Registerkarten für den Benutzer ab. Der Rückruf ruft das TabInformation -Objekt ab. Das TabInstanceParameters -Objekt ist ein optionaler Parameter. function
tabInfo obj
tabInstance obj
microsoftTeams.shareDeepLink(deepLinkParameters: DeepLinkParameters) Verwendet das DeepLinkParameters -Objekt als Eingabe und gibt ein Deep-Link-Dialogfeld, das ein Benutzer verwenden kann, um zu Inhalten innerhalb der Registerkarte zu navigieren. function
deepLink-Obj
microsoftTeams.executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string)) Verwendet einen erforderlichen DeepLink als Eingabe und navigiert den Benutzer zu einer URL oder löst eine Clientaktion (z. B. Öffnen oder Installieren) einer App innerhalb Teams aus. function
microsoftTeams.navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string)) Verwendet das TabInstance-Objekt als Eingabe und navigiert zu einer angegebenen Registerkarteninstanz. function
tabInstance obj

Authentifizierungsnamespace

Funktion Beschreibung Dokumentation
microsoftTeams.authentication.authenticate(authenticateParameters?: AuthenticateParameters) Initiiert eine Authentifizierungsanforderung, die ein neues Fenster mit den vom Aufrufer bereitgestellten Parametern öffnet. Optionale Eingabewerte werden vom AuthenticateParameters-Objekt definiert. function
Authentifizierungs-Obj
microsoftTeams.authentication.notifySuccess(result?: string, callbackUrl?: string) Benachrichtigt den Frame, der die Authentifizierungsanforderung initiiert hat, dass die Anforderung erfolgreich war, und schließt das Authentifizierungsfenster. function
microsoftTeams.authentication.notifyFailure(reason?: string, callbackUrl?: string) Benachrichtigt den Frame, der die Authentifizierungsanforderung initiiert hat, darüber, dass die Anforderung fehlgeschlagen ist, und schließt das Authentifizierungsfenster. function
microsoftTeams.authentication.getAuthToken(authTokenRequest: AuthTokenRequest) Senden Sie eine Anforderung, um Azure AD Token im Auftrag der App auszustellen. Das Token kann aus dem Cache abgerufen werden, wenn es nicht abgelaufen ist. Andernfalls wird eine Anforderung an Azure AD gesendet, um ein neues Token abzurufen. function

Einstellungen-Namespace

Funktion Beschreibung Dokumentation
microsoftTeams.settings.setValidityState(validityState: boolean) Der Anfangswert ist "false". Aktiviert die Schaltfläche "Speichern" oder "Entfernen", wenn der Gültigkeitsstatus "true" ist. function
microsoftTeams.settings.getSettings(callback: (instanceSettings: Settings) Ruft die Einstellungen für die aktuelle Instanz ab. Der Rückruf ruft das Einstellungen-Objekt ab. function
Einstellungs-Obj
microsoftTeams.settings.setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) Konfiguriert die Einstellungen für die aktuelle Instanz. Gültige Einstellungen werden vom Einstellungen-Objekt definiert. function
Einstellungs-Obj
microsoftTeams.settings.registerOnSaveHandler(handler: (evt: SaveEvent) Der Handler, der registriert wird, wenn der Benutzer die Schaltfläche "Speichern" auswählt. Dieser Handler sollte verwendet werden, um die zugrunde liegende Ressource zu erstellen oder zu aktualisieren, die den Inhalt unterstützt. function
microsoftTeams.settings.registerOnRemoveHandler(handler: (evt: RemoveEvent) Der Handler, der registriert wird, wenn der Benutzer die Schaltfläche "Entfernen" auswählt. Dieser Handler sollte verwendet werden, um die zugrunde liegende Ressource zu entfernen, die den Inhalt angibt. function

Aufgabenmodulnamespace

Funktion Beschreibung Dokumentation
microsoftTeams.tasks.startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) Verwendet das TaskInfo-Objekt als Eingabe und ermöglicht es einer App, das Aufgabenmodul zu öffnen. Der optionale submitHandler wird registriert, wenn das Aufgabenmodul abgeschlossen ist. function
taskInfo obj
microsoftTeams.tasks.submitTask(result?: string | object, appIds?: string | string[]) Sendet das Aufgabenmodul. Der optionale Ergebniszeichenfolgenparameter ist das Ergebnis, das an den Bot oder die App gesendet wird und in der Regel ein JSON-Objekt oder eine Serialisierung ist. Der optionale parameter "appIds string" oder "string array" hilft dabei, zu überprüfen, ob der Aufruf von derselben appId stammt wie der Aufruf, der das Aufgabenmodul aufgerufen hat. function