tipo de recurso de notificação (preterido)

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 aplicativo que tem como destino um usuário especificado. A notificação é armazenada no Microsoft Graph e é distribuída para diferentes pontos de extremidade do dispositivo pertencentes ao usuário.

Uma notificação pode ser uma carga de notificação visual que pode ser interpretada pelo sistema operacional (plataformas Windows, Android e iOS). Ele também pode ser uma carga de dados (rawContent) entregue e manipulada por clientes de aplicativo (incluindo a Web), que determina a experiência correspondente do usuário em cada dispositivo. Geralmente, essa é uma interface do usuário de notificação visual, gerada localmente, que corresponde ao conteúdo na carga de dados original.

Quando um usuário atua em uma notificação visual, o cliente do aplicativo pode usar 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 descartada. Em seguida, a atualização será distribuída para todos os outros pontos de extremidade do cliente do aplicativo e os clientes lidam com a alteração de acordo, por exemplo, descartando a notificação para impedir que o usuário veja informações redundantes. Os clientes de aplicativo podem acessar o mesmo recurso de notificação posteriormente antes de expirar (mesmo depois de marcado como descartado), como histórico de notificação, por meio do SDK de notificação.

Observação

As atualizações de estado de notificação, como leitura ou dispensada, não serão exibidas em pontos de extremidade da Web. Isso ocorre porque os pushes da Web em vários navegadores exigem que as notificações de brinde visual sejam exibidas para um usuário. Como as alterações de estado não têm conteúdo visual correspondente, elas só serão alardeadas para notificações direcionadas a plataformas Windows, iOS ou Android.

Métodos

Método	Tipo de retorno	Descrição
Criar notificação	Notificação	Crie e envie uma notificação.

Propriedades

Propriedade	Tipo	Descrição
targetHostName	Cadeia de caracteres	Representa o nome do host do aplicativo ao qual o serviço de chamada deseja postar a notificação para o usuário fornecido. Se estiver direcionando pontos de extremidade da Web (consulte targetPolicy.platformTypes), verifique se targetHostName é o mesmo que o nome usado ao criar uma assinatura no lado do cliente na propriedade JSON do aplicativo.
appNotificationId	Cadeia de caracteres	A ID exclusiva definida pelo servidor de aplicativo de uma notificação que é usada para identificar e direcionar uma notificação individual.
Groupname	Cadeia de caracteres	O nome do grupo ao qual essa notificação pertence. Ele é definido pelo desenvolvedor para agrupar notificações.
targetPolicy	targetPolicyEndpoints	O objeto de política de destino manipula a política de entrega de notificação para tipos de ponto de extremidade que devem ser direcionados (Windows, iOS, Android e WebPush) para o usuário fornecido.
payload	payloadTypes	Esse é o conteúdo de dados de uma notificação bruta ou visual do usuário que será entregue e consumida pelo cliente do aplicativo que recebe essa notificação.
displayTimeToLive	Int32	Define quanto tempo (em segundos) esse conteúdo de notificação permanece no visualizador de notificação de cada plataforma. Por exemplo, quando a notificação é entregue a um dispositivo Windows, o valor dessa propriedade é passado para ToastNotification.ExpirationTime, que determina quanto tempo a notificação do toast permanece no Centro de Ação windows do usuário.
expirationDateTime	DateTimeOffset	Define uma data e hora de validade utc em uma notificação do usuário usando o formato ISO 8601 (por exemplo, meia-noite UTC em 1º de janeiro de 2019 seria assim: '2019-01-01T00:00:00Z'). Quando o tempo acaba, a notificação é removida do repositório de feeds de notificação do Microsoft Graph completamente e não faz mais parte do histórico de notificação. O valor máximo é de 30 dias.
prioridade	cadeia de caracteres	Indica a prioridade de uma notificação bruta do usuário. As notificações visuais são enviadas com alta prioridade por padrão. Os valores válidos são None, High e Low.
fallbackPolicy	fallbackpolicy	O objeto de política de fallback opcional manipula apenas a política de fallback de notificação para pontos de extremidade iOS e foi projetado para ser usado para notificações brutas de alta prioridade que podem não ser entregues a dispositivos devido a restrições específicas da plataforma (por exemplo, modo de economia de bateria).

Relações

Nenhum

Representação JSON

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