Share via


ConversationsExtensions.GetConversationPagedMembersAsync Method

Definition

GetConversationPagedMembers.

public static System.Threading.Tasks.Task<Microsoft.Bot.Connector.PagedMembersResult> GetConversationPagedMembersAsync (this Microsoft.Bot.Connector.IConversations operations, string conversationId, int? pageSize = default, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);
public static System.Threading.Tasks.Task<Microsoft.Bot.Schema.PagedMembersResult> GetConversationPagedMembersAsync (this Microsoft.Bot.Connector.IConversations operations, string conversationId, int? pageSize = default, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);
static member GetConversationPagedMembersAsync : Microsoft.Bot.Connector.IConversations * string * Nullable<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Connector.PagedMembersResult>
static member GetConversationPagedMembersAsync : Microsoft.Bot.Connector.IConversations * string * Nullable<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.PagedMembersResult>
<Extension()>
Public Function GetConversationPagedMembersAsync (operations As IConversations, conversationId As String, Optional pageSize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PagedMembersResult)

Parameters

operations
IConversations

The operations group for this extension method.

conversationId
String

Conversation ID.

pageSize
Nullable<Int32>

Suggested page size.

continuationToken
String

Continuation Token.

cancellationToken
CancellationToken

The cancellation token.

Returns

The PagedMembersResult.

Remarks

Enumerate the members of a conversation one page at a time.

This REST API takes a ConversationId. Optionally a pageSize and/or continuationToken can be provided. It returns a PagedMembersResult, which contains an array of ChannelAccounts representing the members of the conversation and a continuation token that can be used to get more values.

One page of ChannelAccounts records are returned with each call. The number of records in a page may vary between channels and calls. The pageSize parameter can be used as a suggestion. If there are no additional results the response will not contain a continuation token. If there are no members in the conversation the Members will be empty or not present in the response.

A response to a request that has a continuation token from a prior request may rarely return members from a previous request.

Applies to