VoipCallCoordinator.SetupNewAcceptedCall Method

Definition

Sets up a newly accepted call.

public:
 virtual VoipPhoneCall ^ SetupNewAcceptedCall(Platform::String ^ context, Platform::String ^ contactName, Platform::String ^ contactNumber, Platform::String ^ serviceName, VoipPhoneCallMedia media) = SetupNewAcceptedCall;
VoipPhoneCall SetupNewAcceptedCall(winrt::hstring const& context, winrt::hstring const& contactName, winrt::hstring const& contactNumber, winrt::hstring const& serviceName, VoipPhoneCallMedia const& media);
public VoipPhoneCall SetupNewAcceptedCall(string context, string contactName, string contactNumber, string serviceName, VoipPhoneCallMedia media);
function setupNewAcceptedCall(context, contactName, contactNumber, serviceName, media)
Public Function SetupNewAcceptedCall (context As String, contactName As String, contactNumber As String, serviceName As String, media As VoipPhoneCallMedia) As VoipPhoneCall

Parameters

context
String

Platform::String

winrt::hstring

Information that is passed to the VoIP app's foreground UI process. This might be the contact name, or other data that helps the UI display more quickly.

contactName
String

Platform::String

winrt::hstring

The name or ID of the caller.

contactNumber
String

Platform::String

winrt::hstring

The phone number (if applicable) of the caller.

serviceName
String

Platform::String

winrt::hstring

The name of the service or application.

media
VoipPhoneCallMedia

The media types of the new incoming call (either audio and video or audio only). Pass Audio|Video if the call should be answered with outgoing video. This assumes that the user's device has a camera available for the app to use at the time the call is answered. If this is not the case, or the user should only use audio, pass Audio.

Returns

Returns the call as a VoipPhoneCall object.

Windows requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.ApplicationModel.Calls.CallsVoipContract (introduced in v2.0)
App capabilities
backgroundVoIP phoneCallHistory phoneCallHistorySystem voipCall

Remarks

Use this method instead of RequestNewIncomingCall in auto-accept scenarios, where an incoming call is automatically accepted and connected with video. Possible applications include a home surveillance camera, or helping elderly or disabled users accept calls.

All string parameters have a maximum allowed length of 128 characters (including the terminator).

Applies to