Office.Entities interface

Paquete:

outlook

Representa una colección de entidades presente en un mensaje de correo electrónico o en una cita. Solo modo Lectura.

El objeto Entities es un contenedor para las matrices de entidades devueltas por los métodos getEntities y getEntitiesByType cuando el elemento (un mensaje de correo electrónico o una cita) contiene una o varias entidades encontradas por el servidor. Puede usar estas entidades en el código para proporcionar información de contexto adicional al visor, como un mapa para una dirección encontrada en el elemento o para abrir un marcador para un número de teléfono encontrado en el elemento.

Si no existen entidades del tipo especificado en la propiedad en el elemento, la propiedad asociada a esa entidad es null. Por ejemplo, si un mensaje contiene una dirección postal y un número de teléfono, las propiedades addresses y phoneNumbers tendrán información y las demás propiedades serán null.

Para que se reconozca como una dirección, la cadena debe contener una dirección postal de los Estados Unidos que tenga al menos un subconjunto de elementos con el número de la calle, el nombre de la calle, la ciudad, el estado y el código postal.

Para que se reconozca como un número de teléfono, la cadena debe contener un formato de número de teléfono de Estados Unidos.

El reconocimiento de entidades depende del reconocimiento del lenguaje natural basado en el aprendizaje automático de grandes volúmenes de datos. El reconocimiento de una entidad no es determinista y a veces los resultados dependen del contexto concreto del elemento.

Cuando el método devuelve getEntitiesByType las matrices de propiedades, solo la propiedad de la entidad especificada contiene datos; todas las demás propiedades son null.

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Lectura

Importante: Los complementos contextuales de Outlook basados en entidades se retirarán en el segundo trimestre de 2024. El trabajo para retirar esta característica comenzará en mayo y continuará hasta finales de junio. Después de junio, los complementos contextuales ya no podrán detectar entidades en elementos de correo para realizar tareas en ellos. También se retirarán las siguientes API.

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

Para ayudar a minimizar las posibles interrupciones, se seguirá admitiendo lo siguiente después de que se retiren los complementos contextuales basados en entidades.

• Se está desarrollando una implementación alternativa del botón Unirse a la reunión , que se activa mediante complementos de reunión en línea. Una vez finalizada la compatibilidad con complementos contextuales basados en entidades, los complementos de reunión en línea pasarán automáticamente a la implementación alternativa para activar el botón Unirse a la reunión .

• Las reglas de expresión regular seguirán siendo compatibles después de retirar los complementos contextuales basados en entidades. Se recomienda actualizar el complemento contextual para usar reglas de expresión regular como solución alternativa. Para obtener instrucciones sobre cómo implementar estas reglas, vea Usar reglas de activación de expresiones regulares para mostrar un complemento de Outlook.

Para obtener más información, vea Retirada de complementos contextuales de Outlook basados en entidades.

Propiedades

addresses	Obtiene las direcciones físicas (dirección postal o de correo) presentes en un mensaje de correo o una cita.
contacts	Obtiene los contactos presentes en una dirección de correo electrónico o una cita.
emailAddresses	Obtiene las direcciones de correo electrónico presentes en un mensaje de correo o una cita.
meetingSuggestions	Obtiene las sugerencias de reunión presentes en un mensaje de correo.
phoneNumbers	Obtiene los números de teléfono presentes en un mensaje de correo o una cita.
taskSuggestions	Obtiene las sugerencias de tarea presentes en un mensaje de correo o una cita.
urls	Obtiene las direcciones URL de Internet presentes en un mensaje de correo o una cita.

Detalles de las propiedades

addresses

Obtiene las direcciones físicas (dirección postal o de correo) presentes en un mensaje de correo o una cita.

addresses: string[];

Valor de propiedad

string[]

Ejemplos

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

contacts

Obtiene los contactos presentes en una dirección de correo electrónico o una cita.

contacts: Contact[];

Valor de propiedad

Office.Contact[]

Ejemplos

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

emailAddresses

Obtiene las direcciones de correo electrónico presentes en un mensaje de correo o una cita.

emailAddresses: string[];

Valor de propiedad

string[]

Ejemplos

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

meetingSuggestions

Obtiene las sugerencias de reunión presentes en un mensaje de correo.

meetingSuggestions: MeetingSuggestion[];

Valor de propiedad

Office.MeetingSuggestion[]

Ejemplos

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

phoneNumbers

Obtiene los números de teléfono presentes en un mensaje de correo o una cita.

phoneNumbers: PhoneNumber[];

Valor de propiedad

Office.PhoneNumber[]

Ejemplos

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

taskSuggestions

Obtiene las sugerencias de tarea presentes en un mensaje de correo o una cita.

taskSuggestions: string[];

Valor de propiedad

string[]

Ejemplos

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

urls

Obtiene las direcciones URL de Internet presentes en un mensaje de correo o una cita.

urls: string[];

Valor de propiedad

string[]

Ejemplos

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