WebPubSubChatServiceClient.DeleteRoleAsync Method

Definition

Namespace:: Azure.Messaging.WebPubSub.Chat

Assembly:: Azure.Messaging.WebPubSub.Chat.dll

Package:: Azure.Messaging.WebPubSub.Chat v1.0.0-beta.1

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.

Overloads

Name	Description
DeleteRoleAsync(String, MatchConditions, RequestContext)	[Protocol Method] Delete a role. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRoleAsync(String, MatchConditions, CancellationToken)	Delete a role.

Name

Description

DeleteRoleAsync(String, MatchConditions, RequestContext)

[Protocol Method] Delete a role.

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

DeleteRoleAsync(String, MatchConditions, CancellationToken)

Delete a role.

DeleteRoleAsync(String, MatchConditions, RequestContext)

Source:: WebPubSubChatServiceClient.cs

[Protocol Method] Delete a role.

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

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteRoleAsync(string roleName, Azure.MatchConditions matchConditions, Azure.RequestContext context);

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

Public Overridable Function DeleteRoleAsync (roleName As String, matchConditions As MatchConditions, context As RequestContext) As Task(Of Response)

Parameters

roleName: String

Role name. Must start with 'user.' or 'room.' prefix.

matchConditions: MatchConditions

The content to send as the request conditions of the request.

context: RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

roleName is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

DeleteRoleAsync(String, MatchConditions, CancellationToken)

Source:: WebPubSubChatServiceClient.cs

Delete a role.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteRoleAsync(string roleName, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteRoleAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteRoleAsync : string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteRoleAsync (roleName As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)