IBackgroundTaskInstance2 IBackgroundTaskInstance2 IBackgroundTaskInstance2 IBackgroundTaskInstance2 IBackgroundTaskInstance2 Interface

Definition

Namespace:
Windows.ApplicationModel.Background Windows.ApplicationModel.Background Windows.ApplicationModel.Background Windows.ApplicationModel.Background Windows.ApplicationModel.Background
Edit

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

public : interface IBackgroundTaskInstance2 : IBackgroundTaskInstance
struct winrt::Windows::ApplicationModel::Background::IBackgroundTaskInstance2 : IBackgroundTaskInstance
public interface IBackgroundTaskInstance2 : IBackgroundTaskInstance
Public Interface IBackgroundTaskInstance2 Implements IBackgroundTaskInstance
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Inheritance
IBackgroundTaskInstanceIBackgroundTaskInstanceIBackgroundTaskInstance
IBackgroundTaskInstance2IBackgroundTaskInstance2IBackgroundTaskInstance2IBackgroundTaskInstance2IBackgroundTaskInstance2
Attributes
ContractVersionAttribute GuidAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Methods

GetDeferral GetDeferral GetDeferral GetDeferral GetDeferral

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

(Inherited from IBackgroundTaskInstance)
GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter) GetThrottleCount(BackgroundTaskThrottleCounter)

Retrieves the number of times the background task has been suspended for using too many resources.

Events

Canceled Canceled Canceled Canceled 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.

(Inherited from IBackgroundTaskInstance)

Properties

InstanceId InstanceId InstanceId InstanceId InstanceId

Gets the instance ID of the background task instance.

(Inherited from IBackgroundTaskInstance)
Progress Progress Progress Progress Progress

Gets or sets progress status for a background task instance.

(Inherited from IBackgroundTaskInstance)
SuspendedCount SuspendedCount SuspendedCount SuspendedCount SuspendedCount

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

(Inherited from IBackgroundTaskInstance)
Task Task Task Task Task

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

(Inherited from IBackgroundTaskInstance)
TriggerDetails TriggerDetails TriggerDetails TriggerDetails TriggerDetails

Gets additional information associated with a background task instance.

(Inherited from IBackgroundTaskInstance)

See Also