Partilhar via


McuSession.BeginEject Method (ConversationParticipant, AsyncCallback, Object)

Ejects a participant from the MCU.

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

Syntax

'Declaration
Public Function BeginEject ( _
    participant As ConversationParticipant, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As McuSession
Dim participant As ConversationParticipant
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginEject(participant, _
    userCallback, state)
public IAsyncResult BeginEject(
    ConversationParticipant participant,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • 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
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.

RealTimeInvalidOperationException

Thrown when the parent ConferenceSession is reconnecting (FailureReason will be set to InvalidOperationReason.RetryableOperation).

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.

See Also

Reference

McuSession Class

McuSession Members

BeginEject Overload

Microsoft.Rtc.Collaboration Namespace