Share via

HubLifetimeManager<THub>.SendGroupExceptAsync Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.SignalR
Assembly:
Microsoft.AspNetCore.SignalR.Core.dll
Package:
Microsoft.AspNetCore.SignalR.Core v1.0.0
Package:
Microsoft.AspNetCore.SignalR.Core v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0
Source:
HubLifetimeManager.cs

Sends an invocation message to the specified group excluding the specified connections.

public abstract System.Threading.Tasks.Task SendGroupExceptAsync (string groupName, string methodName, object[] args, System.Collections.Generic.IReadOnlyList<string> excludedConnectionIds, System.Threading.CancellationToken cancellationToken = default);
public abstract System.Threading.Tasks.Task SendGroupExceptAsync (string groupName, string methodName, object?[]? args, System.Collections.Generic.IReadOnlyList<string> excludedConnectionIds, System.Threading.CancellationToken cancellationToken = default);
public abstract System.Threading.Tasks.Task SendGroupExceptAsync (string groupName, string methodName, object?[] args, System.Collections.Generic.IReadOnlyList<string> excludedConnectionIds, System.Threading.CancellationToken cancellationToken = default);
abstract member SendGroupExceptAsync : string * string * obj[] * System.Collections.Generic.IReadOnlyList<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public MustOverride Function SendGroupExceptAsync (groupName As String, methodName As String, args As Object(), excludedConnectionIds As IReadOnlyList(Of String), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

groupName
String

The group name.

methodName
String

The invocation method name.

args
Object[]

The invocation arguments.

excludedConnectionIds
IReadOnlyList<String>

A collection of connection IDs to exclude.

cancellationToken
CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A Task that represents the asynchronous send.

Applies to