McuSession.BeginEject Method

Definition

Namespace:

Microsoft.Rtc.Collaboration

Assembly:

Microsoft.Rtc.Collaboration.dll

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 -> IAsyncResult

Public Function BeginEject (participant As ConversationParticipant, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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.

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 -> IAsyncResult

Public Function BeginEject (uri As String, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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

IAsyncResult that references the asynchronous operation.

Exceptions

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 URI is null.

ArgumentException

Thrown when the supplied URI is invalid.

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.

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 -> IAsyncResult

Public Function BeginEject (participant As ConversationParticipant, options As EjectOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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

IAsyncResult

An IAsyncResult that references the asynchronous operation.

Exceptions

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.

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 -> IAsyncResult

Public Function BeginEject (uri As String, options As EjectOptions, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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

IAsyncResult that references the asynchronous operation.

Exceptions

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 URI is null.

ArgumentException

Thrown when the supplied URI is invalid.

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.