Office.NotificationMessageDetails interface

Paket:

outlook

Ein Array mit NotificationMessageDetails-Objekten wird von der NotificationMessages.getAllAsync-Methode zurückgegeben.

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);
});

Eigenschaften

actions	Gibt Aktionen für die Nachricht an. Limit: 1 Aktion. Dieser Grenzwert zählt nicht die Aktion "Schließen", die standardmäßig enthalten ist. Gilt nur, wenn der Typ ist InsightMessage. Wenn Sie diese Eigenschaft für einen nicht unterstützten Typ angeben oder zu viele Aktionen einschließen, wird ein Fehler ausgelöst. Wichtig: In modernen Outlook im Web und neuen Outlook unter Windows ist die actions Eigenschaft nur im Compose Modus verfügbar.
icon	Ein Verweis auf ein Symbol, das im Manifest definiert ist. Wird in der Infoleiste angezeigt. Es ist anwendbar, wenn der Typ ist InformationalMessage, und ist erforderlich, wenn der Typ ist InsightMessage. Wenn dieser Parameter für einen nicht unterstützten Typ angegeben wird, tritt eine Ausnahme auf. Hinweis: Derzeit wird das benutzerdefinierte Symbol nur in Outlook unter Windows und nicht auf anderen Clients (z. B. Mac, Webbrowser) angezeigt.
key	Der Bezeichner für die Benachrichtigung.
message	Der Text der Benachrichtigung. Die maximale Länge beträgt 150 Zeichen. Wenn eine lange Zeichenfolge vom Entwickler übergeben wird, wird eine ArgumentOutOfRange-Ausnahme ausgegeben.
persistent	Gibt an, ob die Nachricht persistent sein soll. Gilt nur, wenn der Typ ist InformationalMessage. Wenn true, bleibt die Nachricht erhalten, bis sie von diesem Add-In entfernt oder vom Benutzer verworfen wird. Wenn false, wird es entfernt, wenn der Benutzer zu einem anderen Element. Für Fehlerbenachrichtigungen bleibt die Nachricht bestehen, bis der Benutzer sie einmal gesehen hat. Wenn dieser Parameter für einen nicht unterstützten Typ angeben wird, wird eine Ausnahme ausgelöst.
type	Gibt die der ItemNotificationMessageType Nachricht an. Wenn der Typ oder ErrorMessageistProgressIndicator, wird automatisch ein Symbol bereitgestellt, und die Nachricht ist nicht persistent. Daher sind das Symbol und die permanenten Eigenschaften für diese Art von Nachrichten ungültig. Wenn Sie sie einschließen, führt dies zu einem ArgumentException. Wenn type ist ProgressIndicator, sollte der Entwickler die Statusanzeige entfernen oder ersetzen, wenn die Aktion abgeschlossen ist. Wichtig: Nur der InformationalMessage Typ wird in Outlook unter Android und unter iOS unterstützt.

Details zur Eigenschaft

actions

Gibt Aktionen für die Nachricht an. Limit: 1 Aktion. Dieser Grenzwert zählt nicht die Aktion "Schließen", die standardmäßig enthalten ist. Gilt nur, wenn der Typ ist InsightMessage. Wenn Sie diese Eigenschaft für einen nicht unterstützten Typ angeben oder zu viele Aktionen einschließen, wird ein Fehler ausgelöst.

Wichtig: In modernen Outlook im Web und neuen Outlook unter Windows ist die actions Eigenschaft nur im Compose Modus verfügbar.

actions?: NotificationMessageAction[];

Eigenschaftswert

Office.NotificationMessageAction[]

Hinweise

[ API-Satz: Postfach 1.10 ]

Anwendbarer Outlook-Modus: Compose oder Lesen

icon

Ein Verweis auf ein Symbol, das im Manifest definiert ist. Wird in der Infoleiste angezeigt. Es ist anwendbar, wenn der Typ ist InformationalMessage, und ist erforderlich, wenn der Typ ist InsightMessage. Wenn dieser Parameter für einen nicht unterstützten Typ angegeben wird, tritt eine Ausnahme auf.

Hinweis: Derzeit wird das benutzerdefinierte Symbol nur in Outlook unter Windows und nicht auf anderen Clients (z. B. Mac, Webbrowser) angezeigt.

icon?: string;

Eigenschaftswert

string

key

Der Bezeichner für die Benachrichtigung.

key?: string;

Eigenschaftswert

string

message

Der Text der Benachrichtigung. Die maximale Länge beträgt 150 Zeichen. Wenn eine lange Zeichenfolge vom Entwickler übergeben wird, wird eine ArgumentOutOfRange-Ausnahme ausgegeben.

message: string;

Eigenschaftswert

string

persistent

Gibt an, ob die Nachricht persistent sein soll. Gilt nur, wenn der Typ ist InformationalMessage. Wenn true, bleibt die Nachricht erhalten, bis sie von diesem Add-In entfernt oder vom Benutzer verworfen wird. Wenn false, wird es entfernt, wenn der Benutzer zu einem anderen Element. Für Fehlerbenachrichtigungen bleibt die Nachricht bestehen, bis der Benutzer sie einmal gesehen hat. Wenn dieser Parameter für einen nicht unterstützten Typ angeben wird, wird eine Ausnahme ausgelöst.

persistent?: Boolean;

Eigenschaftswert

Boolean

type

Gibt die der ItemNotificationMessageType Nachricht an.

Wenn der Typ oder ErrorMessageistProgressIndicator, wird automatisch ein Symbol bereitgestellt, und die Nachricht ist nicht persistent. Daher sind das Symbol und die permanenten Eigenschaften für diese Art von Nachrichten ungültig. Wenn Sie sie einschließen, führt dies zu einem ArgumentException.

Wenn type ist ProgressIndicator, sollte der Entwickler die Statusanzeige entfernen oder ersetzen, wenn die Aktion abgeschlossen ist.

Wichtig: Nur der InformationalMessage Typ wird in Outlook unter Android und unter iOS unterstützt.

type: MailboxEnums.ItemNotificationMessageType | string;

Eigenschaftswert

Office.MailboxEnums.ItemNotificationMessageType | string