ChannelServiceHandlerBase.OnGetConversationPagedMembersAsync Метод

Определение

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

Microsoft.Bot.Builder

Сборка:

Microsoft.Bot.Builder.dll

Пакет:

Microsoft.Bot.Builder v4.18.1

API GetConversationPagedMembers() для навыка.

protected virtual System.Threading.Tasks.Task<Microsoft.Bot.Schema.PagedMembersResult> OnGetConversationPagedMembersAsync (System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, int? pageSize = default, string continuationToken = default, System.Threading.CancellationToken cancellationToken = default);

abstract member OnGetConversationPagedMembersAsync : System.Security.Claims.ClaimsIdentity * string * Nullable<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.PagedMembersResult>
override this.OnGetConversationPagedMembersAsync : System.Security.Claims.ClaimsIdentity * string * Nullable<int> * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.PagedMembersResult>

Protected Overridable Function OnGetConversationPagedMembersAsync (claimsIdentity As ClaimsIdentity, conversationId As String, Optional pageSize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PagedMembersResult)

Параметры

claimsIdentity

ClaimsIdentity

claimsIdentity для бота должен иметь AudienceClaim, AppIdClaim и ServiceUrlClaim.

conversationId

String

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

pageSize

Nullable<Int32>

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

continuationToken

String

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

cancellationToken

CancellationToken

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

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

Task<PagedMembersResult>

задача для ответа.

Комментарии

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

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

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

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