Início Rápido: Notificações por push no SDK do Aplicativo do Windows

Neste início rápido, você criará um aplicativo para desktop do Windows que envia e recebe notificações push usando o Windows App SDK .

Prerequisites

• começar a desenvolver aplicativos do Windows
• Criar um novo projeto que usa o SDK de Aplicativos do Windows OU Usar o SDK do Aplicativo do Windows em um projeto existente
• Um Conta do Azure é necessário para usar notificações push do Windows App SDK.
• Leia a visão geral das notificações por push

Aplicativo de exemplo

Este guia de início rápido explica como adicionar suporte a notificações por push ao seu aplicativo no SDK do Aplicativo do Windows 1.7. Veja um código semelhante a este início rápido nos aplicativos de exemplo encontrados no GitHub. Verifique a ramificação com sua versão preferencial do SDK do Aplicativo do Windows para obter os exemplos que melhor correspondem ao seu projeto.

Você também pode encontrar exemplos para cada versão do SDK de Aplicativo do Windows selecionando um branch de versão no repositório de exemplos.

Referência de API

Para obter a documentação de referência da API para notificações por push, consulte namespace Microsoft.Windows.PushNotifications.

Configurar a identidade do aplicativo no AAD (Azure Active Directory)

As notificações por push no SDK de Aplicativos do Windows usam identidades do AAD (Azure Active Directory). As credenciais do Azure são necessárias ao solicitar um URI do Canal do WNS e ao solicitar tokens de acesso para enviar notificações por push. Observação: Nós NÃO oferecemos suporte ao uso de notificações por push do SDK do Aplicativo Windows com Microsoft Partner Center.

Etapa 1: Criar um registro de aplicativo do AAD

Faça logon em sua conta do Azure e crie um novo recurso de Registro de Aplicativo do AAD . Selecione Novo registro.

Etapa 2: Informe um nome e selecione uma opção multiusuário

1. Forneça um nome de aplicativo.

2. As notificações por push exigem a opção multilocatário, portanto, selecione-a.

   1. Para obter mais informações sobre locatários, consulte Quem pode entrar em seu aplicativo?.

3. Escolha Registrar

4. Anote o ID de Aplicação (cliente) , pois este é o seu AppId do Azure que você usará durante o registro de ativação e solicitação de token de acesso.

5. Anote sua ID do diretório (locatário), pois este é seu ID do Locatário do Azure que você usará ao solicitar um token de acesso.

   Important

   . Tome nota do ID de aplicativo (cliente) e do ID de diretório (locatário) .

6. Anote oda ID do objeto , pois este é o do Azure ObjectId que você usará ao solicitar uma solicitação de canal. Observe que esta não é a ID do objeto listada na página do Essentials. Em vez disso, para encontrar o ID de Objeto correto, clique no nome do aplicativo no campo "aplicativo gerenciado no diretório local" na página "Essentials" .

   

   captura de tela

   Note

   Uma entidade de serviço é necessária para obter uma ID de Objeto. Se não houver uma associada ao seu aplicativo, siga as etapas em um dos seguintes artigos para criar uma no portal do Azure ou usando a linha de comando.

   Use o portal para criar um aplicativo do Azure AD e uma Entidade de Serviço que possa acessar recursos

   Use o Azure PowerShell para criar uma entidade de serviço com um certificado

Etapa 3: Criar um segredo para o registro do aplicativo

Seu segredo será usado junto com seu Azure AppId/ClientId ao solicitar um token de acesso para enviar notificações por push.

Navegue até Certificados & segredos e selecione Novo segredo do cliente.

Etapa 4: Mapear o Nome da Família de Pacotes do aplicativo para o AppId do Azure

Se o aplicativo estiver empacotado (incluindo empacotamento realizado em uma localização externa), você poderá usar este fluxo para mapear o Nome da Família de Pacotes (PFN) do aplicativo e seu AppId do Azure.

Se seu aplicativo for um aplicativo Win32 empacotado, crie uma solicitação de mapeamento PFN (Nome da Família de Pacotes) enviando um email para Win_App_SDK_Push@microsoft.com com a linha de assunto "Solicitação de Mapeamento de Notificações por Push do SDK do Aplicativo Windows" e o corpo "PFN: [seu PFN]", AppId: [sua AppId], ObjectId: [seu ObjectId]. As solicitações de mapeamento são concluídas semanalmente. Você será notificado após a conclusão da solicitação de mapeamento.

Depois de ter seu Azure AppId, ObjectId e segredo, você poderá adicionar essas credenciais ao código de exemplo abaixo.

Configurar seu aplicativo para receber notificações por push

Etapa 1: Adicionar o SDK do Aplicativo do Windows e os pacotes NuGet necessários

Em seguida, clique com o botão direito do mouse na solução no Gerenciador de Soluções e selecione Gerenciar Pacotes NuGet.

No Gerenciador de Pacotes, adicione os seguintes pacotes:

• Microsoft.WindowsAppSDK (versão mínima 1.1.0)
• Microsoft.Windows.SDK.BuildTools (versão mínima 10.0.22000.194)
• Microsoft.Windows.CppWinRT( versão mínima 2.0.210930.14)
• Microsoft.Windows.ImplementationLibrary( versão mínima 1.0.210930.1)

Se esta for a primeira vez que você estiver usando o SDK do Aplicativo windows em seu projeto e ele for empacotado com local externo ou desempacotado, inicialize o SDK do Aplicativo do Windows adicionando a seguinte propriedade ao arquivo de projeto:

<!-- your .vcxproj or .proj file -->
<PropertyGroup Label="Globals">
    <!-- Other properties -->
    <WindowsPackageType>None</WindowsPackageType>
</PropertyGroup>

ou use a API bootstrapper. Consulte Usar o runtime do SDK do Aplicativo do Windows para aplicativos empacotados com localização externa ou desempacotados para obter mais detalhes.

Etapa 2: Adicionar namespaces

Em seguida, adicione o namespace para notificações por push do SDK de Aplicativo do Microsoft.Windows.PushNotificationsWindows.

#include <winrt/Microsoft.Windows.PushNotifications.h>

using namespace winrt::Microsoft::Windows::PushNotifications;

Se você receber um erro "Não é possível localizar Microsoft.Windows.PushNotifications", isso provavelmente significa que os arquivos de cabeçalho não foram gerados. Para resolver, verifique se você tem os pacotes acima instalados, comente a inclusão e o uso de instruções que causam o erro e recompile o aplicativo para gerar os arquivos de cabeçalho. Depois que o build for bem-sucedido, descompacte a inclusão e o uso de instruções e recompile o projeto. Isso deve resolver o erro.

Etapa 3: Adicionar o ativador COM ao manifesto do aplicativo

Se seu aplicativo estiver empacotado (incluindo empacotado com localização externa): abra seu Package.appxmanifest. Adicione o seguinte dentro do elemento <Application>. Substitua os valores Id, Executablee DisplayName por aqueles específicos ao seu aplicativo.

<!--Packaged apps only-->
<!--package.appxmanifest-->

<Package
  ...
  xmlns:com="http://schemas.microsoft.com/appx/manifest/com/windows10"
  ...
  <Applications>
    <Application>
      ...
      <Extensions>

        <!--Register COM activator-->    
        <com:Extension Category="windows.comServer">
          <com:ComServer>
              <com:ExeServer Executable="SampleApp\SampleApp.exe" DisplayName="SampleApp" Arguments="----WindowsAppRuntimePushServer:">
                <com:Class Id="[Your app's Azure AppId]" DisplayName="Windows App SDK Push" />
            </com:ExeServer>
          </com:ComServer>
        </com:Extension>
    
      </Extensions>
    </Application>
  </Applications>
 </Package>    

Etapa 4: Registrar e responder a notificações por push na inicialização do aplicativo

Atualize o método main() do aplicativo para adicionar o seguinte:

1. Registre seu aplicativo para receber notificações push chamando o PushNotificationManager::Default().Register().
2. Verifique a origem da solicitação de ativação chamando AppInstance::GetCurrent(). GetActivatedEventArgs(). Se a ativação foi disparada de uma notificação por push, responda com base no conteúdo da notificação.

Adicionando manipuladores de eventos em primeiro plano

Para lidar com um evento em primeiro plano, registre um manipulador para PushNotificationManager.PushReceived.

System.Runtime.InteropServices.COMException: Element not found. Must register event handlers before calling Register().

Adicionar a verificação PushNotificationManager::IsSupported()

Em seguida, adicione uma verificação se as APIs PushNotification têm suporte com PushNotificationManager.IsSupported(). Caso contrário, recomendamos que você use sondagem ou sua própria implementação de soquete personalizado.

Agora que há suporte confirmado à notificação por push, adicione o comportamento com base em PushNotificationReceivedEventArgs.

Etapa 5: Solicitar um URI do Canal do WNS e registrá-lo no servidor WNS

Os URIs de canal do WNS são os endpoints HTTP para o envio de notificações push. Cada cliente deve solicitar um URI do Canal e registrá-lo no servidor WNS para receber notificações por push.

auto channelOperation{ PushNotificationManager::Default().CreateChannelAsync(winrt::guid("[Your app's Azure ObjectID]")) };

Se você estiver seguindo o código do tutorial, adicione sua ID de Objeto do Azure aqui:

// To obtain an AAD RemoteIdentifier for your app,
// follow the instructions on https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
winrt::guid remoteId{ "00000000-0000-0000-0000-000000000000" }; // Replace this with your own Azure ObjectId

O PushNotificationManager tentará criar uma URI de canal, repetindo automaticamente por no máximo 15 minutos. Crie um manipulador de eventos para aguardar a conclusão da chamada. Depois que a chamada for concluída, se tiver sido bem-sucedida, registre o URI com o servidor WNS.

Código de exemplo

#include <iostream>
#include <winrt/Microsoft.Windows.PushNotifications.h>
#include <winrt/Windows.Foundation.h>
#include <winrt/Microsoft.Windows.AppLifecycle.h>
#include <winrt/Windows.ApplicationModel.Background.h>
#include <wil/cppwinrt.h>
#include <wil/result.h>

using namespace winrt::Microsoft::Windows::PushNotifications;
using namespace winrt::Windows::Foundation;
using namespace winrt::Microsoft::Windows::AppLifecycle;

// To obtain an AAD RemoteIdentifier for your app,
// follow the instructions on https://learn.microsoft.com/azure/active-directory/develop/quickstart-register-app
winrt::guid remoteId{ "00000000-0000-0000-0000-000000000000" }; // Replace this with your own Azure ObjectId

winrt::Windows::Foundation::IAsyncOperation<PushNotificationChannel> RequestChannelAsync()
{
    auto channelOperation = PushNotificationManager::Default().CreateChannelAsync(remoteId);

    // Set up the in-progress event handler
    channelOperation.Progress(
        [](auto&& sender, auto&& args)
        {
            if (args.status == PushNotificationChannelStatus::InProgress)
            {
                // This is basically a noop since it isn't really an error state
                std::cout << "Channel request is in progress." << std::endl << std::endl;
            }
            else if (args.status == PushNotificationChannelStatus::InProgressRetry)
            {
                LOG_HR_MSG(
                    args.extendedError,
                    "The channel request is in back-off retry mode because of a retryable error! Expect delays in acquiring it. RetryCount = %d",
                    args.retryCount);
            }
        });

    auto result = co_await channelOperation;

    if (result.Status() == PushNotificationChannelStatus::CompletedSuccess)
    {
        auto channelUri = result.Channel().Uri();

        std::cout << "channelUri: " << winrt::to_string(channelUri.ToString()) << std::endl << std::endl;

        auto channelExpiry = result.Channel().ExpirationTime();

        // Caller's responsibility to keep the channel alive
        co_return result.Channel();
    }
    else if (result.Status() == PushNotificationChannelStatus::CompletedFailure)
    {
        LOG_HR_MSG(result.ExtendedError(), "We hit a critical non-retryable error with channel request!");
        co_return nullptr;
    }
    else
    {
        LOG_HR_MSG(result.ExtendedError(), "Some other failure occurred.");
        co_return nullptr;
    }

};

PushNotificationChannel RequestChannel()
{
    auto task = RequestChannelAsync();
    if (task.wait_for(std::chrono::seconds(300)) != AsyncStatus::Completed)
    {
        task.Cancel();
        return nullptr;
    }

    auto result = task.GetResults();
    return result;
}

void SubscribeForegroundEventHandler()
{
    winrt::event_token token{ PushNotificationManager::Default().PushReceived([](auto const&, PushNotificationReceivedEventArgs const& args)
    {
        auto payload{ args.Payload() };

        std::string payloadString(payload.begin(), payload.end());
        std::cout << "\nPush notification content received in the FOREGROUND: " << payloadString << std::endl;
    }) };

    std::cout << "Push notification foreground event handler registered." << std::endl;
}

int main()
{
    // Set up an event handler, so we can receive notifications in the foreground while the app is running.
    // You must register notification event handlers before calling Register(). Otherwise, the following runtime
    // exception will be thrown: System.Runtime.InteropServices.COMException: 'Element not found. Must register
    // event handlers before calling Register().'
    SubscribeForegroundEventHandler();

    // Register the app for push notifications.
    PushNotificationManager::Default().Register();

    auto args{ AppInstance::GetCurrent().GetActivatedEventArgs() };
    switch (args.Kind())
    {
        case ExtendedActivationKind::Launch:
        {
            std::cout << "App launched by user or from the debugger." << std::endl;
            if (PushNotificationManager::IsSupported())
            {
                std::cout << "Push notifications are supported on this device." << std::endl;

                // Request a WNS Channel URI which can be passed off to an external app to send notifications to.
                // The WNS Channel URI uniquely identifies this app for this user and device.
                PushNotificationChannel channel{ RequestChannel() };
                if (!channel)
                {
                    std::cout << "\nThere was an error obtaining the WNS Channel URI" << std::endl;

                    if (remoteId == winrt::guid{ "00000000-0000-0000-0000-000000000000" })
                    {
                        std::cout << "\nThe ObjectID has not been set. Refer to the readme file accompanying this sample\nfor the instructions on how to obtain and setup an ObjectID" << std::endl;
                    }
                }

                std::cout << "\nPress 'Enter' at any time to exit App." << std::endl;
                std::cin.ignore();
            }
            else
            {
                std::cout << "Push notifications are NOT supported on this device." << std::endl;
                std::cout << "App implements its own custom socket here to receive messages from the cloud since Push APIs are unsupported." << std::endl;
                std::cin.ignore();
            }
        }
        break;

        case ExtendedActivationKind::Push:
        {
            std::cout << "App activated via push notification." << std::endl;
            PushNotificationReceivedEventArgs pushArgs{ args.Data().as<PushNotificationReceivedEventArgs>() };

            // Call GetDeferral to ensure that code runs in low power
            auto deferral{ pushArgs.GetDeferral() };

            auto payload{ pushArgs.Payload() };

            // Do stuff to process the raw notification payload
            std::string payloadString(payload.begin(), payload.end());
            std::cout << "\nPush notification content received in the BACKGROUND: " << payloadString.c_str() << std::endl;
            std::cout << "\nPress 'Enter' to exit the App." << std::endl;

            // Call Complete on the deferral when finished processing the payload.
            // This removes the override that kept the app running even when the system was in a low power mode.

            deferral.Complete();
            std::cin.ignore();
        }
        break;

        default:
            std::cout << "\nUnexpected activation type" << std::endl;
            std::cout << "\nPress 'Enter' to exit the App." << std::endl;
            std::cin.ignore();
            break;
    }
}

Etapa 6: Criar e instalar seu aplicativo

Use o Visual Studio para criar e instalar seu aplicativo. Clique com o botão direito do mouse no arquivo de solução no Gerenciador de Soluções e selecione Implantar. O Visual Studio criará seu aplicativo e o instalará em seu computador. Você pode executar o aplicativo iniciando-o por meio do Menu Iniciar ou do depurador do Visual Studio.

O console do código do tutorial terá esta aparência:

Você precisará do token para enviar uma notificação por push ao seu aplicativo.

Enviar uma notificação por push para seu aplicativo

Neste ponto, toda a configuração está concluída e o servidor WNS pode enviar notificações por push para aplicativos cliente. Nas etapas a seguir, consulte os cabeçalhos de solicitação e resposta do servidor de notificação por push para obter mais detalhes.

Etapa 1: Solicitar um token de acesso

Para enviar uma notificação por push, primeiro o servidor WNS precisa solicitar um token de acesso. Envie uma solicitação HTTP POST com sua TenantId do Azure, a Azure AppId e o segredo. Para obter informações sobre como recuperar o Azure TenantId e o Azure AppId, consulte Obter valores de ID de locatário e de aplicativo para entrar no.

Solicitação de exemplo HTTP:

POST /{tenantID}/oauth2/v2.0/token Http/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 160

grant_type=client_credentials&client_id=<Azure_App_Registration_AppId_Here>&client_secret=<Azure_App_Registration_Secret_Here>&scope=https://wns.windows.com/.default/

Solicitação de exemplo do C#:

//Sample C# Access token request
var client = new RestClient("https://login.microsoftonline.com/{tenantID}/oauth2/v2.0");
var request = new RestRequest("/token", Method.Post);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("grant_type", "client_credentials");
request.AddParameter("client_id", "[Your app's Azure AppId]");
request.AddParameter("client_secret", "[Your app's secret]");
request.AddParameter("scope", "https://wns.windows.com/.default");
RestResponse response = await client.ExecutePostAsync(request);
Console.WriteLine(response.Content);

Se sua solicitação for bem-sucedida, você receberá uma resposta que contém seu token no campo access_token.

{
    "token_type":"Bearer",
    "expires_in":"86399",
    "ext_expires_in":"86399",
    "expires_on":"1653771789",
    "not_before":"1653685089",
    "access_token":"[your access token]"
}

Etapa 2. Enviar uma notificação bruta

Crie uma solicitação HTTP POST que contenha o token de acesso obtido na etapa anterior e o conteúdo da notificação por push que você deseja enviar. O conteúdo da notificação por push será entregue ao aplicativo.

POST /?token=[The token query string parameter from your channel URL. E.g. AwYAAABa5cJ3...] HTTP/1.1
Host: dm3p.notify.windows.com
Content-Type: application/octet-stream
X-WNS-Type: wns/raw
Authorization: Bearer [your access token]
Content-Length: 46

{ Sync: "Hello from the Contoso App Service" }

var client = new RestClient("[Your channel URL. E.g. https://wns2-by3p.notify.windows.com/?token=AwYAAABa5cJ3...]");
var request = new RestRequest();
request.Method = Method.Post; 
request.AddHeader("Content-Type", "application/octet-stream");
request.AddHeader("X-WNS-Type", "wns/raw");
request.AddHeader("Authorization", "Bearer [your access token]");
request.AddBody("Notification body");
RestResponse response = await client.ExecutePostAsync(request);");

Etapa 3: Enviar uma notificação de aplicativo de origem na nuvem

Se você estiver interessado apenas em enviar notificações brutas, ignore esta etapa. Para enviar uma notificação de aplicativo baseada em nuvem, também conhecida como notificação por push toast, siga primeiro Guia Rápido: Notificações de App no Windows App SDK. As notificações do aplicativo podem ser enviadas por push (enviadas da nuvem) ou enviadas localmente. Enviar uma notificação de aplicativo originada na nuvem é semelhante ao envio de uma notificação bruta na etapa 2, exceto que o cabeçalho X-WNS-Type é toast, o cabeçalho Content-Type é text/xmle o conteúdo inclui a carga XML da notificação do aplicativo. Consulte o esquema XML de notificações para saber mais sobre como construir sua carga XML.

Crie uma solicitação HTTP POST que contenha seu token de acesso e o conteúdo da notificação de aplicativo de origem na nuvem que você deseja enviar. O conteúdo da notificação por push será entregue ao aplicativo.

POST /?token=AwYAAAB%2fQAhYEiAESPobjHzQcwGCTjHu%2f%2fP3CCNDcyfyvgbK5xD3kztniW%2bjba1b3aSSun58SA326GMxuzZooJYwtpgzL9AusPDES2alyQ8CHvW94cO5VuxxLDVzrSzdO1ZVgm%2bNSB9BAzOASvHqkMHQhsDy HTTP/1.1
Host: dm3p.notify.windows.com
Content-Type: text/xml
X-WNS-Type: wns/toast
Authorization: Bearer [your access token]
Content-Length: 180

<toast><visual><binding template="ToastGeneric"><text>Example cloud toast notification</text><text>This is an example cloud notification using XML</text></binding></visual></toast>

var client = new RestClient("https://dm3p.notify.windows.com/?token=AwYAAAB%2fQAhYEiAESPobjHzQcwGCTjHu%2f%2fP3CCNDcyfyvgbK5xD3kztniW%2bjba1b3aSSun58SA326GMxuzZooJYwtpgzL9AusPDES2alyQ8CHvW94cO5VuxxLDVzrSzdO1ZVgm%2bNSB9BAzOASvHqkMHQhsDy");
client.Timeout = -1;

var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "text/xml");
request.AddHeader("X-WNS-Type", "wns/toast");
request.AddHeader("Authorization", "Bearer <AccessToken>");
request.AddParameter("text/xml", "<toast><visual><binding template=\"ToastGeneric\"><text>Example cloud toast notification</text><text>This is an example cloud notification using XML</text></binding></visual></toast>",  ParameterType.RequestBody);
Console.WriteLine(response.Content);

Resources

• Serviço de Notificação por Push do Windows (WNS)
• código de exemplo de notificações por push no GitHub
• detalhes da API Microsoft.Windows.PushNotifications
• especificação de notificações por push no GitHub
• Conteúdo do sistema
• Esquema XML de notificações