Ejects a participant or an endpoint from the
MCU based on the supplied URI.
Namespace:
Microsoft.Rtc.Collaboration
Assembly:
Microsoft.Rtc.Collaboration(in
Microsoft.Rtc.Collaboration.dll)
Syntax
Visual Basic (Declaration) |
Public
Function
BeginEject ( _
uri
As
String, _
userCallback
As
AsyncCallback, _
state
As
Object _
)
As
IAsyncResult
|
C# |
public
IAsyncResult
BeginEject(
string
uri,
AsyncCallback
userCallback,
Object
state
)
|
Visual C++ |
public:
IAsyncResult^
BeginEject(
String^
uri,
AsyncCallback^
userCallback,
Object^
state
)
|
JavaScript |
function
beginEject(
uri,
userCallback,
state);
|
Parameters
-
uri
- Type:
String
The URI of the participant or endpoint to eject.
-
userCallback
- Type:
AsyncCallback
The method to be called when the asynchronous operation is
completed.
-
state
- Type:
Object
A user-provided object that distinguishes this particular
asynchronous operation from other asynchronous operations.
Return Value
IAsyncResult that
references the asynchronous operation.
Remarks
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 URI is null. |
ArgumentException
|
Thrown when the supplied URI is invalid. |
Microsoft.Rtc.Signaling
.
.
::
.
RealTimeInvalidOperationException
|
Thrown when the parent ConferenceSession is reconnecting
(FailureReason will be set to
InvalidOperationReason.RetryableOperation). |
See Also