Leave the chat room. This method ends a user's current session which was initiated by a Join operation.
Assembly: Microsoft.Rtc.Collaboration.GroupChat(in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function BeginLeave ( _ userCallback As AsyncCallback, _ state As Object _ ) As IAsyncResult |
Visual Basic (Usage) |
---|
Dim instance As ChatRoomSession Dim userCallback As AsyncCallback Dim state As Object Dim returnValue As IAsyncResult returnValue = instance. BeginLeave( userCallback, _ state) |
C# |
---|
public IAsyncResult BeginLeave( AsyncCallback userCallback, Object state ) |
Parameters
- userCallback
- Type:
System
.
.
::
.
.
AsyncCallback
The method to be invoked when this asynchronous operation completes.
- state
- Type:
System
.
.
::
.
.
Object
An object to be passed back to the callback.
Exceptions
Exception | Condition |
---|---|
[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException] |
Thrown when the GroupChatEndpoint is not established. |
[Microsoft.Rtc.Collaboration.GroupChat.ChatRoomSessionStateException] |
Thrown when the ChatRoomSession is not joined. |
[System.InvalidOperationException] |
Thrown when the chat server connection is not in a valid state to send the command. |
[RealTimeException] |
Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server. |
Remarks
This request will be processed asynchronously. See EndLeave(IAsyncResult) to complete this asynchronous operation.