DeviceClient.CompleteAsync 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
| 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.TaskPublic Function CompleteAsync (message As Message) As TaskParameters
- 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.TaskPublic Function CompleteAsync (lockToken As String) As TaskParameters
- lockToken
- System.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.TaskPublic Function CompleteAsync (message As Message, cancellationToken As CancellationToken) As TaskParameters
- message
- Message
The message.
- cancellationToken
- System.Threading.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.TaskPublic Function CompleteAsync (lockToken As String, cancellationToken As CancellationToken) As TaskParameters
- lockToken
- System.String
The message lockToken.
- cancellationToken
- System.Threading.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.