ActivityHandler.OnMembersAddedAsync Method

Definition

Override this in a derived class to provide logic for when members other than the bot join the conversation, such as your bot's welcome logic.

protected virtual System.Threading.Tasks.Task OnMembersAddedAsync (System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> membersAdded, Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IConversationUpdateActivity> turnContext, System.Threading.CancellationToken cancellationToken);
abstract member OnMembersAddedAsync : System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> * Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IConversationUpdateActivity> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OnMembersAddedAsync : System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> * Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IConversationUpdateActivity> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Protected Overridable Function OnMembersAddedAsync (membersAdded As IList(Of ChannelAccount), turnContext As ITurnContext(Of IConversationUpdateActivity), cancellationToken As CancellationToken) As Task

Parameters

membersAdded
IList<ChannelAccount>

A list of all the members added to the conversation, as described by the conversation update activity.

turnContext
ITurnContext<IConversationUpdateActivity>

A strongly-typed context object for this turn.

cancellationToken
CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

A task that represents the work queued to execute.

Remarks

When the OnConversationUpdateActivityAsync(ITurnContext<IConversationUpdateActivity>, CancellationToken) method receives a conversation update activity that indicates one or more users other than the bot are joining the conversation, it calls this method.

Applies to

See also