Office.Entities interface

Pacote:

outlook

Representa um conjunto de entidades encontrado em um compromisso ou uma mensagem de email. Somente modo de leitura.

O objeto Entities é um contêiner das matrizes de entidade retornadas pelos métodos getEntities e getEntitiesByType quando o item (uma mensagem de email ou um compromisso) contém uma ou mais entidades que foram encontradas pelo servidor. Você pode usar essas entidades em seu código para fornecer informações adicionais de contexto ao visualizador, como um mapa para um endereço encontrado no item ou para abrir um discador para um número de telefone encontrado no item.

Se nenhuma entidade do tipo especificada na propriedade estiver presente no item, a propriedade associada a essa entidade será nula. Por exemplo, se uma mensagem contiver um endereço de rua e um número de telefone, a propriedade addresses e phoneNumbers conterão informações e as outras propriedades serão nulas.

Para ser reconhecida como um endereço, a cadeia de caracteres deve conter um endereço postal norte-americano com ao menos um subconjunto dos elementos de um número de rua, nome de rua, cidade, estado e CEP.

Para ser reconhecida como um número de telefone, a cadeia de caracteres deve conter um formato numérico norte-americano de telefone.

O reconhecimento da entidade depende de reconhecimento de linguagem natural, que é baseado no aprendizado de máquina de grandes quantidades de dados. O reconhecimento de uma entidade não é determinista e o sucesso, às vezes, depende do contexto específico no item.

Quando as matrizes de propriedade são retornadas pelo getEntitiesByType método, apenas a propriedade da entidade especificada contém dados; todas as outras propriedades são nulas.

Comentários

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: Leitura

Importante: os suplementos contextuais do Outlook baseados em entidade serão desativados no segundo trimestre de 2024. O trabalho para aposentar esse recurso começará em maio e continuará até o final de junho. Após junho, os suplementos contextuais não poderão mais detectar entidades em itens de email para executar tarefas neles. As APIs a seguir também serão retiradas.

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

Para ajudar a minimizar possíveis interrupções, o seguinte ainda será suportado depois que os suplementos contextuais baseados em entidade forem retirados.

• Uma implementação alternativa do botão Ingressar Reunião , que é ativado por suplementos de reunião online, está sendo desenvolvida. Depois que o suporte para suplementos contextuais baseados em entidade terminar, os suplementos de reunião online farão a transição automática para a implementação alternativa para ativar o botão Ingressar Reunião .

• As regras de expressão regular continuarão a ser suportadas depois que os suplementos contextuais baseados em entidade forem retirados. Recomendamos atualizar seu suplemento contextual para usar regras de expressão regulares como uma solução alternativa. Para obter diretrizes sobre como implementar essas regras, consulte Usar regras regulares de ativação de expressão para mostrar um suplemento do Outlook.

Para obter mais informações, consulte Aposentadoria de suplementos contextuais do Outlook baseados em entidade.

Propriedades

addresses	Obtém os endereços físicos (endereços para correspondência ou de ruas) encontrados em um compromisso ou uma mensagem de email.
contacts	Obtém os contatos encontrados em um compromisso ou um endereço de email.
emailAddresses	Obtém os endereços de email encontrados em um compromisso ou uma mensagem de email.
meetingSuggestions	Obtém as sugestões de reunião encontradas em uma mensagem de email.
phoneNumbers	Obtém os números de telefone encontrados em um compromisso ou uma mensagem de email.
taskSuggestions	Obtém as sugestões de tarefas encontradas em um compromisso ou uma mensagem de email.
urls	Obtém as URLs de Internet presentes em um compromisso ou uma mensagem de email.

Detalhes da propriedade

addresses

Obtém os endereços físicos (endereços para correspondência ou de ruas) encontrados em um compromisso ou uma mensagem de email.

addresses: string[];

Valor da propriedade

string[]

Exemplos

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

contacts

Obtém os contatos encontrados em um compromisso ou um endereço de email.

contacts: Contact[];

Valor da propriedade

Office.Contact[]

Exemplos

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

emailAddresses

Obtém os endereços de email encontrados em um compromisso ou uma mensagem de email.

emailAddresses: string[];

Valor da propriedade

string[]

Exemplos

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

meetingSuggestions

Obtém as sugestões de reunião encontradas em uma mensagem de email.

meetingSuggestions: MeetingSuggestion[];

Valor da propriedade

Office.MeetingSuggestion[]

Exemplos

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

phoneNumbers

Obtém os números de telefone encontrados em um compromisso ou uma mensagem de email.

phoneNumbers: PhoneNumber[];

Valor da propriedade

Office.PhoneNumber[]

Exemplos

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

taskSuggestions

Obtém as sugestões de tarefas encontradas em um compromisso ou uma mensagem de email.

taskSuggestions: string[];

Valor da propriedade

string[]

Exemplos

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

urls

Obtém as URLs de Internet presentes em um compromisso ou uma mensagem de email.

urls: string[];

Valor da propriedade

string[]

Exemplos

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