BackgroundAgent Class

July 28, 2014

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.

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

public abstract class BackgroundAgent

The BackgroundAgent type exposes the following members.

  NameDescription
Protected methodBackgroundAgentInitializes a new instance of the BackgroundAgent 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.
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.
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.
Protected methodOnCancelCalled by the operating system to alert a background agent that it is going to be put into a dormant state or terminated.
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