Outlook-Add-In-API-Anforderungssatz 1.3

Die Outlook-Add-In-API-Teilmenge der Office JavaScript-API enthält Objekte, Methoden, Eigenschaften und Ereignisse, die Sie in einem Outlook-Add-In verwenden können.

Hinweis

Diese Dokumentation bezieht sich auf einen anderen Anforderungssatz als den aktuellen.

Neuigkeiten in 1.3

Postfach-Anforderungssatz 1.3 enthält alle Funktionen des Anforderungssatzes 1.2. Zusätzlich wurden die folgenden Funktionen implementiert.

  • Unterstützung für Funktionsbefehle hinzugefügt. Weitere Informationen finden Sie unter Add-In-Befehle.

  • Es wurde eine Methode zum Speichern eines zu verfassenden Elements als Entwurf hinzugefügt.

  • Es wurde eine Methode zum Schließen eines Elements hinzugefügt, das zusammengestellt wird.

  • Methoden zum Abrufen oder Festlegen des gesamten Textkörpers einer Nachricht oder eines Termins wurden hinzugefügt. Weitere Informationen finden Sie unter Abrufen oder Festlegen des Textkörpers einer Nachricht oder eines Termins in Outlook.

  • Methoden zum Konvertieren von Element-IDs zwischen EWS- und REST-Formaten hinzugefügt.

    Wichtig

    Legacy-Benutzeridentitätstoken und Rückruftoken von Exchange Online werden nicht mehr unterstützt und sind für alle Microsoft 365-Mandanten deaktiviert. Wenn ein Outlook-Add-In einen delegierten Benutzerzugriff oder eine delegierte Benutzeridentität erfordert, empfehlen wir die Verwendung von MSAL (Microsoft Authentication Library) und der geschachtelten App-Authentifizierung (NAA). Exchange-Benutzeridentitätstoken werden für Exchange lokal weiterhin unterstützt.

  • Eigenschaft und Methoden zum Hinzufügen, Abrufen, Ersetzen und Entfernen von Benachrichtigungen zu einem Element wurden hinzugefügt.

API-Liste

In der folgenden Tabelle sind die APIs aufgeführt, die im Postfach-Anforderungssatz 1.3 eingeführt wurden. Die API-Referenzdokumentation für alle APIs, die vom Postfachanforderungssatz 1.3 oder früher unterstützt werden, finden Sie unter Outlook-APIs.

Klasse Felder Beschreibung
AppointmentCompose close() Schließt das aktuelle Element, das gerade verfasst wird.
notificationMessages Ruft die Benachrichtigungen für ein Element ab.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Speicher asynchron ein Element. .
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult-Zeichenfolge<>) => void) Speicher asynchron ein Element. .
AppointmentRead notificationMessages Ruft die Benachrichtigungen für ein Element ab.
Body getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void) Gibt den gesamten aktuellen Text in dem von angegebenen Format zurück coercionType.
getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void) Gibt den gesamten aktuellen Text in dem von angegebenen Format zurück coercionType.
setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Ersetzt den gesamten Textkörper mit dem angegebenen Text.
setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void) Ersetzt den gesamten Textkörper mit dem angegebenen Text.
Postfach convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion | string) Konvertiert eine unterstützte ID in das Exchange Web Services (EWS)-Format.
convertToRestId(id: string, restVersion: MailboxEnums.RestVersion | string) Konvertiert eine unterstützte ID in das REST-Format.
MessageCompose close() Schließt das aktuelle Element, das gerade verfasst wird.
notificationMessages Ruft die Benachrichtigungen für ein Element ab.
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Speichert die aktuelle Nachricht asynchron als Entwurf.
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult-Zeichenfolge<>) => void) Speichert die aktuelle Nachricht asynchron als Entwurf.
MessageRead notificationMessages Ruft die Benachrichtigungen für ein Element ab.
NotificationMessageDetails icon Ein Verweis auf ein benutzerdefiniertes Symbol, das im Manifest definiert ist.
key Der Bezeichner für die Benachrichtigung.
Nachricht Der Text der Benachrichtigung.
persistent Gibt an, ob die Nachricht dauerhaft sein soll.
type Gibt die ItemNotificationMessageType of message an.
NotificationMessages addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt eine Benachrichtigung zu einem Element hinzu.
addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Fügt eine Benachrichtigung zu einem Element hinzu.
getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Gibt alle Schlüssel und Nachrichten für ein Element zurück.
getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void) Gibt alle Schlüssel und Nachrichten für ein Element zurück.
removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt eine Benachrichtigung für ein Element.
removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Entfernt eine Benachrichtigung für ein Element.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void) Ersetzt eine Benachrichtigung, die über einen bestimmten Schlüssel mit einer anderen Nachricht verfügt.
replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) Ersetzt eine Benachrichtigung, die über einen bestimmten Schlüssel mit einer anderen Nachricht verfügt.
ItemNotificationMessageType ErrorMessage Die Benachrichtigung ist eine Fehlermeldung.
InformationalMessage Die Benachrichtigung dient nur zu Informationszwecken.
ProgressIndicator Die Benachrichtigungsmeldung ist ein Statusindikator.
RestVersion Beta Beta.
v1_0 Version 1.0.
v2_0 Version 2.0.

Siehe auch