Office.NotificationMessageDetails interface

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

Remarques

[Ensemble d’API : Mailbox 1.3 ]

Niveau d’autorisation minimal :ReadItem

Mode Outlook applicable  : Rédiger ou Lire

Propriétés

icon

Référence à une icône définie dans le manifeste dans la section Resources. Elle apparaît dans la barre d’informations. Applicable uniquement si le type est InformationalMessage. Le fait de spécifier ce paramètre pour un type non pris en charge génère une exception.

Remarque: actuellement, l’icône personnalisée s’affiche dans Outlook sur Windows uniquement et non sur d’autres clients (par exemple, Mac, navigateur web).

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 module ou rejeté 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 message.

Si le type est ProgressIndicator 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 permanentes ne sont pas valides pour ces types de messages. Leur inclure entraîne une ArgumentException.

Si le type est ProgressIndicator, le développeur doit supprimer ou remplacer l’indicateur de progression lorsque l’action est terminée.

Détails de la propriété

icon

Référence à une icône définie dans le manifeste dans la section Resources. Elle apparaît dans la barre d’informations. Applicable uniquement si le type est InformationalMessage. Le fait de spécifier ce paramètre pour un type non pris en charge génère une exception.

Remarque: actuellement, l’icône personnalisée s’affiche dans Outlook sur Windows uniquement et non sur d’autres clients (par exemple, Mac, navigateur web).

icon?: string;

Valeur de propriété

string

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 module ou rejeté 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 message.

Si le type est ProgressIndicator 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 permanentes ne sont pas valides pour ces types de messages. Leur inclure entraîne une ArgumentException.

Si le type est ProgressIndicator, le développeur doit supprimer ou remplacer l’indicateur de progression lorsque l’action est terminée.

type: MailboxEnums.ItemNotificationMessageType | string;

Valeur de propriété