Office.NotificationMessageAction interface

Die Definition der Aktion für eine Benachrichtigungsmeldung.

Hinweise

API-Satz: Postfach 1.10

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Compose oder Lesen

Wichtig: In modernen Outlook im Web und im neuen Outlook unter Windows ist das NotificationMessageAction Objekt nur im Compose Modus verfügbar.

Verwendet von

Beispiele

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

// Adds an informational message with actions to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;

const itemId = Office.context.mailbox.item.itemId;
const details = {
  type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
  message: "This is an insight notification with id = " + id,
  icon: "PG.Icon.16",
  actions: [
    {
      actionText: "Open insight",
      actionType: Office.MailboxEnums.ActionType.ShowTaskPane,
      // Identify whether the current mail item is in read or compose mode to set the appropriate commandId value.
      commandId: (itemId == undefined ? "PG.HelpCommand.Compose" : "PG.HelpCommand.Read"),
      contextData: { a: "aValue", b: "bValue" }
    }
  ]
};

Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add insight notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added insight notification with id = ${id}.`);
});

Eigenschaften

actionText

Der Text des Aktionslinks.

actionType

Der Typ der auszuführenden Aktion. ActionType.ShowTaskPane ist die einzige unterstützte Aktion.

commandId

Die im Manifest definierte Schaltfläche.

contextData

Alle JSON-Daten, die die Aktionsschaltfläche an das Add-In übergeben muss.

Details zur Eigenschaft

actionText

Der Text des Aktionslinks.

actionText: string;

Eigenschaftswert

string

actionType

Der Typ der auszuführenden Aktion. ActionType.ShowTaskPane ist die einzige unterstützte Aktion.

actionType: string | MailboxEnums.ActionType;

Eigenschaftswert

commandId

Die im Manifest definierte Schaltfläche.

commandId: string;

Eigenschaftswert

string

contextData

Alle JSON-Daten, die die Aktionsschaltfläche an das Add-In übergeben muss.

contextData: any;

Eigenschaftswert

any

Hinweise

Wichtig:

  • In Outlook unter Windows wird dieser any Typ ab Version 2402 (Build 17308.20000) unterstützt. In früheren Versionen von Outlook unter Windows wird nur dieser string Typ unterstützt.

  • Um die JSON-Daten abzurufen, rufen Sie Office.context.mailboxitem.getInitializationContextAsyncauf. Wenn Sie eine JSON-Zeichenfolge erstellen JSON.stringify() und sie der contextData Eigenschaft zuweisen, müssen Sie die Zeichenfolge nach dem Abrufen mit JSON.parse() analysieren.

  • Um zu verhindern, dass der Aufgabenbereich einer Benachrichtigungsnachricht neu gestartet wird, wenn er bereits geöffnet ist, implementieren Sie einen Handler für das Office.EventType.InitializationContextChanged Ereignis. Anschließend können Sie die Ereignisargumente an die contextData Eigenschaft übergeben.