Coleções de notificações de aplicativos

Use coleções para organizar as notificações do aplicativo no Centro de Notificação. As coleções ajudam os usuários a localizar informações com mais facilidade e permitem que os desenvolvedores gerenciem melhor suas notificações.

Um aplicativo de mensagens, por exemplo, pode separar notificações por grupo de chat. Cada título de grupo ("Comp Sci 160A Project Chat", "Direct Messages", "Lacrosse Team Chat") é uma coleção separada. As notificações são agrupadas como se fossem de um aplicativo separado, mesmo que todas venham do mesmo aplicativo. Para obter uma maneira mais sutil de organizar notificações, consulte os cabeçalhos de notificação do aplicativo.

Observação

Os exemplos de código neste artigo usam o namespace Microsoft.Windows.AppNotifications para criar conteúdo de notificação e o namespace Windows.UI.Notifications para gerenciamento de coleção. Esses dois namespaces podem ser usados juntos no mesmo aplicativo.

Para obter mais informações sobre notificações do aplicativo, consulte a visão geral das notificações do aplicativo.

Criar uma coleção

Ao criar uma coleção, forneça um nome de exibição e um ícone, que são mostrados na Central de Notificação como parte do título da coleção. As coleções também exigem um argumento de inicialização para que seu aplicativo possa navegar até o local certo quando o usuário clicar no título da coleção. Crie a coleção chamando SaveToastCollectionAsync.

using Windows.UI.Notifications;

var collection = new ToastCollection(
    "MyToastCollection",
    "Work Email",
    "NavigateToWorkEmailInbox",
    new Uri("ms-appx:///Assets/workEmail.png"));

await ToastNotificationManager.GetDefault()
    .GetToastCollectionManager()
    .SaveToastCollectionAsync(collection);

Enviar uma notificação para uma coleção

Use AppNotificationBuilder para construir o conteúdo da notificação e, em seguida, chame GetToastNotifierForToastCollectionIdAsync para obter um notificador escopado para a coleção.

using Microsoft.Windows.AppNotifications.Builder;
using Windows.UI.Notifications;
using Windows.Data.Xml.Dom;

// Build notification content with Windows App SDK
var payload = new AppNotificationBuilder()
    .AddText("Adam sent a message to the group")
    .BuildNotification()
    .Payload;

// Deliver to a collection using the WinRT API
var doc = new XmlDocument();
doc.LoadXml(payload);
var toast = new ToastNotification(doc);

var notifier = await ToastNotificationManager.GetDefault()
    .GetToastNotifierForToastCollectionIdAsync("MyToastCollection");
notifier.Show(toast);

Listar todas as coleções

Recupere todas as coleções criadas para seu aplicativo chamando FindAllToastCollectionsAsync.

var collectionManager = ToastNotificationManager.GetDefault().GetToastCollectionManager();
var collections = await collectionManager.FindAllToastCollectionsAsync();

Atualizar uma coleção

Atualize uma coleção criando uma nova instância toastCollection com a mesma ID e chamando SaveToastCollectionAsync.

var collectionManager = ToastNotificationManager.GetDefault().GetToastCollectionManager();

var updatedCollection = new ToastCollection(
    "MyToastCollection",
    "Updated Display Name",
    "UpdatedLaunchArgs",
    new Uri("ms-appx:///Assets/updatedPicture.png"));

await collectionManager.SaveToastCollectionAsync(updatedCollection);

Remover uma coleção

Remova uma coleção chamando RemoveToastCollectionAsync com a ID da coleção. Todas as notificações na coleção também são removidas da Central de Notificação.

var collectionManager = ToastNotificationManager.GetDefault().GetToastCollectionManager();
await collectionManager.RemoveToastCollectionAsync("MyToastCollection");

Remover notificações em uma coleção

Use as propriedades Marca e Grupo para identificar e remover notificações individuais em uma coleção chamando Remover ou limpar todas as notificações de uma só vez com Limpar.

var collectionHistory = await ToastNotificationManager.GetDefault()
    .GetHistoryForToastCollectionAsync("MyToastCollection");

// Remove a specific notification
collectionHistory.Remove(tag, group);

// Or clear all notifications in the collection
collectionHistory.Clear();

Consulte também

• Visão geral das notificações do aplicativo