ChatRoomSession.BeginJoin Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| BeginJoin(ChatRoomSummary, AsyncCallback, Object) |
Joins the chat room indicated by the given ChatRoomSummary. |
| BeginJoin(String, AsyncCallback, Object) |
Joins the chat room with the given name. |
| BeginJoin(Uri, AsyncCallback, Object) |
Joins the chat room indicated by the given URI. |
BeginJoin(ChatRoomSummary, AsyncCallback, Object)
Joins the chat room indicated by the given ChatRoomSummary.
public:
IAsyncResult ^ BeginJoin(Microsoft::Rtc::Collaboration::PersistentChat::ChatRoomSummary ^ chatRoomSummary, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginJoin (Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomSummary chatRoomSummary, AsyncCallback userCallback, object state);member this.BeginJoin : Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomSummary * AsyncCallback * obj -> IAsyncResultParameters
- chatRoomSummary
- ChatRoomSummary
The chat room summary.
- userCallback
- AsyncCallback
The callback method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult that references this operation.
Exceptions
chatRoomSummary is null.
The chat room is already joined.
The PersistentChatEndpoint is not established.
The PersistentChatEndpoint encountered an error communicating with the chat server.
Remarks
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.
Applies to
BeginJoin(String, AsyncCallback, Object)
Joins the chat room with the given name.
public:
IAsyncResult ^ BeginJoin(System::String ^ chatRoomName, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginJoin (string chatRoomName, AsyncCallback userCallback, object state);member this.BeginJoin : string * AsyncCallback * obj -> IAsyncResultPublic Function BeginJoin (chatRoomName As String, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- chatRoomName
- String
Name of the chat room to join.
- userCallback
- AsyncCallback
The callback method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult object that references this operation.
Exceptions
chatRoomName is null or empty.
The chat room is already joined.
The PersistentChatEndpoint is not established.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
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. Call EndJoin(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginJoin(Uri, AsyncCallback, Object)
Joins the chat room indicated by the given URI.
public:
IAsyncResult ^ BeginJoin(Uri ^ chatRoomUri, AsyncCallback ^ userCallback, System::Object ^ state);public IAsyncResult BeginJoin (Uri chatRoomUri, AsyncCallback userCallback, object state);member this.BeginJoin : Uri * AsyncCallback * obj -> IAsyncResultPublic Function BeginJoin (chatRoomUri As Uri, userCallback As AsyncCallback, state As Object) As IAsyncResultParameters
- chatRoomUri
- Uri
The chat room URI.
- userCallback
- AsyncCallback
The callback method to be invoked when this asynchronous operation completes.
- state
- Object
An object to be passed back to the callback.
Returns
An IAsyncResult that references this operation.
Exceptions
chatRoomUri is null.
chatRoomUri is not a valid chat room URI.
The chat room is already joined.
The PersistentChatEndpoint is not established.
The PersistentChatEndpoint encountered an error communicating with the chat server.
Remarks
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. Call EndJoin(IAsyncResult) to complete this asynchronous operation.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for