ScheduledTaskAgent Class

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

Override this class to implement a Scheduled Task, also referred to as a background agent. This class contains one method, OnInvoke, which is called whenever the Scheduled Task is executed. For more information, see Background agents for Windows Phone 8.

Inheritance Hierarchy

System..::.Object
Microsoft.Phone..::.BackgroundAgent
Microsoft.Phone.Scheduler..::.ScheduledTaskAgent

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

Syntax

Public MustInherit Class ScheduledTaskAgent _
    Inherits BackgroundAgent
public abstract class ScheduledTaskAgent : BackgroundAgent

The ScheduledTaskAgent type exposes the following members.

Constructors

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

Top

Methods

Name Description
Abort Informs the operating system that the agent is unable to perform its intended task and that it should not be launched again until the foreground application mitigates the blocking issue and reenables the agent. (Inherited from BackgroundAgent.)
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.)
NotifyComplete Informs the operating system that the agent has completed its intended task for the current invocation of the agent. (Inherited from BackgroundAgent.)
NotifyCompleteWithResult Informs the operating system that the agent has completed its intended task for the current invocation of the agent. Call this method after successfully handling an invocation with a result. (Inherited from BackgroundAgent.)
OnCancel Not supported. (Overrides BackgroundAgent..::.OnCancel()()().)
OnInvoke Called when the Scheduled Task is executed. Override this method and provide the code that should execute in the background.
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

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