VoipKeepAliveTask Class

July 28, 2014

A background agent that is launched periodically to allow a VoIP app to communicate with its cloud service.

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

public sealed class VoipKeepAliveTask : ScheduledTask

The VoipKeepAliveTask type exposes the following members.

  NameDescription
Public methodVoipKeepAliveTaskInitializes a new instance of the VoipKeepAliveTask class.
Top

  NameDescription
Public propertyBeginTimeThis property is not supported for ScheduledTask objects in the current version. (Inherited from ScheduledTask.)
Public propertyDescriptionGets 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.)
Public propertyExpirationTimeGets or sets the time at which the action’s schedule expires. (Inherited from ScheduledAction.)
Public propertyIntervalGets or sets the interval between launches of the agent.
Public propertyIsEnabledThis value is not used in the current release. (Inherited from ScheduledAction.)
Public propertyIsScheduledGets the scheduled status of the action. (Inherited from ScheduledAction.)
Public propertyLastExitReasonGets the reason that the agent exited the last time it was run. (Inherited from ScheduledTask.)
Public propertyLastScheduledTimeGets the last time the agent was scheduled to be run, in the device’s local time. (Inherited from ScheduledTask.)
Public propertyNameGets the name of the scheduled action. (Inherited from ScheduledAction.)
Top

  NameDescription
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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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.

Show:
© 2014 Microsoft