Utilisation du kit de développement logiciel client TeamsUsing the Teams client SDK

Le Kit de développement logiciel (SDK) JavaScript de teams et la bibliothèque JavaScript teams font partie de la plateforme de développement Microsoft teams et fournissent des outils et des processus pour faciliter la création d’applications Teams.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. Le kit de développement logiciel (SDK) Team client est distribué sous la forme d’un package NPM.The Teams client SDK is distributed as an npm package. La dernière version est disponible ici : https://www.npmjs.com/package/@microsoft/teams-js .The latest version can be found here: https://www.npmjs.com/package/@microsoft/teams-js. La bibliothèque teams se trouve à l’adresse https://github.com/OfficeDev/microsoft-teams-library-js .The Teams Library is located at https://github.com/OfficeDev/microsoft-teams-library-js.

Le tableau suivant présente les fonctions de la bibliothèque teams généralement utilisées dans le développement d’onglets :The following table outlines the Teams Library functions typically used in tabs development:

API publique du kit de développement logiciel teamsTeams SDK public API

FonctionFunction DescriptionDescription DocumentationDocumentation
microsoftTeams.initialize() Initialise la bibliothèque Teams.Initializes the Teams library. Cette fonction doit être appelée avant tout autre appel SDK.This function must be called before any other SDK calls. functionfunction
microsoftTeams.getContext(callback: (context: Context) Obtient l’état actuel dans lequel la page est en cours d’exécution.Gets the current state in which the page is running. Le rappel récupère l’objet de contexte .The callback retrieves the Context object. functionfunction
obj de contextecontext obj
microsoftTeams.initializeWithContext({contentUrl: string, websiteUrl: string}) Initialise la bibliothèque teams et définit le contexte d' image de l’onglet en fonction des ContentUrl et websiteUrl.Initializes the Teams library and sets the tab's frame context depending on the contentUrl and websiteUrl. Cela garantit que la fonctionnalité d’accès au site Web/de chargement fonctionne sur l’URL correcte.This ensures the go-to-website/reload functionality operates on the correct URL. functionfunction
microsoftTeams.setFrameContext({contentUrl: string, websiteUrl: string}) Définit le contexte d' image de l’onglet en fonction des ContentUrl et websiteUrl.Sets the tab's frame context depending on the contentUrl and websiteUrl. Cela garantit que la fonctionnalité d’accès au site Web/de chargement fonctionne sur l’URL correcte.This ensures the go-to-website/reload functionality operates on the correct URL. functionfunction
microsoftTeams.registerFullScreenHandler(handler: (isFullScreen: boolean) Gestionnaire inscrit lorsque l’utilisateur active ou désactive l’affichage plein écran d’un onglet.The handler that is registered when the user toggles a tab's full-screen/windowed view. functionfunction
booleanboolean
microsoftTeams.registerChangeSettingsHandler() Gestionnaire enregistré lorsque l’utilisateur sélectionne le bouton paramètres activés pour reconfigurer un onglet.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,) Obtient les onglets appartenant à l’application.Gets the tabs owned by the app. Le rappel récupère l’objet TabInformation .The callback retrieves the TabInformation object. L’objet TabInstanceParameters est un paramètre facultatif.The TabInstanceParameters object is an optional parameter. functionfunction
tabInfo objtabInfo obj
microsoftTeams.getMruTabInstances(callback: (tabInfo: TabInformation),tabInstanceParameters?: TabInstanceParameters) Obtient les onglets les plus récemment utilisés pour l’utilisateur.Gets the most recently used tabs for the user. Le rappel récupère l’objet TabInformation .The callback retrieves the TabInformation object. L’objet TabInstanceParameters est un paramètre facultatif.The TabInstanceParameters object is an optional parameter. functionfunction
tabInfo objtabInfo obj
tabInstance objtabInstance 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 au sein de l’onglet.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)) Prend un deepLink obligatoire comme entrée et parcourt l’utilisateur vers une URL ou déclenche une action client, telle que l’ouverture ou l’installation, une application dans 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)) Prend l’objet TabInstance comme entrée et accède à une instance d’onglet spécifiée.Takes the TabInstance object as input and navigates to a specified tab instance. functionfunction
tabInstance objtabInstance obj

Espace de noms d’authentificationAuthentication namespace

FonctionFunction DescriptionDescription DocumentationDocumentation
microsoftTeams.authentication.authenticate(authenticateParameters?: AuthenticateParameters) Lance une demande d’authentification qui ouvre une nouvelle fenêtre avec les paramètres fournis par l’appelant.Initiates an authentication request that opens a new window with the parameters provided by the caller. Les valeurs d’entrée facultatives sont définies par l’objet AuthenticateParameters .Optional input values are defined by the AuthenticateParameters object. functionfunction
obj d’authentificationauth obj
microsoftTeams.authentication.notifySuccess(result?: string, callbackUrl?: string) Avertit le cadre qui a initié la demande d’authentification que la demande a réussi et qui ferme la fenêtre d’authentification.Notifies 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) Indique au cadre qui a initié la demande d’authentification que la demande a échoué et ferme la fenêtre d’authentification.Notifies the frame that initiated the authentication request that the request failed and closes the authentication window. functionfunction

Espace de noms paramètresSettings namespace

FonctionFunction DescriptionDescription DocumentationDocumentation
microsoftTeams.settings.setValidityState(validityState: boolean) La valeur initiale est false.The initial value is false. Active le bouton Enregistrer ou supprimer lorsque l’état de validité est true.Activates the Save or Remove button when the validity state is true. functionfunction
microsoftTeams.settings.getSettings(callback: (instanceSettings: Settings) Obtient les paramètres de l’instance actuelle.Gets the settings for the current instance. Le rappel récupère l’objet Settings .The callback retrieves the Settings object. functionfunction
paramètres objsettings obj
microsoftTeams.settings.setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) Configure les paramètres de l’instance actuelle.Configures the settings for the current instance. Les paramètres valides sont définis par l’objet Settings .Valid settings are defined by the Settings object. functionfunction
paramètres objsettings obj
microsoftTeams.settings.registerOnSaveHandler(handler: (evt: SaveEvent) Gestionnaire inscrit lorsque l’utilisateur sélectionne le bouton Enregistrer .The handler that is registered when the user selects the Save button. Ce gestionnaire doit être utilisé pour créer ou mettre à jour la ressource sous-jacente qui alimente le contenu.This handler should be used to create or update the underlying resource powering the content. functionfunction
microsoftTeams.settings.registerOnRemoveHandler(handler: (evt: RemoveEvent) Gestionnaire inscrit lorsque l’utilisateur sélectionne le bouton supprimer .The handler that is registered when the user selects the Remove button. Ce gestionnaire doit être utilisé pour supprimer la ressource sous-jacente qui alimente le contenu.This handler should be used to remove the underlying resource powering the content. functionfunction

Espace de noms tâchesTasks namespace

FonctionFunction DescriptionDescription DocumentationDocumentation
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âches.Takes the TaskInfo object as input and allows an app to open the task module. L' submitHandler facultatif est inscrit lorsque le module de tâche est terminé.The optional submitHandler is registered when the task module is completed. functionfunction
taskInfo objtaskInfo obj
microsoftTeams.tasks.submitTask(result?: string | object, appIds?: string | string[]) Soumet le module de tâche.Submits the task module. Le paramètre de chaîne de résultats facultatif est le résultat envoyé au bot ou à l’application ; il s’agit généralement d’un objet ou d’une sérialisation JSON ; La chaîne ou le paramètre de tableau de chaînes des AppID facultatifs facilite la validation de l’origine de l’appel du même AppID que celui qui a appelé le module de tâche.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