Partager via

Office.NotificationMessageAction interface

Paquet:
outlook

Définition de l’action pour un message de notification.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.10 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Rédiger ou Lire

Important : dans les Outlook sur le web modernes et les nouveaux Outlook sur Windows, l’objet NotificationMessageAction est disponible en mode Compose uniquement.

Exemples

// 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}.`);
});

Propriétés

actionText

Texte du lien d’action.
actionType

Type d’action à effectuer. ActionType.ShowTaskPane est la seule action prise en charge.
commandId

Bouton défini dans le manifeste.
contextData

Toutes les données JSON que le bouton d’action doit transmettre au complément.

Détails de la propriété

actionText

Texte du lien d’action.

actionText: string;

Valeur de propriété

string

actionType

Type d’action à effectuer. ActionType.ShowTaskPane est la seule action prise en charge.

actionType: string | MailboxEnums.ActionType;

Valeur de propriété

string | Office.MailboxEnums.ActionType

commandId

Bouton défini dans le manifeste.

commandId: string;

Valeur de propriété

string

contextData

Toutes les données JSON que le bouton d’action doit transmettre au complément.

contextData: any;

Valeur de propriété

any

Remarques

Important:

  • Dans Outlook sur Windows, le any type est pris en charge à partir de la version 2402 (build 17308.20000). Dans les versions antérieures d’Outlook sur Windows, seul le string type est pris en charge.

  • Pour récupérer les données JSON, appelez Office.context.mailboxitem.getInitializationContextAsync. Si vous créez une chaîne JSON à l’aide JSON.stringify() de et que vous l’attribuez à la contextData propriété , vous devez analyser la chaîne à l’aide JSON.parse() de une fois que vous l’avez récupérée.

  • Pour empêcher la relance du volet Office d’un message de notification s’il est déjà ouvert, implémentez un gestionnaire pour l’événement Office.EventType.InitializationContextChanged . Vous pouvez ensuite passer les arguments d’événement à la contextData propriété .