WebPubSubChatServiceClient.GetRoomMembers 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
GetRoomMembers(String, Nullable<Int32>, String, RequestContext)	[Protocol Method] Get room members. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoomMembers(String, Nullable<Int32>, String, CancellationToken)	Get room members.

Name

Description

GetRoomMembers(String, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get room members.

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

GetRoomMembers(String, Nullable<Int32>, String, CancellationToken)

Get room members.

GetRoomMembers(String, Nullable<Int32>, String, RequestContext)

Source:: WebPubSubChatServiceClient.cs

[Protocol Method] Get room members.

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

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

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

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

Parameters

roomId: String

Room identifier.

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

ArgumentNullException

roomId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Applies to

GetRoomMembers(String, Nullable<Int32>, String, CancellationToken)

Source:: WebPubSubChatServiceClient.cs

Get room members.

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

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

Public Overridable Function GetRoomMembers (roomId As String, Optional maxPageSize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of WebPubSubChatRoomMember)