ChatRoomSession.BeginSendChatMessage 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
BeginSendChatMessage(String, String, String, Boolean, AsyncCallback, Object)
Send a RTF-formatted story message to the joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(System::String ^ title, System::String ^ content, System::String ^ rtfContent, bool alert, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (string title, string content, string rtfContent, bool alert, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : string * string * string * bool * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (title As String, content As String, rtfContent As String, alert As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- title
- String
The title of the story message.
- content
- String
The body of the story message
- rtfContent
- String
The RTF formatted body of the story message.
- alert
- Boolean
If true, send this message as an alert; otherwise send the message with normal priority.
- 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
title
or content
is null or empty, or rtfContent
does not contain valid RTF.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
Story messages are generally used for sending long-format chat messages. They are displayed 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. This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(String, String, Boolean, AsyncCallback, Object)
Send a story message to the joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(System::String ^ title, System::String ^ content, bool alert, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (string title, string content, bool alert, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : string * string * bool * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (title As String, content As String, alert As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- title
- String
The title of the story message.
- content
- String
The body of the story message
- alert
- Boolean
If true, send this message as an alert; otherwise send the message with normal priority.
- 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
title
or content
is null or empty.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
Story messages are generally used for sending long-format chat messages. They are displayed 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. This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(String, Boolean, String, AsyncCallback, Object)
Send a RTF-formatted high priority alert message to the joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(System::String ^ message, bool alert, System::String ^ rtf, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (string message, bool alert, string rtf, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : string * bool * string * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (message As String, alert As Boolean, rtf As String, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- message
- String
The message.
- alert
- Boolean
If true, send this message as an alert; otherwise send the message with normal priority.
- rtf
- String
The RTF formatted version of the message.
- 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
message
is null or empty, or rtf
does not contain valid RTF.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(String, String, AsyncCallback, Object)
Sends an RTF-formatted chat message to the joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(System::String ^ message, System::String ^ rtf, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (string message, string rtf, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : string * string * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (message As String, rtf As String, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- message
- String
The message.
- rtf
- String
The RTF formatted version of the message.
- 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
message
is null or empty, or rtf
does not contain valid RTF.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the chat server.
Remarks
This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(FormattedOutboundChatMessage, AsyncCallback, Object)
Sends a formatted chat message to a joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(Microsoft::Rtc::Collaboration::PersistentChat::FormattedOutboundChatMessage ^ formattedMessage, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (Microsoft.Rtc.Collaboration.PersistentChat.FormattedOutboundChatMessage formattedMessage, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : Microsoft.Rtc.Collaboration.PersistentChat.FormattedOutboundChatMessage * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (formattedMessage As FormattedOutboundChatMessage, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- formattedMessage
- FormattedOutboundChatMessage
The formatted message.
- 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
formattedMessage
is null or empty.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
A formatted message can be composed of hyperlinks, emoticons, and other parts. This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(FormattedOutboundChatMessage, String, AsyncCallback, Object)
Sends a formatted chat message with RTF-formatted content to a chat room.
public:
IAsyncResult ^ BeginSendChatMessage(Microsoft::Rtc::Collaboration::PersistentChat::FormattedOutboundChatMessage ^ formattedMessage, System::String ^ rtfContent, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (Microsoft.Rtc.Collaboration.PersistentChat.FormattedOutboundChatMessage formattedMessage, string rtfContent, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : Microsoft.Rtc.Collaboration.PersistentChat.FormattedOutboundChatMessage * string * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (formattedMessage As FormattedOutboundChatMessage, rtfContent As String, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- formattedMessage
- FormattedOutboundChatMessage
The formatted message.
- rtfContent
- String
The RTF formatted body of the formatted message.
- 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
formattedMessage
is null or empty, or rtfContent
does not contain valid RTF.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
A formatted message is composed of hyperlinks, emoticons, or other parts. This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(String, AsyncCallback, Object)
Sends a chat message to a joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(System::String ^ message, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (string message, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : string * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (message As String, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- message
- String
The message.
- 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 oject that references this operation.
Exceptions
message
is null or empty
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the chat server.
Remarks
This request will be processed asynchronously. See EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
BeginSendChatMessage(String, Boolean, AsyncCallback, Object)
Sends a high priority alert message to the joined chat room.
public:
IAsyncResult ^ BeginSendChatMessage(System::String ^ message, bool alert, AsyncCallback ^ userCallback, System::Object ^ state);
public IAsyncResult BeginSendChatMessage (string message, bool alert, AsyncCallback userCallback, object state);
member this.BeginSendChatMessage : string * bool * AsyncCallback * obj -> IAsyncResult
Public Function BeginSendChatMessage (message As String, alert As Boolean, userCallback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- message
- String
The message.
- alert
- Boolean
If true, send this message as an alert; otherwise send the message with normal priority.
- 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
message
is null or empty.
The PersistentChatEndpoint is not established.
The State is not Established.
The chat server connection is not in a valid state to send the command.
The PersistentChatEndpoint encountered an error communicating with the persistent chat server.
Remarks
This request will be processed asynchronously. Call EndSendChatMessage(IAsyncResult) to complete this asynchronous operation.
Applies to
Feedback
https://aka.ms/ContentUserFeedback.
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:Submit and view feedback for