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