IConversations.DeleteConversationMemberWithHttpMessagesAsync Method

Reference

Definition

Namespace:: Microsoft.Bot.Connector

Assembly:: Microsoft.Bot.Connector.dll

Package:: Microsoft.Bot.Connector v3.30.0

Package:: Microsoft.Bot.Connector 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.

public System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse> DeleteConversationMemberWithHttpMessagesAsync (string conversationId, string memberId, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteConversationMemberWithHttpMessagesAsync : string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.HttpOperationResponse>

Public Function DeleteConversationMemberWithHttpMessagesAsync (conversationId As String, memberId As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of HttpOperationResponse)

Parameters

conversationId: String

Conversation ID.

memberId: String

ID of the member to delete from this conversation.

customHeaders: Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken: CancellationToken

The cancellation token.

Returns

Task<Microsoft.Rest.HttpOperationResponse>

A task that represents the Microsoft.Rest.HttpOperationResponse.

Exceptions

ErrorResponseException

Thrown when the operation returned an invalid status code.

Microsoft.Rest.ValidationException

Thrown when a required parameter is null.

Remarks

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