BackgroundTaskCompletedEventArgs Classe

Definição

Namespace:

Windows.ApplicationModel.Background

Representa informações de conclusão de uma tarefa no momento em que uma notificação de conclusão é enviada.

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

Herança

Object Platform::Object IInspectable BackgroundTaskCompletedEventArgs

Atributos

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Exemplos

O exemplo a seguir mostra como usar a classe BackgroundTaskCompletedEventArgs com um delegado BackgroundTaskCompletedEventHandler para monitorar a conclusão da tarefa em segundo plano enquanto o aplicativo está em primeiro plano. Observe que isso depende da tarefa em segundo plano para relatar status por meio 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;
    });
}

Comentários

O sistema gera essa classe e a passa como um argumento para o manipulador BackgroundTaskCompletedEventHandler do aplicativo.

Propriedades

InstanceId

Obtém o identificador da instância de tarefa em segundo plano para essa notificação de status de conclusão.

Métodos

CheckResult()

Gera uma exceção se o evento concluído da tarefa em segundo plano tiver relatado um erro.