Erwähnung Ressourcentyp

Artikel
04/21/2024

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 Erwähnung. Sie enthält eine mentionsPreview-Eigenschaft, die angibt, ob der angemeldete Benutzer in dieser Nachricht instance erwähnt wird. Es enthält auch die Erwähnungsnavigationseigenschaft, die das Abrufen von Details zu einem Erwähnung oder das Löschen eines Erwähnung in diesem instance 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, die den Benutzer Erwähnung. 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, im vorhandenen Kontext verbleiben kann (z. B. beim Verfassen eines Nachrichtentexts), während die App die zugrunde liegende Erwähnungseigenschaft 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 etwas eingibt@, kann Outlook einen Namen auswählen oder eingeben, 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ähnung, um den Benutzer über Aktionselemente oder Diskussionen zu warnen, 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	Meldung, die mindestens ein Erwähnung -Objekte enthält.	Erstellen Sie einen Entwurf einer neuen Nachricht, und fügen Sie mindestens ein Erwähnung -Objekte 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ähnung in der Nachricht.
Löschen eines Erwähnung	Keine	Löschen Sie die angegebene Erwähnung in der angegebenen Nachricht im Postfach des angemeldeten Benutzers.

Eigenschaften

Eigenschaft	Typ	Beschreibung
Anwendung	String	Der Name der Anwendung, in der die Erwähnung erstellt wird. Optional. Nicht verwendet und standardmäßig null für die Nachricht.
clientReference	String	Ein eindeutiger Bezeichner, der ein übergeordnetes Element der Ressource instance darstellt. Optional. Nicht verwendet und standardmäßig null für die Nachricht.
createdBy	emailAddress	Die E-Mail-Informationen des Benutzers, der die Erwähnung.
createdDateTime	DateTimeOffset	Das Datum und die Uhrzeit der Erstellung des Erwähnung auf dem Client.
Deeplink	String	Ein Deep-Web-Link zum Kontext des Erwähnung im Ressourcen-instance. Optional. Nicht verwendet und standardmäßig null für die Nachricht.
id	String	Der eindeutige Bezeichner eines Erwähnung in einer Ressourcen-instance.
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 der Erstellung des Erwähnung auf dem Server. Optional. Nicht verwendet und standardmäßig null für die Nachricht.

Beziehungen

Keine.

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

Share via