Office.NotificationMessageDetails interface
Un tableau d’objets NotificationMessageDetails est renvoyé par la méthode NotificationMessages.getAllAsync.
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);
});
Propriétés
| icon | Référence à une icône définie dans le manifeste. Elle apparaît dans la barre d’informations. Elle s’applique si le type est Remarque : À l’heure actuelle, 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 type est Si type a la valeur Important : seul le |
Détails de la propriété
icon
Référence à une icône définie dans le manifeste. Elle apparaît dans la barre d’informations. Elle s’applique 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 : À l’heure actuelle, 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 complément ou ignoré 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 de message.
Si 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. Si vous les incluez, vous obtiendrez un ArgumentException.
Si type a la valeur ProgressIndicator, le développeur doit supprimer ou remplacer l’indicateur de progression une fois l’action terminée.
Important : seul le InformationalMessage type est pris en charge dans Outlook sur Android et sur iOS.
type: MailboxEnums.ItemNotificationMessageType | string;