BackgroundTaskRegistration BackgroundTaskRegistration BackgroundTaskRegistration BackgroundTaskRegistration BackgroundTaskRegistration Class

Definition

Represents a background task that has been registered with the system.

public : sealed class BackgroundTaskRegistration : IBackgroundTaskRegistration, IBackgroundTaskRegistration2, IBackgroundTaskRegistration3
struct winrt::Windows::ApplicationModel::Background::BackgroundTaskRegistration : IBackgroundTaskRegistration, IBackgroundTaskRegistration2, IBackgroundTaskRegistration3
public sealed class BackgroundTaskRegistration : IBackgroundTaskRegistration, IBackgroundTaskRegistration2, IBackgroundTaskRegistration3
Public NotInheritable Class BackgroundTaskRegistration Implements IBackgroundTaskRegistration, IBackgroundTaskRegistration2, IBackgroundTaskRegistration3
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The system returns an instance of this class when the application calls the BackgroundTaskBuilder.Register method.

Properties

AllTaskGroups AllTaskGroups AllTaskGroups AllTaskGroups AllTaskGroups

Gets the background task groups.

AllTasks AllTasks AllTasks AllTasks AllTasks

Enumerates an application's registered background tasks, except for the background tasks registered in a group with Windows.ApplicationModel.Background.BackgroundTaskBuilder.TaskGroup.

Name Name Name Name Name

Gets the name of a registered background task.

TaskGroup TaskGroup TaskGroup TaskGroup TaskGroup

Gets the BackgroundTaskRegistrationGroup that this BackgroundTaskRegistration is a part of.

TaskId TaskId TaskId TaskId TaskId

Gets the identifier of a registered background task.

Trigger Trigger Trigger Trigger Trigger

This is not intended for use in your code. For all unsupported trigger types, the value returned by this property is null.

Methods

GetTaskGroup(String) GetTaskGroup(String) GetTaskGroup(String) GetTaskGroup(String) GetTaskGroup(String)

Gets the task group object that is associated with the group identifier.

Unregister(Boolean) Unregister(Boolean) Unregister(Boolean) Unregister(Boolean) Unregister(Boolean)

Cancels the registration of a registered background task.

Events

Completed Completed Completed Completed Completed

Attaches a completed event handler to the registered background task.

Progress Progress Progress Progress Progress

Attaches a progress event handler to the registered background task.