Conversations.GetConversationPagedMembersWithHttpMessagesAsync Método

Definição

Namespace:

Microsoft.Bot.Connector

Assembly:

Microsoft.Bot.Connector.dll

Pacote:

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

Parâmetros

conversationId

String

ID da conversa.

pageSize

Nullable<Int32>

Tamanho da página sugerido.

continuationToken

String

Token de continuação.

customHeaders

Dictionary<String,List<String>>

Cabeçalhos que serão adicionados à solicitação.

cancellationToken

CancellationToken

O token de cancelamento.

Retornos

Task<Microsoft.Rest.HttpOperationResponse<PagedMembersResult>>

Um objeto de resposta que contém o corpo da resposta e os cabeçalhos de resposta.

Implementações

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

Exceções

Microsoft.Rest.HttpOperationException

Gerado quando a operação retornou um código de status inválido.

Microsoft.Rest.SerializationException

Gerado quando não é possível desserializar a resposta.

Microsoft.Rest.ValidationException

Gerado quando um valor de entrada não corresponde ao tipo de dados, intervalo ou padrão esperados.

ArgumentNullException

Gerado quando um parâmetro necessário é nulo.

Comentários

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 representando os membros da conversa e um token de continuação que pode ser usado para obter mais valores.

Uma página dos 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.