Share via


VoipCallCoordinator.RequestIncomingUpgradeToVideoCall Method

Definition

Makes a request to the system for an incoming video call that will replace an existing call.

public:
 virtual VoipPhoneCall ^ RequestIncomingUpgradeToVideoCall(Platform::String ^ context, Platform::String ^ contactName, Platform::String ^ contactNumber, Uri ^ contactImage, Platform::String ^ serviceName, Uri ^ brandingImage, Platform::String ^ callDetails, Uri ^ ringtone, TimeSpan ringTimeout) = RequestIncomingUpgradeToVideoCall;
VoipPhoneCall RequestIncomingUpgradeToVideoCall(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, TimeSpan const& ringTimeout);
public VoipPhoneCall RequestIncomingUpgradeToVideoCall(string context, string contactName, string contactNumber, System.Uri contactImage, string serviceName, System.Uri brandingImage, string callDetails, System.Uri ringtone, System.TimeSpan ringTimeout);
function requestIncomingUpgradeToVideoCall(context, contactName, contactNumber, contactImage, serviceName, brandingImage, callDetails, ringtone, ringTimeout)
Public Function RequestIncomingUpgradeToVideoCall (context As String, contactName As String, contactNumber As String, contactImage As Uri, serviceName As String, brandingImage As Uri, callDetails As String, ringtone As Uri, 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. This might be a contact name or other data that can be used to populate the app's UI more quickly. The maximum length is 128 characters. This parameter must be non-null and must refer to a task defined in the app's manifest file.

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 1 MB.

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 128 KB.

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 1 MB.

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

The object representing the new incoming call.

Windows requirements

App capabilities
phoneCallHistory phoneCallHistorySystem voipCall

Applies to