BackgroundTaskCompletedEventArgs Clase

Definición

Espacio de nombres:

Windows.ApplicationModel.Background

Representa la información de finalización de una tarea en el momento en que se envía una notificación de finalización.

public ref class BackgroundTaskCompletedEventArgs sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class BackgroundTaskCompletedEventArgs final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class BackgroundTaskCompletedEventArgs

Public NotInheritable Class BackgroundTaskCompletedEventArgs

Herencia

Object Platform::Object IInspectable BackgroundTaskCompletedEventArgs

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

En el ejemplo siguiente se muestra cómo usar la clase BackgroundTaskCompletedEventArgs con un delegado BackgroundTaskCompletedEventHandler para supervisar la finalización de tareas en segundo plano mientras la aplicación está en primer plano. Tenga en cuenta que esto depende de la tarea en segundo plano para notificar el estado a través de LocalSettings.

private async void OnCompleted(IBackgroundTaskRegistration task,
                               BackgroundTaskCompletedEventArgs args)
{
    var settings = ApplicationData.Current.LocalSettings;
    var key = task.TaskId.ToString();
    string status = settings.Values[key].ToString();

    //
    // UI element updates should be done asynchronously.
    //
    await Dispatcher.RunAsync(CoreDispatcherPriority.Normal,
    () =>
    {
        ExampleProgressElement.Text = "Task completed with status: " + status;
    });
}

Comentarios

El sistema genera esta clase y la pasa como argumento al controlador BackgroundTaskCompletedEventHandler de la aplicación.

Propiedades

InstanceId

Obtiene el identificador de la instancia de tarea en segundo plano para esta notificación de estado de finalización.

Métodos

CheckResult()

Produce una excepción si el evento de tarea en segundo plano completado ha notificado un error.