Office.Entities interface

Stellt eine Sammlung von in einer E-Mail-Nachricht oder einem Termin gefundenen Entitäten dar. Nur Lesemodus.

Das Entities -Objekt ist ein Container für die Entitätsarrays, die von den getEntities Methoden und getEntitiesByType zurückgegeben werden, wenn das Element (entweder eine E-Mail-Nachricht oder ein Termin) eine oder mehrere Entitäten enthält, die vom Server gefunden wurden. Sie können diese Entitäten im Code verwenden, um zusätzliche Kontextinformationen für den Betrachter bereitzustellen, z. B. eine Karte für eine im Element gefundene Adresse anzeigen oder ein Wählprogramm für eine Telefonnummer im Element öffnen.

Wenn keine Entitäten des in der Eigenschaft angegebenen Typs im Element vorhanden sind, lautet die dieser Entität zugeordnete Eigenschaft null. Wenn eine Nachricht z. B. eine Adresse und eine Telefonnummer enthält, enthalten die addresses-Eigenschaft und die phoneNumbers-Eigenschaft Informationen, und die anderen Eigenschaften sind null.

Damit eine Zeichenfolge als Adresse erkannt wird, muss sie eine US-Postadresse enthalten, die mindestens einen Teilsatz der Elemente Straßennummer, Straßenname, Stadt, Staat und Postleitzahl enthält.

Damit die Zeichenfolge als Telefonnummer erkannt wird, muss die Zeichenfolge ein nordamerikanisches Telefonnummernformat enthalten.

Die Entitätserkennung beruht auf der Erkennung von natürlicher Sprache, die auf großen, maschinell eingelernten Datenmengen basiert. Die Erkennung einer Entität ist nichtdeterministisch und der Erfolg hängt in einigen Fällen vom jeweiligen Kontext in einem Element ab.

Wenn die Eigenschaftenarrays von der getEntitiesByType -Methode zurückgegeben werden, enthält nur die -Eigenschaft für die angegebene Entität Daten; alle anderen Eigenschaften sind NULL.

Hinweise

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen

Wichtig: Entitätsbasierte kontextbezogene Outlook-Add-Ins werden im 2. Quartal 2024 eingestellt. Die Arbeiten zur Einstellung dieses Features beginnen im Mai und werden bis Ende Juni fortgesetzt. Nach Juni können Kontext-Add-Ins keine Entitäten mehr in E-Mail-Elementen erkennen, um Aufgaben für sie auszuführen. Die folgenden APIs werden ebenfalls eingestellt.

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

Um potenzielle Unterbrechungen zu minimieren, werden die folgenden Elemente weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden.

  • Eine alternative Implementierung der Schaltfläche " An Besprechung teilnehmen ", die von Onlinebesprechungs-Add-Ins aktiviert wird, wird entwickelt. Sobald die Unterstützung für entitätsbasierte Kontext-Add-Ins endet, werden Onlinebesprechungs-Add-Ins automatisch zur alternativen Implementierung übergehen, um die Schaltfläche An Besprechung teilnehmen zu aktivieren.

  • Regeln für reguläre Ausdrücke werden weiterhin unterstützt, nachdem entitätsbasierte Kontext-Add-Ins eingestellt wurden. Es wird empfohlen, Ihr Kontext-Add-In zu aktualisieren, um Regeln für reguläre Ausdrücke als alternative Lösung zu verwenden. Anleitungen zum Implementieren dieser Regeln finden Sie unter Verwenden von Aktivierungsregeln für reguläre Ausdrücke zum Anzeigen eines Outlook-Add-Ins.

Weitere Informationen finden Sie unter Außerbetriebnahme entitätsbasierter kontextbezogener Outlook-Add-Ins.

Eigenschaften

addresses

Ruft die physischen Adressen (Postadressen) in einer E-Mail-Nachricht oder einem Termin ab.

contacts

Ruft die in einer E-Mail-Adresse oder einem Termin enthalten Kontakte ab.

emailAddresses

Ruft die E-Mail-Adressen in einer E-Mail-Nachricht oder einem Termin ab.

meetingSuggestions

Ruft die Besprechungsvorschläge in einer E-Mail-Nachricht ab.

phoneNumbers

Ruft die Telefonnummern in einer E-Mail-Nachricht oder einem Termin ab.

taskSuggestions

Ruft die in einer E-Mail-Nachricht oder einem Termin enthalten Vorgangsvorschläge ab.

urls

Ruft die in einer E-Mail-Nachricht oder einem Termin enthaltenen Internet-URLs ab.

Details zur Eigenschaft

addresses

Ruft die physischen Adressen (Postadressen) in einer E-Mail-Nachricht oder einem Termin ab.

addresses: string[];

Eigenschaftswert

string[]

Beispiele

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

contacts

Ruft die in einer E-Mail-Adresse oder einem Termin enthalten Kontakte ab.

contacts: Contact[];

Eigenschaftswert

Beispiele

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

emailAddresses

Ruft die E-Mail-Adressen in einer E-Mail-Nachricht oder einem Termin ab.

emailAddresses: string[];

Eigenschaftswert

string[]

Beispiele

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

meetingSuggestions

Ruft die Besprechungsvorschläge in einer E-Mail-Nachricht ab.

meetingSuggestions: MeetingSuggestion[];

Eigenschaftswert

Beispiele

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

phoneNumbers

Ruft die Telefonnummern in einer E-Mail-Nachricht oder einem Termin ab.

phoneNumbers: PhoneNumber[];

Eigenschaftswert

Beispiele

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

taskSuggestions

Ruft die in einer E-Mail-Nachricht oder einem Termin enthalten Vorgangsvorschläge ab.

taskSuggestions: string[];

Eigenschaftswert

string[]

Beispiele

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

urls

Ruft die in einer E-Mail-Nachricht oder einem Termin enthaltenen Internet-URLs ab.

urls: string[];

Eigenschaftswert

string[]

Beispiele

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