Office.NotificationMessageAction interface

Paquet:

outlook

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

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

Remarques

[Ensemble d’API : Mailbox 1.10 ]

Niveau d’autorisation minimal :ReadItem

Mode Outlook applicable  : Rédiger ou Lire

Exemples

// Define notification.
const insightMessage = {
    type: Office.MailboxEnums.ItemNotificationMessageType.InsightMessage,
    message: "This is an insight notification",
    icon: "Icon.80x80",
    actions: [{
        actionText: "Open insight",
        actionType: Office.MailboxEnums.ActionType.ShowTaskPane,
        commandId: "msgComposeOpenPaneButton",
        contextData: JSON.stringify({a: "aValue", b: "bValue"})
    }]
};

// Show notification.
Office.context.mailbox.item.notificationMessages.replaceAsync("messageKey", insightMessage, (result) => {
    console.log("Added notification:");
    console.log(result);
});

// Retrieve contextData.
// IMPORTANT: At present, this property is in preview and only works in Outlook on Windows.
Office.context.mailbox.item.getInitializationContextAsync(function (asyncResult) {
    console.log("Initialization context:");
    console.log(asyncResult);

    // Note: Use JSON.parse(asyncResult.value) to read the result. Example:
    var contextData = JSON.parse(asyncResult.value);
    console.log("a:")
    console.log(contextData.a);
});

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 en fonction du type d’élément.
contextData	Toutes les données JSON que le bouton doit transmettre. Ces données peuvent être récupérées en appelant item.getInitializationContextAsync. Important: dans Outlook sur le web, la possibilité de récupérer contextData n’est pas encore disponible.

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 en fonction du type d’élément.

commandId: string;

Valeur de propriété

string

contextData

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Toutes les données JSON que le bouton doit transmettre. Ces données peuvent être récupérées en appelant item.getInitializationContextAsync.

Important: dans Outlook sur le web, la possibilité de récupérer contextData n’est pas encore disponible.

contextData: any;

Valeur de propriété

any

Remarques

[Ensemble d’API : aperçu de boîte aux lettres ]