SubscriptionClient.DeadLetterAsync Method

Definition

Overloads

DeadLetterAsync(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid, IDictionary<String,Object>)

Asynchronously moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid, String, String)

Asynchronously moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

public System.Threading.Tasks.Task DeadLetterAsync (Guid lockToken);
Parameters
lockToken
Guid

The lock token bound to the locked message instance.

Returns

A task instance that represents the asynchronous deadletter operation.

DeadLetterAsync(Guid, IDictionary<String,Object>)

Asynchronously moves the undelivered message to the dead letter queue.

public System.Threading.Tasks.Task DeadLetterAsync (Guid lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify);
Parameters
lockToken
Guid

The lock token bound to the locked message instance.

propertiesToModify
IDictionary<String,Object>

The properties to modify.

Returns

A task instance that represents the asynchronous deadletter operation.

DeadLetterAsync(Guid, String, String)

Asynchronously moves the undelivered message to the dead letter queue.

public System.Threading.Tasks.Task DeadLetterAsync (Guid lockToken, string deadLetterReason, string deadLetterErrorDescription);
Parameters
lockToken
Guid

The lock token bound to the locked message instance.

deadLetterReason
String

The reason for deadlettering the message.

deadLetterErrorDescription
String

The error description for deadlettering the message.

Returns

A task instance that represents the asynchronous deadletter operation.