Barra de progresso da notificação do aplicativo e associação de dados

O uso de uma barra de progresso dentro da notificação do aplicativo permite que você transmita o status de operações de execução longa para o usuário, como downloads, renderização de vídeo, metas de exercício e muito mais.

Uma barra de progresso dentro de uma notificação de aplicativo pode ser "indeterminada" (nenhum valor específico, os ponto animados indicam que uma operação está ocorrendo) ou "determinante" (um percentual específico da barra é preenchido, como 60%).

A imagem abaixo mostra uma barra de progresso determinante com todas as suas propriedades correspondentes rotuladas.

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

Use AppNotificationBuilder.AddProgressBar para adicionar uma barra de progresso à notificação. O exemplo a seguir gera a notificação mostrada acima.

var builder = new AppNotificationBuilder()
    .AddText("Downloading your weekly playlist...")
    .AddProgressBar(new AppNotificationProgressBar()
        .SetTitle("Weekly playlist")
        .SetValue(0.6)
        .SetValueStringOverride("15/26 songs")
        .SetStatus("Downloading..."));

Para atualizar dinamicamente os valores da barra de progresso, use a associação de dados conforme descrito na próxima seção.

Atualizar uma barra de progresso com associação de dados

Para exibir uma barra de progresso ao vivo, use a associação de dados para atualizar os valores de notificação sem enviar novamente toda a notificação.

1. Construa o conteúdo da notificação com campos associados a dados chamando os Bind métodos em AppNotificationProgressBar.
2. Atribua uma marca (e, opcionalmente, um grupo) para identificar a notificação.
3. Defina os valores iniciais de AppNotificationProgressData .
4. Mostre a notificação chamando AppNotificationManager.Default.Show.

using Microsoft.Windows.AppNotifications;
using Microsoft.Windows.AppNotifications.Builder;

string tag = "weekly-playlist";
string group = "downloads";

var builder = new AppNotificationBuilder()
    .AddText("Downloading your weekly playlist...")
    .AddProgressBar(new AppNotificationProgressBar()
        .BindTitle()
        .BindValue()
        .BindValueStringOverride()
        .BindStatus());

var notification = builder.BuildNotification();
notification.Tag = tag;
notification.Group = group;

notification.Progress = new AppNotificationProgressData(1)
{
    Title = "Weekly playlist",
    Value = 0.6,
    ValueStringOverride = "15/26 songs",
    Status = "Downloading..."
};

AppNotificationManager.Default.Show(notification);

Em seguida, atualize os valores de progresso chamando AppNotificationManager.Default.UpdateAsync com uma nova instância AppNotificationProgressData . Incremente o número de sequência para que a plataforma saiba que essa é uma atualização mais recente.

using Microsoft.Windows.AppNotifications;

string tag = "weekly-playlist";
string group = "downloads";

var data = new AppNotificationProgressData(2)
{
    Value = 0.7,
    ValueStringOverride = "18/26 songs"
};

await AppNotificationManager.Default.UpdateAsync(data, tag, group);

Usar UpdateAsync em vez de substituir toda a notificação garante que a notificação permaneça na mesma posição na Central de Notificação e não se mova para cima ou para baixo. O método retorna um NotificationUpdateResult que indica se a atualização foi bem-sucedida ou se a notificação não pôde ser encontrada (o usuário pode tê-la ignorado).

Elementos que dão suporte à associação de dados

Os seguintes elementos nas notificações do aplicativo dão suporte à associação de dados:

• Todas as propriedades em AppNotificationProgressBar
• A propriedade Text nos elementos de texto de nível superior

Atualizar ou substituir uma notificação

Você pode substituir uma notificação enviando uma nova notificação pela mesma Marca e Grupo. A tabela a seguir descreve a diferença entre substituir e atualizar uma notificação.

Em geral, a atualização é útil para informações que são alteradas com frequência e não exigem a atenção imediata do usuário, como o progresso mudando de 50% para 65%.

Após a conclusão da sequência de atualizações (por exemplo, um arquivo terminou de baixar), considere substituir a notificação para a etapa final porque:

• A notificação final provavelmente tem layout diferente, como remoção da barra de progresso ou adição de novos botões.
• O usuário pode ter descartado a notificação de progresso, mas ainda deseja ver um pop-up quando a operação for concluída.

Consulte também

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