VoipForegroundLifetimeAgent Class

VoipForegroundLifetimeAgent Class

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

An agent that keeps the background process alive while the foreground app is active.


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

public abstract class VoipForegroundLifetimeAgent : BackgroundAgent

The VoipForegroundLifetimeAgent type exposes the following members.

Protected methodVoipForegroundLifetimeAgentInitializes a new instance of the VoipForegroundLifetimeAgent class.

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 methodOnCancelCalled by the operating system to alert a background agent that it is going to be put into a dormant state or terminated. (Inherited from BackgroundAgent.)
Protected methodOnLaunchedCalled when the VoipForegroundLifetimeAgent is launched as a result of a call to Launch().
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This agent is launched when the foreground app calls Launch(). It is terminated when the foreground application leaves the foreground. This agent is used to maintain the background process so that it will be bootstrapped and ready when the user initiates a call in the foreground app.


If you use this API in your app, you must specify the following capabilities in the app manifest. Otherwise, your app might not work correctly or it might exit unexpectedly.


Windows Phone 8

For more info, see App capabilities and hardware requirements for Windows Phone 8.

Windows Phone OS

Supported in: 8.1, 8.0

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

© 2017 Microsoft