Conversations.GetConversationPagedMembersWithHttpMessagesAsync Метод

Определение

Пространство имен:

Microsoft.Bot.Connector

Сборка:

Microsoft.Bot.Connector.dll

Пакет:

Microsoft.Bot.Connector v4.22.7

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))

Параметры

conversationId

String

Идентификатор беседы.

pageSize

Nullable<Int32>

Предлагаемый размер страницы.

continuationToken

String

Маркер продолжения.

customHeaders

Dictionary<String,List<String>>

Заголовки, которые будут добавлены в запрос.

cancellationToken

CancellationToken

Токен отмены.

Возвращаемое значение

Task<Microsoft.Rest.HttpOperationResponse<PagedMembersResult>>

Объект ответа, содержащий текст отклика и заголовки ответа.

Реализации

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

Исключения

Microsoft.Rest.HttpOperationException

Возникает, когда операция возвращает недопустимый код состояния.

Microsoft.Rest.SerializationException

Возникает, если не удается десериализовать ответ.

Microsoft.Rest.ValidationException

Возникает, если входное значение не соответствует ожидаемому типу данных, диапазону или шаблону.

ArgumentNullException

Возникает, если обязательный параметр имеет значение NULL.

Комментарии

Перечисление участников беседы по одной странице за раз.

Этот REST API принимает ConversationId. При необходимости можно указать pageSize и(или) continuationToken. Он возвращает объект PagedMembersResult, содержащий массив ChannelAccounts, представляющий членов диалога, и маркер продолжения, который можно использовать для получения дополнительных значений.

При каждом вызове возвращается одна страница записей ChannelAccounts. Количество записей на странице может отличаться в разных каналах и вызовах. Параметр pageSize можно использовать в качестве предложения. Если нет дополнительных результатов, ответ не будет содержать маркер продолжения. Если в беседе нет участников, они будут пустыми или отсутствуют в ответе.

Ответ на запрос, имеющий маркер продолжения из предыдущего запроса, редко может возвращать участников из предыдущего запроса.