Office.NotificationMessageDetails interface
Ein Array mit NotificationMessageDetails-Objekten wird von der NotificationMessages.getAllAsync-Methode zurückgegeben.
Hinweise
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.
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(JSON.stringify(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
Wichtig: In modernen Outlook im Web und neuen Outlook unter Windows ist die |
| icon | Ein Verweis auf ein benutzerdefiniertes Symbol, das im Manifest definiert ist. Das Symbol wird vor der Benachrichtigung im Infoleistenbereich angezeigt. Für - und |
| 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 |
| persistent | Gibt an, ob die Nachricht persistent sein soll. Gilt nur, wenn der Typ ist |
| type | Gibt die der |
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
Hinweise
Anwendbarer Outlook-Modus: Compose oder Lesen
icon
Ein Verweis auf ein benutzerdefiniertes Symbol, das im Manifest definiert ist. Das Symbol wird vor der Benachrichtigung im Infoleistenbereich angezeigt. Für - und InsightMessage -Benachrichtigungen muss ein Symbol angegeben InformationalMessage werden.
icon?: string;Eigenschaftswert
string
Hinweise
Wichtig:
Derzeit wird das benutzerdefinierte Symbol nur im klassischen Outlook unter Windows angezeigt.
Ein benutzerdefiniertes Symbol wird nur in - und
InsightMessage-InformationalMessageBenachrichtigungen unterstützt. Die Angabe eines Symbols für andere Benachrichtigungstypen führt zu einer Ausnahme.Wenn Ihr Add-In nur das Add-In-Manifest verwendet, muss das Symbol im Images-Element des Abschnitts Resources des Manifests angegeben werden.
Wenn Ihr Add-In das einheitliche Manifest für Microsoft 365 verwendet, können Sie das Symbol einer
InformationalMessage- oderInsightMessage-Benachrichtigung derzeit nicht anpassen. Die Benachrichtigung verwendet das erste Bild, das im Symbolarray des ersten extensions.ribbons.tabs.groups.controls-Objekts des Manifests angegeben ist. Obwohl dies der Fall ist, müssen Sie dennoch eine Zeichenfolge in dericon-Eigenschaft angeben (z. B. "icon-16").
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.
type: MailboxEnums.ItemNotificationMessageType | string;Eigenschaftswert
Hinweise
Wichtig:
Für die
ProgressIndicatorTypen oderErrorMessagewird automatisch ein Symbol bereitgestellt, und die Nachricht ist nicht persistent. Daher sind das Symbol und die persistenten Eigenschaften für diese Nachrichtentypen nicht gültig. Wenn Sie sie einschließen, führt dies zu einemArgumentException.Für den
ProgressIndicatorTyp sollten Sie die Statusanzeige entfernen oder ersetzen, wenn die Aktion abgeschlossen ist.In Outlook für Android und unter iOS werden nur die Benachrichtigungstypen
ProgressIndicator,InformationalMessageundErrorMessageunterstü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.