PeriodicTask Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Represents a scheduled task that runs regularly for a small amount of time.

Inheritance Hierarchy

System..::.Object
Microsoft.Phone.Scheduler..::.ScheduledAction
Microsoft.Phone.Scheduler..::.ScheduledTask
Microsoft.Phone.Scheduler..::.PeriodicTask

Namespace: Microsoft.Phone.Scheduler
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)

Syntax

Public NotInheritable Class PeriodicTask _
    Inherits ScheduledTask
public sealed class PeriodicTask : ScheduledTask

The PeriodicTask type exposes the following members.

Constructors

Name Description
PeriodicTask Initializes a new instance of the PeriodicTask class.

Top

Properties

Name Description
BeginTime This property is not supported for ScheduledTask objects in the current version. (Inherited from ScheduledTask.)
Description Gets or sets the description of the ScheduledTask. This string is displayed to the user in the Background Tasks settings page on the device. (Inherited from ScheduledTask.)
ExpirationTime Gets or sets the time at which the task’s schedule expires. (Overrides ScheduledAction..::.ExpirationTime.)
IsEnabled This value is not used in the current release. (Inherited from ScheduledAction.)
IsScheduled Gets the scheduled status of the action. (Inherited from ScheduledAction.)
LastExitReason Gets the reason that the agent exited the last time it was run. (Inherited from ScheduledTask.)
LastScheduledTime Gets the last time the agent was scheduled to be run, in the device’s local time. (Inherited from ScheduledTask.)
Name Gets the name of the scheduled action. (Inherited from ScheduledAction.)

Top

Methods

Name Description
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

PeriodicTask inherits from the base classes ScheduledTask and ScheduledAction. It allows applications to perform processing even when the main application is not in the foreground. This class is used for tasks that need to run regularly for a small amount of time and are allowed a very limited amount of device resources. Tasks that require more significant processing should use the ResourceIntensiveTask, which runs less often, but is allowed to use more device resources. For information about the schedules and limitations for these classes, see Background agents for Windows Phone 8.

For more information about using Scheduled Tasks in your application, see How to implement background agents for Windows Phone 8.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Phone.Scheduler Namespace