ChatRoomSession.BeginSendChatMessage Method (FormattedOutboundChatMessage, AsyncCallback, Object)

Sends a formatted chat message to a chat room. A formatted message can be composed of hyperlinks, emoticons, and other parts.

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

public IAsyncResult BeginSendChatMessage(
	FormattedOutboundChatMessage formattedMessage,
	AsyncCallback userCallback,
	Object state
)

Parameters

formattedMessage
Type: Microsoft.Rtc.Collaboration.GroupChat.FormattedOutboundChatMessage
The formatted message.
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.

ExceptionCondition
ArgumentException

Thrown when invalid arguments are passed.

[Microsoft.Rtc.Collaboration.GroupChat.ChatServerConnectionException]

Thrown when the GroupChatEndpoint is not established.

[Microsoft.Rtc.Collaboration.GroupChat.ChatRoomSessionStateException]

Thrown when the ChatRoomSession is not joined.

[System.InvalidOperationException]

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

[RealTimeException]

Thrown when the GroupChatEndpoint encounters an error communicating with the group chat server.

This request will be processed asynchronously. See EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.

Show: