Ressourcentyp erwähnen

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Stellt eine Benachrichtigung an eine Person basierend auf der E-Mail-Adresse der Person dar. Diese Art von Benachrichtigung wird auch als @-Erwähnungen bezeichnet.

Die Nachrichtenressource unterstützt Erwähnungen. Sie enthält eine MentionsPreview-Eigenschaft, die angibt, ob der angemeldete Benutzer in dieser Nachrichteninstanz erwähnt wird. Sie enthält auch die Erwähnungsnavigationseigenschaft, die das Abrufen von Details zu einer Erwähnung oder das Löschen einer Erwähnung in dieser Instanz unterstützt.

Beim Erstellen einer Nachricht kann eine App eine Erwähnung in derselben Anforderung erstellen, indem sie die Erwähnung POST in die Erwähnungseigenschaft einbeschafft. Mithilfe einer Anforderung mit dem Abfrageparameter kann eine App alle Nachrichten im Postfach des angemeldeten Benutzers zurückgeben, in dem der GET $filter Benutzer erwähnt wird. Mit GET einer Anforderung mit dem $expand Abfrageparameter kann die App alle Erwähnungen in einer bestimmten Nachricht erweitern.

Dieser Mechanismus, mit dem eine App Erwähnungen in Nachrichten festlegen und erhalten kann, ermöglicht einfache Benachrichtigungen, bei denen der Benutzer, der die Erwähnung macht, im vorhandenen Kontext verbleiben kann (z. B. erstellen eines Nachrichtentexts), während die App die zugrunde liegende Erwähnungseigenschaft legt. Die erwähnten Personen können ganz einfach herausfinden, ob und wo sie durch Anforderungen mit dem GET Parameter $filter "or $expand query" erwähnt werden.

Wenn ein Benutzer beispielsweise im Outlook-E-Mail-Client beim Schreiben einer Nachricht eingaben, kann der Benutzer in Outlook einen Namen auswählen oder eingeben, um die @ @-Erwähnung zu vervollständigen. Outlook legt die Erwähnungseigenschaft fest, bevor die Nachricht oder das Ereignis erstellt und gesendet wird. Outlook verwendet auch Vorgänge mit und ermöglicht dem angemeldeten Benutzer das Nachschauen von Nachrichten, in denen der Benutzer erwähnt wird, und warnt den Benutzer vor Aktionselementen oder Diskussionen, was eine schnellere Antwort GET $filter $expand ermöglicht.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "application": "string",
  "clientReference": "string",
  "createdBy": {"@odata.type": "microsoft.graph.emailAddress"},
  "createdDateTime": "DateTimeOffset",
  "deepLink": "string",
  "id": "string (identifier)",
  "mentioned": {"@odata.type": "microsoft.graph.emailAddress"},
  "mentionText": "string",
  "serverCreatedDateTime": "DateTimeOffset"
}

Eigenschaften

Eigenschaft Typ Beschreibung
Anwendung String Der Name der Anwendung, in der die Erwähnung erstellt wird. Optional. Nicht verwendet und standardmäßig als NULL für Nachricht festgelegt.
clientReference String Ein eindeutiger Bezeichner, der ein übergeordnetes Element der Ressourceninstanz darstellt. Optional. Nicht verwendet und standardmäßig als NULL für Nachricht festgelegt.
createdBy emailAddress Die E-Mail-Informationen des Benutzers, der die Erwähnung vorgenommen hat.
createdDateTime DateTimeOffset Datum und Uhrzeit der Erwähnung auf dem Client.
deepLink String Ein Deep-Web-Link zum Kontext der Erwähnung in der Ressourceninstanz. Optional. Nicht verwendet und standardmäßig als NULL für Nachricht festgelegt.
id String Der eindeutige Bezeichner einer Erwähnung in einer Ressourceninstanz.
mentioned emailAddress Die E-Mail-Informationen der erwähnten Person. Erforderlich.
mentionText Zeichenfolge Optional. Nicht verwendet und standardmäßig als NULL für Nachricht festgelegt. Um die Erwähnungen in einer Nachricht zu erhalten, sehen Sie sich stattdessen die bodyPreview-Eigenschaft der Nachricht an.
serverCreatedDateTime DateTimeOffset Datum und Uhrzeit der Erwähnung auf dem Server. Optional. Nicht verwendet und standardmäßig als NULL für Nachricht festgelegt.

Beziehungen

Keine

Methoden

Methode Rückgabetyp Beschreibung
Posten und Senden Keine Erstellen und Senden von Erwähnungen als Teil einer neuen Nachricht.
Posten in einem neuen Entwurf nachricht, die ein oder mehrere Erwähnungsobjekte enthält. Erstellen Sie einen Entwurf einer neuen Nachricht, und schließen Sie ein oder mehrere Erwähnungsobjekte ein.
Erhalten von Nachrichten, die mich erwähnen message-Sammlung Alle Nachrichten im Postfach des angemeldeten Benutzers mit einer Erwähnung dieses Benutzers erhalten.
Erhalten einer Nachricht und ihrer Erwähnungen message-Sammlung Erhalten Sie eine Nachricht, und erweitern Sie die Details der einzelnen Erwähnungen in der Nachricht.
Löschen einer Erwähnung Keine Löscht die angegebene Erwähnung in der angegebenen Nachricht im Postfach des angemeldeten Benutzers.