Actualizar un icono dinámico desde una tarea en segundo plano

API importantes

• IBackgroundTask
• BackgroundTaskBuilder

Usa una tarea en segundo plano para actualizar el icono dinámico de tu aplicación con contenido actualizado.

Este vídeo te muestra cómo agregar iconos dinámicos a tus aplicaciones.

Crear el proyecto de tareas en segundo plano

Para habilitar un icono dinámico para la aplicación, agregue un nuevo proyecto de componente de Windows Runtime a la solución. Este es un ensamblado independiente que el sistema operativo carga y ejecuta en segundo plano cuando un usuario instala tu aplicación.

1. En el Explorador de soluciones, haga clic con el botón derecho en la solución; luego, en Agregar y en Nuevo proyecto.
2. En el cuadro de diálogo Agregar nuevo proyecto, seleccione la plantilla Componente Windows Runtime en la sección Instalado > Otros lenguajes > Visual C# > Windows Universal.
3. Asigna el nombre BackgroundTasks al proyecto y haz clic o pulsa Aceptar. Microsoft Visual Studio agrega el nuevo proyecto a la solución.
4. En el proyecto principal, agrega una referencia al proyecto BackgroundTasks.

Implementar la tarea en segundo plano

Implementa la interfaz IBackgroundTask para crear una clase que actualice el icono dinámico de tu aplicación. El trabajo en segundo plano se incluye en el método Run. En este caso, la tarea obtiene una fuente de distribución para los blogs de MSDN. Para impedir que la tarea se cierre de forma prematura mientras aún se ejecuta el código asincrónico, obtén un aplazamiento.

1. En el Explorador de soluciones, cambia el nombre del archivo generado automáticamente, Class1.cs, a BlogFeedBackgroundTask.cs.
2. En BlogFeedBackgroundTask.cs, reemplaza el código generado automáticamente con el código auxiliar de la clase BlogFeedBackgroundTask.
3. En la implementación del método Run, agrega código para los métodos GetMSDNBlogFeed y UpdateTile.

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

// Added during quickstart
using Windows.ApplicationModel.Background;
using Windows.Data.Xml.Dom;
using Windows.UI.Notifications;
using Windows.Web.Syndication;

namespace BackgroundTasks
{
    public sealed class BlogFeedBackgroundTask  : IBackgroundTask
    {
        public async void Run( IBackgroundTaskInstance taskInstance )
        {
            // Get a deferral, to prevent the task from closing prematurely
            // while asynchronous code is still running.
            BackgroundTaskDeferral deferral = taskInstance.GetDeferral();

            // Download the feed.
            var feed = await GetMSDNBlogFeed();

            // Update the live tile with the feed items.
            UpdateTile( feed );

            // Inform the system that the task is finished.
            deferral.Complete();
        }

        private static async Task<SyndicationFeed> GetMSDNBlogFeed()
        {
            SyndicationFeed feed = null;

            try
            {
                // Create a syndication client that downloads the feed.  
                SyndicationClient client = new SyndicationClient();
                client.BypassCacheOnRetrieve = true;
                client.SetRequestHeader( customHeaderName, customHeaderValue );

                // Download the feed.
                feed = await client.RetrieveFeedAsync( new Uri( feedUrl ) );
            }
            catch( Exception ex )
            {
                Debug.WriteLine( ex.ToString() );
            }

            return feed;
        }

        private static void UpdateTile( SyndicationFeed feed )
        {
            // Create a tile update manager for the specified syndication feed.
            var updater = TileUpdateManager.CreateTileUpdaterForApplication();
            updater.EnableNotificationQueue( true );
            updater.Clear();

            // Keep track of the number feed items that get tile notifications.
            int itemCount = 0;

            // Create a tile notification for each feed item.
            foreach( var item in feed.Items )
            {
                XmlDocument tileXml = TileUpdateManager.GetTemplateContent( TileTemplateType.TileWide310x150Text03 );

                var title = item.Title;
                string titleText = title.Text == null ? String.Empty : title.Text;
                tileXml.GetElementsByTagName( textElementName )[0].InnerText = titleText;

                // Create a new tile notification.
                updater.Update( new TileNotification( tileXml ) );

                // Don't create more than 5 notifications.
                if( itemCount++ > 5 ) break;
            }
        }

        // Although most HTTP servers do not require User-Agent header, others will reject the request or return
        // a different response if this header is missing. Use SetRequestHeader() to add custom headers.
        static string customHeaderName = "User-Agent";
        static string customHeaderValue = "Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; WOW64; Trident/6.0)";

        static string textElementName = "text";
        static string feedUrl = @"http://blogs.msdn.com/b/MainFeed.aspx?Type=BlogsOnly";
    }
}

Configurar el manifiesto del paquete

Para configurar el manifiesto del paquete, ábrelo y agrégale una nueva declaración de tarea en segundo plano. Establece el punto de entrada de la tarea en el nombre de la clase, incluido su espacio de nombres.

1. Abre "Package.appxmanifest" en el Explorador de soluciones.
2. Haz clic o pulsa en la pestaña Declaraciones .
3. En Declaraciones disponibles, selecciona BackgroundTasks y haz clic en Agregar. Visual Studio agrega BackgroundTasks en Declaraciones admitidas.
4. En Tipos de tareas admitidos, asegúrate de que esté activado Temporizador.
5. En Configuración de la aplicación, establece el punto de entrada en BackgroundTasks.BlogFeedBackgroundTask.
6. Haz clic o pulsa en la pestaña IU de la aplicación.
7. Establece Notificaciones de pantallas de bloqueo en Distintivo y texto de imagen.
8. Establece una ruta de acceso en un icono de 24 x 24 píxeles en el campo Logotipo del distintivo . Importante Este icono solo debe usar píxeles monocromáticos y transparentes.
9. En el campo Logotipo pequeño, establece una ruta de acceso en un icono de 30 x 30 píxeles.
10. En el campo Logotipo ancho , establece una ruta de acceso a un icono de 310 x 150 píxeles.

Registrar la tarea en segundo plano

Crea un BackgroundTaskBuilder para registrar tu tarea.

Nota A partir de Windows 8.1, los parámetros de registro de tareas en segundo plano se validan en el momento del registro. Se devuelve un error si cualquiera de los parámetros de registro no es válido. La aplicación debe poder enfrentarse a los escenarios en que se produce un error en el registro de tareas en segundo plano. Por ejemplo, usa una instrucción condicional para comprobar si hay errores de registro y después vuelve a probar el registro con errores con valores de parámetros diferentes.  

En la página principal de tu aplicación, agrega el método RegisterBackgroundTask y llámalo en el controlador de eventos OnNavigatedTo.

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Windows.ApplicationModel.Background;
using Windows.Data.Xml.Dom;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Windows.Web.Syndication;

// The Blank Page item template is documented at https://go.microsoft.com/fwlink/p/?LinkID=234238

namespace ContosoApp
{
    /// <summary>
    /// An empty page that can be used on its own or navigated to within a Frame.
    /// </summary>
    public sealed partial class MainPage : Page
    {
        public MainPage()
        {
            this.InitializeComponent();
        }

        /// <summary>
        /// Invoked when this page is about to be displayed in a Frame.
        /// </summary>
        /// <param name="e">Event data that describes how this page was reached.  The Parameter
        /// property is typically used to configure the page.</param>
        protected override void OnNavigatedTo( NavigationEventArgs e )
        {
            this.RegisterBackgroundTask();
        }


        private async void RegisterBackgroundTask()
        {
            var backgroundAccessStatus = await BackgroundExecutionManager.RequestAccessAsync();
            if( backgroundAccessStatus == BackgroundAccessStatus.AllowedSubjectToSystemPolicy ||
                backgroundAccessStatus == BackgroundAccessStatus.AlwaysAllowed )
            {
                foreach( var task in BackgroundTaskRegistration.AllTasks )
                {
                    if( task.Value.Name == taskName )
                    {
                        task.Value.Unregister( true );
                    }
                }

                BackgroundTaskBuilder taskBuilder = new BackgroundTaskBuilder();
                taskBuilder.Name = taskName;
                taskBuilder.TaskEntryPoint = taskEntryPoint;
                taskBuilder.SetTrigger( new TimeTrigger( 15, false ) );
                var registration = taskBuilder.Register();
            }
        }

        private const string taskName = "BlogFeedBackgroundTask";
        private const string taskEntryPoint = "BackgroundTasks.BlogFeedBackgroundTask";
    }
}

Depurar la tarea en segundo plano

Para depurar la tarea en segundo plano, establece un punto de interrupción en el método Run de la tarea. En la barra de herramientas Ubicación de depuración, selecciona tu tarea en segundo plano. Esto hace que el sistema llame al método Run inmediatamente.

1. Establece un punto de interrupción en el método Run de la tarea.
2. Presiona F5 o pulsa Depurar > Iniciar depuración para implementar y ejecutar la aplicación.
3. Una vez iniciada la aplicación, vuelve a Visual Studio.
4. Asegúrate de que la barra de herramientas Ubicación de depuración aparezca visible. Se encuentra en el menú Ver > Barras de herramientas.
5. En la barra de herramientas Ubicación de depuración , haz clic en la lista desplegable Suspender y selecciona BlogFeedBackgroundTask.
6. Visual Studio suspende la ejecución en el punto de interrupción.
7. Presiona F5 o pulsa Depurar > Continuar para continuar con la ejecución de la aplicación.
8. Presiona Mayús+F5 o pulsa Depurar > Detener depuración para detener la depuración.
9. Regresa al icono de la aplicación en la pantalla Inicio. Tras unos pocos segundos, aparecerán notificaciones de icono en el icono de tu aplicación.

Temas relacionados

• BackgroundTaskBuilder
• TileUpdateManager
• TileNotification
• Hacer que tu aplicación sea compatible con las tareas en segundo plano
• Directrices y lista de comprobación de iconos y distintivos