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

机器人的 claimsIdentity 应具有 AudienceClaim、AppIdClaim 和 ServiceUrlClaim。

conversationId

String

对话 ID。

pageSize

Nullable<Int32>

建议的页面大小。

continuationToken

String

延续标记。

cancellationToken

CancellationToken

取消标记。

返回

Task<PagedMembersResult>

响应的任务。

注解

重写此方法，一次枚举一页对话的成员。

此 REST API 采用 ConversationId。 （可选）可以提供 pageSize 和/或 continuationToken。 它返回一个 PagedMembersResult，其中包含一个 ChannelAccounts 数组（表示会话的成员）和一个可用于获取更多值的延续标记。

每次调用都会返回一页 ChannelAccounts 记录。 页面中的记录数可能因通道和调用而异。 pageSize 参数可用作建议。 如果没有其他结果，则响应将不包含延续标记。 如果对话中没有成员，则成员将为空或响应中不存在。

对具有前一个请求的延续令牌的请求的响应可能很少返回前一个请求的成员。