WebUIBackgroundTaskInstanceRuntimeClass class
TOC
Collapse the table of content
Expand the table of content

WebUIBackgroundTaskInstanceRuntimeClass class

Provides access to an instance of a background task.

Note  A background task must explicitly call the Web Workers close method to terminate itself after the task has completed.
 

Syntax


var webUIBackgroundTaskInstanceRuntimeClass = WebUIBackgroundTaskInstance.current;

Members

The WebUIBackgroundTaskInstanceRuntimeClass class has these types of members:

Events

The WebUIBackgroundTaskInstanceRuntimeClass class has these events.

EventDescription
Canceled Attaches a cancellation event handler to the background task instance.

 

Methods

The WebUIBackgroundTaskInstanceRuntimeClass class has these methods.

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

 

Properties

The WebUIBackgroundTaskInstanceRuntimeClass class has these properties.

PropertyAccess typeDescription

InstanceId

Read-only

Gets the instance ID of the background task instance.

Progress

Read/write

Gets or sets progress status for a background task instance.

Succeeded

Read/write

Gets or sets the success value for the background task.

SuspendedCount

Read-only

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

Task

Read-only

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

TriggerDetails

Read-only

Gets additional information associated with a background task instance.

 

Remarks

To retrieve this object, use the WebUIBackgroundTaskInstance.current property.

Note  : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX).
 

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.WebUI

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.WebUI

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Standard)]
[Version(0x06020000)]

See also

Object
IWebUIBackgroundTaskInstance
IBackgroundTaskInstance

 

 

Show:
© 2016 Microsoft