Freigeben über

Ressourcentyp erwähnen

  • Artikel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

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 die Erwähnung. Sie enthält eine mentionsPreview-Eigenschaft , die angibt, ob der angemeldete Benutzer in dieser Nachrichteninstanz erwähnt wird. Sie enthält auch die Navigationseigenschaft erwähnungen , die das Abrufen von Details 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 POST Anforderung erstellen, indem sie die Erwähnung in die Erwähnungseigenschaft einschließt. Mithilfe einer GET Anforderung mit dem $filter Abfrageparameter kann eine App alle Nachrichten im Postfach des angemeldeten Benutzers zurückgeben, in denen der Benutzer erwähnt wird. Mit einer GET 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 abrufen kann, ermöglicht einfache Benachrichtigungen, bei denen der Benutzer, der die Erwähnung vorgibt, im vorhandenen Kontext verbleiben kann (z. B. beim Verfassen eines Nachrichtentexts), während die App die zugrunde liegende Mentions-Eigenschaft festlegt. Erwähnte Personen können durch GET Anforderungen mit dem $filter Abfrageparameter oder $expand leicht herausfinden, ob und wo sie erwähnt werden.

Wenn ein Benutzer beispielsweise im Outlook-E-Mail-Client beim Schreiben einer Nachricht eingaben @ , ermöglicht Outlook dem Benutzer, einen Namen auszuwählen oder einzugeben, um die @-Erwähnung abzuschließen. Outlook legt die Erwähnungseigenschaft fest, bevor die Nachricht oder das Ereignis erstellt und gesendet wird. Outlook verwendet GET auch Vorgänge mit $filter und $expand , damit der angemeldete Benutzer Nachrichten nachschlagen kann, die den Benutzer erwähnen, und den Benutzer auf Aktionselemente oder Diskussionen aufmerksam machen, was eine schnellere Antwort ermöglicht.

Methoden

Methode Rückgabetyp Beschreibung
Posten und Senden Keine Erstellen und senden Sie Erwähnungen als Teil einer neuen Nachricht.
Posten in einem neuen Entwurf -Nachricht , die mindestens ein Erwähnungsobjekt enthält. Erstellen Sie einen Entwurf einer neuen Nachricht, und fügen Sie mindestens ein Erwähnungsobjekt ein.
Abrufen von Nachrichten, die mich erwähnen message-Sammlung Ruft alle Nachrichten im Postfach des angemeldeten Benutzers ab, die eine Erwähnung dieses Benutzers enthalten.
Abrufen einer Nachricht und ihrer Erwähnungen message-Sammlung Rufen Sie eine Nachricht ab, und erweitern Sie die Details der einzelnen Erwähnungen in der Nachricht.
Löschen einer Erwähnung Keine Löschen Sie die angegebene Erwähnung in der angegebenen Nachricht im Postfach des angemeldeten Benutzers.

Eigenschaften

Eigenschaft Typ Beschreibung
Anwendung Zeichenfolge Der Name der Anwendung, in der die Erwähnung erstellt wird. Optional. Nicht verwendet und standardmäßig null für die Nachricht.
clientReference Zeichenfolge Ein eindeutiger Bezeichner, der ein übergeordnetes Element der Ressourceninstanz darstellt. Optional. Nicht verwendet und standardmäßig null für die Nachricht.
createdBy emailAddress Die E-Mail-Informationen des Benutzers, der die Erwähnung vorgenommen hat.
createdDateTime DateTimeOffset Das Datum und die Uhrzeit der Erstellung der Erwähnung auf dem Client.
deepLink Zeichenfolge Ein Deep-Weblink zum Kontext der Erwähnung in der Ressourceninstanz. Optional. Nicht verwendet und standardmäßig null für die Nachricht.
id Zeichenfolge Der eindeutige Bezeichner einer Erwähnung in einer Ressourceninstanz.
erwähnt emailAddress Die E-Mail-Informationen der genannten Person. Erforderlich.
mentionText Zeichenfolge Optional. Nicht verwendet und standardmäßig null für die Nachricht. Informationen zum Abrufen der Erwähnungen in einer Nachricht finden Sie stattdessen in der bodyPreview-Eigenschaft der Nachricht.
serverCreatedDateTime DateTimeOffset Das Datum und die Uhrzeit, zu dem die Erwähnung auf dem Server erstellt wird. Optional. Nicht verwendet und standardmäßig null für die Nachricht.

Beziehungen

Keine.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

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