Benachrichtigungsressourcentyp (veraltet)

Namespace: microsoft.graph

Wichtig

Die Microsoft Graph-Benachrichtigungs-API ist veraltet und wird ab Ende Januar 2022 keine Daten mehr zurückgeben. Eine alternative Benachrichtigungserfahrung finden Sie im Microsoft Azure Notification Hubs, und lesen Sie diesen Blogbeitrag für weitere Informationen.

Stellt eine Benachrichtigung dar, die von einem App-Server veröffentlicht wird, der auf einen angegebenen Benutzer ausgerichtet ist. Die Benachrichtigung wird in Microsoft Graph gespeichert und an verschiedene Geräteendpunkte verteilt, die dem Benutzer gehören.

Eine Benachrichtigung kann eine visuelle Benachrichtigungsnutzlast sein, die vom Betriebssystem interpretiert werden kann (Windows, Android und iOS-Plattformen). Es kann auch eine Datennutzlast (rawContent) sein, die an App-Clients (einschließlich Web) übermittelt und von diesen verarbeitet wird, die dann die entsprechende Benutzeroberfläche auf jedem Gerät bestimmen. Dies ist in der Regel eine lokal generierte benutzeroberfläche für visuelle Benachrichtigungen, die dem Inhalt in der ursprünglichen Datennutzlast entspricht.

Wenn ein Benutzer eine visuelle Benachrichtigung verwendet, kann der App-Client dann das clientseitige Benachrichtigungs-SDK verwenden, um den Status des entsprechenden Benachrichtigungsfeeds in Microsoft Graph zu aktualisieren, z. B. indem eine Benachrichtigung als geschlossen markiert wird. Das Update wird dann an alle anderen App-Clientendpunkte verteilt, und die Clients behandeln die Änderung entsprechend, z. B. indem sie die Benachrichtigung schließen, um zu verhindern, dass der Benutzer redundante Informationen sieht. App-Clients können über das Benachrichtigungs-SDK zu einem späteren Zeitpunkt auf dieselbe Benachrichtigungsressource zugreifen, bevor sie abläuft (auch nachdem sie als geschlossen markiert wurde), als Benachrichtigungsverlauf.

Hinweis

Benachrichtigungsstatusupdates, z. B. gelesen oder geschlossen, werden nicht an Webendpunkte gefächert. Dies liegt daran, dass Für Web-Pushs über verschiedene Browser hinweg visuelle Popupbenachrichtigungen für einen Benutzer angezeigt werden müssen. Da Zustandsänderungen keine entsprechenden visuellen Inhalte aufweisen, werden sie nur für Benachrichtigungen für Windows-, iOS- oder Android-Plattformen gefächert.

Methoden

Methode	Rückgabetyp	Beschreibung
Benachrichtigung erstellen	Benachrichtigung	Erstellen und Senden einer Benachrichtigung.

Eigenschaften

Eigenschaft	Typ	Beschreibung
targetHostName	Zeichenfolge	Stellt den Hostnamen der App dar, in der der aufrufende Dienst die Benachrichtigung für den angegebenen Benutzer veröffentlichen möchte. Wenn Sie auf Webendpunkte abzielen (siehe targetPolicy.platformTypes), stellen Sie sicher, dass targetHostName mit dem Namen übereinstimmt, der beim Erstellen eines Abonnements auf der Clientseite innerhalb der JSON-Eigenschaft der Anwendung verwendet wird.
appNotificationId	Zeichenfolge	Die eindeutige ID, die vom App-Server einer Benachrichtigung festgelegt wurde, die verwendet wird, um eine einzelne Benachrichtigung zu identifizieren und als Ziel festzulegen.
Groupname	Zeichenfolge	Der Name der Gruppe, zu der diese Benachrichtigung gehört. Sie wird vom Entwickler festgelegt, um Benachrichtigungen zu gruppieren.
targetPolicy	targetPolicyEndpoints	Das Zielrichtlinienobjekt behandelt die Benachrichtigungsübermittlungsrichtlinie für Endpunkttypen, die für den angegebenen Benutzer zielgerichtet sein sollten (Windows, iOS, Android und WebPush).
payload	payloadTypes	Dies ist der Dateninhalt einer unformatierten oder visuellen Benutzerbenachrichtigung, die an den App-Client übermittelt und vom App-Client genutzt wird, der diese Benachrichtigung empfängt.
displayTimeToLive	Int32	Legt fest, wie lange (in Sekunden) diese Benachrichtigungsinhalte im Benachrichtigungsviewer jeder Plattform verbleiben. Wenn die Benachrichtigung beispielsweise an ein Windows Gerät übermittelt wird, wird der Wert dieser Eigenschaft an ToastNotification.ExpirationTime übergeben, der bestimmt, wie lange die Popupbenachrichtigung im Windows Info-Center des Benutzers bleibt.
expirationDateTime	DateTimeOffset	Legt ein UTC-Ablaufdatum und eine Uhrzeit für eine Benutzerbenachrichtigung im ISO 8601-Format fest (Mitternacht UTC-Zeit am 1. Januar 2019 würde z. B. wie folgt aussehen: '2019-01-01T00:00:00Z'). Nach Ablauf der Zeit wird die Benachrichtigung vollständig aus dem Microsoft Graph Benachrichtigungsfeedspeicher entfernt und ist nicht mehr Teil des Benachrichtigungsverlaufs. Der maximale Wert beträgt 30 Tage.
priority	string	Gibt die Priorität einer unformatierten Benutzerbenachrichtigung an. Visuelle Benachrichtigungen werden standardmäßig mit hoher Priorität gesendet. Gültige Werte sind None, High und Low.
fallbackPolicy	Fallbackpolicy	Optionale Fallbackrichtlinienobjekt behandelt Benachrichtigungs-Fallback-Richtlinien nur für iOS-Endpunkte und ist für die Verwendung von unformatierten Benachrichtigungen mit hoher Priorität konzipiert, die aufgrund plattformspezifischer Einschränkungen (z. B. Stromsparmodus) möglicherweise nicht an Geräte übermittelt werden.

Beziehungen

Keine.

JSON-Darstellung

Es folgt eine JSON-Darstellung der 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"} 
}