Conversations.GetConversationPagedMembersWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Bot.Connector

Assembly:

Microsoft.Bot.Connector.dll

Package:

Microsoft.Bot.Connector v4.18.1

GetConversationPagedMembers.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Bot.Schema.PagedMembersResult>> GetConversationPagedMembersWithHttpMessagesAsync (string conversationId, int? pageSize = default, string continuationToken = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetConversationPagedMembersWithHttpMessagesAsync : string * Nullable<int> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Bot.Schema.PagedMembersResult>>
override this.GetConversationPagedMembersWithHttpMessagesAsync : string * Nullable<int> * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse<Microsoft.Bot.Schema.PagedMembersResult>>

Public Function GetConversationPagedMembersWithHttpMessagesAsync (conversationId As String, Optional pageSize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse(Of PagedMembersResult))

Parameters

conversationId

String

Conversation ID.

pageSize

Nullable<Int32>

Suggested page size.

continuationToken

String

Continuation Token.

customHeaders

Dictionary<String,List<String>>

Headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<Microsoft.Rest.HttpOperationResponse<PagedMembersResult>>

A response object containing the response body and response headers.

Implements

GetConversationPagedMembersWithHttpMessagesAsync(String, Nullable<Int32>, String, Dictionary<String,List<String>>, CancellationToken)

Exceptions

Microsoft.Rest.HttpOperationException

Thrown when the operation returned an invalid status code.

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response.

Microsoft.Rest.ValidationException

Thrown when an input value does not match the expected data type, range or pattern.

ArgumentNullException

Thrown when a required parameter is null.

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.