Compartilhar via

tipo de recurso de notificação (preterido)

  • Artigo

Namespace: microsoft.graph

Importante

A API de notificações do Microsoft Graph está preterida e deixará de retornar dados no final de janeiro de 2022. Para uma experiência de notificação alternativa, confira os Hubs de Notificações do Microsoft Azure e veja esta postagem no blog para obter mais informações.

Representa uma notificação publicada por um servidor de aplicações que visa um utilizador especificado. A notificação é armazenada no Microsoft Graph e é distribuída para diferentes pontos finais de dispositivo pertencentes ao utilizador.

Uma notificação pode ser um payload de notificação visual que pode ser interpretado pelo sistema operativo (plataformas Windows, Android e iOS). Também pode ser um payload de dados (rawContent) que é entregue e processado por clientes de aplicações (incluindo Web), que determinam a experiência de utilizador correspondente em cada dispositivo. Normalmente, trata-se de uma IU de notificação visual, gerada localmente, que corresponde ao conteúdo no payload de dados original.

Quando um utilizador atua numa notificação visual, o cliente da aplicação pode utilizar o SDK de notificações do lado do cliente para atualizar o estado do feed de notificação correspondente no Microsoft Graph, por exemplo, marcando uma notificação como dispensada. Em seguida, a atualização será distribuída para todos os outros pontos finais do cliente da aplicação e os clientes processam a alteração em conformidade, por exemplo, ao dispensar a notificação para impedir que o utilizador veja informações redundantes. Os clientes da aplicação podem aceder ao mesmo recurso de notificação mais tarde antes de expirar (mesmo depois de ser marcado como dispensado), como histórico de notificações, através do SDK de notificação.

Observação

As atualizações de estado de notificação, como lidas ou dispensadas, não serão distribuídas para pontos finais Web. Isto deve-se ao facto de os pushes Web em vários browsers exigirem que as notificações de alerta visual sejam apresentadas a um utilizador. Uma vez que as alterações de estado não têm conteúdos visuais correspondentes, apenas serão apresentadas para notificações destinadas a plataformas Windows, iOS ou Android.

Métodos

Método Tipo de retorno Descrição
Create e enviar uma notificação (preterida) notificação Create e envie uma notificação.

Propriedades

Propriedade Tipo Descrição
targetHostName Cadeia de caracteres Representa o nome de anfitrião da aplicação à qual o serviço de chamada pretende publicar a notificação, para o utilizador especificado. Se filtrar pontos finais Web (ver targetPolicy.platformTypes), certifique-se de que targetHostName é o mesmo que o nome utilizado ao criar uma subscrição no lado do cliente na propriedade JSON da aplicação.
appNotificationId Cadeia de caracteres O ID exclusivo definido pelo servidor de aplicações de uma notificação que é utilizada para identificar e direcionar uma notificação individual.
groupName Cadeia de caracteres O nome do grupo ao qual esta notificação pertence. É definido pelo programador para agrupar notificações.
targetPolicy targetPolicyEndpoints O objeto de política de destino processa a política de entrega de notificações para tipos de pontos finais que devem ser visados (Windows, iOS, Android e WebPush) para o utilizador especificado.
payload payloadTypes Este é o conteúdo de dados de uma notificação de utilizador não processada ou visual que será entregue e consumido pelo cliente da aplicação que recebe esta notificação.
displayTimeToLive Int32 Define durante quanto tempo (em segundos) este conteúdo de notificação permanece no visualizador de notificações de cada plataforma. Por exemplo, quando a notificação é entregue a um dispositivo Windows, o valor desta propriedade é transmitido para ToastNotification.ExpirationTime, que determina quanto tempo a notificação de alerta permanece no Centro de Ação do Windows do utilizador.
expirationDateTime DateTimeOffset Define uma data e hora de expiração UTC numa notificação de utilizador com o formato ISO 8601 (por exemplo, meia-noite UTC a 1 de janeiro de 2019 teria o seguinte aspeto: '2019-01-01T00:00:00Z'). Quando o tempo terminar, a notificação é removida completamente do arquivo de feeds de notificações do Microsoft Graph e já não faz parte do histórico de notificações. O valor máximo é 30 dias.
prioridade string Indica a prioridade de uma notificação de utilizador não processada. As notificações visuais são enviadas com alta prioridade por predefinição. Os valores válidos são None, High e Low.
fallbackPolicy fallbackpolicy O objeto de política de contingência opcional processa a política de contingência de notificação apenas para pontos finais iOS e foi concebido para ser utilizado para notificações não processadas de alta prioridade que podem não ser entregues a dispositivos devido a restrições específicas da plataforma (por exemplo, o modo de poupança de bateria).

Relações

Nenhum

Representação JSON

A representação JSON seguinte mostra o 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"} 
}