VoipCallCoordinator.RequestNewIncomingCall Method

Definition

Namespace:

Windows.ApplicationModel.Calls

Overloads

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipPhoneCallMedia, TimeSpan)	Makes a request to the system for a new incoming call.
RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipPhoneCallMedia, TimeSpan, String)	Makes a request to the system for a new incoming call.

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipPhoneCallMedia, TimeSpan)

Makes a request to the system for a new incoming call.

public:
 virtual VoipPhoneCall ^ RequestNewIncomingCall(Platform::String ^ context, Platform::String ^ contactName, Platform::String ^ contactNumber, Uri ^ contactImage, Platform::String ^ serviceName, Uri ^ brandingImage, Platform::String ^ callDetails, Uri ^ ringtone, VoipPhoneCallMedia media, TimeSpan ringTimeout) = RequestNewIncomingCall;

VoipPhoneCall RequestNewIncomingCall(winrt::hstring const& context, winrt::hstring const& contactName, winrt::hstring const& contactNumber, Uri const& contactImage, winrt::hstring const& serviceName, Uri const& brandingImage, winrt::hstring const& callDetails, Uri const& ringtone, VoipPhoneCallMedia const& media, TimeSpan const& ringTimeout);

public VoipPhoneCall RequestNewIncomingCall(string context, string contactName, string contactNumber, System.Uri contactImage, string serviceName, System.Uri brandingImage, string callDetails, System.Uri ringtone, VoipPhoneCallMedia media, System.TimeSpan ringTimeout);

function requestNewIncomingCall(context, contactName, contactNumber, contactImage, serviceName, brandingImage, callDetails, ringtone, media, ringTimeout)

Public Function RequestNewIncomingCall (context As String, contactName As String, contactNumber As String, contactImage As Uri, serviceName As String, brandingImage As Uri, callDetails As String, ringtone As Uri, media As VoipPhoneCallMedia, ringTimeout As TimeSpan) 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.

contactImage

Uri Uri

The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1MB.

serviceName

String

Platform::String

winrt::hstring

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

brandingImage

Uri Uri

The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128KB.

callDetails

String

Platform::String

winrt::hstring

A string indicating who the call is on behalf of. The maximum length is 128 characters.

ringtone

Uri Uri

The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1MB.

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.

ringTimeout

TimeSpan TimeSpan

The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds.

Returns

VoipPhoneCall

The object representing the new incoming call.

Windows requirements

App capabilities

phoneCallHistory phoneCallHistorySystem voipCall

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipPhoneCallMedia, TimeSpan, String)

Makes a request to the system for a new incoming call.

public:
 virtual VoipPhoneCall ^ RequestNewIncomingCall(Platform::String ^ context, Platform::String ^ contactName, Platform::String ^ contactNumber, Uri ^ contactImage, Platform::String ^ serviceName, Uri ^ brandingImage, Platform::String ^ callDetails, Uri ^ ringtone, VoipPhoneCallMedia media, TimeSpan ringTimeout, Platform::String ^ contactRemoteId) = RequestNewIncomingCall;

/// [Windows.Foundation.Metadata.Overload("RequestNewIncomingCallWithContactRemoteId")]
VoipPhoneCall RequestNewIncomingCall(winrt::hstring const& context, winrt::hstring const& contactName, winrt::hstring const& contactNumber, Uri const& contactImage, winrt::hstring const& serviceName, Uri const& brandingImage, winrt::hstring const& callDetails, Uri const& ringtone, VoipPhoneCallMedia const& media, TimeSpan const& ringTimeout, winrt::hstring const& contactRemoteId);

[Windows.Foundation.Metadata.Overload("RequestNewIncomingCallWithContactRemoteId")]
public VoipPhoneCall RequestNewIncomingCall(string context, string contactName, string contactNumber, System.Uri contactImage, string serviceName, System.Uri brandingImage, string callDetails, System.Uri ringtone, VoipPhoneCallMedia media, System.TimeSpan ringTimeout, string contactRemoteId);

function requestNewIncomingCall(context, contactName, contactNumber, contactImage, serviceName, brandingImage, callDetails, ringtone, media, ringTimeout, contactRemoteId)

Public Function RequestNewIncomingCall (context As String, contactName As String, contactNumber As String, contactImage As Uri, serviceName As String, brandingImage As Uri, callDetails As String, ringtone As Uri, media As VoipPhoneCallMedia, ringTimeout As TimeSpan, contactRemoteId As String) 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.

contactImage

Uri Uri

The Uri of an image file associated with the caller to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 1MB.

serviceName

String

Platform::String

winrt::hstring

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

brandingImage

Uri Uri

The Uri of an image file that is a logo or icon of the VoIP service or application to be displayed on the incoming call UI. The file type must be PNG or JPG. The maximum file size is 128KB.

callDetails

String

Platform::String

winrt::hstring

A string indicating who the call is on behalf of. The maximum length is 128 characters.

ringtone

Uri Uri

The Uri of an audio file containing the ringtone for this call. The file type must be WMA or MP3. The maximum file size is 1MB.

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.

ringTimeout

TimeSpan TimeSpan

The time, in seconds, the system should wait for the user to answer or ignore the call before rejecting the call. The allowed range is 5 to 120 seconds. The default value is 30 seconds.

contactRemoteId

String

Platform::String

winrt::hstring

The contact remote ID of the caller. The maximum length is 256 characters.

Returns

VoipPhoneCall

The object representing the new incoming call.

Attributes

OverloadAttribute

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	voipCall

Remarks

Use this method when the user has turned on quiet hours. If caller's contact remote ID is on the quiet hour breakthrough list, the call will be connected, and an incoming call notification will be shown. If not, the call will not be connected, and no notification will be shown.