ConversationClient.DeleteConversationMemberAsync Method
Definition
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.
Deletes a member from a conversation.
public virtual System.Threading.Tasks.Task DeleteConversationMemberAsync(string conversationId, string memberId, Uri serviceUrl, Microsoft.Teams.Core.Http.BotRequestContext? requestContext = default, System.Collections.Generic.Dictionary<string,string>? customHeaders = default, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteConversationMemberAsync : string * string * Uri * Microsoft.Teams.Core.Http.BotRequestContext * System.Collections.Generic.Dictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DeleteConversationMemberAsync : string * string * Uri * Microsoft.Teams.Core.Http.BotRequestContext * System.Collections.Generic.Dictionary<string, string> * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function DeleteConversationMemberAsync (conversationId As String, memberId As String, serviceUrl As Uri, Optional requestContext As BotRequestContext = Nothing, Optional customHeaders As Dictionary(Of String, String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- conversationId
- String
The ID of the conversation. Cannot be null or whitespace.
- memberId
- String
The ID of the member to delete. Cannot be null or whitespace.
- serviceUrl
- Uri
The service URL for the conversation. Cannot be null.
- requestContext
- BotRequestContext
Optional per-request properties (see BotRequestContext) to stamp onto the request's options.
- customHeaders
- Dictionary<String,String>
Optional custom headers to include in the request.
- cancellationToken
- CancellationToken
A cancellation token that can be used to cancel the operation.
Returns
A task that represents the asynchronous operation.
Exceptions
Thrown if the member could not be deleted successfully.
Remarks
If the deleted member was the last member of the conversation, the conversation is also deleted.