ChatRoomSession.BeginJoin Method (ChatRoomSummary, AsyncCallback, Object)
Join the chat room indicated by the given ChatRoomSession. To join a chat room, a user must be an authorized member. Only one active ChatRoomSession may exist for any given chat room per endpoint.
Namespace: Microsoft.Rtc.Collaboration.GroupChat
Assembly: Microsoft.Rtc.Collaboration.GroupChat (in Microsoft.Rtc.Collaboration.GroupChat.dll)
Syntax
'Declaration
Public Function BeginJoin ( _
chatRoomSummary As ChatRoomSummary, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As ChatRoomSession
Dim chatRoomSummary As ChatRoomSummary
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginJoin(chatRoomSummary, _
userCallback, state)
public IAsyncResult BeginJoin(
ChatRoomSummary chatRoomSummary,
AsyncCallback userCallback,
Object state
)
Parameters
- chatRoomSummary
Type: Microsoft.Rtc.Collaboration.GroupChat.ChatRoomSummary
The chat room summary.
- 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.
Return Value
Type: System.IAsyncResult
An IAsyncResult that references this operation.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | Thrown when invalid arguments are passed. |
| [System.InvalidOperationException] | Thrown when the session is already joined. |
| [Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException] | Thrown when the GroupChatEndpoint is not established. |
| [RealTimeException] | Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server. |
Remarks
This request will be processed asynchronously. See EndJoin(IAsyncResult) to complete this asynchronous operation.