ChannelServiceHandlerBase.OnGetConversationPagedMembersAsync 方法

定義

命名空間:

Microsoft.Bot.Builder

組件:

Microsoft.Bot.Builder.dll

套件:

Microsoft.Bot.Builder v4.22.7

GetConversationPagedMembers () API for Skill。

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

bot 的 claimsIdentity 應具有 AudienceClaim、AppIdClaim 和 ServiceUrlClaim。

conversationId

String

交談識別碼。

pageSize

Nullable<Int32>

建議的頁面大小。

continuationToken

String

接續權杖。

cancellationToken

CancellationToken

取消語彙基元。

傳回

Task<PagedMembersResult>

回應的工作。

備註

覆寫這個方法，以一次列舉一頁交談的成員。

此 REST API 會採用 ConversationId。 您可以選擇性地提供 pageSize 和/或 continuationToken。 它會傳回 PagedMembersResult，其中包含代表交談成員的 ChannelAccounts 陣列，以及可用來取得更多值的接續權杖。

每個呼叫都會傳回一頁 ChannelAccounts 記錄。 頁面中的記錄數目可能會因通道和呼叫而有所不同。 pageSize 參數可作為建議。 如果沒有其他結果，回應將不會包含接續權杖。 如果交談中沒有成員，成員將會是空的，或不存在於回應中。

對具有先前要求之接續權杖的要求回應，可能很少會從先前的要求傳回成員。