VoipPhoneCall VoipPhoneCall VoipPhoneCall VoipPhoneCall Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a VoIP phone call.

public : sealed class VoipPhoneCall : IVoipPhoneCallpublic sealed class VoipPhoneCall : IVoipPhoneCallPublic NotInheritable Class VoipPhoneCall Implements IVoipPhoneCall// This API is not available in Javascript.
Attributes
Windows 10 requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Properties

CallMedia CallMedia CallMedia CallMedia

Gets the media types used by the call.

public : VoipPhoneCallMedia CallMedia { get; set; }public VoipPhoneCallMedia CallMedia { get; set; }Public ReadWrite Property CallMedia As VoipPhoneCallMedia// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

ContactName ContactName ContactName ContactName

Gets or sets contact name associated with the VoIP call.

public : PlatForm::String ContactName { get; set; }public string ContactName { get; set; }Public ReadWrite Property ContactName As string// This API is not available in Javascript.
Value
PlatForm::String string string string

The contact name associated with the VoIP call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

StartTime StartTime StartTime StartTime

Gets or sets the start time associated with the VoIP call.

public : DateTime StartTime { get; set; }public DateTimeOffset StartTime { get; set; }Public ReadWrite Property StartTime As DateTimeOffset// This API is not available in Javascript.
Value
DateTime DateTimeOffset DateTimeOffset DateTimeOffset

The start time associated with the call.

Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

Apps can set the start time for the given call to match their conventions for when calls begin. The value can be queried to allow the foreground VoIP application to display the same current call duration shown in the minimized call UI.

Methods

NotifyCallActive() NotifyCallActive() NotifyCallActive() NotifyCallActive()

Notifies the system that the VoIP call is active.

public : void NotifyCallActive()public void NotifyCallActive()Public Function NotifyCallActive() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

NotifyCallEnded() NotifyCallEnded() NotifyCallEnded() NotifyCallEnded()

Notifies the system that the call has ended.

public : void NotifyCallEnded()public void NotifyCallEnded()Public Function NotifyCallEnded() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

NotifyCallHeld() NotifyCallHeld() NotifyCallHeld() NotifyCallHeld()

Notifies the system that the call is currently on hold.

public : void NotifyCallHeld()public void NotifyCallHeld()Public Function NotifyCallHeld() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

Apps must call this method before calling NotifyCallActive on another VoIP call. Only one call can be active at a time.

NotifyCallReady() NotifyCallReady() NotifyCallReady() NotifyCallReady()

When upgrading a call from cellular to video, notifies the system that the app is done setting up the audio and video streams for the video call so that the system can end the existing cellular call.

public : void NotifyCallReady()public void NotifyCallReady()Public Function NotifyCallReady() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

TryShowAppUI() TryShowAppUI() TryShowAppUI() TryShowAppUI()

Prerelease. Brings the VOIP app's user interface into the foreground after accepting a call.

public : void TryShowAppUI()public void TryShowAppUI()Public Function TryShowAppUI() As void// This API is not available in Javascript.
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v2)
Capabilities
voipCall

Events

AnswerRequested AnswerRequested AnswerRequested AnswerRequested

Raised when the user answers an incoming call.

public : event TypedEventHandler AnswerRequested<VoipPhoneCall,  CallAnswerEventArgs>public event TypedEventHandler AnswerRequested<VoipPhoneCall,  CallAnswerEventArgs>Public Event AnswerRequested<VoipPhoneCall,  CallAnswerEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

EndRequested EndRequested EndRequested EndRequested

Raised to alert the VoIP app that the call should be ended.

public : event TypedEventHandler EndRequested<VoipPhoneCall,  CallStateChangeEventArgs>public event TypedEventHandler EndRequested<VoipPhoneCall,  CallStateChangeEventArgs>Public Event EndRequested<VoipPhoneCall,  CallStateChangeEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

After this event has been raised, the application is required to call NotifyCallEnded within 5 seconds.

HoldRequested HoldRequested HoldRequested HoldRequested

Raised to alert the VoIP app that the call should be placed on hold.

public : event TypedEventHandler HoldRequested<VoipPhoneCall,  CallStateChangeEventArgs>public event TypedEventHandler HoldRequested<VoipPhoneCall,  CallStateChangeEventArgs>Public Event HoldRequested<VoipPhoneCall,  CallStateChangeEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

After this event is raised, the application is required to call NotifyCallHeld within 5 seconds.

RejectRequested RejectRequested RejectRequested RejectRequested

Raised when a call has been rejected.

public : event TypedEventHandler RejectRequested<VoipPhoneCall,  CallRejectEventArgs>public event TypedEventHandler RejectRequested<VoipPhoneCall,  CallRejectEventArgs>Public Event RejectRequested<VoipPhoneCall,  CallRejectEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

After this event is raised, the application must call NotifyCallEnded within 5 seconds.

ResumeRequested ResumeRequested ResumeRequested ResumeRequested

Raised to indicate that a previously held VoIP call should be made active.

public : event TypedEventHandler ResumeRequested<VoipPhoneCall,  CallStateChangeEventArgs>public event TypedEventHandler ResumeRequested<VoipPhoneCall,  CallStateChangeEventArgs>Public Event ResumeRequested<VoipPhoneCall,  CallStateChangeEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows Mobile Extension SDK (introduced v10.0.10240.0) Windows 10 (introduced v10.0.10586.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced v1)
Capabilities
voipCall

Remarks

After this event has been raised, the application must call NotifyCallActive within 5 seconds.