Office.NotificationMessages interface

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

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.

Méthodes

addAsync(key, JSONmessage, options, callback)	Ajoute une notification à un élément.
addAsync(key, JSONmessage, callback)	Ajoute une notification à un élément.
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.

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

Facultatif. 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:

Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, vous pouvez définir un maximum de cinq notifications par message. La définition d’autres 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 notification précédente.
Une seule notification de type InsightMessage est autorisée par complément. Toute tentative d’ajout génère une erreur.
Dans les Outlook sur le web modernes et les nouveaux Outlook sur Windows, vous pouvez ajouter une InsightMessage notification uniquement en mode Compose.
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.
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}.`);
});

addAsync(key, JSONmessage, callback)

Ajoute une notification à un élément.

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

Paramètres

key: string

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

Facultatif. 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:

Dans Outlook sur le web, sur Windows (nouveau et classique) et sur Mac, vous pouvez définir un maximum de cinq notifications par message. La définition d’autres 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 notification précédente.
Une seule notification de type InsightMessage est autorisée par complément. Toute tentative d’ajout génère une erreur.
Dans les Outlook sur le web modernes et les nouveaux Outlook sur Windows, vous pouvez ajouter une InsightMessage notification uniquement en mode Compose.
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.
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.

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

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

Facultatif. 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(JSON.stringify(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

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

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

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

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

Facultatif. 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

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

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

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

Facultatif. 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

Rétroaction

Cette page vous a-t-elle été utile ?

Partager via

Office.NotificationMessages interface

Remarques

Méthodes

Détails de la méthode

addAsync(key, JSONmessage, options, callback)

Paramètres

Retours

Remarques

Exemples

addAsync(key, JSONmessage, callback)

Paramètres

Retours

Remarques

getAllAsync(options, callback)

Paramètres

Retours

Remarques

Exemples

getAllAsync(callback)

Paramètres

Retours

Remarques

removeAsync(key, options, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(key, callback)

Paramètres

Retours

Remarques

replaceAsync(key, JSONmessage, options, callback)

Paramètres

Retours

Remarques

Exemples

replaceAsync(key, JSONmessage, callback)

Paramètres

Retours

Remarques

Rétroaction