WebPubSubServiceClient.CloseUserConnections Method

Reference

Definition

Namespace:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Package:: Azure.Messaging.WebPubSub v1.4.0

Source:: WebPubSubServiceClient.cs

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.

[Protocol Method] Close connections for the specific user.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

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

abstract member CloseUserConnections : string * seq<string> * string * Azure.RequestContext -> Azure.Response
override this.CloseUserConnections : string * seq<string> * string * Azure.RequestContext -> Azure.Response

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

Parameters

userId: String

The user Id.

excluded: IEnumerable<String>

Exclude these connectionIds when closing the connections for the user.

reason: String

The reason closing the client connection.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

userId is null.

ArgumentException

userId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CloseUserConnections.

WebPubSubServiceClient client = new WebPubSubServiceClient("<Endpoint>", "<Hub>");

Response response = client.CloseUserConnections("<userId>");

Console.WriteLine(response.Status);

This sample shows how to call CloseUserConnections with all parameters.

WebPubSubServiceClient client = new WebPubSubServiceClient("<Endpoint>", "<Hub>");

Response response = client.CloseUserConnections("<userId>", excluded: new string[] { "<excluded>" }, reason: "<reason>");

Console.WriteLine(response.Status);

Remarks

Schema for Response Error:

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

Applies to

Share via