BackgroundTaskCancellationReason BackgroundTaskCancellationReason BackgroundTaskCancellationReason BackgroundTaskCancellationReason Enum

Specifies the reasons for cancelling a background task.

Syntax

Declaration

public enum BackgroundTaskCancellationReasonpublic enum BackgroundTaskCancellationReasonPublic Enum BackgroundTaskCancellationReasonpublic enum BackgroundTaskCancellationReason

Fields

Abort
Abort
Abort
Abort

The background task was canceled by the application. This can happen for one of the following four reasons:

  • The task is considered an idle task. This means that the background task is still running, but without doing anything – for example, a JavaScript task that does not call the close() function.
  • The background task uses the MaintenanceTrigger and the system transitions to DC (battery power).
  • The app unregisters the background task, in which case the task is cancelled if it is currently running.
  • The app that registered the background task is uninstalled while the task is running.
ConditionLoss
ConditionLoss
ConditionLoss
ConditionLoss

The background task was canceled because one or more of its required conditions is no longer met.

EnergySaver
EnergySaver
EnergySaver
EnergySaver

The background task was cancelled because of the current Energy Saver policy.

ExecutionTimeExceeded
ExecutionTimeExceeded
ExecutionTimeExceeded
ExecutionTimeExceeded

The background task was cancelled because it exceeded its allotted time to run.

IdleTask
IdleTask
IdleTask
IdleTask

The background task was canceled because it was active, but not doing any work.

LoggingOff
LoggingOff
LoggingOff
LoggingOff

The background task was canceled because the user has logged off the system.

QuietHoursEntered
QuietHoursEntered
QuietHoursEntered
QuietHoursEntered

The background task was cancelled because the device entered the quiet hours period.

Note

QuietHoursEntered is no longer available for use as of Windows 10.

ResourceRevocation
ResourceRevocation
ResourceRevocation
ResourceRevocation

The background task was cancelled because the system needed additional resources. The background task was cancelled to free up those resources.

ServicingUpdate
ServicingUpdate
ServicingUpdate
ServicingUpdate

The background task was canceled because the application was updated.

SystemPolicy
SystemPolicy
SystemPolicy
SystemPolicy

The background task was cancelled because of system policy.

Terminating
Terminating
Terminating
Terminating

The background task was canceled because the application is about to be terminated due to system policy. The application should save any state that will be needed when the application restarts.

Uninstall
Uninstall
Uninstall
Uninstall

The background task was canceled because the application was uninstalled.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute

Details

Assembly

Windows.ApplicationModel.Background.dll