ConferenceSession.BeginEject Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| BeginEject(ConversationParticipant, AsyncCallback, Object) |
Ejects all endpoints of a participant from the conference. |
| BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object) |
Ejects all endpoints of a participant from the conference. |
BeginEject(ConversationParticipant, AsyncCallback, Object)
Ejects all endpoints of a participant from the conference.
public:
IAsyncResult ^ BeginEject(Microsoft::Rtc::Collaboration::ConversationParticipant ^ participant, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginEject (Microsoft.Rtc.Collaboration.ConversationParticipant participant, AsyncCallback userCallback, object state);member this.BeginEject : Microsoft.Rtc.Collaboration.ConversationParticipant * AsyncCallback * obj -> IAsyncResultPublic Function BeginEject (participant As ConversationParticipant, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- participant
- ConversationParticipant
The participant to eject.
- 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
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the operation is not valid at the given conference session state.
Thrown when the participant argument was null.
Remarks
This operation is allowed by the server for conference leaders only.
Applies to
BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object)
Ejects all endpoints of a participant from the conference.
public:
IAsyncResult ^ BeginEject(Microsoft::Rtc::Collaboration::ConversationParticipant ^ participant, Microsoft::Rtc::Collaboration::EjectOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginEject (Microsoft.Rtc.Collaboration.ConversationParticipant participant, Microsoft.Rtc.Collaboration.EjectOptions options, AsyncCallback userCallback, object state);member this.BeginEject : Microsoft.Rtc.Collaboration.ConversationParticipant * Microsoft.Rtc.Collaboration.EjectOptions * AsyncCallback * obj -> IAsyncResultPublic Function BeginEject (participant As ConversationParticipant, options As EjectOptions, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- participant
- ConversationParticipant
The participant to eject.
- options
- EjectOptions
Options to customize ejecting a participant.
- 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
An IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the operation is not valid at the given conference session state.
Thrown when the participant argument was null.
Remarks
This operation is allowed by the server for conference leaders only.