BackgroundTaskBuilder class

Applies to Windows and Windows Phone

Represents a background task to be registered with the system.

Note  Starting in Windows 8.1, the parameters used to register the background task are validated at the time the task is registered. See the remarks for BackgroundTaskBuilder.Register.

Syntax


var backgroundTaskBuilder = new Windows.ApplicationModel.Background.BackgroundTaskBuilder();

Attributes

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

Members

The BackgroundTaskBuilder class has these types of members:

Constructors

The BackgroundTaskBuilder class has these constructors.

ConstructorDescription
BackgroundTaskBuilder Creates an instance of the BackgroundTaskBuilder class.

 

Methods

The BackgroundTaskBuilder class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
AddCondition Adds a condition to a background task.
Register Registers a background task with the system.
SetTrigger Sets the event trigger for a background task.

 

Properties

The BackgroundTaskBuilder class has these properties.

PropertyAccess typeDescription

CancelOnConditionLoss

Read/writeIndicates whether the background task will be canceled if at least one of its required conditions is no longer met.

IsNetworkRequested

Read/writeThis API is not available to all Windows/Windows Phone apps. Unless your developer account is specially provisioned by Microsoft, calls to these APIs will fail at runtime.

Name

Read/writeGets or sets the name of a background task.

TaskEntryPoint

Read/writeGets or sets the class that performs the work of a background task.

 

Remarks

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) and Using Windows Runtime objects in a multithreaded environment (.NET).

Requirements

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 Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.ApplicationModel.Background
Windows::ApplicationModel::Background [C++]

Metadata

Windows.winmd

 

 

Show:
© 2014 Microsoft. All rights reserved.