Création d’onglets et d’autres expériences hébergées avec Microsoft Teams SDK client JavaScript

Le Microsoft Teams SDK client JavaScript peut vous aider à créer des expériences hébergées dans Teams, ce qui signifie afficher le contenu de votre application dans un iframe.

Le SDK est utile pour le développement d’applications avec l’une des fonctionnalités Teams suivantes :

Par exemple, le SDK peut faire réagir votre onglet aux modifications de thème apportées par vos utilisateurs dans Teams client.

Prise en main

Faites l’une des choses suivantes en fonction de vos préférences de développement :

Fonctions SDK courantes

Consultez les tableaux suivants pour comprendre les fonctions courantes du SDK. La documentation de référence du SDK fournit des informations plus complètes.

Fonctions de base

Fonction Description Documentation
microsoftTeams.initialize() Initialise le SDK. Cette fonction doit être appelée avant tout autre appel du SDK. function
microsoftTeams.getContext(callback: (context: Context) Obtient l’état actuel dans lequel la page est en cours d’exécution. Le rappel récupère l’objet Context. function
context obj
microsoftTeams.initializeWithContext({contentUrl: string, websiteUrl: string}) Initialise la bibliothèque Teams et définit le contexte d’image de l’onglet en fonction de contentUrl et websiteUrl. Cela garantit que la fonctionnalité d’accès au site web/recharge fonctionne sur l’URL correcte. function
microsoftTeams.setFrameContext({contentUrl: string, websiteUrl: string}) Définit le contexte d’image de l’onglet en fonction de contentUrl et websiteUrl. Cela garantit que la fonctionnalité d’accès au site web/recharge fonctionne sur l’URL correcte. function
microsoftTeams.registerFullScreenHandler(handler: (isFullScreen: boolean) Le handler qui est enregistré lorsque l’utilisateur bascule la vue plein écran/fenêtre d’un onglet. function
boolean
microsoftTeams.registerChangeSettingsHandler() Le handler inscrit lorsque l’utilisateur sélectionne le bouton Paramètres pour reconfigurer un onglet. function
microsoftTeams.getTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters,) Obtient les onglets de l’application. Le rappel récupère l’objet TabInformation. L’objet TabInstanceParameters est un paramètre facultatif. function
tabInfo obj
microsoftTeams.getMruTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters) Obtient les derniers onglets utilisés pour l’utilisateur. Le rappel récupère l’objet TabInformation. L’objet TabInstanceParameters est un paramètre facultatif. function
tabInfo obj
tabInstance obj
microsoftTeams.shareDeepLink(deepLinkParameters: DeepLinkParameters) Prend l’objet DeepLinkParameters comme entrée et partage une boîte de dialogue de lien profond qu’un utilisateur peut utiliser pour accéder au contenu de l’onglet. function
deepLink obj
microsoftTeams.executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string)) Prend un deepLink requis en tant qu’entrée et permet à l’utilisateur d’accéder à une URL ou déclenche une action du client, telle que l’ouverture ou l’installation, d’une application dans Teams. function
microsoftTeams.navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string)) Prend l’objet TabInstance comme entrée et navigue jusqu’à une instance d’onglet spécifiée. function
tabInstance obj

Espace de noms d’authentification

Fonction Description Documentation
microsoftTeams.authentication.authenticate(authenticateParameters?: AuthenticateParameters) Lance une demande d’authentification qui ouvre une nouvelle fenêtre avec les paramètres fournis par l’appelant. Les valeurs d’entrée facultatives sont définies par l’objet AuthenticateParameters. function
auth obj
microsoftTeams.authentication.notifySuccess(result?: string, callbackUrl?: string) Avertit la trame à l’origine de la demande d’authentification que la demande a réussi et ferme la fenêtre d’authentification. function
microsoftTeams.authentication.notifyFailure(reason?: string, callbackUrl?: string) Avertit la trame à l’origine de la demande d’authentification que la demande a échoué et ferme la fenêtre d’authentification. function
microsoftTeams.authentication.getAuthToken(authTokenRequest: AuthTokenRequest) Envoyez une demande pour émettre Azure AD de la part de l’application. Le jeton peut être acquis à partir du cache, s’il n’a pas expiré. Dans le cas contraire, une demande est envoyée Azure AD pour obtenir un nouveau jeton. function

Paramètres de noms

Fonction Description Documentation
microsoftTeams.settings.setValidityState(validityState: boolean) La valeur initiale est false. Active le bouton Enregistrer ou Supprimer lorsque l’état de validité est true. function
microsoftTeams.settings.getSettings(callback: (instanceSettings: Settings) Obtient les paramètres de l’instance actuelle. Le rappel récupère l’Paramètres objet. function
settings obj
microsoftTeams.settings.setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) Configure les paramètres de l’instance actuelle. Les paramètres valides sont définis par l’objet Paramètres. function
settings obj
microsoftTeams.settings.registerOnSaveHandler(handler: (evt: SaveEvent) Le handler qui est enregistré lorsque l’utilisateur sélectionne le bouton Enregistrer. Ce handler doit être utilisé pour créer ou mettre à jour la ressource sous-jacente qui alimentera le contenu. function
microsoftTeams.settings.registerOnRemoveHandler(handler: (evt: RemoveEvent) Le handler inscrit lorsque l’utilisateur sélectionne le bouton Supprimer. Ce handler doit être utilisé pour supprimer la ressource sous-jacente qui alimentera le contenu. function

Espace de noms des modules de tâche

Fonction Description Documentation
microsoftTeams.tasks.startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) Prend l’objet TaskInfo comme entrée et permet à une application d’ouvrir le module de tâche. Le submitHandler facultatif est inscrit lorsque le module de tâche est terminé. function
taskInfo obj
microsoftTeams.tasks.submitTask(result?: string | object, appIds?: string | string[]) Envoie le module de tâche. Le paramètre de chaîne de résultat facultatif est le résultat envoyé au bot ou à l’application et est généralement un objet JSON ou une sérialisation ; Le paramètre facultatif de chaîne appIds ou de tableau de chaînes permet de valider que l’appel provient du même appId que celui qui a appelé le module de tâche. function