MessageReceiver.AbandonAsync(String, IDictionary<String,Object>) Method

Reference

Definition

Namespace:: Microsoft.Azure.ServiceBus.Core

Assembly:: Microsoft.Azure.ServiceBus.dll

Package:: Microsoft.Azure.ServiceBus v5.2.0

Source:: MessageReceiver.cs

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.

Abandons a Message using a lock token. This will make the message available again for processing.

public System.Threading.Tasks.Task AbandonAsync (string lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default);

abstract member AbandonAsync : string * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task
override this.AbandonAsync : string * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task

Public Function AbandonAsync (lockToken As String, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing) As Task

Parameters

lockToken: String

The lock token of the corresponding message to abandon.

propertiesToModify: IDictionary<String,Object>

The properties of the message to modify while abandoning the message.

Returns

Task

Implements

AbandonAsync(String, IDictionary<String,Object>)

Remarks

A lock token can be found in LockToken, only when ReceiveMode is set to PeekLock. Abandoning a message will increase the delivery count on the message. This operation can only be performed on messages that were received by this receiver.

Applies to