ConferenceSession.BeginEject Method (ConversationParticipant, EjectOptions, AsyncCallback, Object)

Ejects all endpoints of a participant from the conference.

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

Syntax

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

returnValue = instance.BeginEject(participant, _
    options, userCallback, state)

public IAsyncResult BeginEject(
    ConversationParticipant participant,
    EjectOptions options,
    AsyncCallback userCallback,
    Object state
)

Parameters

• participant
  Type: Microsoft.Rtc.Collaboration.ConversationParticipant
  The participant to eject.

• options
  Type: Microsoft.Rtc.Collaboration.EjectOptions
  Options to customize ejecting a participant.

• 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

Remarks

This operation is allowed by the server for conference leaders only.

See Also

Reference

ConferenceSession Class

ConferenceSession Members

BeginEject Overload

Microsoft.Rtc.Collaboration Namespace