MediaProvider.BeginTerminateCall Method

Definition

Namespace:

Microsoft.Rtc.Collaboration.ComponentModel

Assembly:

Microsoft.Rtc.Collaboration.dll

Overloads

BeginTerminateCall(CallDialogContext, IEnumerable<SignalingHeader>, AsyncCallback, Object)	Begins the asynchronous operation to terminate the Call.
BeginTerminateCall(CallDialogContext, IEnumerable<SignalingHeader>, DiagnosticsInformation, AsyncCallback, Object)	Begins the asynchronous operation to terminate the Call with specific diagnostic information.

BeginTerminateCall(CallDialogContext, IEnumerable<SignalingHeader>, AsyncCallback, Object)

Begins the asynchronous operation to terminate the Call.

protected:
 IAsyncResult ^ BeginTerminateCall(Microsoft::Rtc::Collaboration::CallDialogContext ^ signalingContext, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ headers, AsyncCallback ^ userCallback, System::Object ^ state);

protected IAsyncResult BeginTerminateCall (Microsoft.Rtc.Collaboration.CallDialogContext signalingContext, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> headers, AsyncCallback userCallback, object state);

member this.BeginTerminateCall : Microsoft.Rtc.Collaboration.CallDialogContext * seq<Microsoft.Rtc.Signaling.SignalingHeader> * AsyncCallback * obj -> IAsyncResult

Protected Function BeginTerminateCall (signalingContext As CallDialogContext, headers As IEnumerable(Of SignalingHeader), userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

signalingContext

CallDialogContext

The signaling context for the corresponding call.

headers

IEnumerable<SignalingHeader>

Additional headers to be sent out with the call terminating BYE message.

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

ArgumentNullException

Thrown when signalingContext is null.

ArgumentException

Thrown when headers contain a restricted or invalid header.

BeginTerminateCall(CallDialogContext, IEnumerable<SignalingHeader>, DiagnosticsInformation, AsyncCallback, Object)

Begins the asynchronous operation to terminate the Call with specific diagnostic information.

protected:
 IAsyncResult ^ BeginTerminateCall(Microsoft::Rtc::Collaboration::CallDialogContext ^ signalingContext, System::Collections::Generic::IEnumerable<Microsoft::Rtc::Signaling::SignalingHeader ^> ^ headers, Microsoft::Rtc::Signaling::DiagnosticsInformation ^ diagnosticsInformation, AsyncCallback ^ userCallback, System::Object ^ state);

protected IAsyncResult BeginTerminateCall (Microsoft.Rtc.Collaboration.CallDialogContext signalingContext, System.Collections.Generic.IEnumerable<Microsoft.Rtc.Signaling.SignalingHeader> headers, Microsoft.Rtc.Signaling.DiagnosticsInformation diagnosticsInformation, AsyncCallback userCallback, object state);

member this.BeginTerminateCall : Microsoft.Rtc.Collaboration.CallDialogContext * seq<Microsoft.Rtc.Signaling.SignalingHeader> * Microsoft.Rtc.Signaling.DiagnosticsInformation * AsyncCallback * obj -> IAsyncResult

Parameters

signalingContext

CallDialogContext

The signaling context for the corresponding call.

headers

IEnumerable<SignalingHeader>

Additional headers to be sent out with the call terminating BYE message.

diagnosticsInformation

DiagnosticsInformation

Diagnostics information to use when terminating the call.

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

ArgumentNullException

Thrown when signalingContext is null.

ArgumentException

Throw when diagnosticsInformation is specified and the headers parameter contains diagnostics headers.