IBackgroundTaskInstance2 Interface

Reference

Definition

Namespace:: Windows.ApplicationModel.Background

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Provides access to a background task instance. Inherits from the IBackgroundTaskInstance interface and adds the GetThrottleCount method.

public interface class IBackgroundTaskInstance2 : IBackgroundTaskInstance

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(1333592438, 3190, 20404, 137, 109, 93, 225, 134, 65, 34, 246)]
struct IBackgroundTaskInstance2 : IBackgroundTaskInstance

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(1333592438, 3190, 20404, 137, 109, 93, 225, 134, 65, 34, 246)]
public interface IBackgroundTaskInstance2 : IBackgroundTaskInstance

Public Interface IBackgroundTaskInstance2
Implements IBackgroundTaskInstance

Attributes: ContractVersionAttribute GuidAttribute

Implements: IBackgroundTaskInstance

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. (Inherited from IBackgroundTaskInstance)
Progress	Gets or sets progress status for a background task instance. (Inherited from IBackgroundTaskInstance)
SuspendedCount	Gets the number of times resource management policy caused the background task to be suspended. (Inherited from IBackgroundTaskInstance)
Task	Gets access to the registered background task for this background task instance. (Inherited from IBackgroundTaskInstance)
TriggerDetails	Gets additional information associated with a background task instance. (Inherited from IBackgroundTaskInstance)

Methods

GetDeferral()	Informs the system that the background task might continue to perform work after the IBackgroundTask.Run method returns. (Inherited from IBackgroundTaskInstance)
GetThrottleCount(BackgroundTaskThrottleCounter)	Retrieves the number of times the background task has been suspended for using too many resources.

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.

(Inherited from IBackgroundTaskInstance)

Applies to