Conversations.GetConversationPagedMembersWithHttpMessagesAsync Methode

Definition

Namespace:

Microsoft.Bot.Connector

Assembly:

Microsoft.Bot.Connector.dll

Paket:

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

Parameter

conversationId

String

Konversations-ID.

pageSize

Nullable<Int32>

Vorgeschlagene Seitengröße.

continuationToken

String

Fortsetzungstoken.

customHeaders

Dictionary<String,List<String>>

Header, die der Anforderung hinzugefügt werden.

cancellationToken

CancellationToken

Das Abbruchtoken.

Gibt zurück

Task<Microsoft.Rest.HttpOperationResponse<PagedMembersResult>>

Ein Antwortobjekt, das den Antworttext und die Antwortheader enthält.

Implementiert

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

Ausnahmen

Microsoft.Rest.HttpOperationException

Wird ausgelöst, wenn der Vorgang einen ungültigen Statuscode zurückgegeben hat.

Microsoft.Rest.SerializationException

Wird ausgelöst, wenn die Antwort nicht deserialisiert werden kann.

Microsoft.Rest.ValidationException

Wird ausgelöst, wenn ein Eingabewert nicht mit dem erwarteten Datentyp, Bereich oder Muster übereinstimmt.

ArgumentNullException

Wird ausgelöst, wenn ein erforderlicher Parameter NULL ist.

Hinweise

Listen Sie die Mitglieder einer Unterhaltung seite für Seite auf.

Diese REST-API akzeptiert eine ConversationId. Optional kann ein pageSize und/oder continuationToken bereitgestellt werden. Sie gibt ein PagedMembersResult zurück, das ein Array von ChannelAccounts enthält, das die Mitglieder der Unterhaltung darstellt, und ein Fortsetzungstoken, das zum Abrufen weiterer Werte verwendet werden kann.

Bei jedem Aufruf wird eine Seite mit ChannelAccounts-Datensätzen zurückgegeben. Die Anzahl der Datensätze auf einer Seite kann zwischen Kanälen und Aufrufen variieren. Der pageSize-Parameter kann als Vorschlag verwendet werden. Wenn keine zusätzlichen Ergebnisse vorliegen, enthält die Antwort kein Fortsetzungstoken. Wenn keine Mitglieder in der Unterhaltung vorhanden sind, sind die Mitglieder leer oder in der Antwort nicht vorhanden.

Eine Antwort auf eine Anforderung, die über ein Fortsetzungstoken aus einer vorherigen Anforderung verfügt, gibt möglicherweise selten Mitglieder aus einer vorherigen Anforderung zurück.