Activer des compléments avec des événements

L’activation basée sur les événements déclenche automatiquement votre complément pour effectuer ses tâches sans le lancer explicitement. Cela permet au complément de valider, d’insérer ou d’actualiser du contenu critique sans aucune opération manuelle. Le complément est ouvert en arrière-plan pour éviter d’interrompre l’utilisateur. Vous pouvez également intégrer l’activation basée sur les événements avec les commandes de fonction et du volet Office.

Vue d’ensemble

Bien que les étapes particulières pour ajouter des fonctionnalités basées sur des événements à votre complément varient selon la plateforme et le type de manifeste, le flux général est le suivant.

1. Mettez à jour le manifeste avec une extension pour l’événement.
2. Connectez l’événement dans le manifeste avec une fonction JavaScript pour gérer l’événement.
3. Demander à la fonction gestionnaire d’événements d’effectuer ses actions, puis d’appeler event.completed une fois l’opération terminée.
4. Appelez Office.actions.associate pour connecter la fonction gestionnaire d’événements avec l’ID spécifié dans le manifeste.

Essayer l’activation basée sur les événements

Découvrez comment simplifier les flux de travail et améliorer les expériences utilisateur avec l’activation basée sur les événements. Essayez les exemples pour voir la fonctionnalité en action.

Exemples Outlook

• Définir automatiquement l’objet d’un nouveau message ou d’un nouveau rendez-vous
• Case activée automatiquement pour une pièce jointe avant l’envoi d’un message
• Mettre à jour automatiquement votre signature lorsque vous passez d’un compte de messagerie à l’autre
• Chiffrer les pièces jointes, traiter les participants aux demandes de réunion et réagir aux modifications de date/heure de rendez-vous à l’aide de l’activation basée sur les événements Outlook
• Définir votre signature à l’aide de l’activation basée sur les événements Outlook
• Identifier et étiqueter les destinataires externes à l’aide de l’activation basée sur les événements Outlook
• Vérifier les catégories de couleurs d’un message ou d’un rendez-vous avant son envoi à l’aide d’alertes intelligentes
• Vérifier l’étiquette de confidentialité d’un message

exemples Word

• Ajouter des en-têtes à l’ouverture d’un document

Événements pris en charge

Les tableaux suivants répertorient les événements actuellement disponibles et les clients pris en charge pour chaque événement. Lorsqu’un événement est déclenché, le gestionnaire reçoit un event objet qui peut inclure des détails spécifiques au type d’événement. La colonne Description inclut un lien vers l’objet associé, le cas échéant.

Événements Excel, PowerPoint Word

Événements Outlook

La prise en charge de cette fonctionnalité dans Outlook a été introduite dans l’ensemble de conditions requises 1.10, avec des événements supplémentaires désormais disponibles dans les ensembles de conditions requises suivants. Le tableau suivant répertorie l’ensemble de conditions requises minimales de chaque événement, ainsi que les clients et plateformes qui le prennent en charge. Pour plus d’informations sur les clients Outlook et les ensembles de conditions requises qu’ils prennent en charge, consultez Ensembles de conditions requises pris en charge par les serveurs Exchange et les clients Outlook.

Activation par événement dans Outlook sur les appareils mobiles

Outlook sur mobile prend en charge les API jusqu’à l’ensemble de conditions requises de boîte aux lettres 1.5. Toutefois, la prise en charge est désormais activée pour les API et fonctionnalités supplémentaires introduites dans les ensembles de conditions requises ultérieurs, telles que l’événement OnNewMessageCompose . Pour plus d’informations, consultez Implémenter l’activation basée sur les événements dans les compléments mobiles Outlook.

Comportement et limitations

Lorsque vous développez un complément basé sur les événements, tenez compte des comportements et limitations des fonctionnalités suivants.

• Les compléments basés sur les événements fonctionnent uniquement lorsqu’ils sont déployés par un administrateur. Si les utilisateurs les installent directement à partir de la Place de marché Microsoft ou de l’Office Store, ils ne se lancent pas automatiquement (pour les solutions de contournement de la limitation de la Place de marché Microsoft, voir les options de référencement de la Place de marché Microsoft pour votre complément basé sur les événements). Administration déploiements s’effectuent en chargeant le manifeste sur le Centre d’administration Microsoft 365.

• Les API qui interagissent avec l’interface utilisateur ou affichent des éléments d’interface utilisateur ne sont pas prises en charge pour Word, PowerPoint et Excel sur Windows. Cela est dû au fait que le gestionnaire d’événements s’exécute dans un runtime JavaScript uniquement. Pour plus d’informations, voir Runtimes dans les compléments Office.

• Les compléments basés sur les événements nécessitent une connexion Internet pour pouvoir être lancés lorsqu’un événement spécifique se produit. Les gestionnaires d’événements de complément sont censés être courts, légers et aussi non invasifs que possible. Après l’activation, votre complément expire dans un délai d’environ 300 secondes, durée maximale autorisée pour l’exécution des compléments basés sur les événements. Pour signaler que votre complément a terminé le traitement d’un événement de lancement, votre gestionnaire d’événements associé doit appeler la méthode event.completed . (Notez que l’exécution du code inclus après l’instruction event.completed n’est pas garantie.) Chaque fois qu’un événement géré par votre complément est déclenché, le complément est réactivé et exécute le gestionnaire d’événements associé, et la fenêtre de délai d’expiration est réinitialisée. Le complément se termine après son expiration, ou l’utilisateur ferme la fenêtre de composition ou envoie l’élément.

• Le comportement de plusieurs compléments qui s’abonnent au même événement n’est pas déterministe. Outlook lance les compléments dans aucun ordre particulier. Pour Excel, PowerPoint et Word, un seul complément aléatoire est activé. Par exemple, si plusieurs compléments Word qui gèrent OnDocumentOpened, un seul de ces gestionnaires s’exécute.

• Actuellement, seuls cinq compléments basés sur des événements peuvent être en cours d’exécution.

• Dans tous les clients Outlook pris en charge, l’utilisateur doit rester sur l’élément de courrier actuel dans lequel le complément a été activé pour qu’il s’exécute. La navigation loin de l’élément actif (par exemple, le passage à une autre fenêtre ou onglet de composition) met fin à l’opération de complément. Toutefois, un complément qui s’active sur l’événement gère le OnMessageSend basculement d’élément différemment selon le client Outlook sur lequel il s’exécute. Pour plus d’informations, consultez la section « L’utilisateur quitte le message actuel » de Gérer les événements OnMessageSend et OnAppointmentSend dans votre complément Outlook avec des alertes intelligentes.

• En plus du changement d’élément, un complément basé sur les événements cesse également de fonctionner lorsque l’utilisateur envoie le message ou le rendez-vous qu’il compose.

Limitations des compléments basés sur les événements dans Excel, PowerPoint, Word et Outlook classique sur Windows

Lorsque vous développez un complément basé sur des événements à exécuter sur un client Windows, tenez compte des points suivants :

• Les importations ne sont pas prises en charge dans le fichier JavaScript dans lequel vous implémentez la gestion de l’activation basée sur les événements.

• Seul le fichier JavaScript référencé dans le manifeste est pris en charge pour l’activation basée sur les événements. Vous devez regrouper votre code JavaScript de gestion des événements dans ce fichier unique. L’emplacement du fichier JavaScript référencé dans le manifeste varie en fonction du type de manifeste utilisé par votre complément.

  • Manifeste du complément uniquement : <Override> élément enfant du <Runtime> nœud
  • Manifeste unifié pour Microsoft 365 : "script" propriété de l’objet "code"

  Notez qu’un ensemble JavaScript volumineux peut entraîner des problèmes de performances de votre complément. Nous vous recommandons de prétraiter les opérations lourdes afin qu’elles ne soient pas incluses dans votre code de gestion des événements.

• Lorsque la fonction JavaScript spécifiée dans le manifeste pour gérer un événement s’exécute, le code dans Office.onReady() et Office.initialize n’est pas exécuté. Nous vous recommandons d’ajouter aux gestionnaires d’événements toute logique de démarrage requise par les gestionnaires d’événements, comme la vérification de la version du client de l’utilisateur.

Limitations des compléments basés sur les événements dans Excel, PowerPoint et Word

Les plateformes ou fonctionnalités suivantes ne sont pas encore prises en charge.

• Office sur Mac
• Manifeste unifié pour Microsoft 365

Limitations des compléments basés sur les événements dans Outlook sur le web et la nouvelle version d’Outlook sur Windows

Dans Outlook sur le web et la nouvelle version d’Outlook sur Windows, l’activation basée sur les événements n’est prise en charge que sur les surfaces standard de lecture et de composition des messages et des rendez-vous. L’activation basée sur les événements peut ne pas fonctionner lors de la composition sur certaines surfaces non standard. Par exemple :

• Réponse à une invitation à une réunion à l’aide de l’option RSVP avec note .
• Transfert d’une réunion à partir du calendrier.

API non prises en charge

Certaines API Office.js qui changent ou modifient l’interface utilisateur ne sont pas autorisées à partir de compléments basés sur des événements. Voici les API bloquées.

Fonctionnalités en préversion dans les gestionnaires d’événements (Outlook classique sur Windows)

Outlook classique sur Windows inclut une copie locale des versions de production et bêta de Office.js au lieu de charger à partir du réseau de distribution de contenu (CDN). Par défaut, la copie de production locale de l’API est référencée. Pour référencer la copie bêta locale de l’API, vous devez configurer le registre de votre ordinateur. Cela vous permet de tester les fonctionnalités en préversion dans vos gestionnaires d’événements dans outlook classique sur Windows.

1. Dans le Registre, accédez à HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Outlook\Options\WebExt\Developer. Si la clé n’existe pas, créez-la.

2. Créez une entrée nommée EnableBetaAPIsInJavaScript et définissez sa valeur sur 1.

   

Activer l’authentification unique (SSO)

Pour activer l’authentification unique dans votre complément basé sur les événements, vous devez ajouter son fichier JavaScript à un URI connu. Pour obtenir des conseils sur la configuration de cette ressource, consultez Utiliser l’authentification unique (SSO) ou le partage de ressources cross-origin (CORS) dans votre complément Office basé sur les événements ou la création de rapports de courrier indésirable.

Demander des données externes

Vous pouvez demander des données externes à l’aide d’une API telle que Fetch ou à l’aide de XMLHttpRequest (XHR), une API web standard qui émet des requêtes HTTP pour interagir avec les serveurs.

N’oubliez pas que vous devez utiliser des mesures de sécurité supplémentaires lors de l’utilisation d’objets XMLHttpRequest, nécessitant la même stratégie d’origine et CORS (Cross-Origin Resource Sharing).

Pour effectuer des demandes CORS à partir de votre complément basé sur les événements, vous devez ajouter le complément et son fichier JavaScript à un URI connu. Pour obtenir des conseils sur la configuration de cette ressource, consultez Utiliser l’authentification unique (SSO) ou le partage de ressources cross-origin (CORS) dans votre complément Office basé sur les événements ou la création de rapports de courrier indésirable.

Résoudre les problèmes de votre complément

À mesure que vous développez votre complément basé sur les événements, vous devrez peut-être résoudre des problèmes, tels que le fait que votre complément ne se charge pas ou que l’événement ne se produit pas. Pour obtenir des conseils sur la façon de résoudre les problèmes d’un complément basé sur les événements, consultez Résoudre les problèmes liés aux compléments basés sur les événements et la création de rapports de courrier indésirable.

Déployer votre complément

Selon l’application Office, les compléments basés sur les événements peuvent être déployés via l’une des options suivantes.

• Déploiement géré Administration : le complément est déployé via le Centre d’administration Microsoft 365.
• Référencement restreint sur la Place de marché Microsoft : le complément est publié sur la Place de marché Microsoft, mais il n’apparaît pas dans les résultats de recherche. L’acquisition de compléments nécessite une URL de code de version d’évaluation. Le complément doit toujours être déployé par un administrateur pour que la fonctionnalité d’activation basée sur les événements fonctionne.
• Référencement non restreint sur la Place de marché Microsoft : le complément est publié sur la Place de marché Microsoft et peut être recherché par les utilisateurs et les administrateurs à l’aide du nom ou de l’ID du complément. Administration déploiement n’est pas nécessaire pour que la fonctionnalité d’activation basée sur les événements fonctionne. Le complément doit répondre à certaines exigences pour une inscription sans restriction.

Le tableau suivant décrit les options de déploiement pour l’activation basée sur les événements par application Office.

Pour obtenir des instructions sur le déploiement d’un complément via le Centre d’administration Microsoft 365, consultez Déploiement géré par Administration. Pour en savoir plus sur l’affichage de votre complément basé sur les événements dans la Place de marché Microsoft, consultez Options de référencement de votre complément basé sur les événements sur la Place de marché Microsoft.

Déploiement géré par Administration

Administration déploiements s’effectuent en chargeant le manifeste sur le Centre d’administration Microsoft 365. Pour ce faire, procédez comme suit.

1. Dans le portail d’administration, développez la section Paramètres dans le volet de navigation, puis sélectionnez Applications intégrées.
2. Dans la page Applications intégrées , choisissez l’action Charger des applications personnalisées .

Pour plus d’informations sur le déploiement d’un complément, reportez-vous à Déployer et publier des compléments Office dans le Centre d’administration Microsoft 365.

Déployer des mises à jour de manifeste

Si un complément basé sur un événement a été déployé par l’administrateur, toute modification apportée au manifeste nécessite le consentement de l’administrateur via le Centre d’administration Microsoft 365. Tant que l’administrateur n’accepte pas vos modifications, les utilisateurs de leur organization ne peuvent pas utiliser le complément. Pour en savoir plus sur le processus de consentement administrateur, consultez Administration consentement pour l’installation de compléments basés sur des événements.

Voir aussi

• Résoudre les problèmes liés aux modules complémentaires de signalement d'événements et de spams
• Déboguer les modules complémentaires basés sur les événements et les rapports de spam
• Options de référencement de la Place de marché Microsoft pour votre complément basé sur les événements
• Gérer les événements OnMessageSend et OnAppointmentSend dans votre complément Outlook avec des alertes intelligentes