EventGridReceiverClient.Acknowledge Method

Reference

Definition

Namespace:: Azure.Messaging.EventGrid.Namespaces

Assembly:: Azure.Messaging.EventGrid.Namespaces.dll

Package:: Azure.Messaging.EventGrid.Namespaces v1.0.0

Source:: EventGridReceiverClient.cs

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.

Acknowledge a batch of Cloud Events. The response will include the set of successfully acknowledged lock tokens, along with other failed lock tokens with their corresponding error information. Successfully acknowledged events will no longer be available to be received by any consumer.

public virtual Azure.Response<Azure.Messaging.EventGrid.Namespaces.AcknowledgeResult> Acknowledge (System.Collections.Generic.IEnumerable<string> lockTokens, System.Threading.CancellationToken cancellationToken = default);

abstract member Acknowledge : seq<string> * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.EventGrid.Namespaces.AcknowledgeResult>
override this.Acknowledge : seq<string> * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.EventGrid.Namespaces.AcknowledgeResult>

Public Overridable Function Acknowledge (lockTokens As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As Response(Of AcknowledgeResult)

Parameters

lockTokens: IEnumerable<String>

Array of lock tokens.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Response<AcknowledgeResult>

Exceptions

ArgumentNullException

lockTokens is null.

Applies to

Share via