ScheduledTask Class

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

Represents a task that will be run periodically or when the phone is in a state that supports resource-intensive processing.

Inheritance Hierarchy

System..::.Object
  Microsoft.Phone.Scheduler..::.ScheduledAction
    Microsoft.Phone.Scheduler..::.ScheduledTask
      Microsoft.Phone.Networking.Voip..::.VoipHttpIncomingCallTask
      Microsoft.Phone.Networking.Voip..::.VoipKeepAliveTask
      Microsoft.Phone.NetworkOperators..::.IncomingMobileNetworkMessageTask
      Microsoft.Phone.Scheduler..::.PeriodicTask
      Microsoft.Phone.Scheduler..::.ResourceIntensiveTask

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

Syntax

Public MustInherit Class ScheduledTask _
    Inherits ScheduledAction
public abstract class ScheduledTask : ScheduledAction

The ScheduledTask type exposes the following members.

Properties

  Name Description
BeginTime This property is not supported for ScheduledTask objects in the current version. (Overrides ScheduledAction..::.BeginTime.)
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.
ExpirationTime Gets or sets the time at which the action’s schedule expires. (Inherited from ScheduledAction.)
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.
LastScheduledTime Gets the last time the agent was scheduled to be run, in the device’s local time.
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

This class, which inherits from ScheduledAction, is abstract and cannot be instantiated directly. Instead, use the subclasses PeriodicTask and ResourceIntensiveTask.

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