Share via


VoipCallCoordinator.RequestNewIncomingCall Method

Definition

Overloads

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipCallMedia, TimeSpan, String)

Important

The types in the Windows.Phone.Networking.Voip namespace are deprecated, and may not be available in future versions of Windows. Instead, use the equivalent types in the Windows.ApplicationModel.Calls namespace.

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

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipCallMedia, TimeSpan, VoipPhoneCall)

Important

The types in the Windows.Phone.Networking.Voip namespace are deprecated, and may not be available in future versions of Windows. Instead, use the equivalent types in the Windows.ApplicationModel.Calls namespace.

Notifies the system of a new incoming call.

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipCallMedia, TimeSpan, String, IVector<String>)

Important

The types in the Windows.Phone.Networking.Voip namespace are deprecated, and may not be available in future versions of Windows. Instead, use the equivalent types in the Windows.ApplicationModel.Calls namespace.

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipCallMedia, TimeSpan, String)

Important

The types in the Windows.Phone.Networking.Voip namespace are deprecated, and may not be available in future versions of Windows. Instead, use the equivalent types in the Windows.ApplicationModel.Calls namespace.

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, VoipCallMedia 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, VoipCallMedia 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, VoipCallMedia 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 VoipCallMedia, 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 whom 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
VoipCallMedia

The media types used by the call (whether the call is audio/video rather than audio only).

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

The object representing the new incoming call.

Attributes

Windows requirements

App capabilities
ID_CAP_VOIP [Windows Phone]

Remarks

Use this method when the user has turned on quiet hours. If the 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.

Applies to

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipCallMedia, TimeSpan, VoipPhoneCall)

Important

The types in the Windows.Phone.Networking.Voip namespace are deprecated, and may not be available in future versions of Windows. Instead, use the equivalent types in the Windows.ApplicationModel.Calls namespace.

Notifies the system of a new incoming call.

public:
 virtual void RequestNewIncomingCall(Platform::String ^ context, Platform::String ^ contactName, Platform::String ^ contactNumber, Uri ^ contactImage, Platform::String ^ serviceName, Uri ^ brandingImage, Platform::String ^ callDetails, Uri ^ ringtone, VoipCallMedia media, TimeSpan ringTimeout, [Out] VoipPhoneCall ^ & call) = RequestNewIncomingCall;
void 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, VoipCallMedia const& media, TimeSpan const& ringTimeout, [Out] VoipPhoneCall const& & call);
public void RequestNewIncomingCall(string context, string contactName, string contactNumber, System.Uri contactImage, string serviceName, System.Uri brandingImage, string callDetails, System.Uri ringtone, VoipCallMedia media, System.TimeSpan ringTimeout, out VoipPhoneCall call);
Public Sub 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 VoipCallMedia, ringTimeout As TimeSpan, ByRef call 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 whom 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
VoipCallMedia

The media types used by the call (whether the call is audio/video rather than audio only).

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.

call
VoipPhoneCall

The object representing the new incoming call.

Windows requirements

App capabilities
ID_CAP_VOIP [Windows Phone]

Applies to

RequestNewIncomingCall(String, String, String, Uri, String, Uri, String, Uri, VoipCallMedia, TimeSpan, String, IVector<String>)

Important

The types in the Windows.Phone.Networking.Voip namespace are deprecated, and may not be available in future versions of Windows. Instead, use the equivalent types in the Windows.ApplicationModel.Calls namespace.

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, VoipCallMedia media, TimeSpan ringTimeout, Platform::String ^ contactRemoteId, IVector<Platform::String ^> ^ pAssociatedDeviceIds) = 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, VoipCallMedia const& media, TimeSpan const& ringTimeout, winrt::hstring const& contactRemoteId, IVector<winrt::hstring> const& pAssociatedDeviceIds);
[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, VoipCallMedia media, System.TimeSpan ringTimeout, string contactRemoteId, IList<string> pAssociatedDeviceIds);
function requestNewIncomingCall(context, contactName, contactNumber, contactImage, serviceName, brandingImage, callDetails, ringtone, media, ringTimeout, contactRemoteId, pAssociatedDeviceIds)
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 VoipCallMedia, ringTimeout As TimeSpan, contactRemoteId As String, pAssociatedDeviceIds As IList(Of String)) As VoipPhoneCall

Parameters

context
String

Platform::String

winrt::hstring

contactName
String

Platform::String

winrt::hstring

contactNumber
String

Platform::String

winrt::hstring

contactImage
Uri Uri
serviceName
String

Platform::String

winrt::hstring

brandingImage
Uri Uri
callDetails
String

Platform::String

winrt::hstring

ringtone
Uri Uri
ringTimeout
TimeSpan TimeSpan
contactRemoteId
String

Platform::String

winrt::hstring

pAssociatedDeviceIds

IVector<String>

IList<String>

IVector<Platform::String>

IVector<winrt::hstring>

Returns

Attributes

Applies to