⚠️⚠️⚠️ UNSUPPORTED ⚠️⚠️⚠️

This is now unsupported and does not work. You cannot use alternate push channels on UWP apps.

Alternate Push Channels (Web Push for Windows apps)

How to use the alternate push channel for Windows apps

Super quick start

1. Clone this repository
2. Open the VS solution located in src
3. Build, deploy, and launch the app
4. Copy your SubscriptionJson from the app
5. Go to this website, paste your SubscriptionJson, type a message, and click Send
6. A notification should appear on your computer!

Integrate into your own apps...

1. Create a new Windows app

Create a new UWP app, or open an existing one.

2. Add the library

Install the NuGet package, AlternatePushChannel.Library (be sure to include prerelease as it's currently in alpha).

3. Create your application server keys

To use alternate push channels, you need to have a pair of public and private server keys, exactly like Web Push.

You can easily generate a public and private key at this website: https://web-push-codelab.glitch.me/

4. Create the push subscription

Create a subscription, passing in your public server key. You also get to create up to 1,000 different channels, so pick a channel of your choice.

You'll want to grab the subscriptionJson as you'll need that to send a push notification.

var subscription = await PushManager.SubscribeAsync("YOUR_PUBLIC_KEY", "myChannel1");

var subscriptionJson = subscription.ToJson();

// TODO: Display the subscriptionJson or send that to your push server

5. Handle background task activation

Your app's background task will be activated when you receive a push (the foreground event listener doesn't work). In your App.xaml.cs, add the following code and call this from your app's constructor

public App()
{
    this.InitializeComponent();
    this.Suspending += OnSuspending;

    // Call the new method
    RegisterPushBackgroundTask();
}

// New method
private void RegisterPushBackgroundTask()
{
    try
    {
        const string PushBackgroundTaskName = "Push";
        if (!BackgroundTaskRegistration.AllTasks.Any(i => i.Value.Name == PushBackgroundTaskName))
        {
            var builder = new BackgroundTaskBuilder();
            builder.Name = PushBackgroundTaskName;
            builder.SetTrigger(new PushNotificationTrigger());
            builder.Register();
        }
    }
    catch (Exception ex)
    {
    }
}

// New method
protected override void OnBackgroundActivated(BackgroundActivatedEventArgs args)
{
    // We need to get a deferral since we'll be doing async code
    var deferral = args.TaskInstance.GetDeferral();

    try
    {
        RawNotification notification = (RawNotification)args.TaskInstance.TriggerDetails;

        // Decrypt the content
        string payload = await PushManager.GetDecryptedContentAsync(notification);

        // Show a notification
        // You'll need Microsoft.Toolkit.Uwp.Notifications NuGet package installed for this code
        ToastContent content = new ToastContent()
        {
            Visual = new ToastVisual()
            {
                BindingGeneric = new ToastBindingGeneric()
                {
                    Children =
                    {
                        new AdaptiveText()
                        {
                            Text = "Push notification received"
                        },

                        new AdaptiveText()
                        {
                            Text = payload
                        }
                    }
                }
            }
        };

        ToastNotificationManager.CreateToastNotifier().Show(new ToastNotification(content.GetXml()));
    }
    catch
    {
        // Decryption probably failed, did your server use the correct keys to sign?
    }

    // Complete the deferral, telling the OS that we're done
    deferral.Complete();
}

6. Launch app!

Launch your app and grab your subscription details!

7. Test pushing to your app

Go to https://interactivenotifs.azurewebsites.net/webpush, enter your public and private key from earlier, paste in your subscription JSON from your app, and click send!

8. You should see a notification appear!

Your background task should be triggered and a notification should appear!

9. Pushing to your app from your own server

Follow any online instructions for sending web push notifications from your server's choice of language (the server-side code is identical to web push notifications). For C#, we like the WebPush NuGet package for its simplicity and ease-of-use.

Here's a C# sample using the NuGet package...

public static class WebPush
{
    // Keys generated from step #3 (don't store private in public source code)
    // Note that this is the same public key you include in your app in step #4
    private const string PublicKey = "BGg3UxX...";
    private const string PrivateKey = "_RwmE...";

    private static WebPushClient _webPushClient = new WebPushClient();

    public class Subscription
    {
        public string Endpoint { get; set; }
        public SubscriptionKeys Keys { get; set; }
    }

    public class SubscriptionKeys
    {
        public string P256DH { get; set; }
        public string Auth { get; set; }
    }

    public static async Task SendAsync(string subscriptionJson, string payload)
    {
        var subscription = JsonConvert.DeserializeObject<Subscription>(subscriptionJson);

        try
        {
            await _webPushClient.SendNotificationAsync(
                subscription: new PushSubscription(
                    endpoint: subscription.Endpoint,
                    p256dh: subscription.Keys.P256DH,
                    auth: subscription.Keys.Auth),
                payload: payload,
                vapidDetails: new VapidDetails(
                    subject: "mailto:nothanks@microsoft.com",
                    publicKey: PublicKey,
                    privateKey: PrivateKey));
        }
        catch (Exception ex)
        {
            Debugger.Break();
            throw ex;
        }
        return;
    }
}