ConnectionExtensions.Send Method

.NET Framework 4

Sends a message to all connections subscribed to the specified signal. An example of signal may be a specific connection id, or fully qualified group name (Use IGroupManager to manipulate groups).

Namespace:  Microsoft.AspNet.SignalR
Assembly:  Microsoft.AspNet.SignalR.Core (in Microsoft.AspNet.SignalR.Core.dll)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Send ( _
    connection As IConnection, _
    connectionId As String, _
    value As Object, _
    ParamArray excludeConnectionIds As String() _
) As Task
'Usage
Dim connection As IConnection 
Dim connectionId As String 
Dim value As Object 
Dim excludeConnectionIds As String()
Dim returnValue As Task 

returnValue = connection.Send(connectionId, _
    value, excludeConnectionIds)
public static Task Send(
    this IConnection connection,
    string connectionId,
    Object value,
    params string[] excludeConnectionIds
)
[ExtensionAttribute]
public:
static Task^ Send(
    IConnection^ connection, 
    String^ connectionId, 
    Object^ value, 
    ... array<String^>^ excludeConnectionIds
)
static member Send : 
        connection:IConnection * 
        connectionId:string * 
        value:Object * 
        excludeConnectionIds:string[] -> Task
public static function Send(
    connection : IConnection, 
    connectionId : String, 
    value : Object, 
    ... excludeConnectionIds : String[]
) : Task

Parameters

  • excludeConnectionIds
    Type: System.String[]
    The list of connection ids to exclude

Return Value

Type: System.Threading.Tasks.Task
A task that represents when the broadcast is complete.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IConnection. When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=vs.100) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.100).

See Also

Reference

ConnectionExtensions Class

Microsoft.AspNet.SignalR Namespace