Freigeben über

Notification-Ressourcentyp (veraltet)

  • Artikel

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 abzielt. Die Benachrichtigung wird in Microsoft Graph gespeichert und an verschiedene Geräteendpunkte verteilt, die sich im Besitz des Benutzers befinden.

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

Wenn ein Benutzer auf eine visuelle Benachrichtigung reagiert, kann der App-Client dann das clientseitige Benachrichtigungs-SDK verwenden, um den Status des entsprechenden Benachrichtigungsfeeds in Microsoft Graph zu aktualisieren, z. B. indem er eine Benachrichtigung als verworfen markiert. Das Update wird dann an alle anderen App-Clientendpunkte verteilt, und die Clients behandeln die Änderung entsprechend, indem sie z. B. die Benachrichtigung schließen, um zu verhindern, dass der Benutzer redundante Informationen anzeigt. 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 verworfen markiert wurde).

Hinweis

Aktualisierungen des Benachrichtigungszustands, z. B. gelesen oder verworfen, werden nicht an Webendpunkte aufgefächert. Dies liegt daran, dass Webpushs über verschiedene Browser hinweg visuelle Popupbenachrichtigungen für einen Benutzer anzeigen müssen. Da Zustandsänderungen keinen entsprechenden visuellen Inhalt aufweisen, werden sie nur für Benachrichtigungen auf Windows-, iOS- oder Android-Plattformen aufgefächert.

Methoden

Methode Rückgabetyp Beschreibung
Create und Senden einer Benachrichtigung (veraltet) Benachrichtigung Create und senden Sie eine Benachrichtigung.

Eigenschaften

Eigenschaft Typ Beschreibung
targetHostName Zeichenfolge Stellt den Hostnamen der App dar, an die der aufrufende Dienst die Benachrichtigung für den angegebenen Benutzer senden möchte. Wenn Sie webendpunkte als Ziel verwenden (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 wird, 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 zum Gruppieren von Benachrichtigungen festgelegt.
targetPolicy targetPolicyEndpoints Das Zielrichtlinienobjekt verarbeitet die Benachrichtigungsübermittlungsrichtlinie für Endpunkttypen, die für den angegebenen Benutzer als Ziel verwendet werden sollen (Windows, iOS, Android und WebPush).
payload payloadTypes Dies ist der Dateninhalt einer unformatierten oder visuellen Benutzerbenachrichtigung, die an den App-Client übermittelt und von dort genutzt wird, der diese Benachrichtigung empfängt.
displayTimeToLive Int32 Legt fest, wie lange (in Sekunden) dieser Benachrichtigungsinhalt im Benachrichtigungs-Viewer der einzelnen Plattformen verbleibt. 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 verbleibt.
expirationDateTime DateTimeOffset Legt ein UTC-Ablaufdatum und eine UTC-Uhrzeit für eine Benutzerbenachrichtigung im ISO 8601-Format fest (Mitternacht UTC am 1. Januar 2019 würde beispielsweise 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 Maximalwert beträgt 30 Tage.
priority Zeichenfolge 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 Das optionale Fallbackrichtlinienobjekt verarbeitet die Fallbackrichtlinie für Benachrichtigungen nur für iOS-Endpunkte und ist für unformatierte Benachrichtigungen mit hoher Priorität konzipiert, die aufgrund plattformspezifischer Einschränkungen (z. B. Im Energiesparmodus) möglicherweise nicht an Geräte übermittelt werden.

Beziehungen

Keine.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

{
  "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"} 
}