Join the chat room with the given name. 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

Visual Basic (Declaration) 
Public 
Function 
BeginJoin ( _
	
chatRoomName 
As 
String, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
Visual Basic (Usage) 
Dim 
instance 
As 

ChatRoomSession
Dim 
chatRoomName 
As 
String
Dim 
userCallback 
As 
AsyncCallback
Dim 
state 
As 
Object
Dim 
returnValue 
As 
IAsyncResult

returnValue = instance.
BeginJoin(
chatRoomName, _
	
userCallback, 
state)
C# 
public 
IAsyncResult 
BeginJoin(
	
string 
chatRoomName,
	
AsyncCallback 
userCallback,
	
Object 
state
)

Parameters

chatRoomName
Type: System . . :: . . String

Name of the chat room to join.

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.

See Also