ChannelServiceHandlerBase.OnGetConversationPagedMembersAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
スキル用の GetConversationPagedMembers() API。
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)パラメーター
- claimsIdentity
- ClaimsIdentity
ボットの claimsIdentity には、AudienceClaim、AppIdClaim、ServiceUrlClaim が必要です。
- conversationId
- String
会話 ID。
- continuationToken
- String
継続トークン。
- cancellationToken
- CancellationToken
キャンセル トークン。
戻り値
応答のタスク。
注釈
会話のメンバーを一度に 1 ページずつ列挙するには、このメソッドをオーバーライドします。
この REST API は ConversationId を受け取ります。 必要に応じて、pageSize または continuationToken を指定できます。 PagedMembersResult を返します。これには、会話のメンバーを表す ChannelAccounts の配列と、より多くの値を取得するために使用できる継続トークンが含まれます。
ChannelAccounts レコードの 1 ページが、呼び出しごとに返されます。 ページ内のレコードの数は、チャネルと呼び出しによって異なる場合があります。 pageSize パラメーターは、候補として使用できます。 追加の結果がない場合、応答には継続トークンは含まれません。 会話にメンバーが存在しない場合、メンバーは空であるか、応答に存在しません。
以前の要求からの継続トークンを持つ要求に対する応答で、前の要求のメンバーが返されることはほとんどありません。