tipo de recurso mention
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Representa una notificación a una persona en función de la dirección de correo electrónico de la persona. Este tipo de notificación también se conoce como @-menciones.
El recurso de mensaje admite la mención. Incluye una propiedad mentionsPreview que indica si el usuario que ha iniciado sesión se menciona en esa instancia de mensaje. También incluye la propiedad de navegación menciones , que admite la obtención de detalles de una mención o la eliminación de una mención en esa instancia.
Al crear un mensaje, una aplicación puede crear una mención en la misma POST solicitud incluyendo la mención en la propiedad mentions . Con una GET solicitud con el $filter parámetro de consulta, una aplicación puede devolver todos los mensajes del buzón del usuario que ha iniciado sesión que mencionan al usuario. Una GET solicitud con el parámetro de $expand consulta permite a la aplicación expandir todas las menciones de un mensaje específico.
Este mecanismo de permitir que una aplicación establezca y obtenga menciones en los mensajes permite notificaciones ligeras, donde el usuario que realiza la mención puede permanecer en el contexto existente (por ejemplo, redactar un cuerpo del mensaje) mientras la aplicación establece la propiedad de menciones subyacente. Las personas mencionadas pueden averiguar fácilmente si y dónde se mencionan a través GET de solicitudes con el $filter parámetro de consulta o $expand .
Por ejemplo, en el cliente de correo de Outlook, cuando un usuario escribe @ mientras escribe un mensaje, Outlook permite al usuario seleccionar o escribir un nombre para completar la @mención. Outlook establece la propiedad mentions antes de crear y enviar el mensaje o evento. Outlook también usa GET operaciones con $filter y $expand para permitir que el usuario que ha iniciado sesión busque mensajes que mencionen al usuario, lo que alerta al usuario de elementos de acción o discusiones, lo que permite una respuesta más rápida.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| Publicar y enviar | Ninguno | Cree y envíe menciones como parte de un mensaje nuevo. |
| Publicación en un nuevo borrador | mensaje que contiene uno o varios objetos de mención . | Cree un borrador de un mensaje nuevo e incluya uno o varios objetos de mención . |
| Obtener mensajes que me mencionen | Colección message | Obtenga todos los mensajes del buzón del usuario que ha iniciado sesión que contienen una mención de este usuario. |
| Obtener un mensaje y sus menciones | Colección message | Obtenga un mensaje y expanda los detalles de cada mención en el mensaje. |
| Eliminar una mención | Ninguno | Elimine la mención especificada en el mensaje especificado en el buzón del usuario que ha iniciado sesión. |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| aplicación | Cadena | Nombre de la aplicación donde se crea la mención. Opcional. No se usa y se establece de forma predeterminada como null para el mensaje. |
| clientReference | Cadena | Identificador único que representa un elemento primario de la instancia de recurso. Opcional. No se usa y se establece de forma predeterminada como null para el mensaje. |
| createdBy | emailAddress | La información de correo electrónico del usuario que hizo la mención. |
| createdDateTime | DateTimeOffset | Fecha y hora en que se crea la mención en el cliente. |
| deepLink | Cadena | Vínculo web profundo al contexto de la mención en la instancia de recurso. Opcional. No se usa y se establece de forma predeterminada como null para el mensaje. |
| id | Cadena | Identificador único de una mención en una instancia de recurso. |
| susodicho | emailAddress | La información de correo electrónico de la persona mencionada. Obligatorio. |
| mentionText | Cadena | Opcional. No se usa y se establece de forma predeterminada como null para el mensaje. Para obtener las menciones en un mensaje, vea la propiedad bodyPreview del mensaje en su lugar. |
| serverCreatedDateTime | DateTimeOffset | Fecha y hora en que se crea la mención en el servidor. Opcional. No se usa y se establece de forma predeterminada como null para el mensaje. |
Relaciones
Ninguna.
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"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"
}