Sends a message to another endpoint. To send a non-empty message, use the options parameter.

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

Syntax

Visual Basic (Declaration) 
Public 
Function 
BeginSendMessage ( _
	
messageType 
As 

MessageType, _
	
sessionTarget 
As 

RealTimeAddress, _
	
options 
As 

SendMessageOptions, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C# 
public 
IAsyncResult 
BeginSendMessage(
	
MessageType

messageType,
	

RealTimeAddress 
sessionTarget,
	

SendMessageOptions 
options,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++ 
public:
IAsyncResult^ 
BeginSendMessage(
	
MessageType

messageType, 
	

RealTimeAddress^ 
sessionTarget, 
	

SendMessageOptions^ 
options, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript 
function 
beginSendMessage(
messageType, 
sessionTarget, 
options, 
userCallback, 
state);

Parameters

messageType
Type: Microsoft.Rtc.Signaling . . :: . MessageType
The message type.
sessionTarget
Type: Microsoft.Rtc.Signaling . . :: . RealTimeAddress
The target to send the message.
options
Type: Microsoft.Rtc.Signaling . . :: . SendMessageOptions
The options to customize the behavior of this method.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from others.

Return Value

An IAsyncResult that references the asynchronous operation.

Exceptions

Exception Condition
ArgumentNullException Thrown when null is supplied for a required argument. The argument name which is required is is part of the exception message.
ArgumentException Thrown if one of the SignalingHeader in signalingHeaders collection have null or restricted header.
Microsoft.Rtc.Signaling . . :: . ServerPolicyException Thrown when a server policy setting does not allow sending the message.

See Also