ChannelServiceHandlerBase.OnDeleteConversationMemberAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Builder

Assembly:: Microsoft.Bot.Builder.dll

Package:: Microsoft.Bot.Builder v4.22.7

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.

DeleteConversationMember() API for Skill.

protected virtual System.Threading.Tasks.Task OnDeleteConversationMemberAsync (System.Security.Claims.ClaimsIdentity claimsIdentity, string conversationId, string memberId, System.Threading.CancellationToken cancellationToken = default);

abstract member OnDeleteConversationMemberAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OnDeleteConversationMemberAsync : System.Security.Claims.ClaimsIdentity * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Overridable Function OnDeleteConversationMemberAsync (claimsIdentity As ClaimsIdentity, conversationId As String, memberId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

claimsIdentity: ClaimsIdentity

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

conversationId: String

Conversation ID.

memberId: String

ID of the member to delete from this conversation.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task

task.

Remarks

Override this method to deletes a member from a conversation.

This REST API takes a ConversationId and a memberId (of type string) and removes that member from the conversation. If that member was the last member of the conversation, the conversation will also be deleted.

Applies to

Jaa