WebPubSubChatServiceClient.GetRoles 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
GetRoles(Nullable<Int32>, String, CancellationToken)	Query roles in a hub.
GetRoles(Nullable<Int32>, String, RequestContext)	[Protocol Method] Query roles in a hub. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetRoles(Nullable<Int32>, String, CancellationToken)

Source:

WebPubSubChatServiceClient.cs

Query roles in a hub.

public virtual Azure.Pageable<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole> GetRoles(int? maxPageSize = default, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRoles : Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole>
override this.GetRoles : Nullable<int> * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRole>

Public Overridable Function GetRoles (Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of WebPubSubChatRole)

Parameters

maxPageSize

Nullable<Int32>

The maximum number of result items per page.

continuationToken

String

Continuation token for pagination.

cancellationToken

CancellationToken

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

Returns

Pageable<WebPubSubChatRole>

Exceptions

RequestFailedException

Service returned a non-success status code.

GetRoles(Nullable<Int32>, String, RequestContext)

Source:

WebPubSubChatServiceClient.cs

[Protocol Method] Query roles in a hub.

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

public virtual Azure.Pageable<BinaryData> GetRoles(int? maxPageSize, string continuationToken, Azure.RequestContext context);

abstract member GetRoles : Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetRoles : Nullable<int> * string * Azure.RequestContext -> Azure.Pageable<BinaryData>

Public Overridable Function GetRoles (maxPageSize As Nullable(Of Integer), continuationToken As String, context As RequestContext) As Pageable(Of BinaryData)

Parameters

maxPageSize

Nullable<Int32>

The maximum number of result items per page.

continuationToken

String

Continuation token for pagination.

context

RequestContext

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

Returns

Pageable<BinaryData>

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.