Export (0) Print
Expand All

ChatRoomSession.BeginJoin method (ChatRoomSummary, AsyncCallback, Object)

Joins the chat room indicated by the given ChatRoomSummary.

Namespace:  Microsoft.Rtc.Collaboration.PersistentChat
Assembly:  Microsoft.Rtc.Collaboration.PersistentChat (in Microsoft.Rtc.Collaboration.PersistentChat.dll)

public IAsyncResult BeginJoin(
	ChatRoomSummary chatRoomSummary,
	AsyncCallback userCallback,
	Object state
)

Parameters

chatRoomSummary
Type: Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomSummary

The chat room summary.

userCallback
Type: System.AsyncCallback

The callback 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.

ExceptionCondition
ArgumentNullException

chatRoomSummary is null.

InvalidOperationException

The chat room is already joined.

ChatRoomSessionStateException

The State is not Idle

ChatServerConnectionException

The PersistentChatEndpoint is not established.

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the chat server.

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. This request will be processed asynchronously. See EndJoin(IAsyncResult) to complete this asynchronous operation.

Show:
© 2015 Microsoft