Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ScheduledTaskAgent Class

July 28, 2014

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.

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

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

'Declaration
Public MustInherit Class ScheduledTaskAgent _
	Inherits BackgroundAgent

The ScheduledTaskAgent type exposes the following members.

  NameDescription
Protected methodScheduledTaskAgentInitializes a new instance of the ScheduledTaskAgent class.
Top

  NameDescription
Protected methodAbortInforms 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.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodNotifyCompleteInforms the operating system that the agent has completed its intended task for the current invocation of the agent. (Inherited from BackgroundAgent.)
Protected methodNotifyCompleteWithResultInforms 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.)
Protected methodOnCancelNot supported. (Overrides BackgroundAgent.OnCancel.)
Protected methodOnInvokeCalled when the Scheduled Task is executed. Override this method and provide the code that should execute in the background.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

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

Show:
© 2014 Microsoft