Qu’est-ce que la bibliothèque de client JavaScript Teams ?
La plateforme de développement Teams propose la bibliothèque de client JavaScript Teams en tant que bibliothèque JavaScript pour vos applications clientes. La bibliothèque est une collection de fonctions JavaScript via lesquelles vous pouvez utiliser l’API Teams pour intégrer des fonctionnalités et des fonctionnalités dans vos applications Teams. Les fonctionnalités apparaissent comme natives du client Teams. La bibliothèque garantit que les applications que vous créez avec elle ont une expérience cohérente et conviviale pour les utilisateurs de Teams.
Dans cette unité, vous allez apprendre à utiliser la bibliothèque dans une application.
Intégrer la bibliothèque dans votre application
Examinons différentes façons d’installer la bibliothèque dans une application.
Vous pouvez installer la version LTS de la bibliothèque de client JavaScript Teams à l’aide de npm ou de yarn.
Pour installer la bibliothèque à l’aide de npm :
npm install --save @microsoft/teams-js
Pour installer la bibliothèque à l’aide de yarn :
yarn add @microsoft/teams-js
Si vous créez des applications web sans utiliser de bundler, vous pouvez charger la bibliothèque directement à partir du réseau de distribution de contenu. Ajoutez l’extrait de code suivant à votre application web :
<script src="https://res.cdn.office.net/teams-js/2.7.1/js/MicrosoftTeams.min.js "></script>
Utilisation de la bibliothèque
La bibliothèque de client JavaScript Teams a des API qui sont regroupées logiquement en fonctionnalités. Ces fonctionnalités sont des espaces de noms à l’intérieur de la bibliothèque. L’application d’espace de noms de niveau supérieur contient toutes les API dont vous avez besoin pour l’utilisation globale de l’application.
Vous pouvez initialiser la bibliothèque à l’aide de app.Initialize(). Une fois la bibliothèque initialisée, vous pouvez commencer à utiliser l’espace de noms pour accéder à toutes les API et fonctionnalités incluses dans la bibliothèque. Pour obtenir les informations contextuelles de base de votre application, appelez app.getContext(). Pour générer et afficher un lien copiable vers des informations que l’utilisateur doit partager, appelez pages.shareDeepLink().
Pour obtenir les informations de contexte de l’application, exécutez ce code :
await app.initialize();
const context = await app.getContext();
L’obtention d’informations contextuelles sur Microsoft Teams permet à votre application Teams de fournir une expérience meilleure et plus personnalisée pour les utilisateurs. Par exemple, avec les informations de contexte, votre application peut comprendre l’environnement spécifique dans lequel elle s’exécute, comme dans Teams ou dans un navigateur, une équipe ou un canal, ou même l’utilisateur avec lequel votre application interagit. Ces insights sont utiles pour déterminer comment configurer et afficher correctement des fonctionnalités ou des fonctionnalités pertinentes et personnalisées pour l’utilisateur.
Fonctionnalités
Les API du Kit de développement logiciel (SDK) sont regroupées logiquement et sont appelées fonctionnalités. La conversation, le dialogue et l’authentification sont des exemples de fonctionnalités. Chaque fonctionnalité a ses propres espaces de noms ; par exemple, conversation, boîte de dialogue ou page.
Remarque
La bibliothèque de client JavaScript Teams version 2.0.0 et ultérieure permet aux applications Teams de s’exécuter dans d’autres applications hôtes telles qu’Outlook et Office.com. Ces fonctionnalités d’extensibilité sont actuellement en préversion sur ces applications.
Considérez Microsoft Teams comme l’hôte actuel de votre application. L’hôte dispose de certaines fonctionnalités qui peuvent être intégrées à votre application. Par exemple, votre application peut lancer une nouvelle conversation en appelant la chat.openChat() fonction de la fonctionnalité de conversation Microsoft Teams. Cela ouvre une nouvelle conversation 1 :1 avec un utilisateur.
Vous pouvez utiliser <the-capability>.isSupported() la fonction pour chaque fonctionnalité pour vérifier si la fonctionnalité est prise en charge par l’hôte. Par exemple, avant d’effectuer l’appel à chat.openChat(), vous pouvez vérifier si la conversation est prise en charge dans l’application hôte où votre application s’exécute. Pour vérifier, vous appelez la fonction chat.isSupported(). Elle retourne true si la conversation est prise en charge et false si la conversation n’est pas prise en charge. Cette vérification permet à votre application d’exécuter uniquement les fonctionnalités prises en charge dans les applications hôtes, afin que les utilisateurs bénéficient d’une expérience plus naturelle dans chaque hôte.