WebPubSubChatServiceClient.GetRole Method

Definition

Namespace:

Azure.Messaging.WebPubSub.Chat

Assembly:

Azure.Messaging.WebPubSub.Chat.dll

Package:

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

Overloads

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

GetRole(String, RequestContext)

Source:

WebPubSubChatServiceClient.cs

[Protocol Method] Get role information.

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

public virtual Azure.Response GetRole(string roleName, Azure.RequestContext context);

abstract member GetRole : string * Azure.RequestContext -> Azure.Response
override this.GetRole : string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetRole (roleName As String, context As RequestContext) As Response

Parameters

roleName

String

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

context

RequestContext

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

Returns

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.

GetRole(String, CancellationToken)

Source:

WebPubSubChatServiceClient.cs

Get role information.

public virtual Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole> GetRole(string roleName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRole : string * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole>
override this.GetRole : string * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole>

Public Overridable Function GetRole (roleName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of WebPubSubChatRole)

Parameters

roleName

String

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

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<WebPubSubChatRole>

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.