Action Center Notifications In Universal Windows Programs - Part Three

Before reading this article, I highly recommend reading the previous parts of the series.

• Action Center Notifications In Universal Windows Programs: Part 1
• Action Center Notifications In Universal Windows Programs: Part 2

In Windows 10 Anniversary update, Microsoft has allowed context menu features in the Action Center. The application can give more options to the user to get the specific input  and one more advantage for this is that without activating a foreground app, we can process the input into the background.

Note: This article has a required background task concept knowledge, if you don’t have any idea about the Background task, I highly recommend you read the BackgroundTask complete series.

Context menu Default menu 

The image, given below, with default context menu, is available in the Action Center for all the Applications notifications. If app contains a custom context menu, it will be placed on the top of the menu.

 

Overall concept 

1. Any notification will create the Action Center notification toast message with the custom action menu.
2. To create a custom menu, the menu prepares with the Background or Foreground activation type.
3. If the custom menu contains a background type, register the ToastNotificationAction TriggerDetails background task to handle the background task request. 
4. Foreground activation is required to type launch the Application. 

Quick Overview BackgroundTask implementation of Time Zone

 

In this example, background task has implemented into the single process model.

 

TimerZone event has registered.

public void IsTimeClassRegister()
       {
           var bgTimerReg = new SystemTrigger(SystemTriggerType.TimeZoneChange, false);
           var bgTimeTask = HandlingBgTask.CreateBgTask("TimerRegister", "BGProcess.BgTask", bgTimerReg);
           if (bgTimeTask != null) bgTimeTask.Completed += BgTask_Completed;
       }

Note

HandlingBgTask is a user defined class source code, which is available at the end of the article.

Trigger the ToastNotification (More details in the next section) into the Run method.

public static void RunBackGroundTask(IBackgroundActivatedEventArgs args)
        {
            var bgInstance = args.TaskInstance;
            if (bgInstance == null) return;
            _appServiceDeferral = bgInstance.GetDeferral();
            bgInstance.Canceled += BgInstance_Canceled;
            HandlingMenu();
            _appServiceDeferral.Complete(); }

Activate Background Task into Single Process Modal. 

protected override void OnBackgroundActivated(BackgroundActivatedEventArgs args)
       {
           RunBackGroundTask(args);
       }

Microsoft. Toolkit. Uwp.Notifications Tool kit

As we have seen previous articles that ToastNotification has updated by making a use of XML template, instead of the template. In this article, we are going to use the UWPToolkit to create toast notification.

Install UWP toolkit

Go to Manage NuGet Packages for the solutions -> go to Browse -> Search “Microsoft.Toolkit.Uwp.Notifications” & Install.

 

Ex

Its id is used to change the Window Title bar color, which is based on the user input, which is clicked by the Action Center context menu.

ToastContextMenuItem

ToastContextMenuItem class is used to create the context menu. Three properties are used to create a menu item, which are shown below.

1. Name of the context menu
2. Arguments (Input) to the application.
3. Activation type.

Menu click ActivationType: ActivationType property is used to how the Application should react, which is based on the menu click activated.

• Background
  Execute the code into the background task and the user interaction is not required.
  
  
• Foreground
  Default behavior, where an Application is launched.
  
  
• Protocol
  Launch the different Application.

Create Context Menu & Menu handing code

Create a Context menu function, as shown below.

public static ToastContextMenuItem CreateMenuItem(string menuName, string args,ToastActivationType activationType)
        {
            ToastContextMenuItem menuItem = new ToastContextMenuItem(menuName, args)
            {
                ActivationType = activationType
            };

            return menuItem;
        }

Create Menu command with Background ActivationType & show the ToastNofitication in the ActionCenter. This function is called when the Time Zone event has occurred.  

public static void HandlingMenu()
        {
            var toastCustom = new ToastActionsCustom()
            {
                ContextMenuItems =
                {
                    CreateMenuItem("Red", "1",ToastActivationType.Background),
                    CreateMenuItem("Green", "2",ToastActivationType.Background),
                    CreateMenuItem("Blue", "3",ToastActivationType.Background)
                }
            };

            var tostVisual = new ToastVisual { BindingGeneric = new ToastBindingGeneric() };

            var toastMenu = new ToastContent
            {
                Visual = tostVisual,
                Actions = toastCustom
            };
            ToastNotification toastNotification = new ToastNotification(toastMenu.GetXml());
            ToastNotificationManager.CreateToastNotifier().Show(toastNotification);
        }

Handle the Menu command

ToastNotificationActionTriggerDetail arguments : It is required to find which contextmenu command is triggered by the user.

private static async void ExecuteMenuCmd(ToastNotificationActionTriggerDetail toatInfo)
        {
            if (toatInfo == null) return;
            var cmdId = Convert.ToInt32(toatInfo.Argument);

            switch (cmdId)
            {
                case 1:
                    _toastColor = Colors.Red;
                    break;
                case 2:
                    _toastColor = Colors.Green;
                    break;
                case 3:
                    _toastColor = Colors.Blue;
                    break;
            }
            var strColor = _toastColor.ToString();
            var dialog = new MessageDialog("You Clicked " + strColor, "Information");
            await dialog.ShowAsync();
        }

Register ToastNotificationActionTrigger as BackgroundTask  

 

If the custom menu has implemented as Background activation type, we have to register ToastNotificationActionTrigger as a background task, so that we can handle the ToastNotification. 

public void IsToastClassRegister()
        {
            var bgToastReg = new ToastNotificationActionTrigger();
            var bgToastTask = HandlingBgTask.CreateBgTask("ToastRegister", "BGProcess.BgTask1", bgToastReg);
            if (bgToastTask != null) bgToastTask.Completed += BgToastTask_Completed;
        }

In the same Run ( defined into the previous section) method, we can use and handle the Toast notification. Also, small changes need to be done in Run method, Check the TriggerDetails; if it is ToastNotificationActionTriggerDetail it calls to ToastNotification code, else call the create ToastNotification code. 

public static void RunBackGroundTask(IBackgroundActivatedEventArgs args)
        {
            var bgInstance = args.TaskInstance;
            if (bgInstance == null) return;
            _appServiceDeferral = bgInstance.GetDeferral();
            bgInstance.Canceled += BgInstance_Canceled;
            var bgTaskInstance = bgInstance.TriggerDetails as ToastNotificationActionTriggerDetail;

            if (bgTaskInstance != null)
            {
                ExecuteMenuCmd(bgTaskInstance);
            }
            else
            {
               HandlingMenu();
            }
            _appServiceDeferral.Complete();
        }

Leave Background & Update the titleBar color. 

private void Current_LeavingBackground(object sender, LeavingBackgroundEventArgs e)
        {
            var titleBar = ApplicationView.GetForCurrentView().TitleBar;
            titleBar.BackgroundColor = _toastColor;        }

Handling BG Task code is shown.

public static class HandlingBgTask
    {
        private static IBackgroundTaskRegistration _backgroundTask;

        private static IBackgroundTrigger _setTrigger;

        public static IBackgroundTaskRegistration CreateBgTask(string bgTaskName, string bgEntryPoint,
            IBackgroundTrigger bgTigger)
        {
            _setTrigger = bgTigger;
            _backgroundTask = RegisterBgTask(bgTaskName);
            return _backgroundTask;
        }

        private static async Task<bool> IsAppHasPermission()
        {
            var bgStatus = await BackgroundExecutionManager.RequestAccessAsync();
            return IsBackgroundAccessValid(bgStatus);
        }

        private static bool IsBackgroundAccessValid(BackgroundAccessStatus bgStatus)
        {
            var status = default(bool);
            switch (bgStatus)
            {
                case BackgroundAccessStatus.DeniedBySystemPolicy:
                case BackgroundAccessStatus.DeniedByUser:
                    break;
                case BackgroundAccessStatus.AllowedSubjectToSystemPolicy:
                case BackgroundAccessStatus.AlwaysAllowed:
                    status = true;
                    break;
            }
            return status;
        }

        private static IBackgroundTaskRegistration RegisterBgTask(string bgTaskName)
        {
            try
            {
                if (!IsAppHasPermission().Result) return null;
                var bgRegister = IsBackgroundRegister(bgTaskName);
                if (bgRegister != null) return bgRegister;

                var objBg = new BackgroundTaskBuilder()
                {
                    Name = bgTaskName

                };

                objBg.SetTrigger(_setTrigger);

                bgRegister = objBg.Register();
                return bgRegister;
            }
            catch (Exception exception)
            {

            }
            return null;
        }

        private static IBackgroundTaskRegistration IsBackgroundRegister(string bgTaskName)
        {
            var bgTask = BackgroundTaskRegistration.AllTasks.Where(taskReg => taskReg.Value.Name == bgTaskName)
                    .Select(bgTask1 => bgTask1.Value).FirstOrDefault();
            return bgTask;
        }


    }

I hope, you understood how to implement ToastContextMenuItem concept.