WebPubSubServiceClient.CloseUserConnectionsAsync Method
Definition
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.
Close connections for the specific user.
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)
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
The response returned from the service.
Exceptions
userId
is null.
userId
is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call CloseUserConnectionsAsync with required parameters.
var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");
Response response = await client.CloseUserConnectionsAsync("<userId>");
Console.WriteLine(response.Status);
This sample shows how to call CloseUserConnectionsAsync with all parameters.
var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");
Response response = await client.CloseUserConnectionsAsync("<userId>", new String[]{"<excluded>"}, "<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
Azure SDK for .NET
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro