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
actions | Spécifie les actions pour le message. Limite : 1 action. Cette limite ne compte pas l’action « Ignorer » qui est incluse par défaut. Applicable uniquement lorsque le type est Important: dans les Outlook sur le web modernes, la propriété |
icon | Référence à une icône définie dans le manifeste dans la section 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 |
persistent | Spécifie si le message doit être persistant. Applicable uniquement lorsque le type est |
type | Spécifie le Si le type est Si le type est |
Détails de la propriété
actions
Spécifie les actions pour le 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
. Le fait de spécifier cette propriété pour un type non pris en place ou d’inclure un trop grand nombre d’actions permet de lancer une erreur.
Important: dans les Outlook sur le web modernes, la propriété actions
est disponible en mode Composition uniquement.
actions?: NotificationMessageAction[];
Valeur de propriété
Remarques
[Ensemble d’API : Mailbox 1.10 ]
Mode Outlook applicable : Rédiger ou Lire
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 si le type est InformationalMessage
et est obligatoire si le type est InsightMessage
. 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;