SubscriptionClient.DeadLetter Method

Definition

Overloads

DeadLetter(Guid)

Moves the undelivered message to the dead letter queue.

DeadLetter(Guid, IDictionary<String,Object>)

Moves the undelivered message to the dead letter queue.

DeadLetter(Guid, String, String)

Moves the undelivered message to the dead letter queue.

DeadLetter(Guid)

Moves the undelivered message to the dead letter queue.

public void DeadLetter (Guid lockToken);
Parameters
lockToken
Guid

The lock token bound to the locked message instance.

Exceptions

Thrown if the operation exceeded the timeout value set by OperationTimeout.

Thrown if the client entity has been closed or aborted.

Thrown if the message represented by lockToken has lost the message lock.

DeadLetter(Guid, IDictionary<String,Object>)

Moves the undelivered message to the dead letter queue.

public void DeadLetter (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.

DeadLetter(Guid, String, String)

Moves the undelivered message to the dead letter queue.

public void DeadLetter (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.

Exceptions

Thrown if the operation exceeded the timeout value set by OperationTimeout.

Thrown if the client entity has been closed or aborted.

Thrown if the message represented by lockToken has lost the message lock.