ConversationClient.GetConversationPagedMembersAsync Method

Definition

Namespace:

Microsoft.Teams.Core

Assembly:

Microsoft.Teams.Core.dll

Package:

Microsoft.Teams.Core v2.1.1

Gets the members of a conversation one page at a time.

public virtual System.Threading.Tasks.Task<Microsoft.Teams.Core.PagedMembersResult> GetConversationPagedMembersAsync(string conversationId, Uri serviceUrl, int? pageSize = default, string? continuationToken = default, Microsoft.Teams.Core.Http.BotRequestContext? requestContext = default, System.Collections.Generic.Dictionary<string,string>? customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetConversationPagedMembersAsync : string * Uri * Nullable<int> * string * Microsoft.Teams.Core.Http.BotRequestContext * System.Collections.Generic.Dictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Teams.Core.PagedMembersResult>
override this.GetConversationPagedMembersAsync : string * Uri * Nullable<int> * string * Microsoft.Teams.Core.Http.BotRequestContext * System.Collections.Generic.Dictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Teams.Core.PagedMembersResult>

Public Overridable Function GetConversationPagedMembersAsync (conversationId As String, serviceUrl As Uri, Optional pageSize As Nullable(Of Integer) = Nothing, Optional continuationToken As String = Nothing, Optional requestContext As BotRequestContext = Nothing, Optional customHeaders As Dictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PagedMembersResult)

Parameters

conversationId

String

The ID of the conversation. Cannot be null or whitespace.

serviceUrl

Uri

The service URL for the conversation. Cannot be null.

pageSize

Nullable<Int32>

Optional page size for the number of members to retrieve.

continuationToken

String

Optional continuation token for pagination.

requestContext

BotRequestContext

Optional per-request properties (see BotRequestContext) to stamp onto the request's options.

customHeaders

Dictionary<String,String>

Optional custom headers to include in the request.

cancellationToken

CancellationToken

A cancellation token that can be used to cancel the operation.

Returns

Task<PagedMembersResult>

A task that represents the asynchronous operation. The task result contains a page of members and an optional continuation token.

Exceptions

HttpRequestException

Thrown if the conversation members could not be retrieved successfully.