Guia de início rápido: notificações por push no SDK do Aplicativo Windows

Neste início rápido, você criará um aplicativo da área de trabalho do Windows que envia e recebe notificações por push usando o SDK do Aplicativo Windows.

Prerequisites

• Comece a desenvolver aplicativos do Windows
• Criar um novo projeto que usa o SDK do Aplicativo Windows OU Usar o SDK do Aplicativo Windows em um projeto existente
• É necessária uma Conta Azure para usar notificações por push do SDK de aplicações Windows.
• Leia visão geral das notificações push

Aplicativo de exemplo

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

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

Referência da API

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

Configurar a identidade do seu aplicativo no Azure Ative Directory (AAD)

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

Etapa 1: Criar um registro de aplicativo AAD

Inicie sessão na sua conta do Azure e crie um novo recurso de Registo de Aplicações AAD. Selecione Novo registo.

Etapa 2: Forneça um nome e selecione uma opção multilocatá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 no seu aplicativo?.

3. Selecione Registo

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

5. Anote o seu ID de Diretório (tenant) , pois este é o seu Azure TenantId que você utilizará ao solicitar um token de acesso.

   Important

   Anote o seu ID de Aplicação (cliente) e ID de Diretório (locatário) .

6. Anote o seu Object ID, pois este é o seu ObjectId do Azure que irá utilizar ao fazer um pedido de canal. Observe que esse NÃO é o ID do objeto listado na página do Essentials. Em vez disso, para encontrar o ID de Objeto correto, clique no nome da aplicação no campo Aplicação gerida no diretório local na página Essentials:

   

   

   Note

   Uma entidade de serviço é necessária para obter uma ID do objeto, caso não haja uma associada ao seu aplicativo, siga os passos em um dos seguintes artigos para criar uma no portal do Azure ou usando a linha de comando.

   Use o portal para criar uma aplicação do Azure AD e um principal de serviço que possa acessar recursos

   Usar o Azure PowerShell para criar um principal de serviço com um certificado

Etapa 3: criar um segredo para o registro do seu aplicativo

Seu segredo será usado junto com seu AppId/ClientId do Azure 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 seu aplicativo para seu AppId do Azure

Se o seu aplicativo estiver empacotado (inclusive empacotado com um local externo), você poderá usar esse fluxo para mapear o PFN (Nome da Família de Pacotes) do seu aplicativo e seu AppId do Azure.

Se a sua aplicação for uma aplicação Win32 empacotada, crie uma solicitação de mapeamento PFN (Nome da Família do Pacote) enviando um e-mail para Win_App_SDK_Push@microsoft.com com o assunto "Solicitação de Mapeamento de Notificações Push do SDK do Windows App" e no corpo "PFN: [sua PFN]", AppId: [seu AppId], ObjectId: [seu ObjectId]. As solicitações de mapeamento são concluídas semanalmente. Você será notificado assim que sua solicitação de mapeamento for concluída.

Depois de ter seu AppId, ObjectId e segredo do Azure, você pode 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 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 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 de bootstrapper. Consulte Usar o tempo de execução do SDK de aplicativos do Windows para aplicativos empacotados com local externo ou desempacotados para obter mais detalhes.

Etapa 2: Adicionar namespaces

Em seguida, adicione o namespace para notificações Microsoft.Windows.PushNotificationspor push do SDK do Windows App.

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

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

Se você receber um erro "Não é possível encontrar Microsoft.Windows.PushNotifications", isso provavelmente significa que os arquivos de cabeçalho não foram gerados. Para resolver, certifique-se de ter os pacotes acima instalados, comente as instruções include e using que causam o erro e reconstrua o aplicativo para gerar os arquivos de cabeçalho. Quando a compilação for bem-sucedida, descomente as instruções include e using e reconstrua o projeto. Isso deve resolver o erro.

Etapa 3: adicionar o ativador COM ao manifesto do aplicativo

Se o seu aplicativo estiver empacotado (inclusive empacotado com local externo): abra seu Package.appxmanifest. Adicione o seguinte dentro do elemento <Application>. Substitua os valores Id, Executablee DisplayName por valores específicos do 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: Registre-se e responda às notificações por push na inicialização do aplicativo

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

1. Registe a sua aplicação para receber notificações push chamando PushNotificationManager::Default().Register().
2. Verifique a origem da solicitação de ativação chamando AppInstance::GetCurrent(). GetActivatedEventArgs(). Se a ativação foi acionada a partir de uma notificação push, responda com base na carga útil da notificação.

Adicionando manipuladores de eventos em primeiro plano

Para manipular 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().

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

Em seguida, adicione uma verificação se as APIs PushNotification são suportadas 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 a notificações por push, adicione um comportamento baseado em PushNotificationReceivedEventArgs.

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

Os URIs do Canal WNS são os pontos de extremidade HTTP para o envio de notificações por push. Cada cliente deve solicitar um URI de canal e registrá-lo no servidor WNS para receber notificações 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 um URI de canal, repetindo automaticamente por no máximo 15 minutos. Crie um manipulador de eventos para aguardar a conclusão da chamada. Quando a chamada for concluída, se tiver sido bem-sucedida, registre o URI no 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 sua máquina. 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 para 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 e para obter mais detalhes.

Etapa 1: Solicitar um token de acesso

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

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 amostra em 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 o seu pedido for bem-sucedido, receberá uma resposta que contém o 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]"
}

Passo 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 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 originado na nuvem

Se você estiver interessado apenas em enviar notificações brutas, ignore esta etapa. Para enviar uma notificação de aplicativo proveniente da nuvem, também conhecida como notificação push, primeiro siga Guia de início rápido: notificações de aplicativos no Windows App SDK. As notificações do aplicativo podem ser enviadas por push (enviadas da nuvem) ou enviadas localmente. O envio de uma notificação de aplicativo originada na nuvem é semelhante ao envio de uma notificação bruta na Etapa 2, exceto cabeçalho X-WNS-Type é , Content-Type é e o conteúdo contém a carga XML de notificação do aplicativo. Consulte o esquema XML de notificações para obter mais informações sobre como construir a sua carga útil 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 push no GitHub
• Conteúdo do sistema
• Esquema XML de Notificações