HubLifetimeManager<THub>.RemoveFromGroupAsync 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

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.

Removes a connection from the specified group.

public abstract System.Threading.Tasks.Task RemoveFromGroupAsync (string connectionId, string groupName, System.Threading.CancellationToken cancellationToken = default);

abstract member RemoveFromGroupAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public MustOverride Function RemoveFromGroupAsync (connectionId As String, groupName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

connectionId: String

The connection ID to remove from a group.

groupName: String

The group name.

cancellationToken: CancellationToken

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

Returns

Task

A Task that represents the asynchronous remove.

Applies to