ActivityHandler.OnMembersRemovedAsync 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.

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

protected virtual System.Threading.Tasks.Task OnMembersRemovedAsync (System.Collections.Generic.IList<Microsoft.Bot.Schema.ChannelAccount> membersRemoved, Microsoft.Bot.Builder.ITurnContext<Microsoft.Bot.Schema.IConversationUpdateActivity> turnContext, System.Threading.CancellationToken cancellationToken);

abstract member OnMembersRemovedAsync : 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.OnMembersRemovedAsync : 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 OnMembersRemovedAsync (membersRemoved As IList(Of ChannelAccount), turnContext As ITurnContext(Of IConversationUpdateActivity), cancellationToken As CancellationToken) As Task

Parameters

membersRemoved: IList<ChannelAccount>

A list of all the members removed from 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

Task

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 leaving the conversation, it calls this method.

Applies to