WebPubSubServiceClient.CloseUserConnectionsAsync Méthode

Définition

Espace de noms:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Paquet:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

Fermez les connexions pour l’utilisateur spécifique.

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)

Paramètres

userId

String

ID utilisateur.

excluded

IEnumerable<String>

Excluez ces id de connexion lors de la fermeture des connexions pour l’utilisateur.

reason

String

Raison de la fermeture de la connexion cliente.

context

RequestContext

Contexte de requête, qui peut remplacer les comportements par défaut du pipeline client par appel.

Retours

Task<Response>

Réponse retournée par le service.

Exceptions

ArgumentNullException

userId a la valeur null.

ArgumentException

userId est une chaîne vide, et on s’attendait à ce qu’elle ne soit pas vide.

RequestFailedException

Le service a retourné un code de status non réussi.

Exemples

Cet exemple montre comment appeler CloseUserConnectionsAsync avec les paramètres requis.

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

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

Cet exemple montre comment appeler CloseUserConnectionsAsync avec tous les paramètres.

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

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

Remarques

Schéma pour Response Error:

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