TimeTrigger class

Applies to Windows and Windows Phone

Represents a time event that triggers a background task to run.

Syntax


public ref class TimeTrigger sealed : IBackgroundTrigger

Attributes

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

Members

The TimeTrigger class has these types of members:

Constructors

The TimeTrigger class has these constructors.

ConstructorDescription
TimeTrigger Initializes a new instance of a time event trigger.

 

Properties

The TimeTrigger class has these properties.

PropertyAccess typeDescription

FreshnessTime

Read-onlyGets the interval of a time event trigger.

OneShot

Read-onlyGets whether the time event trigger will be used only once or each time the FreshnessTime interval elapses.

 

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

Examples

The following example shows how to create and register a time trigger. Note that your app must be placed on the lock screen, and the background task must be declared in the manifest, before the registration can be successful.


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

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

//
// A time trigger that repeats at 15-minute intervals.
//
IBackgroundTrigger trigger = new TimeTrigger(15, false);

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

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

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

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