WebPubSubChatServiceClient.DeleteMessageAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub.Chat

Assembly:

Azure.Messaging.WebPubSub.Chat.dll

Package:

Azure.Messaging.WebPubSub.Chat v1.0.0-beta.1

Overloads

Name	Description
DeleteMessageAsync(String, String, MatchConditions, RequestContext)	[Protocol Method] Delete a message. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteMessageAsync(String, String, MatchConditions, CancellationToken)	Delete a message.

DeleteMessageAsync(String, String, MatchConditions, RequestContext)

Source:

WebPubSubChatServiceClient.cs

[Protocol Method] Delete a message.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteMessageAsync(string conversationId, string messageId, Azure.MatchConditions matchConditions, Azure.RequestContext context);

abstract member DeleteMessageAsync : string * string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteMessageAsync : string * string * Azure.MatchConditions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteMessageAsync (conversationId As String, messageId As String, matchConditions As MatchConditions, context As RequestContext) As Task(Of Response)

Parameters

conversationId

String

Conversation identifier.

messageId

String

Message identifier.

matchConditions

MatchConditions

The content to send as the request conditions of the request.

context

RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

conversationId or messageId is null.

ArgumentException

conversationId or messageId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

DeleteMessageAsync(String, String, MatchConditions, CancellationToken)

Source:

WebPubSubChatServiceClient.cs

Delete a message.

public virtual System.Threading.Tasks.Task<Azure.Response> DeleteMessageAsync(string conversationId, string messageId, Azure.MatchConditions matchConditions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteMessageAsync : string * string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
override this.DeleteMessageAsync : string * string * Azure.MatchConditions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function DeleteMessageAsync (conversationId As String, messageId As String, Optional matchConditions As MatchConditions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

Parameters

conversationId

String

Conversation identifier.

messageId

String

Message identifier.

matchConditions

MatchConditions

The content to send as the request conditions of the request.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<Response>

Exceptions

ArgumentNullException

conversationId or messageId is null.

ArgumentException

conversationId or messageId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.