MessageReceiver.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(IEnumerable<String>) |
Completes a series of Message using a list of lock tokens. This will delete the message from the service. |
CompleteAsync(String) |
Completes a Message using its lock token. This will delete the message from the service. |
CompleteAsync(IEnumerable<String>)
- Source:
- MessageReceiver.cs
Completes a series of Message using a list of lock tokens. This will delete the message from the service.
public System.Threading.Tasks.Task CompleteAsync (System.Collections.Generic.IEnumerable<string> lockTokens);
abstract member CompleteAsync : seq<string> -> System.Threading.Tasks.Task
override this.CompleteAsync : seq<string> -> System.Threading.Tasks.Task
Public Function CompleteAsync (lockTokens As IEnumerable(Of String)) As Task
Parameters
- lockTokens
- IEnumerable<String>
An IEnumerable<T> containing the lock tokens of the corresponding messages to complete.
Returns
Implements
Remarks
A lock token can be found in LockToken, only when ReceiveMode is set to PeekLock. This operation can only be performed on messages that were received by this receiver.
Applies to
CompleteAsync(String)
- Source:
- MessageReceiver.cs
Completes a Message using its lock token. This will delete the message from the service.
public System.Threading.Tasks.Task CompleteAsync (string lockToken);
abstract member CompleteAsync : string -> System.Threading.Tasks.Task
override this.CompleteAsync : string -> System.Threading.Tasks.Task
Public Function CompleteAsync (lockToken As String) As Task
Parameters
- lockToken
- String
The lock token of the corresponding message to complete.
Returns
Implements
Remarks
A lock token can be found in LockToken, only when ReceiveMode is set to PeekLock. This operation can only be performed on messages that were received by this receiver.