VoipCallCoordinator.RequestNewAppInitiatedCall Method

Reference

Definition

Namespace:: Windows.ApplicationModel.Calls

Important

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

Edit

Requests a new call object from the system. Call this method from your VoIP app to tell the system that there's a new incoming call, and that you want to host an incoming call notification for that new call.

public:
 virtual VoipPhoneCall ^ RequestNewAppInitiatedCall(Platform::String ^ context, Platform::String ^ contactName, Platform::String ^ contactNumber, Platform::String ^ serviceName, VoipPhoneCallMedia media) = RequestNewAppInitiatedCall;

VoipPhoneCall RequestNewAppInitiatedCall(winrt::hstring const& context, winrt::hstring const& contactName, winrt::hstring const& contactNumber, winrt::hstring const& serviceName, VoipPhoneCallMedia const& media);

public VoipPhoneCall RequestNewAppInitiatedCall(string context, string contactName, string contactNumber, string serviceName, VoipPhoneCallMedia media);

function requestNewAppInitiatedCall(context, contactName, contactNumber, serviceName, media)

Public Function RequestNewAppInitiatedCall (context As String, contactName As String, contactNumber As String, serviceName As String, media As VoipPhoneCallMedia) As VoipPhoneCall

Parameters

context: String
Platform::String

winrt::hstring

A string that is passed to the associated foreground app as a deep link. The maximum length is 128 characters. This parameter must be non-null.

contactName: String
Platform::String

winrt::hstring

The contact name of the caller to be displayed on the incoming call UI. The maximum length is 128 characters.

contactNumber: String
Platform::String

winrt::hstring

The phone number of the caller to be displayed on the incoming call UI. The maximum length is 128 characters.

serviceName: String
Platform::String

winrt::hstring

The name of the VoIP service or application. The maximum length is 128 characters.

media: VoipPhoneCallMedia

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

Returns

VoipPhoneCall

The object representing the new initiated call.

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.ApplicationModel.Calls.CallsVoipContract (introduced in v3.0)
App capabilities	backgroundVoIP voipCall

Remarks

Use this method to create a new VoipPhoneCall object. You can use a VoipPhoneCall object to send in-app call notifications, and to handle events that the VoipPhoneCall raises. See VoipPhoneCall for more info about how to work with these notifications and events.

Applies to