Windows Dev Center

MaintenanceTrigger class

Represents a maintenance trigger.

Syntax


public sealed class MaintenanceTrigger : IBackgroundTrigger

Attributes

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

Members

The MaintenanceTrigger class has these types of members:

Constructors

The MaintenanceTrigger class has these constructors.

ConstructorDescription
MaintenanceTrigger Initializes a new instance of a maintenance trigger.

 

Properties

The MaintenanceTrigger class has these properties.

PropertyAccess typeDescription

FreshnessTime

Read-onlyGets the interval of a maintenance trigger.

OneShot

Read-onlyGets whether the maintenance trigger is used only once or each time the FreshnessTime interval elapses.

 

Remarks

Background tasks that use a maintenance trigger run only when the system is connected to AC power.

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

Examples

The following example shows how to create and register a maintenance trigger.


//
// A friendly task name.
//
String name = "ExampleTaskName";

//
// Must be the same entry point that is specified in the manifest.
//
String taskEntryPoint = "ExampleNamespace.ExampleTaskName";

//
// A system trigger that goes off every 15 minutes as long as the device is plugged in to AC power.
//
MaintenanceTrigger trigger = new MaintenanceTrigger(15, false);

//
// Build the background task.
//
BackgroundTaskBuilder builder = new BackgroundTaskBuilder();

builder.Name = name;
builder.TaskEntryPoint = taskEntryPoint;
builder.SetTrigger(trigger);

//
// Register the background task, and get back a BackgroundTaskRegistration object representing the registered task.
//
BackgroundTaskRegistration task = builder.Register();

Requirements (device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (operating system)

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

See also

Object
IBackgroundTrigger

 

 

Show:
© 2015 Microsoft