BeginJoin Method (String, AsyncCallback, Object)

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

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

'Declaration
Public Function BeginJoin ( _
    chatRoomName As String, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'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)
public IAsyncResult BeginJoin(
    string chatRoomName,
    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.

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

Reference

ChatRoomSession Class

ChatRoomSession Members

BeginJoin Overload

Microsoft.Rtc.Collaboration.GroupChat Namespace