VoipKeepAliveTask Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
A background agent that is launched periodically to allow a VoIP app to communicate with its cloud service.
Inheritance Hierarchy
System..::.Object
Microsoft.Phone.Scheduler..::.ScheduledAction
Microsoft.Phone.Scheduler..::.ScheduledTask
Microsoft.Phone.Networking.Voip..::.VoipKeepAliveTask
Namespace: Microsoft.Phone.Networking.Voip
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
Syntax
Public NotInheritable Class VoipKeepAliveTask _
Inherits ScheduledTask
public sealed class VoipKeepAliveTask : ScheduledTask
The VoipKeepAliveTask type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
VoipKeepAliveTask | Initializes a new instance of the VoipKeepAliveTask class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BeginTime | This property is not supported for ScheduledTask objects in the current version. (Inherited from ScheduledTask.) |
|
Description | Gets or sets the description of the ScheduledTask. This string is displayed to the user in the Background Tasks settings page on the device. (Inherited from ScheduledTask.) |
|
ExpirationTime | Gets or sets the time at which the action’s schedule expires. (Inherited from ScheduledAction.) |
|
Interval | Gets or sets the interval between launches of the agent. |
|
IsEnabled | This value is not used in the current release. (Inherited from ScheduledAction.) |
|
IsScheduled | Gets the scheduled status of the action. (Inherited from ScheduledAction.) |
|
LastExitReason | Gets the reason that the agent exited the last time it was run. (Inherited from ScheduledTask.) |
|
LastScheduledTime | Gets the last time the agent was scheduled to be run, in the device’s local time. (Inherited from ScheduledTask.) |
|
Name | Gets the name of the scheduled action. (Inherited from ScheduledAction.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
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.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
Just like periodic background agents, the VoIP keep alive task agent will be unscheduled if it throws an unhandled exception or if it exceeds the memory cap twice in a row. The agent can be rescheduled by the foreground application by removing it and then adding it again.
Capabilities
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.
ID_CAP_VOIP |
Windows Phone 8 |
For more info, see App capabilities and hardware requirements for Windows Phone 8.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0
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.