McuSession.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 a participant from the MCU. |
| BeginEject(String, AsyncCallback, Object) |
Ejects a participant or an endpoint from the MCU based on the supplied URI. |
| BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object) |
Ejects a participant from the MCU. |
| BeginEject(String, EjectOptions, AsyncCallback, Object) |
Ejects a participant or an endpoint from the MCU based on the supplied URI. |
BeginEject(ConversationParticipant, AsyncCallback, Object)
Ejects a participant from the MCU.
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 parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.
Thrown when the supplied participant is null.
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.
Applies to
BeginEject(String, AsyncCallback, Object)
Ejects a participant or an endpoint from the MCU based on the supplied URI.
public:
IAsyncResult ^ BeginEject(System::String ^ uri, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginEject (string uri, AsyncCallback userCallback, object state);member this.BeginEject : string * AsyncCallback * obj -> IAsyncResultPublic Function BeginEject (uri As String, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- uri
- String
The URI of the participant or endpoint 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
IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.
Thrown when the supplied URI is null.
Thrown when the supplied URI is invalid.
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.
Applies to
BeginEject(ConversationParticipant, EjectOptions, AsyncCallback, Object)
Ejects a participant from the MCU.
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 the operation. Could be null.
- 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 parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.
Thrown when the supplied participant is null.
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.
Applies to
BeginEject(String, EjectOptions, AsyncCallback, Object)
Ejects a participant or an endpoint from the MCU based on the supplied URI.
public:
IAsyncResult ^ BeginEject(System::String ^ uri, Microsoft::Rtc::Collaboration::EjectOptions ^ options, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginEject (string uri, Microsoft.Rtc.Collaboration.EjectOptions options, AsyncCallback userCallback, object state);member this.BeginEject : string * Microsoft.Rtc.Collaboration.EjectOptions * AsyncCallback * obj -> IAsyncResultPublic Function BeginEject (uri As String, options As EjectOptions, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- uri
- String
The URI of the participant or endpoint to eject.
- options
- EjectOptions
Options to customize the eject operation. Could be null.
- 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
IAsyncResult that references the asynchronous operation.
Exceptions
Thrown when the parent ConferenceSession is not in a valid state or the conference does not support the corresponding MCU type.
Thrown when the supplied URI is null.
Thrown when the supplied URI is invalid.
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.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for