BackgroundAgent Class

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

This is the base class for ScheduledTaskAgent, AudioPlayerAgent, and AudioStreamingAgent. For more information about background audio agents, see Microsoft.Phone.BackgroundAudio. For information about Scheduled Tasks, see Background agents for Windows Phone 8.

Inheritance Hierarchy

System..::.Object
Microsoft.Phone..::.BackgroundAgent
Microsoft.Phone.BackgroundAudio..::.AudioPlayerAgent
Microsoft.Phone.BackgroundAudio..::.AudioStreamingAgent
Microsoft.Phone.DeviceManufacturers..::.ServiceAgent
Microsoft.Phone.Networking.Voip..::.VoipCallInProgressAgent
Microsoft.Phone.Networking.Voip..::.VoipForegroundLifetimeAgent
Microsoft.Phone.Scheduler..::.ScheduledTaskAgent
Microsoft.Phone.Wallet..::.WalletAgent

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

Syntax

Public MustInherit Class BackgroundAgent
public abstract class BackgroundAgent

The BackgroundAgent type exposes the following members.

Constructors

Name Description
BackgroundAgent Initializes a new instance of the BackgroundAgent 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.
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.
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.
OnCancel Called by the operating system to alert a background agent that it is going to be put into a dormant state or terminated.
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 Namespace