ChatRoomSession.BeginLeave(AsyncCallback, Object) Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.PersistentChat

Assembly:: Microsoft.Rtc.Collaboration.PersistentChat.dll

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.

Leaves the chat room and ends a user's current session which was initiated by a joining operation.

public:
 IAsyncResult ^ BeginLeave(AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginLeave (AsyncCallback userCallback, object state);

member this.BeginLeave : AsyncCallback * obj -> IAsyncResult

Public Function BeginLeave (userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

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

IAsyncResult

An IAsyncResult object that references this operation.

Exceptions

ChatServerConnectionException

The PersistentChatEndpoint is not established.

ChatRoomSessionStateException

The State is not Established.

InvalidOperationException

The chat server connection is not in a valid state to send the command.

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the chat server.

Remarks

This request will be processed asynchronously. Call EndLeave(IAsyncResult) to complete this asynchronous operation.

Applies to