ChannelServiceHandlerBase.OnGetConversationMemberAsync Method

Definition

GetConversationMember() API for Skill.

protected virtual System.Threading.Tasks.Task<Microsoft.Bot.Schema.ChannelAccount> OnGetConversationMemberAsync (System.Security.Claims.ClaimsIdentity claimsIdentity, string userId, string conversationId, System.Threading.CancellationToken cancellationToken = default);
abstract member OnGetConversationMemberAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.ChannelAccount>
override this.OnGetConversationMemberAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Bot.Schema.ChannelAccount>
Protected Overridable Function OnGetConversationMemberAsync (claimsIdentity As ClaimsIdentity, userId As String, conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ChannelAccount)

Parameters

claimsIdentity
ClaimsIdentity

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

userId
String

User ID.

conversationId
String

Conversation ID.

cancellationToken
CancellationToken

The cancellation token.

Returns

task for a response.

Remarks

Override this method to get the account of a single conversation member.

This REST API takes a ConversationId and UserId and returns the ChannelAccount objects representing the member of the conversation.

Applies to