ChannelServiceHandlerBase.OnGetConversationMembersAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.18.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

GetConversationMembers() API for Skill.

protected virtual System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount>> OnGetConversationMembersAsync (System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, System.Threading.CancellationToken cancellationToken = default);

abstract member OnGetConversationMembersAsync : System.Security.Claims.ClaimsIdentity * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount>>
override this.OnGetConversationMembersAsync : System.Security.Claims.ClaimsIdentity * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount>>

Protected Overridable Function OnGetConversationMembersAsync (claimsIdentity As ClaimsIdentity, conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IList(Of ChannelAccount))

Parameters

claimsIdentity: ClaimsIdentity

claimsIdentity for the bot, should have AudienceClaim, AppIdClaim and ServiceUrlClaim.

conversationId: String

Conversation ID.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<IList<ChannelAccount>>

task for a response.

Remarks

Override this method to enumerate the members of a conversation.

This REST API takes a ConversationId and returns an array of ChannelAccount objects representing the members of the conversation.

Applies to