type de ressource notification (déconseillé)

Espace de noms: microsoft.graph

Importante

L’API de notifications Microsoft Graph est déconseillée et cessera de retourner des données d’ici la fin de janvier 2022. Pour une autre expérience de notification, consultez Microsoft Azure Notification Hubs et consultez ce billet de blog pour plus d’informations.

Représente une notification publiée par un serveur d’applications qui cible un utilisateur spécifié. La notification est stockée dans Microsoft Graph et distribuée à différents points de terminaison d’appareil appartenant à l’utilisateur.

Une notification peut être une charge utile de notification visuelle qui peut être interprétée par le système d’exploitation (plateformes Windows, Android et iOS). Il peut également s’agir d’une charge utile de données (rawContent) qui est remise et gérée par les clients d’application (y compris le web), qui déterminent ensuite l’expérience utilisateur correspondante sur chaque appareil. Il s’agit généralement d’une interface utilisateur de notification visuelle, générée localement, qui correspond au contenu de la charge utile de données d’origine.

Lorsqu’un utilisateur agit sur une notification visuelle, le client d’application peut ensuite utiliser le Kit de développement logiciel (SDK) de notifications côté client pour mettre à jour l’état du flux de notification correspondant dans Microsoft Graph, par exemple en marquant une notification comme étant ignorée. La mise à jour est ensuite distribuée à tous les autres points de terminaison clients d’application, et les clients gèrent la modification en conséquence, par exemple en rejetant la notification pour empêcher l’utilisateur de voir des informations redondantes. Les clients d’application peuvent accéder à la même ressource de notification ultérieurement avant qu’elle n’expire (même après qu’elle soit marquée comme ignorée), en tant qu’historique de notification, via le KIT de développement logiciel (SDK) de notification.

Remarque

Les mises à jour de l’état des notifications, telles que lues ou ignorées, ne sont pas envoyées aux points de terminaison web. Cela est dû au fait que les notifications push web sur différents navigateurs nécessitent l’affichage de notifications toast visuelles pour un utilisateur. Étant donné que les changements d’état n’ont pas de contenu visuel correspondant, ils sont uniquement supprimés pour les notifications ciblant les plateformes Windows, iOS ou Android.

Méthodes

Méthode	Type renvoyé	Description
Créer une notification	Notification	Créer et envoyer une notification.

Propriétés

Propriété	Type	Description
targetHostName	String	Représente le nom d’hôte de l’application vers laquelle le service appelant souhaite publier la notification, pour l’utilisateur donné. Si vous ciblez des points de terminaison web (voir targetPolicy.platformTypes), vérifiez que targetHostName est identique au nom utilisé lors de la création d’un abonnement côté client dans la propriété JSON de l’application.
appNotificationId	String	ID unique défini par le serveur d’applications d’une notification utilisée pour identifier et cibler une notification individuelle.
Groupname	String	Nom du groupe auquel cette notification appartient. Il est défini par le développeur pour regrouper les notifications.
targetPolicy	targetPolicyEndpoints	L’objet de stratégie cible gère la stratégie de remise de notification pour les types de points de terminaison qui doivent être ciblés (Windows, iOS, Android et WebPush) pour l’utilisateur donné.
payload	payloadTypes	Il s’agit du contenu des données d’une notification utilisateur brute ou visuelle qui sera remise et consommée par le client d’application recevant cette notification.
displayTimeToLive	Int32	Définit la durée (en secondes) de ce contenu de notification dans la visionneuse de notification de chaque plateforme. Par exemple, lorsque la notification est remise à un appareil Windows, la valeur de cette propriété est transmise à ToastNotification.ExpirationTime, qui détermine la durée pendant laquelle la notification toast reste dans le Centre de notifications Windows de l’utilisateur.
expirationDateTime	DateTimeOffset	Définit une date et une heure d’expiration UTC sur une notification utilisateur au format ISO 8601 (par exemple, minuit UTC le 1er janvier 2019 se présente comme suit : '2019-01-01T00:00:00Z'). Lorsque le temps est dépassé, la notification est complètement supprimée du magasin de flux de notification Microsoft Graph et ne fait plus partie de l’historique des notifications. La valeur maximale est de 30 jours.
priorité	string	Indique la priorité d’une notification utilisateur brute. Les notifications visuelles sont envoyées avec une priorité élevée par défaut. Les valeurs valides sont None, High et Low.
stratégie de secours	Stratégie de secours	L’objet de stratégie de secours facultatif gère la stratégie de secours de notification pour les points de terminaison iOS uniquement et est conçu pour être utilisé pour les notifications brutes de priorité élevée qui peuvent ne pas être remises aux appareils en raison de restrictions spécifiques à la plateforme (par exemple, le mode économiseur de batterie).

Relations

Aucun.

Représentation JSON

La représentation JSON suivante montre le type de ressource.

{
  "targetHostName": "String",
  "appNotificationid": "String (identifier)",
  "groupName": "String", 
  "targetPolicy": {"@odata.type": "microsoft.graph.targetPolicyEndpoints"},
  "payload": {"@odata.type": "microsoft.graph.payloadTypes"},
  "displayTimeToLive": 1024,
  "expirationDateTime": "String (timestamp)",
  "priority": "string",
  "fallbackPolicy": {"@odata.type": "microsoft.graph.fallbackpolicy"} 
}