Office.Entities interface

Paquet:

outlook

Représente une collection d’entités trouvées dans un message électronique ou un rendez-vous. Mode lecture uniquement.

L’objet Entities est un conteneur pour les tableaux d’entités renvoyés par les méthodes getEntities et getEntitiesByType quand l’élément (message électronique ou rendez-vous) contient une ou plusieurs entités qui ont été trouvées par le serveur. Vous pouvez utiliser ces entités dans votre code pour fournir des informations de contexte supplémentaires, par exemple une carte montrant une adresse trouvée dans l’élément, ou pour ouvrir un numéroteur quand un numéro de téléphone est trouvé dans l’élément.

Si aucune entité du type spécifié dans la propriété n’est présente dans l’élément, la propriété associée à cette entité a la valeur null. Par exemple, si un message contient une adresse et un numéro de téléphone, les propriétés addresses et phoneNumbers contiennent des informations, alors que les autres propriétés ont la valeur null.

Pour être reconnue en tant qu’adresse, la chaîne doit contenir une adresse postale incluant au moins un sous-ensemble d’éléments tels que le numéro de rue, le nom de rue, la ville, le département/la région/l’État et le code postal.

Pour être reconnue comme numéro de téléphone, la chaîne doit contenir un numéro de téléphone de type nord-américain.

La reconnaissance d’entité repose sur la reconnaissance du langage naturel qui est basée sur l’apprentissage par l’ordinateur de grandes quantités de données. La reconnaissance d’une entité n’est pas déterministe et sa réussite s’appuie parfois sur le contexte particulier de l’élément.

Lorsque les tableaux de propriétés sont retournés par la getEntitiesByType méthode , seule la propriété de l’entité spécifiée contient des données ; toutes les autres propriétés sont null.

Remarques

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Lecture

Important : les compléments Outlook contextuels basés sur des entités seront mis hors service au deuxième trimestre 2024. Le travail de mise hors service de cette fonctionnalité commencera en mai et se poursuivra jusqu’à la fin du mois de juin. Après juin, les compléments contextuels ne seront plus en mesure de détecter les entités dans les éléments de courrier pour effectuer des tâches sur ces derniers. Les API suivantes seront également mises hors service.

• Office.context.mailbox.item.getEntities - Office.context.mailbox.item.getEntitiesByType - Office.context.mailbox.item.getFilteredEntitiesByName - Office.context.mailbox.item.getSelectedEntities

Pour réduire les interruptions potentielles, les éléments suivants seront toujours pris en charge une fois les compléments contextuels basés sur des entités mis hors service.

• Une autre implémentation du bouton Participer à une réunion , qui est activé par les compléments de réunion en ligne, est en cours de développement. Une fois la prise en charge des compléments contextuels basés sur des entités terminée, les compléments de réunion en ligne passent automatiquement à l’implémentation alternative pour activer le bouton Participer à une réunion .

• Les règles d’expression régulière continueront d’être prises en charge une fois les compléments contextuels basés sur des entités mis hors service. Nous vous recommandons de mettre à jour votre complément contextuel pour utiliser des règles d’expression régulière comme solution alternative. Pour obtenir des conseils sur la façon d’implémenter ces règles, voir Utiliser des règles d’activation d’expression régulière pour afficher un complément Outlook.

Pour plus d’informations, consultez Retrait des compléments Outlook contextuels basés sur des entités.

Propriétés

addresses	Obtient les adresses physiques (rue ou adresse postale) trouvées dans un e-mail ou un rendez-vous.
contacts	Obtient les contacts trouvés dans une adresse de messagerie ou un rendez-vous.
emailAddresses	Obtient les adresses de messagerie trouvées dans un e-mail ou un rendez-vous.
meetingSuggestions	Obtient les suggestions de réunion trouvées dans un e-mail.
phoneNumbers	Obtient les numéros de téléphone trouvés dans un e-mail ou un rendez-vous.
taskSuggestions	Obtient les suggestions de tâche trouvées dans un e-mail ou un rendez-vous.
urls	Obtient les URL Internet présentes dans un e-mail ou un rendez-vous.

Détails de la propriété

addresses

Obtient les adresses physiques (rue ou adresse postale) trouvées dans un e-mail ou un rendez-vous.

addresses: string[];

Valeur de propriété

string[]

Exemples

const item = Office.context.mailbox.item;
const addresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.Address);

contacts

Obtient les contacts trouvés dans une adresse de messagerie ou un rendez-vous.

contacts: Contact[];

Valeur de propriété

Office.Contact[]

Exemples

const item = Office.context.mailbox.item;
const contacts = item.getEntitiesByType(Office.MailboxEnums.EntityType.Contact);

emailAddresses

Obtient les adresses de messagerie trouvées dans un e-mail ou un rendez-vous.

emailAddresses: string[];

Valeur de propriété

string[]

Exemples

const item = Office.context.mailbox.item;
const emailAddresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.EmailAddress);

meetingSuggestions

Obtient les suggestions de réunion trouvées dans un e-mail.

meetingSuggestions: MeetingSuggestion[];

Valeur de propriété

Office.MeetingSuggestion[]

Exemples

const item = Office.context.mailbox.item;
const meetingSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.MeetingSuggestion);

phoneNumbers

Obtient les numéros de téléphone trouvés dans un e-mail ou un rendez-vous.

phoneNumbers: PhoneNumber[];

Valeur de propriété

Office.PhoneNumber[]

Exemples

const item = Office.context.mailbox.item;
const phoneNumbers = item.getEntitiesByType(Office.MailboxEnums.EntityType.PhoneNumber);

taskSuggestions

Obtient les suggestions de tâche trouvées dans un e-mail ou un rendez-vous.

taskSuggestions: string[];

Valeur de propriété

string[]

Exemples

const item = Office.context.mailbox.item;
const taskSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.TaskSuggestion);

urls

Obtient les URL Internet présentes dans un e-mail ou un rendez-vous.

urls: string[];

Valeur de propriété

string[]

Exemples

const item = Office.context.mailbox.item;
const urls = item.getEntitiesByType(Office.MailboxEnums.EntityType.Url);