Conversations.GetConversationPagedMembersWithHttpMessagesAsync Metod

Definition

Namnområde:

Microsoft.Bot.Connector

Sammansättning:

Microsoft.Bot.Connector.dll

Paket:

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

Parametrar

conversationId

String

Konversations-ID.

pageSize

Nullable<Int32>

Föreslagen sidstorlek.

continuationToken

String

Fortsättningstoken.

customHeaders

Dictionary<String,List<String>>

Rubriker som läggs till i begäran.

cancellationToken

CancellationToken

Annulleringstoken.

Returer

Task<Microsoft.Rest.HttpOperationResponse<PagedMembersResult>>

Ett svarsobjekt som innehåller svarstexten och svarsrubrikerna.

Implementeringar

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

Undantag

Microsoft.Rest.HttpOperationException

Genereras när åtgärden returnerade en ogiltig statuskod.

Microsoft.Rest.SerializationException

Returneras när det inte går att deserialisera svaret.

Microsoft.Rest.ValidationException

Genereras när ett indatavärde inte matchar den förväntade datatypen, intervallet eller mönstret.

ArgumentNullException

Genereras när en obligatorisk parameter är null.

Kommentarer

Räkna upp medlemmarna i en konversation en sida i taget.

Det här REST-API:et tar ett ConversationId. Du kan också ange en pageSize och/eller continuationToken. Den returnerar en PagedMembersResult, som innehåller en matris med ChannelAccounts som representerar medlemmarna i konversationen och en fortsättningstoken som kan användas för att hämta fler värden.

En sida med ChannelAccounts-poster returneras med varje anrop. Antalet poster på en sida kan variera mellan kanaler och anrop. Parametern pageSize kan användas som ett förslag. Om det inte finns några ytterligare resultat kommer svaret inte att innehålla en fortsättningstoken. Om det inte finns några medlemmar i konversationen är medlemmarna tomma eller inte närvarande i svaret.

Ett svar på en begäran som har en fortsättningstoken från en tidigare begäran kan sällan returnera medlemmar från en tidigare begäran.