Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Le sous-ensemble de l’API de complément Outlook de l’API JavaScript d’Office comprend des objets, des méthodes, des propriétés et des événements que vous pouvez utiliser dans un complément Outlook.
Remarque
Dans cette documentation, l’ensemble de conditions requises présenté est différent de l’ensemble de conditions requises de la version précédente.
Nouveautés de la version 1.5
Le jeu de conditions requises de boîte aux lettres 1.5 inclut toutes les fonctionnalités du jeu de conditions requises 1.4. Les fonctionnalités suivantes ont été ajoutées.
- Prise en charge des volets Office épinglables.
- Prise en charge de l’appel des API REST.
Importante
Les points de terminaison Outlook REST v2.0 et bêta sont déconseillés. Utilisez plutôt l’API REST de Microsoft Graph .
- Ajout de la prise en charge du marquage d’une pièce jointe comme étant incluse.
- Ajout de la prise en charge de la fermeture par programme d’un volet Office ou d’une boîte de dialogue.
- Ajout de la prise en charge de la propriété Office.context.diagnostics et de ses objets associés.
- Ajout d’un événement pour déterminer quand un élément de courrier Outlook est sélectionné pour affichage lorsque le volet Office du complément est épinglé.
Liste des API
Le tableau suivant répertorie les API introduites dans le jeu de conditions requises de boîte aux lettres 1.5. Pour consulter la documentation de référence sur toutes les API prises en charge par le jeu d’exigences de boîte aux lettres 1.5 ou version antérieure, consultez API Outlook.
| Classe | Champs | Description |
|---|---|---|
| DragAndDropEventArgs | dragAndDropEventData | Obtient les détails sur la position du pointeur de la souris dans le volet Office d’un complément et les messages ou pièces jointes glissés dans le volet Office. |
| type | Obtient le type de l’événement. | |
| DragoverEventData | pageX | Obtient la coordonnée x du pointeur de la souris qui représente la position horizontale en pixels. |
| pageY | Obtient la coordonnée y du pointeur de la souris qui représente la position verticale en pixels. | |
| taskPaneX | Obtient la coordonnée x du pointeur de la souris qui représente la position horizontale en pixels. | |
| taskPaneY | Obtient la coordonnée y du pointeur de la souris qui représente la position verticale en pixels. | |
| type | Obtient le type d’événement de glisser-déplacer. | |
| DropEventData (en anglais) | transfert de données | Adresse les messages ou pièces jointes déplacés par glisser-déplacer dans le volet Office d’un complément. |
| pageX | Obtient la coordonnée x du pointeur de la souris qui représente la position horizontale en pixels. | |
| pageY | Obtient la coordonnée y du pointeur de la souris qui représente la position verticale en pixels. | |
| taskPaneX | Obtient la coordonnée x du pointeur de la souris qui représente la position horizontale en pixels. | |
| taskPaneY | Obtient la coordonnée y du pointeur de la souris qui représente la position verticale en pixels. | |
| type | Obtient le type d’événement de glisser-déplacer. | |
| DroppedItemDetails | fileContent | Obtient le contenu du fichier glissé et déposé. |
| name | Récupère le nom du fichier que vous avez glissé et déposé. | |
| type | Obtient le type de fichier que vous avez glissé et déposé. | |
| DroppedItems | fichiers | Obtient un tableau des messages ou pièces jointes que vous glissez et déposez dans le volet Office d’un complément. |
| Boîte aux lettres | addHandlerAsync(eventType : Office.EventType | string, handler : any, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | ajoute un gestionnaire d’événements pour un événement pris en charge. |
| addHandlerAsync(eventType : Office.EventType | string, handler : any, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | ajoute un gestionnaire d’événements pour un événement pris en charge. | |
| getCallbackTokenAsync(options : Office.AsyncContextOptions & { isRest ?: boolean }, callback : (asyncResult : Office.AsyncResult<string>) => void) | Obtient une chaîne contenant un jeton utilisé pour appeler des API REST ou des services web Exchange (EWS). | |
| removeHandlerAsync(eventType : Office.EventType | string, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime les gestionnaires d’événements pour un type d’événement pris en charge. | |
| removeHandlerAsync(eventType : Office.EventType | string, options : Office.AsyncContextOptions, callback ?: (asyncResult : Office.AsyncResult<void>) => void) | Supprime les gestionnaires d’événements pour un type d’événement pris en charge. | |
| restUrl | obtient l’URL du point de terminaison REST de ce compte de messagerie. |
Événements
Le tableau suivant répertorie les événements introduits dans le jeu d’exigences 1.5. Pour obtenir la liste de tous les événements pris en charge qui peuvent être gérés à l’aide des méthodes etremoveHandlerAsync, consultez Office.EventTypeaddHandlerAsync.
| Événement | Description | Objet |
|---|---|---|
| ItemChanged | Un autre élément Outlook est sélectionné pour l’affichage tandis que le volet Office du complément est épinglé. | Boîte aux lettres |