Call.BeginSendReliableProvisionalResponse Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration

Assembly:: Microsoft.Rtc.Collaboration.dll

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.

This method can be used to send a reliable provisional response with option to send answer for early media. If the inviter supports 100rel and the local policy is not unsupported, this method will wait for the PRACK. Otherwise, this method will not require 100rel. Any application that supports 100rel is recommended to use this method for sending provisional response. SendProvisional method can be used only when the application knows for sure that the remote does not require 100rel.

protected:
 IAsyncResult ^ BeginSendReliableProvisionalResponse(int responseCode, bool needEarlyMediaSupport, Microsoft::Rtc::Collaboration::CallProvisionalResponseOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);

protected IAsyncResult BeginSendReliableProvisionalResponse (int responseCode, bool needEarlyMediaSupport, Microsoft.Rtc.Collaboration.CallProvisionalResponseOptions options, AsyncCallback userCallback, object state);

member this.BeginSendReliableProvisionalResponse : int * bool * Microsoft.Rtc.Collaboration.CallProvisionalResponseOptions * AsyncCallback * obj -> IAsyncResult

Protected Function BeginSendReliableProvisionalResponse (responseCode As Integer, needEarlyMediaSupport As Boolean, options As CallProvisionalResponseOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

responseCode: Int32

The response code.

needEarlyMediaSupport: Boolean

The flag indicating whether the provisional response need to send media description

options: CallProvisionalResponseOptions

Optional parameters for sending the provisional response.

userCallback: AsyncCallback

The method to be called when the asynchronous operation is completed.

state: Object

A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

ArgumentOutOfRangeException

Thrown when the responseCode parameter passed is not in the valid range (101-199) for sending provisional response.

ArgumentNullException

Thrown when the options parameter contains null values.

ArgumentException

Thrown when the options parameter contains invalid signaling headers.

InvalidOperationException

Thrown when the call is not in the valid state or the remote side does not support reliable provisional response.

Also, thrown when the needEarlyMediaSupport parameter is set and this method is called while early media is already being negotiated.

Remarks

A provisional response must be sent on primary signaling session of the call. A provisional response could be sent only on an Incoming call, before the call is established.

Applies to