Office.NotificationMessages interface

Ajoute une notification à un élément.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important:

• Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, vous pouvez définir un maximum de cinq notifications par message. En définissant plus, il renvoie une NumberOfNotificationMessagesExceeded erreur. Dans Outlook sur Android et iOS, vous ne pouvez définir qu’une seule notification par message. La définition d’une notification supplémentaire remplace la précédente.

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

• Dans la version moderne d’Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous pouvez ajouter une InsightMessage notification uniquement en mode Composer.

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

• En mode de composition, bien que le style de chaque type de notification varie sur 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.

• La addAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

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 = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add progress notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added progress notification with id = ${id}.`);
});

...

// Adds an informational notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added informational notification with id = ${id}.`);
});

...

// Adds a persistent information notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "PG.Icon.16",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add persistent informational notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added persistent informational notification with id = ${id}.`);
});

...

// Adds an error notification to the mail item.
const id = (document.getElementById("notificationId") as HTMLInputElement).value;
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ErrorMessage,
    message: "Error notification message with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to add error notification with id = ${id}. Try using a different ID.`);
    return;
  }
  console.log(`Added error notification with id = ${id}.`);
});

Ajoute une notification à un élément.

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important:

• Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, vous pouvez définir un maximum de cinq notifications par message. En définissant plus, il renvoie une NumberOfNotificationMessagesExceeded erreur. Dans Outlook sur Android et iOS, vous ne pouvez définir qu’une seule notification par message. La définition d’une notification supplémentaire remplace la précédente.

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

• Dans la version moderne d’Outlook sur le web et la nouvelle version d’Outlook sur Windows, vous pouvez ajouter une InsightMessage notification uniquement en mode Composer.

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

• En mode de composition, bien que le style de chaque type de notification varie sur 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.

• La addAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

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

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

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

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

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

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

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important : La removeAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

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 = (document.getElementById("notificationId") as HTMLInputElement).value;
Office.context.mailbox.item.notificationMessages.removeAsync(id, (result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.log(`Failed to remove notification with id = ${id}. ${result.error.message}.`);
    return;
  }
  console.log(`Removed notification with id = ${id}.`);
});

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

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

Paramètres

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important : La removeAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

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

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important : La replaceAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.

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 = (document.getElementById("notificationId") as HTMLInputElement).value;
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
  },
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.log(`Failed to replace notification with id = ${id}. ${result.error.message}.`);
      return;
    }
    console.log(`Replaced notification with id = ${id}.`);
  });

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

Retours

Remarques

Jeu d’API : Boîte aux lettres 1.3

Niveau d’autorisation minimal : lire l’élément

Mode Outlook applicable : Rédiger ou Lire

Important : La replaceAsync méthode n’est pas prise en charge sur un message actuellement chargé à l’aide de la loadItemByIdAsync méthode. Pour plus d’informations, voir Activer votre complément Outlook sur plusieurs messages.