Compartilhar via


ChannelServiceHandlerBase.OnGetConversationPagedMembersAsync Método

Definição

API GetConversationPagedMembers() para Skill.

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)

Parâmetros

claimsIdentity
ClaimsIdentity

claimsIdentity para o bot deve ter AudienceClaim, AppIdClaim e ServiceUrlClaim.

conversationId
String

ID da conversa.

pageSize
Nullable<Int32>

Tamanho de página sugerido.

continuationToken
String

Token de continuação.

cancellationToken
CancellationToken

O token de cancelamento.

Retornos

tarefa para uma resposta.

Comentários

Substitua esse método para enumerar os membros de uma conversa uma página por vez.

Essa API REST usa uma ConversationId. Opcionalmente, um pageSize e/ou continuationToken pode ser fornecido. Ele retorna um PagedMembersResult, que contém uma matriz de ChannelAccounts que representa os membros da conversa e um token de continuação que pode ser usado para obter mais valores.

Uma página de registros ChannelAccounts é retornada com cada chamada. O número de registros em uma página pode variar entre canais e chamadas. O parâmetro pageSize pode ser usado como uma sugestão. Se não houver resultados adicionais, a resposta não conterá um token de continuação. Se não houver membros na conversa, os Membros estarão vazios ou não estarão presentes na resposta.

Uma resposta a uma solicitação que tem um token de continuação de uma solicitação anterior raramente pode retornar membros de uma solicitação anterior.

Aplica-se a