MediaProvider.BeginTerminateCall Method (CallDialogContext, IEnumerable<SignalingHeader>, DiagnosticsInformation, AsyncCallback, Object)
Begins the asynchronous operation to terminate the Call with specific diagnostic information.
Namespace: Microsoft.Rtc.Collaboration.ComponentModel
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Protected Function BeginTerminateCall ( _
signalingContext As CallDialogContext, _
headers As IEnumerable(Of SignalingHeader), _
diagnosticsInformation As DiagnosticsInformation, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim signalingContext As CallDialogContext
Dim headers As IEnumerable(Of SignalingHeader)
Dim diagnosticsInformation As DiagnosticsInformation
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = Me.BeginTerminateCall(signalingContext, _
headers, diagnosticsInformation, _
userCallback, state)
protected IAsyncResult BeginTerminateCall(
CallDialogContext signalingContext,
IEnumerable<SignalingHeader> headers,
DiagnosticsInformation diagnosticsInformation,
AsyncCallback userCallback,
Object state
)
Parameters
- signalingContext
Type: Microsoft.Rtc.Collaboration.CallDialogContext
The signaling context for the corresponding call.
- headers
Type: System.Collections.Generic.IEnumerable<SignalingHeader>
Additional headers to be sent out with the call terminating BYE message.
- diagnosticsInformation
Type: Microsoft.Rtc.Signaling.DiagnosticsInformation
Diagnostics information to use when terminating the call.
- userCallback
Type: System.AsyncCallback
The method to be called when the asynchronous operation is completed.
- state
Type: System.Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | Thrown when signalingContext is null. |
| ArgumentException | Thrown when signalingContext is not valid. |
| ArgumentException | Thrown when headers contain a restricted or invalid header. |
| ArgumentException | Throw when diagnosticsInformation has an invalid values. |
| ArgumentException | Throw when diagnosticsInformation is specified and the headers parameter contains diagnostics headers. |