ScheduledActionService Class

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

Enables the management of scheduled actions.

Inheritance Hierarchy

System..::.Object
  Microsoft.Phone.Scheduler..::.ScheduledActionService

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

Syntax

Public NotInheritable Class ScheduledActionService
public sealed class ScheduledActionService

The ScheduledActionService type exposes the following members.

Methods

  Name Description
Add Registers a scheduled action with the operating system.
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.)
Find Attempts to return the ScheduledAction with the specified name.
GetActions<(Of <(T>)>) Returns all ScheduledAction objects of the specified type that are registered with the system.
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
LaunchForTest Causes the background agent associated with a ScheduledTask to be run in the background after the specified delay.
LaunchVoipHttpIncomingCallTask This method does nothing.
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Remove Removes the ScheduledAction with the specified name from the Scheduled Action Service.
Replace Replaces an existing ScheduledAction with the one provided. The Name property uniquely identifies ScheduledAction objects and is used to determine which existing object, if any, is replaced.
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

ScheduledAction is a base class for Alarm and Reminder, which enable scheduled notifications to the end user, as well as PeriodicTask and ResourceIntensiveTask, which enable background agents that do processing even when the main application is not in the foreground. Use these child classes to create and configure scheduled actions, then use the Add(ScheduledAction) method to register the actions with the system. Use GetActions<(Of <(T>)>)()()() and Find(String) to retrieve actions that have been previously registered. Replace(ScheduledAction) is used to update an existing action, and Remove(String) removes a scheduled action from the system.

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