Ejects a participant from the MCU.

Namespace:  Microsoft.Rtc.Collaboration
Assembly:  Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginEject ( _
	
participant 
As 

ConversationParticipant, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
public 
IAsyncResult 
BeginEject(
	

ConversationParticipant 
participant,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
public:
IAsyncResult^ 
BeginEject(
	

ConversationParticipant^ 
participant, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginEject(
participant, 
userCallback, 
state);

Parameters

participant
Type: Microsoft.Rtc.Collaboration . . :: . ConversationParticipant
The participant to eject.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

The parent ConferenceSession has to be connected to a conference that supports the corresponding MCU type.

The operation times out if no response was received within three minutes. If a pending response was received, the wait period is reset back to three minutes.

Exceptions

Exception Condition
InvalidOperationException Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.
ArgumentNullException Thrown when the supplied participant is null.
Microsoft.Rtc.Signaling . . :: . RealTimeInvalidOperationException Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

See Also