Partager via

Office.NotificationMessages interface

  • Référence
Paquet:
outlook

L’objet NotificationMessages est renvoyé en tant que propriété notificationMessages d’un élément.

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

Méthodes

addAsync(key, JSONmessage, options, callback)

Ajoute une notification à un élément.

Chaque message est limité à 5 notifications. Si vous en définissez plus, une erreur NumberOfNotificationMessagesExceeded est renvoyée.
addAsync(key, JSONmessage, callback)

Ajoute une notification à un élément.

Chaque message est limité à 5 notifications. Si vous en définissez plus, une erreur NumberOfNotificationMessagesExceeded est renvoyée.
getAllAsync(options, callback)

Renvoie l’ensemble des clés et messages pour un élément.
getAllAsync(callback)

Renvoie l’ensemble des clés et messages pour un élément.
removeAsync(key, options, callback)

Supprime un message de notification pour un élément.
removeAsync(key, callback)

Supprime un message de notification pour un élément.
replaceAsync(key, JSONmessage, options, callback)

Remplace un message de notification disposant d’une clé donnée par un autre message.

Si un message de notification avec la clé spécifiée n’existe pas, replaceAsync ajoute la notification.
replaceAsync(key, JSONmessage, callback)

Remplace un message de notification disposant d’une clé donnée par un autre message.

Si un message de notification avec la clé spécifiée n’existe pas, replaceAsync ajoute la notification.

Détails de la méthode

addAsync(key, JSONmessage, options, callback)

Ajoute une notification à un élément.

Chaque message est limité à 5 notifications. Si vous en définissez plus, une erreur NumberOfNotificationMessagesExceeded est renvoyée.

addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

key

string

Clé spécifiée par un développeur pour référencer ce message de notification. Les développeurs peuvent l’utiliser pour modifier ce message ultérieurement. Sa longueur ne peut pas être supérieure à 32 caractères.

JSONmessage
Office.NotificationMessageDetails

Objet JSON qui contient le message de notification à ajouter à l’élément. Il contient un NotificationMessageDetails objet .

options
Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

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:

  • Une seule notification de type InsightMessage est autorisée par complément. Toute tentative d’ajout génère une erreur.

  • Dans Outlook sur le web moderne et outlook sur Windows, vous pouvez ajouter une InsightMessage notification uniquement en mode Composition.

  • Seul le InformationalMessage type est pris en charge dans Outlook sur Android et sur iOS.

Exemples

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

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an error notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

addAsync(key, JSONmessage, callback)

Ajoute une notification à un élément.

Chaque message est limité à 5 notifications. Si vous en définissez plus, une erreur NumberOfNotificationMessagesExceeded est renvoyée.

addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

key

string

Clé spécifiée par un développeur pour référencer ce message de notification. Les développeurs peuvent l’utiliser pour modifier ce message ultérieurement. Sa longueur ne peut pas être supérieure à 32 caractères.

JSONmessage
Office.NotificationMessageDetails

Objet JSON qui contient le message de notification à ajouter à l’élément. Il contient un NotificationMessageDetails objet .

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

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:

  • Une seule notification de type InsightMessage est autorisée par complément. Toute tentative d’ajout génère une erreur.

  • Dans Outlook sur le web moderne et outlook sur Windows, vous pouvez ajouter une InsightMessage notification uniquement en mode Composition.

  • Seul le InformationalMessage type est pris en charge dans Outlook sur Android et sur iOS.

getAllAsync(options, callback)

Renvoie l’ensemble des clés et messages pour un élément.

getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Paramètres

options
Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

(asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. La value propriété du résultat est un tableau d’objets NotificationMessageDetails .

Retours

void

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

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(asyncResult.value);
});

getAllAsync(callback)

Renvoie l’ensemble des clés et messages pour un élément.

getAllAsync(callback?: (asyncResult: Office.AsyncResult<NotificationMessageDetails[]>) => void): void;

Paramètres

callback

(asyncResult: Office.AsyncResult<Office.NotificationMessageDetails[]>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult. La value propriété du résultat est un tableau d’objets NotificationMessageDetails .

Retours

void

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

removeAsync(key, options, callback)

Supprime un message de notification pour un élément.

removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

key

string

Clé pour le message de notification à supprimer.

options
Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

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

Exemples

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

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

removeAsync(key, callback)

Supprime un message de notification pour un élément.

removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

key

string

Clé pour le message de notification à supprimer.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

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

replaceAsync(key, JSONmessage, options, callback)

Remplace un message de notification disposant d’une clé donnée par un autre message.

Si un message de notification avec la clé spécifiée n’existe pas, replaceAsync ajoute la notification.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

key

string

Clé pour le message de notification à remplacer. Elle peut contenir jusqu’à 32 caractères.

JSONmessage
Office.NotificationMessageDetails

Objet JSON qui contient le nouveau message de notification qui va remplacer le message existant. Il contient un NotificationMessageDetails objet .

options
Office.AsyncContextOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

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

Exemples

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

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

replaceAsync(key, JSONmessage, callback)

Remplace un message de notification disposant d’une clé donnée par un autre message.

Si un message de notification avec la clé spécifiée n’existe pas, replaceAsync ajoute la notification.

replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

key

string

Clé pour le message de notification à remplacer. Elle peut contenir jusqu’à 32 caractères.

JSONmessage
Office.NotificationMessageDetails

Objet JSON qui contient le nouveau message de notification qui va remplacer le message existant. Il contient un NotificationMessageDetails objet .

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

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