BackgroundTaskCompletedEventArgs Класс

Определение

Пространство имен:

Windows.ApplicationModel.Background

Представляет сведения о завершении задачи на момент отправки уведомления о завершении.

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

Наследование

Object Platform::Object IInspectable BackgroundTaskCompletedEventArgs

Атрибуты

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Требования к Windows

Семейство устройств	Windows 10 (появилось в 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (появилось в v1.0)

Примеры

В следующем примере показано, как использовать класс BackgroundTaskCompletedEventArgs с делегатом BackgroundTaskCompletedEventHandler для отслеживания завершения фоновой задачи, пока приложение находится на переднем плане. Обратите внимание, что это зависит от фоновой задачи, которая будет сообщать о состоянии с помощью 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;
    });
}

Комментарии

Система создает этот класс и передает его в качестве аргумента обработчику BackgroundTaskCompletedEventHandler приложения.

Свойства

InstanceId

Возвращает идентификатор экземпляра фоновой задачи для уведомления о состоянии завершения.

Методы

CheckResult()

Создает исключение, если событие завершения фоновой задачи сообщило об ошибке.