Partager via

Office.NotificationMessageDetails interface

Paquet:
outlook

Un tableau d’objets NotificationMessageDetails est renvoyé par la méthode NotificationMessages.getAllAsync.

Remarques

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

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

Mode Outlook applicable : Rédiger ou Lire

Important : pour en savoir plus sur les différents types de messages de notification que vous pouvez implémenter, voir Créer des notifications pour votre complément Outlook.

Exemples

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

Propriétés

actions

Spécifie les actions du message. Limite : 1 action. Cette limite ne compte pas l’action « Ignorer » qui est incluse par défaut. Applicable uniquement lorsque le type est InsightMessage. La spécification de cette propriété pour un type non pris en charge ou l’inclusion d’un trop grand nombre d’actions génère une erreur.

Important : dans les Outlook sur le web modernes et les nouveaux Outlook sur Windows, la actions propriété est disponible en mode Compose uniquement.
icon

Référence à une icône personnalisée définie dans le manifeste. L’icône apparaît avant le message de notification dans la zone de barre d’informations. Une icône doit être spécifiée pour InformationalMessage les notifications et .InsightMessage
key

Identificateur du message de notification.
message

Texte du message de notification. La longueur maximale est de 150 caractères. Si le développeur génère une chaîne plus longue, une exception ArgumentOutOfRange se déclenche.
persistent

Spécifie si le message doit être persistant. Applicable uniquement lorsque le type est InformationalMessage. Si la valeur est true, le message reste jusqu’à ce qu’il soit supprimé par ce complément ou ignoré par l’utilisateur. Si false, il est supprimé lorsque l'utilisateur navigue vers un autre élément. Pour les notifications d’erreur, le message est conservé jusqu’à ce qu’il soit vu par l’utilisateur. Le fait de spécifier ce paramètre pour un type non pris en charge génère une exception.
type

Spécifie le ItemNotificationMessageType de message.

Détails de la propriété

actions

Spécifie les actions du message. Limite : 1 action. Cette limite ne compte pas l’action « Ignorer » qui est incluse par défaut. Applicable uniquement lorsque le type est InsightMessage. La spécification de cette propriété pour un type non pris en charge ou l’inclusion d’un trop grand nombre d’actions génère une erreur.

Important : dans les Outlook sur le web modernes et les nouveaux Outlook sur Windows, la actions propriété est disponible en mode Compose uniquement.

actions?: NotificationMessageAction[];

Valeur de propriété

Office.NotificationMessageAction[]

Remarques

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

Mode Outlook applicable : Rédiger ou Lire

icon

Référence à une icône personnalisée définie dans le manifeste. L’icône apparaît avant le message de notification dans la zone de barre d’informations. Une icône doit être spécifiée pour InformationalMessage les notifications et .InsightMessage

icon?: string;

Valeur de propriété

string

Remarques

Important:

  • Actuellement, l’icône personnalisée s’affiche uniquement dans Outlook classique sur Windows.

  • Une icône personnalisée est uniquement prise en charge dans les InformationalMessage notifications et InsightMessage . La spécification d’une icône pour d’autres types de notification entraîne une exception.

  • Si votre complément utilise uniquement le manifeste de complément, l’icône doit être spécifiée dans l’élément Images de la section Resources du manifeste.

  • Si votre complément utilise le manifeste unifié pour Microsoft 365, vous ne pouvez pas personnaliser actuellement l’icône d’une InformationalMessage notification ou InsightMessage . La notification utilise la première image spécifiée dans le tableau « icons » du premier objet extensions.ribbons.tabs.groups.controls du manifeste. Bien que ce soit le cas, vous devez toujours spécifier une chaîne dans la icon propriété (par exemple, « icon-16 »).

key

Identificateur du message de notification.

key?: string;

Valeur de propriété

string

message

Texte du message de notification. La longueur maximale est de 150 caractères. Si le développeur génère une chaîne plus longue, une exception ArgumentOutOfRange se déclenche.

message: string;

Valeur de propriété

string

persistent

Spécifie si le message doit être persistant. Applicable uniquement lorsque le type est InformationalMessage. Si la valeur est true, le message reste jusqu’à ce qu’il soit supprimé par ce complément ou ignoré par l’utilisateur. Si false, il est supprimé lorsque l'utilisateur navigue vers un autre élément. Pour les notifications d’erreur, le message est conservé jusqu’à ce qu’il soit vu par l’utilisateur. Le fait de spécifier ce paramètre pour un type non pris en charge génère une exception.

persistent?: Boolean;

Valeur de propriété

Boolean

type

Spécifie le ItemNotificationMessageType de message.

type: MailboxEnums.ItemNotificationMessageType | string;

Valeur de propriété

Office.MailboxEnums.ItemNotificationMessageType | string

Remarques

Important:

  • Pour les ProgressIndicator types ou ErrorMessage , une icône est automatiquement fournie et le message n’est pas persistant. Par conséquent, l’icône et les propriétés persistantes ne sont pas valides pour ces types de messages. Si vous les incluez, vous obtiendrez un ArgumentException.

  • Pour le ProgressIndicator type, vous devez supprimer ou remplacer l’indicateur de progression une fois l’action terminée.

  • Dans Outlook sur Android et sur iOS, seuls les ProgressIndicatortypes de notification , InformationalMessageet ErrorMessage sont pris en charge.

  • En mode composition, alors que le style de chaque type de notification varie selon les autres clients Outlook, les notifications dans Outlook sur Android et sur iOS utilisent toutes le même style. Le message de notification est toujours précédé d’une icône d’information.