Export (0) Print
Expand All

BeginSendChatMessage Method (String, String, Boolean, 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.

Send a story message to the chat room. Story messages are generally used for sending long-format chat messages. They are displayed in the group chat client as a one-line message, on which the title of the story appears as a clickable link. When selected, the entire content of the message is displayed in a dialog box. Users must first successfully join a chat room to initiate the session before a message can be sent.

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

public IAsyncResult BeginSendChatMessage(
	string title,
	string content,
	bool alert,
	AsyncCallback userCallback,
	Object state
)

Parameters

title
Type: System.String
The title of the story message.
content
Type: System.String
The body of the story message
alert
Type: System.Boolean
If true, send this message as an alert; otherwise send the message with normal priority.
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:
© 2014 Microsoft