MessageReceiver.DeferAsync(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.

Indicates that the receiver wants to defer the processing for the message.

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

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

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

Parameters

lockToken: String

The lock token of the Message.

propertiesToModify: IDictionary<String,Object>

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

Returns

Task

Implements

DeferAsync(String, IDictionary<String,Object>)

Remarks

A lock token can be found in LockToken, only when ReceiveMode is set to PeekLock. In order to receive this message again in the future, you will need to save the SequenceNumber and receive it using ReceiveDeferredMessageAsync(Int64). Deferring messages does not impact message's expiration, meaning that deferred messages can still expire. This operation can only be performed on messages that were received by this receiver.

Applies to