你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

WebPubSubServiceClient.CloseUserConnectionsAsync 方法

定义

命名空间:

Azure.Messaging.WebPubSub

程序集:

Azure.Messaging.WebPubSub.dll

包:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

关闭特定用户的连接。

public virtual System.Threading.Tasks.Task<Azure.Response> CloseUserConnectionsAsync (string userId, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

abstract member CloseUserConnectionsAsync : string * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CloseUserConnectionsAsync : string * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function CloseUserConnectionsAsync (userId As String, Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

参数

userId

String

用户 ID。

excluded

IEnumerable<String>

关闭用户连接时排除这些 connectionId。

reason

String

关闭客户端连接的原因。

context

RequestContext

请求上下文，可以基于每个调用替代客户端管道的默认行为。

返回

Task<Response>

从服务返回的响应。

例外

ArgumentNullException

userId 为 null。

ArgumentException

userId 是一个空字符串，预期为非空。

RequestFailedException

服务返回了非成功状态代码。

示例

此示例演示如何使用所需参数调用 CloseUserConnectionsAsync。

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = await client.CloseUserConnectionsAsync("<userId>");
Console.WriteLine(response.Status);

此示例演示如何使用所有参数调用 CloseUserConnectionsAsync。

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = await client.CloseUserConnectionsAsync("<userId>", new String[]{"<excluded>"}, "<reason>");
Console.WriteLine(response.Status);

注解

的 Response Error架构：

{
              code: string,
              message: string,
              target: string,
              details: [ErrorDetail],
              inner: {
                code: string,
                inner: InnerError
              }
            }