ChannelServiceHandlerBase.OnGetConversationPagedMembersAsync Metoda

Definicja

Przestrzeń nazw:

Microsoft.Bot.Builder

Zestaw:

Microsoft.Bot.Builder.dll

Pakiet:

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)

Parametry

claimsIdentity

ClaimsIdentity

claimsIdentity dla bota powinna mieć wartość AudienceClaim, AppIdClaim i ServiceUrlClaim.

conversationId

String

Identyfikator konwersacji.

pageSize

Nullable<Int32>

Sugerowany rozmiar strony.

continuationToken

String

Token kontynuacji.

cancellationToken

CancellationToken

Token anulowania.

Zwraca

Task<PagedMembersResult>

zadanie odpowiedzi.

Uwagi

Zastąpij tę metodę, aby wyliczyć członków konwersacji po jednej stronie naraz.

Ten interfejs API REST przyjmuje identyfikator ConversationId. Opcjonalnie można podać parametr pageSize i/lub continuationToken. Zwraca on element PagedMembersResult, który zawiera tablicę obiektów ChannelAccount reprezentujących członków konwersacji i token kontynuacji, który może służyć do uzyskiwania większej liczby wartości.

Jedna strona rekordów ChannelAccounts jest zwracana z każdym wywołaniem. Liczba rekordów na stronie może się różnić w zależności od kanałów i wywołań. Parametr pageSize może służyć jako sugestia. Jeśli nie ma dodatkowych wyników, odpowiedź nie będzie zawierać tokenu kontynuacji. Jeśli w konwersacji nie ma żadnych członków, członkowie będą pusti lub nie będą obecni w odpowiedzi.

Odpowiedź na żądanie, które ma token kontynuacji z poprzedniego żądania, może rzadko zwracać elementy członkowskie z poprzedniego żądania.