Compartir a través de


tipo de recurso notification (en desuso)

Espacio de nombres: microsoft.graph

Importante

La API de notificaciones de Microsoft Graph está en desuso y dejará de devolver datos a finales de enero de 2022. Para obtener una experiencia de notificación alternativa, consulte Microsoft Azure Notification Hubs y esta entrada de blog para más información.

Representa una notificación publicada por un servidor de aplicaciones que tiene como destino un usuario especificado. La notificación se almacena en Microsoft Graph y se distribuye a distintos puntos de conexión de dispositivo propiedad del usuario.

Una notificación puede ser una carga de notificación visual que puede interpretar el sistema operativo (plataformas Windows, Android e iOS). También puede ser una carga de datos (rawContent) que se entrega a los clientes de la aplicación (incluida la web) y la controla, que luego determina la experiencia de usuario correspondiente en cada dispositivo. Normalmente se trata de una interfaz de usuario de notificación visual, generada localmente, que corresponde al contenido de la carga de datos original.

Cuando un usuario actúa en una notificación visual, el cliente de la aplicación puede usar el SDK de notificaciones del lado cliente para actualizar el estado de la fuente de notificaciones correspondiente en Microsoft Graph, por ejemplo, marcando una notificación como descartada. A continuación, la actualización se distribuirá a todos los demás puntos de conexión de cliente de la aplicación y los clientes controlarán el cambio en consecuencia, por ejemplo, descartando la notificación para evitar que el usuario vea información redundante. Los clientes de la aplicación pueden acceder al mismo recurso de notificación más adelante antes de que expire (incluso después de que se marque como descartado) como historial de notificaciones, a través del SDK de notificaciones.

Nota:

Las actualizaciones de estado de notificación, como las leídas o descartadas, no se enviarán a los puntos de conexión web. Esto se debe a que las inserciones web en varios exploradores requieren que las notificaciones del sistema visual se muestren a un usuario. Dado que los cambios de estado no tienen contenido visual correspondiente, solo se distribuirán para las notificaciones destinadas a plataformas Windows, iOS o Android.

Métodos

Método Tipo de valor devuelto Description
Create y enviar una notificación (en desuso) Notificación Create y envíe una notificación.

Propiedades

Propiedad Tipo Description
targetHostName Cadena Representa el nombre de host de la aplicación en la que el servicio que realiza la llamada quiere publicar la notificación para el usuario especificado. Si tiene como destino puntos de conexión web (vea targetPolicy.platformTypes), asegúrese de que targetHostName sea el mismo que el nombre usado al crear una suscripción en el lado cliente dentro de la propiedad JSON de la aplicación.
appNotificationId Cadena Identificador único establecido por el servidor de aplicaciones de una notificación que se usa para identificar y dirigirse a una notificación individual.
Groupname Cadena Nombre del grupo al que pertenece esta notificación. El desarrollador lo establece para agrupar las notificaciones.
targetPolicy targetPolicyEndpoints El objeto de directiva de destino controla la directiva de entrega de notificaciones para los tipos de punto de conexión que deben tener como destino (Windows, iOS, Android y WebPush) para el usuario determinado.
carga útil payloadTypes Este es el contenido de datos de una notificación de usuario sin procesar o visual que el cliente de la aplicación que recibe esta notificación recibirá y consumirá.
displayTimeToLive Int32 Establece cuánto tiempo (en segundos) permanece este contenido de notificación en el visor de notificaciones de cada plataforma. Por ejemplo, cuando la notificación se entrega a un dispositivo Windows, el valor de esta propiedad se pasa a ToastNotification.ExpirationTime, que determina cuánto tiempo permanece la notificación del sistema en el Centro de acciones de Windows del usuario.
expirationDateTime DateTimeOffset Establece una fecha y hora de expiración UTC en una notificación de usuario con el formato ISO 8601 (por ejemplo, medianoche UTC el 1 de enero de 2019 tendría el siguiente aspecto: '2019-01-01T00:00:00Z'). Cuando se ha terminado el tiempo, la notificación se quita completamente del almacén de fuentes de notificaciones de Microsoft Graph y ya no forma parte del historial de notificaciones. El valor máximo es de 30 días.
priority string Indica la prioridad de una notificación de usuario sin procesar. Las notificaciones visuales se envían con prioridad alta de forma predeterminada. Los valores válidos son None, High y Low.
fallbackPolicy fallbackpolicy El objeto de directiva de reserva opcional controla la directiva de reserva de notificaciones solo para puntos de conexión de iOS y está diseñado para usarse para notificaciones sin procesar de alta prioridad que podrían no entregarse a los dispositivos debido a restricciones específicas de la plataforma (por ejemplo, el modo de ahorro de batería).

Relaciones

Ninguna.

Representación JSON

La siguiente representación JSON muestra el tipo de recurso.

{
  "targetHostName": "String",
  "appNotificationId": "String (identifier)",
  "groupName": "String", 
  "targetPolicy": {"@odata.type": "microsoft.graph.targetPolicyEndpoints"},
  "payload": {"@odata.type": "microsoft.graph.payloadTypes"},
  "displayTimeToLive": 1024,
  "expirationDateTime": "String (timestamp)",
  "priority": "string",
  "fallbackPolicy": {"@odata.type": "microsoft.graph.fallbackpolicy"} 
}