ChannelServiceHandlerBase.OnGetActivityMembersAsync Method

Definition

OnGetActivityMembersAsync() API.

protected virtual System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount>> OnGetActivityMembersAsync (System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, string activityId, System.Threading.CancellationToken cancellationToken = default);
abstract member OnGetActivityMembersAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount>>
override this.OnGetActivityMembersAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount>>
Protected Overridable Function OnGetActivityMembersAsync (claimsIdentity As ClaimsIdentity, conversationId As String, activityId 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.

activityId
String

Activity ID.

cancellationToken
CancellationToken

The cancellation token.

Returns

task with result.

Remarks

Override this method to enumerate the members of an activity.

This REST API takes a ConversationId and a ActivityId, returning an array of ChannelAccount objects representing the members of the particular activity in the conversation.

Applies to