Verwenden des Teams-Client-SDKsUsing the Teams client SDK

Das Microsoft Teams-JavaScript- Client-SDK und die JavaScript- Bibliothek für Teams sind Teil der Microsoft Teams-Entwicklerplattform und stellen Tools und Prozesse zur Verfügung, um die Anwendungserstellung für Teams zu vereinfachen.The Teams JavaScript client SDK and Teams JavaScript Library are part of the Microsoft Teams developer platform and provide tools and processes to facilitate Teams application creation. Das Microsoft Teams-Client-SDK wird als NPM-Paket verteilt.The Teams client SDK is distributed as an npm package. Die neueste Version finden Sie hier: https://www.npmjs.com/package/@microsoft/teams-js .The latest version can be found here: https://www.npmjs.com/package/@microsoft/teams-js. Die Microsoft Teams-Bibliothek befindet sich unter https://github.com/OfficeDev/microsoft-teams-library-js .The Teams Library is located at https://github.com/OfficeDev/microsoft-teams-library-js.

In der folgenden Tabelle werden die in der Entwicklung von Tabs üblicherweise verwendeten Teams-Bibliotheksfunktionen beschrieben:The following table outlines the Teams Library functions typically used in tabs development:

Öffentliche Microsoft Teams SDK-APITeams SDK public API

FunktionFunction BeschreibungDescription DokumentationDocumentation
microsoftTeams.initialize() Initialisiert die Teams-Bibliothek.Initializes the Teams library. Diese Funktion muss vor anderen SDK-aufrufen aufgerufen werden.This function must be called before any other SDK calls. functionfunction
microsoftTeams.getContext(callback: (context: Context) Ruft den aktuellen Zustand ab, in dem die Seite läuft.Gets the current state in which the page is running. Der Rückruf Ruft das context -Objekt ab.The callback retrieves the Context object. functionfunction
Kontext-objcontext obj
microsoftTeams.initializeWithContext({contentUrl: string, websiteUrl: string}) Initialisiert die Teams-Bibliothek und legt den Rahmen Kontext der Registerkarte abhängig von der contentUrl und websiteUrl.Initializes the Teams library and sets the tab's frame context depending on the contentUrl and websiteUrl. Dadurch wird sichergestellt, dass die Funktion "Gehe zu Website/Reload" mit der korrekten URL arbeitet.This ensures the go-to-website/reload functionality operates on the correct URL. functionfunction
microsoftTeams.setFrameContext({contentUrl: string, websiteUrl: string}) Legt den Rahmen Kontext der Registerkarte je nach contentUrl und websiteUrl.Sets the tab's frame context depending on the contentUrl and websiteUrl. Dadurch wird sichergestellt, dass die Funktion "Gehe zu Website/Reload" mit der korrekten URL arbeitet.This ensures the go-to-website/reload functionality operates on the correct URL. functionfunction
microsoftTeams.registerFullScreenHandler(handler: (isFullScreen: boolean) Der Handler, der registriert wird, wenn der Benutzer die Vollbildansicht/Fenster Ansicht eines Tabs umschalten kann.The handler that is registered when the user toggles a tab's full-screen/windowed view. functionfunction
booleanboolean
microsoftTeams.registerChangeSettingsHandler() Der Handler, der registriert wird, wenn der Benutzer die Schaltfläche "aktivierte Einstellungen " auswählt, um eine Registerkarte neu zu konfigurieren.The handler that is registered when the user selects the enabled Settings button to reconfigure a tab. functionfunction
microsoftTeams.getTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters,) Ruft die Registerkarten im Besitz der App ab.Gets the tabs owned by the app. Der Rückruf Ruft das TabInformation -Objekt ab.The callback retrieves the TabInformation object. Das TabInstanceParameters -Objekt ist ein optionaler Parameter.The TabInstanceParameters object is an optional parameter. functionfunction
TabInfo objtabInfo obj
microsoftTeams.getMruTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters) Ruft die zuletzt verwendeten Registerkarten für den Benutzer ab.Gets the most recently used tabs for the user. Der Rückruf Ruft das TabInformation -Objekt ab.The callback retrieves the TabInformation object. Das TabInstanceParameters -Objekt ist ein optionaler Parameter.The TabInstanceParameters object is an optional parameter. functionfunction
TabInfo objtabInfo obj
tabInstance objtabInstance obj
microsoftTeams.shareDeepLink(deepLinkParameters: DeepLinkParameters) Das DeepLinkParameters -Objekt wird als Eingabe verwendet, und es wird ein Dialogfeld Deep Link gemeinsam verwendet, mit dem ein Benutzer zu Inhalten innerhalb der Registerkartenavigieren kann.Takes the DeepLinkParameters object as input and shares a deep link dialog box that a user can use to navigate to content within the tab. functionfunction
deepLink objdeepLink obj
microsoftTeams.executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string)) Akzeptiert eine erforderliche deepLink als Eingabe und navigiert Benutzer zu einer URL oder löst eine Clientaktion aus – beispielsweise öffnen oder installieren – eine APP in Microsoft Teams.Takes a required deepLink as input and navigates user to a URL or triggers a client action—such as opening or installing—an app within Teams. functionfunction
microsoftTeams.navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string)) Das TabInstance -Objekt wird als Eingabe verwendet und zu einer angegebenen Registerkarten Instanz navigiert.Takes the TabInstance object as input and navigates to a specified tab instance. functionfunction
tabInstance objtabInstance obj

Authentifizierungs NamespaceAuthentication namespace

FunktionFunction BeschreibungDescription DokumentationDocumentation
microsoftTeams.authentication.authenticate(authenticateParameters?: AuthenticateParameters) Initiiert eine Authentifizierungsanforderung, die ein neues Fenster mit den vom Aufrufer bereitgestellten Parametern öffnet.Initiates an authentication request that opens a new window with the parameters provided by the caller. Optionale Eingabewerte werden durch das AuthenticateParameters -Objekt definiert.Optional input values are defined by the AuthenticateParameters object. functionfunction
Authentifizierungs-objauth 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 AuthentifizierungsfensterNotifies the frame that initiated the authentication request that the request was successful and closes the authentication window functionfunction
microsoftTeams.authentication.notifyFailure(reason?: string, callbackUrl?: string) Benachrichtigt den Frame, der die Authentifizierungsanforderung initiiert hat, dass die Anforderung fehlgeschlagen ist, und schließt das Authentifizierungsfenster.Notifies the frame that initiated the authentication request that the request failed and closes the authentication window. functionfunction

Namespace "Settings"Settings namespace

FunktionFunction BeschreibungDescription DokumentationDocumentation
microsoftTeams.settings.setValidityState(validityState: boolean) Der Anfangswert ist false.The initial value is false. Aktiviert die Schaltfläche Speichern oder Entfernen , wenn der Gültigkeitsstatus auf true festgelegt ist.Activates the Save or Remove button when the validity state is true. functionfunction
microsoftTeams.settings.getSettings(callback: (instanceSettings: Settings) Ruft die Einstellungen für die aktuelle Instanz ab.Gets the settings for the current instance. Der Rückruf Ruft das Settings -Objekt ab.The callback retrieves the Settings object. functionfunction
obj-Einstellungensettings obj
microsoftTeams.settings.setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) Konfiguriert die Einstellungen für die aktuelle Instanz.Configures the settings for the current instance. Gültige Einstellungen werden durch das Settings -Objekt definiert.Valid settings are defined by the Settings object. functionfunction
obj-Einstellungensettings obj
microsoftTeams.settings.registerOnSaveHandler(handler: (evt: SaveEvent) Der Handler, der registriert wird, wenn der Benutzer die Schaltfläche Speichern auswählt.The handler that is registered when the user selects the Save button. Dieser Handler sollte verwendet werden, um die zugrunde liegende Ressource, die den Inhalt einmacht, zu erstellen oder zu aktualisieren.This handler should be used to create or update the underlying resource powering the content. functionfunction
microsoftTeams.settings.registerOnRemoveHandler(handler: (evt: RemoveEvent) Der Handler, der registriert wird, wenn der Benutzer die Schaltfläche Entfernen auswählt.The handler that is registered when the user selects the Remove button. Dieser Handler sollte verwendet werden, um die zugrunde liegende Ressource zu entfernen, die den Inhalt einmacht.This handler should be used to remove the underlying resource powering the content. functionfunction

Aufgaben-NamespaceTasks namespace

FunktionFunction BeschreibungDescription DokumentationDocumentation
microsoftTeams.tasks.startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) Das taskinfo -Objekt wird als Eingabe verwendet und ermöglicht einer APP das Öffnen des Aufgabenmoduls.Takes the TaskInfo object as input and allows an app to open the task module. Das optionale submitHandler wird registriert, wenn der Aufgabenmodul abgeschlossen ist.The optional submitHandler is registered when the task module is completed. functionfunction
taskInfo objtaskInfo obj
microsoftTeams.tasks.submitTask(result?: string | object, appIds?: string | string[]) Sendet das Aufgabenmodul.Submits the task module. Der optionale Ergebnis Zeichenfolgen-Parameter ist das Ergebnis, das an den bot oder die APP gesendet wurde, und ist in der Regel ein JSON-Objekt oder eine Serialisierung; Die optionale Zeichenfolge oder der String-Arrayparameter für die Zeichenfolgengruppe hilft bei der Überprüfung, dass der Aufruf von der gleichen Webanwendung stammt wie diejenige, die den Aufgabenmodul aufgerufen hat.The optional result string parameter is the result sent to the bot or the app and is typically a JSON object or serialization; The optional appIds string or string array parameter aids in validating that the call originated from the same appId as the one that invoked the task module. functionfunction