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

Definition

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 = null);
abstract member 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) = null) As Task

Parameters

lockToken
System.String

The lock token of the corresponding message to abandon.

propertiesToModify
System.Collections.Generic.IDictionary<System.String,System.Object>

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

Returns

System.Threading.Tasks.Task

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