VoipCallCoordinator.RequestNewIncomingCall | requestNewIncomingCall method

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

Notifies the system of a new incoming call.

Syntax

voipCallCoordinator.requestNewIncomingCall(context, contactName, contactNumber, contactImage, serviceName, brandingImage, callDetails, ringtone, media, ringTimeout);

public void RequestNewIncomingCall(
  string context, 
  string contactName, 
  string contactNumber, 
  Uri contactImage, 
  string serviceName, 
  Uri brandingImage, 
  string callDetails, 
  Uri ringtone, 
  VoipPhoneCallMedia media, 
  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 VoipPhoneCallMedia,  
  ringTimeout As TimeSpan,  
  <OutAttribute> ByRef call As VoipPhoneCall 
)

public:
void RequestNewIncomingCall(
  String^ context, 
  String^ contactName, 
  String^ contactNumber, 
  Uri^ contactImage, 
  String^ serviceName, 
  Uri^ brandingImage, 
  String^ callDetails, 
  Uri^ ringtone, 
  VoipPhoneCallMedia media, 
  TimeSpan ringTimeout, 
  [OutAttribute] VoipPhoneCall^ call
)

Parameters

• context
  Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

  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
  Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

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

• contactNumber
  Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

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

• contactImage
  Type: Windows.Foundation.Uri [JavaScript] | System.Uri [.NET] | Windows::Foundation::Uri [C++]

  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
  Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

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

• brandingImage
  Type: Windows.Foundation.Uri [JavaScript] | System.Uri [.NET] | Windows::Foundation::Uri [C++]

  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
  Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

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

• ringtone
  Type: Windows.Foundation.Uri [JavaScript] | System.Uri [.NET] | Windows::Foundation::Uri [C++]

  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
  Type: VoipPhoneCallMedia

  The media types of the new incoming call.

• ringTimeout
  Type: Number [JavaScript] | System.TimeSpan [.NET] | Windows::Foundation::TimeSpan [C++]

  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 (out parameter)
  Type: VoipPhoneCall

  The object representing the new incoming call.

Requirements

See also

VoipCallCoordinator