Conversations.GetConversationPagedMembersWithHttpMessagesAsync メソッド

定義

名前空間:

Microsoft.Bot.Connector

アセンブリ:

Microsoft.Bot.Connector.dll

パッケージ:

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

パラメーター

conversationId

String

会話 ID。

pageSize

Nullable<Int32>

推奨されるページ サイズ。

continuationToken

String

継続トークン。

customHeaders

Dictionary<String,List<String>>

要求に追加されるヘッダー。

cancellationToken

CancellationToken

キャンセル トークン。

戻り値

Task<Microsoft.Rest.HttpOperationResponse<PagedMembersResult>>

応答本文と応答ヘッダーを含む応答オブジェクト。

実装

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

例外

Microsoft.Rest.HttpOperationException

操作が無効な状態コードを返したときにスローされます。

Microsoft.Rest.SerializationException

応答を逆シリアル化できない場合にスローされます。

Microsoft.Rest.ValidationException

入力値が予想されるデータ型、範囲、またはパターンと一致しない場合にスローされます。

ArgumentNullException

必須パラメーターが null の場合にスローされます。

注釈

会話のメンバーを一度に 1 ページずつ列挙します。

この REST API は ConversationId を受け取ります。 必要に応じて、pageSize または continuationToken を指定できます。 PagedMembersResult を返します。これには、会話のメンバーを表す ChannelAccounts の配列と、より多くの値を取得するために使用できる継続トークンが含まれます。

ChannelAccounts レコードの 1 ページが、呼び出しごとに返されます。 ページ内のレコードの数は、チャネルと呼び出しによって異なる場合があります。 pageSize パラメーターは、候補として使用できます。 追加の結果がない場合、応答には継続トークンは含まれません。 会話にメンバーが存在しない場合、メンバーは空であるか、応答に存在しません。

以前の要求からの継続トークンを持つ要求に対する応答で、前の要求のメンバーが返されることはほとんどありません。