IWebUIBackgroundTaskInstance IWebUIBackgroundTaskInstance IWebUIBackgroundTaskInstance IWebUIBackgroundTaskInstance Interface

Definition

Provides access to an instance of a background task.

Note

Once the background task sets this property and has therefore completed its work, the task must explicitly call the Web Workers close method to terminate itself.

public : interface IWebUIBackgroundTaskInstance
public interface IWebUIBackgroundTaskInstance
Public Interface IWebUIBackgroundTaskInstance
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Succeeded Succeeded Succeeded Succeeded

Gets or sets the success value for the background task. The success value is what is returned to the foreground instance of your app in the completed event.

public : Platform::Boolean Succeeded { get; set; }
public bool Succeeded { get; set; }
Public ReadWrite Property Succeeded As bool
var bool = iWebUIBackgroundTaskInstance.succeeded;
iWebUIBackgroundTaskInstance.succeeded = bool;
Value
Platform::Boolean bool bool bool

An app can set this property to false to indicate that the background task has failed. Otherwise this property is always true.

Remarks

An app can set this property to false to indicate that the background task has failed. Otherwise this property is always true. The foreground instance of your app can check if the task succeeded using the completed event. The checkResult method on the event args will throw an exception if the succeeded property is set to false.

Note

Once the background task sets this property and has therefore completed its work, the task must explicitly call the Web Workers close method to terminate itself.