ModuleClient.AbandonAsync Method
Definition
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.
Overloads
AbandonAsync(Message) |
Puts a received message back onto the module queue. |
AbandonAsync(String) |
Puts a received message back onto the module queue. |
AbandonAsync(Message, CancellationToken) |
Puts a received message back onto the module queue. |
AbandonAsync(String, CancellationToken) |
Puts a received message back onto the module queue. |
AbandonAsync(Message)
Puts a received message back onto the module queue.
public System.Threading.Tasks.Task AbandonAsync (Microsoft.Azure.Devices.Client.Message message);
member this.AbandonAsync : Microsoft.Azure.Devices.Client.Message -> System.Threading.Tasks.Task
Public Function AbandonAsync (message As Message) As Task
Parameters
- message
- Message
Returns
The lock identifier for the previously received message
Applies to
AbandonAsync(String)
Puts a received message back onto the module queue.
public System.Threading.Tasks.Task AbandonAsync (string lockToken);
member this.AbandonAsync : string -> System.Threading.Tasks.Task
Public Function AbandonAsync (lockToken As String) As Task
Parameters
- lockToken
- String
The message lockToken.
Returns
The previously received message
Applies to
AbandonAsync(Message, CancellationToken)
Puts a received message back onto the module queue.
public System.Threading.Tasks.Task AbandonAsync (Microsoft.Azure.Devices.Client.Message message, System.Threading.CancellationToken cancellationToken);
member this.AbandonAsync : Microsoft.Azure.Devices.Client.Message * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function AbandonAsync (message As Message, cancellationToken As CancellationToken) As Task
Parameters
- message
- Message
The message.
- cancellationToken
- CancellationToken
A cancellation token to cancel the operation.
Returns
The lock identifier for the previously received message
Exceptions
Thrown when the operation has been canceled.
Applies to
AbandonAsync(String, CancellationToken)
Puts a received message back onto the module queue.
public System.Threading.Tasks.Task AbandonAsync (string lockToken, System.Threading.CancellationToken cancellationToken);
member this.AbandonAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function AbandonAsync (lockToken As String, cancellationToken As CancellationToken) As Task
Parameters
- lockToken
- String
The message lockToken.
- cancellationToken
- CancellationToken
A cancellation token to cancel the operation.
Returns
The previously received message
Exceptions
Thrown when the operation has been canceled.