Tutorial: Enviar notificações push localizadas para aplicações do Windows com os Hubs de Notificação do Azure

Artigo
06/01/2023

Descrição Geral

Nota

O Serviço de Notificações Push da Microsoft (MPNS) foi preterido e já não é suportado.

Este tutorial mostra-lhe como enviar notificações localizadas para dispositivos móveis registados no serviço Hubs de Notificação. No tutorial, vai atualizar as aplicações criadas em Tutorial: Send notifications to specific devices (Universal Windows Platform) (Tutorial: Enviar notificações para dispositivos específicos [Plataforma Universal do Windows]), de modo a que suportem os seguintes cenários:

A aplicação Loja Windows permite que os dispositivos cliente especifiquem um idioma e subscrevam diferentes categorias de notícias de última hora.
A aplicação de back-end difunde notificações com as funcionalidades de etiqueta e modelo dos Hubs de Notificação do Azure.

Quando concluir o tutorial, a aplicação móvel vai permitir-lhe registar-se em categorias nas quais está interessado, bem como especificar um idioma no qual as notificações vão ser recebidas. A aplicação de back-end envia notificações que estão localizadas por idioma e dispositivo.

Neste tutorial, ficará a saber como:

Atualizar a aplicação do Windows para suportar informações de região
Atualizar a aplicação de back-end para enviar notificações localizadas
Testar a aplicação

Pré-requisitos

Concluir Tutorial: Send notifications to specific devices (Universal Windows Platform) (Tutorial: Enviar notificações para dispositivos específicos [Plataforma Universal do Windows]).

Em Tutorial: Send notifications to specific devices (Universal Windows Platform), compilou uma aplicação que utilizava etiquetas para subscrever notificações para diferentes categorias de notícias. Neste tutorial, vai utilizar a funcionalidade modelo dos Hubs de Notificação para entregar facilmente notificações de notícias de última hora localizadas.

A um nível alto, os modelos são uma forma de especificar o formato no qual um dispositivo específico deverá receber as notificações. O modelo especifica o formato de payload exato ao consultar as propriedades que fazem parte da mensagem enviada pelo back-end da sua aplicação. Neste tutorial, a aplicação de back-end envia uma mensagem independente em termos de região que contém todos os idiomas suportados:

{
    "News_English": "...",
    "News_French": "...",
    "News_Mandarin": "..."
}

Os dispositivos são registados num modelo que consulta a propriedade correta. Por exemplo, se uma aplicação da Loja Windows que pretenda receber uma mensagem de alerta em inglês regista-se no modelo seguinte, com todas as etiquetas correspondentes:

<toast>
    <visual>
    <binding template=\"ToastText01\">
        <text id=\"1\">$(News_English)</text>
    </binding>
    </visual>
</toast>

Para saber mais sobre modelos, veja Modelos Push.

Atualizar a aplicação do Windows para suportar informações de região

Abra a solução do Visual Studio que criou para Tutorial: Send notifications to specific devices (Universal Windows Platform) (Tutorial: Enviar notificações para dispositivos específicos [Plataforma Universal do Windows]).

Atualize o ficheiro da MainPage.xaml solução para incluir uma caixa de combinação de região:

<Grid Margin="120, 58, 120, 80"  
        Background="{StaticResource ApplicationPageBackgroundThemeBrush}">
    <Grid.RowDefinitions>
        <RowDefinition />
        <RowDefinition />
        <RowDefinition />
        <RowDefinition />
        <RowDefinition />
        <RowDefinition />
    </Grid.RowDefinitions>
    <Grid.ColumnDefinitions>
        <ColumnDefinition />
        <ColumnDefinition />
    </Grid.ColumnDefinitions>
    <TextBlock Grid.Row="0" Grid.Column="0" Grid.ColumnSpan="2"  TextWrapping="Wrap" Text="Breaking News" FontSize="42" VerticalAlignment="Top"/>
    <ComboBox Name="Locale" HorizontalAlignment="Left" VerticalAlignment="Center" Width="200" Grid.Row="1" Grid.Column="0">
        <x:String>English</x:String>
        <x:String>French</x:String>
        <x:String>Mandarin</x:String>
    </ComboBox>
    <ToggleSwitch Header="World" Name="WorldToggle" Grid.Row="2" Grid.Column="0"/>
    <ToggleSwitch Header="Politics" Name="PoliticsToggle" Grid.Row="3" Grid.Column="0"/>
    <ToggleSwitch Header="Business" Name="BusinessToggle" Grid.Row="4" Grid.Column="0"/>
    <ToggleSwitch Header="Technology" Name="TechnologyToggle" Grid.Row="2" Grid.Column="1"/>
    <ToggleSwitch Header="Science" Name="ScienceToggle" Grid.Row="3" Grid.Column="1"/>
    <ToggleSwitch Header="Sports" Name="SportsToggle" Grid.Row="4" Grid.Column="1"/>
    <Button Content="Subscribe" HorizontalAlignment="Center" Grid.Row="5" Grid.Column="0" Grid.ColumnSpan="2" Click="SubscribeButton_Click" />
</Grid>

Notifications Na classe , adicione um parâmetro de região aos StoreCategoriesAndSubscribe métodos e SubscribeToCategories .

public async Task<Registration> StoreCategoriesAndSubscribe(string locale, IEnumerable<string> categories)
{
    ApplicationData.Current.LocalSettings.Values["categories"] = string.Join(",", categories);
    ApplicationData.Current.LocalSettings.Values["locale"] = locale;
    return await SubscribeToCategories(locale, categories);
}

public async Task<Registration> SubscribeToCategories(string locale, IEnumerable<string> categories = null)
{
    var channel = await PushNotificationChannelManager.CreatePushNotificationChannelForApplicationAsync();

    if (categories == null)
    {
        categories = RetrieveCategories();
    }

    // Using a template registration. This makes supporting notifications across other platforms much easier.
    // Using the localized tags based on locale selected.
    string templateBodyWNS = String.Format("<toast><visual><binding template=\"ToastText01\"><text id=\"1\">$(News_{0})</text></binding></visual></toast>", locale);

    return await hub.RegisterTemplateAsync(channel.Uri, templateBodyWNS, "localizedWNSTemplateExample", categories);
}

Em vez de chamar o RegisterNativeAsync método , chame RegisterTemplateAsync. Vai registar um formato de notificações específico no qual o modelo depende da região. Vai igualmente indicar um nome para o modelo ("localizedWNSTemplateExample"), porque poderá pretender registar mais de um modelo (por exemplo, um modelo para notificações de alerta e outro para mosaicos). Também tem de dar um nome a esses modelos para atualizá-los ou eliminá-los.

Se um dispositivo registar vários modelos com a mesma etiqueta, o envio de uma mensagem segmentada para essa etiqueta resulta na entrega de múltiplas notificações no dispositivo (uma por cada modelo). Este comportamento é útil em cenários nos quais a mesma mensagem lógica tem de resultar em várias notificações visuais que mostrem, por exemplo, um distintivo e um alerta a uma aplicação da Loja Windows.

Adicione o seguinte método para obter a região armazenada:

public string RetrieveLocale()
{
    var locale = (string) ApplicationData.Current.LocalSettings.Values["locale"];
    return locale != null ? locale : "English";
}

MainPage.xaml.cs No ficheiro, atualize o processador de cliques do botão para obter o valor atual da caixa de combinação Região e forneça-o à chamada para a Notifications classe:

private async void SubscribeButton_Click(object sender, RoutedEventArgs e)
{
    var locale = (string)Locale.SelectedItem;

    var categories = new HashSet<string>();
    if (WorldToggle.IsOn) categories.Add("World");
    if (PoliticsToggle.IsOn) categories.Add("Politics");
    if (BusinessToggle.IsOn) categories.Add("Business");
    if (TechnologyToggle.IsOn) categories.Add("Technology");
    if (ScienceToggle.IsOn) categories.Add("Science");
    if (SportsToggle.IsOn) categories.Add("Sports");

    var result = await ((App)Application.Current).notifications.StoreCategoriesAndSubscribe(locale,
            categories);

    var dialog = new MessageDialog("Locale: " + locale + " Subscribed to: " + 
        string.Join(",", categories) + " on registration Id: " + result.RegistrationId);
    dialog.Commands.Add(new UICommand("OK"));
    await dialog.ShowAsync();
}

Por fim, no App.xaml.cs ficheiro, atualize o InitNotificationsAsync método para obter a região e utilizá-la ao subscrever:

private async void InitNotificationsAsync()
{
    var result = await notifications.SubscribeToCategories(notifications.RetrieveLocale());

    // Displays the registration ID so you know it was successful
    if (result.RegistrationId != null)
    {
        var dialog = new MessageDialog("Registration successful: " + result.RegistrationId);
        dialog.Commands.Add(new UICommand("OK"));
        await dialog.ShowAsync();
    }
}

Executar a aplicação UWP

Execute a aplicação Plataforma Universal do Windows. Aguarde até ver a mensagem Registration successful (Registo bem-sucedido).
Selecione as categorias e a região, e clique em Subscribe (Subscrever). A aplicação converte as categorias selecionadas em etiquetas e pede um novo registo do dispositivo para as etiquetas selecionadas ao hub de notificação.
Verá uma mensagem de confirmação sobre as subscrições.

Atualizar a aplicação de consola para enviar notificações localizadas

Quando envia notificações de modelos, só tem de indicar um conjunto de propriedades. Neste tutorial, a aplicação de back-end envia o conjunto de propriedades que contêm a versão localizada das notícias atuais, por exemplo:

{
    "News_English": "World News in English!",
    "News_French": "World News in French!",
    "News_Mandarin": "World News in Mandarin!"
}

Nesta secção, vai atualizar o projeto de aplicação de consola na solução. Modifique o método SendTemplateNotificationAsync na aplicação de consola que criou anteriormente com o seguinte código:

Importante

Especifique o nome e a cadeia de ligação com acesso total ao seu hub de notificações no código.

private static async void SendTemplateNotificationAsync()
{
    // Define the notification hub.
    NotificationHubClient hub = NotificationHubClient.CreateClientFromConnectionString(
        "<connection string with full access>", "<hub name>");

    // Sending the notification as a template notification. All template registrations that contain
    // "messageParam" or "News_<local selected>" and the proper tags will receive the notifications.
    // This includes APNS, FCM, WNS, and MPNS template registrations.
    Dictionary<string, string> templateParams = new Dictionary<string, string>();

    // Create an array of breaking news categories.
    var categories = new string[] { "World", "Politics", "Business", "Technology", "Science", "Sports"};
    var locales = new string[] { "English", "French", "Mandarin" };

    foreach (var category in categories)
    {
        templateParams["messageParam"] = "Breaking " + category + " News!";

        // Sending localized News for each tag too...
        foreach( var locale in locales)
        {
            string key = "News_" + locale;

            // Your real localized news content would go here.
            templateParams[key] = "Breaking " + category + " News in " + locale + "!";
        }

        await hub.SendTemplateNotificationAsync(templateParams, category);
    }
}

Esta chamada simples fornece a notícia localizada a todos os dispositivos, independentemente da plataforma, à medida que o Hub de Notificação cria e entrega o payload nativo correto a todos os dispositivos subscritos a uma etiqueta específica.

Executar a aplicação de consola para enviar uma notificação localizada

Execute a aplicação de consola para enviar notificações para cada categoria e em cada idioma suportado. Verifique se só recebe uma notificação para as categorias que subscreveu e que a mensagem se destina à região que selecionou.

Mensagens de notificação

Passos seguintes

Neste tutorial, aprendeu a enviar notificações localizadas para dispositivos específicos que têm etiquetas associadas aos respetivos registos. Para saber como enviar notificações para utilizadores específicos que podem utilizar vários dispositivos, avance para o tutorial seguinte:

Enviar notificações push para utilizadores específicos

Partilhar via