mention type de ressource
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente une notification à une personne en fonction de son adresse e-mail. Ce type de notification est également appelé @-mentions.
La ressource de message prend en charge la mention. Il inclut une propriété mentionsPreview qui indique si l’utilisateur connecté est mentionné dans cette instance de message. Il inclut également la propriété de navigation mentions , qui prend en charge l’obtention des détails d’une mention ou la suppression d’une mention dans cette instance.
Lors de la création d’un message, une application peut créer une mention dans la même POST requête en incluant la mention dans la propriété mentions . En utilisant une GET demande avec le $filter paramètre de requête, une application peut renvoyer tous les messages dans la boîte aux lettres de l’utilisateur connecté qui mentionnent l’utilisateur. Une GET demande avec le $expand paramètre de requête permet à l’application de développer toutes les mentions dans un message spécifique.
Ce mécanisme de laisser une application définir et obtenir des mentions dans les messages active des notifications légères, où l’utilisateur qui fait la mention peut rester dans le contexte existant (par exemple, composer le corps d’un message) tandis que l’application définit la propriété de mentions sous-jacente. Les personnes mentionnées peuvent facilement savoir si et où elles sont mentionnées à l’aide de demandes GET avec le $filter ou du paramètre de requête $expand.
Par exemple, dans le client de messagerie Outlook, lorsqu’un utilisateur tape @ lors de l’écriture d’un message, Outlook permet à l’utilisateur de sélectionner ou d’entrer un nom pour compléter la @-mention. Outlook définit la propriété mentions avant de créer et d’envoyer le message ou l’événement. Outlook utilise également des GET opérations avec $filter et $expand pour permettre à l’utilisateur connecté de rechercher des messages qui mentionnent l’utilisateur, alertant l’utilisateur sur des actions ou des discussions, ce qui permet une réponse plus rapide.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Publier et envoyer | Aucune | Créez et envoyez des mentions dans le cadre d’un nouveau message. |
| Publier dans un nouveau brouillon | message qui contient un ou plusieurs objets de mention . | Créez un brouillon d’un nouveau message et incluez un ou plusieurs objets de mention . |
| Obtenir des messages me mentionnant | collection message | Obtenez tous les messages de la boîte aux lettres de l’utilisateur connecté qui contiennent une mention de cet utilisateur. |
| Obtenir un message et ses mentions | collection message | Obtenez un message et développez les détails de chaque mention dans le message. |
| Supprimer une mention | Aucune | Supprimez la mention spécifiée dans le message spécifié dans la boîte aux lettres de l’utilisateur connecté. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| application | Chaîne | Nom de l’application où la mention est créée. Optional. Non utilisé et défini par défaut comme null pour le message. |
| clientReference | Chaîne | Identificateur unique représentant un parent de l’instance de ressource. Optional. Non utilisé et défini par défaut comme null pour le message. |
| createdBy | emailAddress | Informations d’e-mail de l’utilisateur qui ont réalisé la mention. |
| createdDateTime | DateTimeOffset | Date et heure auxquelles la mention est créée sur le client. |
| deepLink | Chaîne | Lien Web profond vers le contexte de la mention dans l'instance de ressource. Optional. Non utilisé et défini par défaut comme null pour le message. |
| id | Chaîne | Identifiant unique d’une mention dans une instance de ressource. |
| susmentionné | emailAddress | E-mail d'informations de la personne mentionnée. Obligatoire. |
| mentionText | String | Facultatif. Non utilisé et défini par défaut comme null pour le message. Pour obtenir les mentions dans un message, consultez plutôt la propriété bodyPreview du message. |
| serverCreatedDateTime | DateTimeOffset | Date et heure auxquelles la mention est créée sur le serveur. Optional. Non utilisé et défini par défaut comme null pour le message. |
Relations
Aucun.
Représentation JSON
La représentation JSON suivante montre le type de 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"
}