Office.NotificationMessages interface

Paket:

outlook

Das NotificationMessages-Objekt wird als notificationMessages-Eigenschaft eines Elements zurückgegeben.

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Informationen zu den verschiedenen Typen von Benachrichtigungen, die Sie implementieren können, finden Sie unter Erstellen von Benachrichtigungen für Ihr Outlook-Add-In.

Methoden

addAsync(key, JSONmessage, options, callback)	Fügt eine Benachrichtigung zu einem Element hinzu.
addAsync(key, JSONmessage, callback)	Fügt eine Benachrichtigung zu einem Element hinzu.
getAllAsync(options, callback)	Gibt alle Schlüssel und Nachrichten für ein Element zurück.
getAllAsync(callback)	Gibt alle Schlüssel und Nachrichten für ein Element zurück.
removeAsync(key, options, callback)	Entfernt eine Benachrichtigung für ein Element.
removeAsync(key, callback)	Entfernt eine Benachrichtigung für ein Element.
replaceAsync(key, JSONmessage, options, callback)	Ersetzt eine Benachrichtigung, die über einen bestimmten Schlüssel mit einer anderen Nachricht verfügt. Wenn keine Benachrichtigung mit dem angegebenen Schlüssel vorhanden ist, fügt replaceAsync die Benachrichtigung hinzu.
replaceAsync(key, JSONmessage, callback)	Ersetzt eine Benachrichtigung, die über einen bestimmten Schlüssel mit einer anderen Nachricht verfügt. Wenn keine Benachrichtigung mit dem angegebenen Schlüssel vorhanden ist, fügt replaceAsync die Benachrichtigung hinzu.

Details zur Methode

addAsync(key, JSONmessage, options, callback)

Fügt eine Benachrichtigung zu einem Element hinzu.

addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

key

string

Ein vom Entwickler spezifizierter Schlüssel für einen Verweis auf diese Benachrichtigung. Entwickler können diese Zeichenfolge verwenden, um später die Nachricht zu ändern. Sie darf nicht länger als 32 Zeichen sein.

JSONmessage

Office.NotificationMessageDetails

Ein JSON-Objekt, das enthält die Benachrichtigung enthält, die dem Element hinzugefügt werden soll. Sie enthält ein NotificationMessageDetails -Objekt.

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

• In Outlook im Web können Sie unter Windows (neu und klassisch) und unter Mac maximal fünf Benachrichtigungen pro Nachricht festlegen. Das Festlegen von more gibt einen NumberOfNotificationMessagesExceeded Fehler zurück. In Outlook für Android und unter iOS können Sie nur eine Benachrichtigung pro Nachricht festlegen. Durch das Festlegen einer zusätzlichen Benachrichtigung wird die vorherige Benachrichtigung ersetzt.

• Pro Add-In ist nur eine Benachrichtigung vom Typ InsightMessage zulässig. Der Versuch, weitere hinzuzufügen, löst einen Fehler aus.

• In modernen Outlook im Web und outlook unter Windows können Sie eine InsightMessage Benachrichtigung nur im Compose Modus hinzufügen.

• In Outlook für Android und unter iOS werden nur die Benachrichtigungstypen ProgressIndicator, InformationalMessageund ErrorMessage unterstützt.

• Im Verfassenmodus, während der Stil der einzelnen Benachrichtigungstypen von anderen Outlook-Clients variiert, verwenden Benachrichtigungen in Outlook für Android und iOS alle denselben Stil. Der Benachrichtigung wird immer ein Informationssymbol vorangestellt.

• Die addAsync -Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync -Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an error notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

addAsync(key, JSONmessage, callback)

Fügt eine Benachrichtigung zu einem Element hinzu.

addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

key

string

Ein vom Entwickler spezifizierter Schlüssel für einen Verweis auf diese Benachrichtigung. Entwickler können diese Zeichenfolge verwenden, um später die Nachricht zu ändern. Sie darf nicht länger als 32 Zeichen sein.

JSONmessage

Office.NotificationMessageDetails

Ein JSON-Objekt, das enthält die Benachrichtigung enthält, die dem Element hinzugefügt werden soll. Sie enthält ein NotificationMessageDetails -Objekt.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig:

• In Outlook im Web können Sie unter Windows (neu und klassisch) und unter Mac maximal fünf Benachrichtigungen pro Nachricht festlegen. Das Festlegen von more gibt einen NumberOfNotificationMessagesExceeded Fehler zurück. In Outlook für Android und unter iOS können Sie nur eine Benachrichtigung pro Nachricht festlegen. Durch das Festlegen einer zusätzlichen Benachrichtigung wird die vorherige Benachrichtigung ersetzt.

• Pro Add-In ist nur eine Benachrichtigung vom Typ InsightMessage zulässig. Der Versuch, weitere hinzuzufügen, löst einen Fehler aus.

• In modernen Outlook im Web und outlook unter Windows können Sie eine InsightMessage Benachrichtigung nur im Compose Modus hinzufügen.

• In Outlook für Android und unter iOS werden nur die Benachrichtigungstypen ProgressIndicator, InformationalMessageund ErrorMessage unterstützt.

• Im Verfassenmodus, während der Stil der einzelnen Benachrichtigungstypen von anderen Outlook-Clients variiert, verwenden Benachrichtigungen in Outlook für Android und iOS alle denselben Stil. Der Benachrichtigung wird immer ein Informationssymbol vorangestellt.

• Die addAsync -Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync -Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

getAllAsync(options, callback)

Gibt alle Schlüssel und Nachrichten für ein Element zurück.

getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Parameter

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Die value -Eigenschaft des Ergebnisses ist ein Array von NotificationMessageDetails -Objekten.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

getAllAsync(callback)

Gibt alle Schlüssel und Nachrichten für ein Element zurück.

getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Parameter

callback

(asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen. Die value -Eigenschaft des Ergebnisses ist ein Array von NotificationMessageDetails -Objekten.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

removeAsync(key, options, callback)

Entfernt eine Benachrichtigung für ein Element.

removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

key

string

Der für die Benachrichtigung zu entfernende Schlüssel.

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Die removeAsync -Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync -Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Removes a notification message from the current mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

removeAsync(key, callback)

Entfernt eine Benachrichtigung für ein Element.

removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

key

string

Der für die Benachrichtigung zu entfernende Schlüssel.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Die removeAsync -Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync -Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

replaceAsync(key, JSONmessage, options, callback)

Ersetzt eine Benachrichtigung, die über einen bestimmten Schlüssel mit einer anderen Nachricht verfügt.

Wenn keine Benachrichtigung mit dem angegebenen Schlüssel vorhanden ist, fügt replaceAsync die Benachrichtigung hinzu.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

key

string

Der für die Benachrichtigung zu ersetzende Schlüssel. Er darf höchstens 32 Zeichen lang sein.

JSONmessage

Office.NotificationMessageDetails

Ein JSON-Objekt, das die neue Benachrichtigung zum Ersetzen der vorhandenen Benachrichtigung enthält. Sie enthält ein NotificationMessageDetails -Objekt.

options

Office.AsyncContextOptions

Ein Objektliteral, das eine oder mehrere der folgenden Eigenschaften enthält: asyncContextEntwickler können jedes Objekt bereitstellen, auf das sie in der Rückruffunktion zugreifen möchten.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Die replaceAsync -Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync -Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Replaces a notification message of a given key with another message.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

replaceAsync(key, JSONmessage, callback)

Ersetzt eine Benachrichtigung, die über einen bestimmten Schlüssel mit einer anderen Nachricht verfügt.

Wenn keine Benachrichtigung mit dem angegebenen Schlüssel vorhanden ist, fügt replaceAsync die Benachrichtigung hinzu.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameter

key

string

Der für die Benachrichtigung zu ersetzende Schlüssel. Er darf höchstens 32 Zeichen lang sein.

JSONmessage

Office.NotificationMessageDetails

Ein JSON-Objekt, das die neue Benachrichtigung zum Ersetzen der vorhandenen Benachrichtigung enthält. Sie enthält ein NotificationMessageDetails -Objekt.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Wenn die -Methode abgeschlossen ist, wird die im callback -Parameter übergebene Funktion mit einem einzelnen Parameter vom Typ Office.AsyncResultaufgerufen.

Gibt zurück

void

Hinweise

[ API-Satz: Postfach 1.3 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: Die replaceAsync -Methode wird für eine Nachricht, die derzeit mit der loadItemByIdAsync -Methode geladen wird, nicht unterstützt. Weitere Informationen finden Sie unter Aktivieren Ihres Outlook-Add-Ins für mehrere Nachrichten.