Office.NotificationMessageAction interface

Paket:

outlook

Die Definition der Aktion für eine Benachrichtigungsnachricht.

Hinweise

[ API-Satz: Postfach 1.10 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Verfassen oder Lesen

Wichtig: In modernen Outlook im Web ist das NotificationMessageAction Objekt nur im Compose-Modus verfügbar.

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 = $("#notificationId").val().toString();

const itemId = Office.context.mailbox.item.itemId;
const details = {
  type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
  message: "This is an insight notification with id = " + id,
  icon: "icon1",
  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, handleResult);

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

string | Office.MailboxEnums.ActionType

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 der any Typ ab Version 2402 (Build 17308.20000) unterstützt. In früheren Versionen von Outlook unter Windows wird nur der string Typ unterstützt.

• Rufen Office.context.mailboxitem.getInitializationContextAsyncSie auf, um die JSON-Daten abzurufen. Wenn Sie eine JSON-Zeichenfolge mit JSON.stringify() erstellen und der contextData -Eigenschaft zuweisen, müssen Sie die Zeichenfolge mit JSON.parse() analysieren, sobald Sie sie abgerufen haben.