IBackgroundTaskInstance Interface

Definition

Provides access to a background task instance.

C#
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(2254166650, 8664, 17779, 143, 50, 146, 138, 27, 6, 65, 246)]
public interface IBackgroundTaskInstance
Derived
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Properties

InstanceId

Gets the instance ID of the background task instance.

Progress

Gets or sets progress status for a background task instance.

SuspendedCount

Gets the number of times resource management policy caused the background task to be suspended.

Task

Gets access to the registered background task for this background task instance.

TriggerDetails

Gets additional information associated with a background task instance.

Methods

GetDeferral()

Informs the system that the background task might continue to perform work after the IBackgroundTask.Run method returns.

Events

Canceled

Attaches a cancellation event handler to the background task instance.

For Windows Phone 8.x app, if the device becomes low on memory, background tasks may be terminated without any warning and without raising the OnCanceled event. This helps to ensure the user experience of the app in the foreground. Your background task should be designed to handle this scenario. Note that this only applies to Windows Phone.

Applies to

Product Versions
WinRT Build 10240, Build 10586, Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100