IBackgroundTaskInstance4 Interface

Definition

Provides access to a background task instance including information about the user.

public interface class IBackgroundTaskInstance4 : IBackgroundTaskInstance
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.Guid(2133455420, 43524, 19208, 151, 176, 6, 216, 116, 205, 171, 245)]
struct IBackgroundTaskInstance4 : IBackgroundTaskInstance
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.Guid(2133455420, 43524, 19208, 151, 176, 6, 216, 116, 205, 171, 245)]
public interface IBackgroundTaskInstance4 : IBackgroundTaskInstance
Public Interface IBackgroundTaskInstance4
Implements IBackgroundTaskInstance
Attributes
Implements

Windows 10 requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.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)
User

Gets the user context for the background task. AppServiceConnection.User is used by the calling app to pass the user context. The app service can retrieve that user context with this property.

Methods

GetDeferral()

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

(Inherited from IBackgroundTaskInstance)

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

See also