EventGridReceiverClient Class

Definition

Namespace:

Azure.Messaging.EventGrid.Namespaces

Assembly:

Azure.Messaging.EventGrid.Namespaces.dll

Package:

Azure.Messaging.EventGrid.Namespaces v1.0.0

Source:

EventGridReceiverClient.cs

The EventGridReceiver service client.

public class EventGridReceiverClient

type EventGridReceiverClient = class

Public Class EventGridReceiverClient

Inheritance

Object

EventGridReceiverClient

Constructors

EventGridReceiverClient()	Initializes a new instance of EventGridReceiverClient for mocking.
EventGridReceiverClient(Uri, String, String, AzureKeyCredential, EventGridReceiverClientOptions)	Initializes a new instance of EventGridReceiverClient.
EventGridReceiverClient(Uri, String, String, AzureKeyCredential)	Initializes a new instance of EventGridReceiverClient.
EventGridReceiverClient(Uri, String, String, TokenCredential, EventGridReceiverClientOptions)	Initializes a new instance of EventGridReceiverClient.
EventGridReceiverClient(Uri, String, String, TokenCredential)	Initializes a new instance of EventGridReceiverClient.

Properties

Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Acknowledge(IEnumerable<String>, CancellationToken)	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.
AcknowledgeAsync(IEnumerable<String>, CancellationToken)	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.
Receive(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Receive a batch of Cloud Events from a subscription.
ReceiveAsync(Nullable<Int32>, Nullable<TimeSpan>, CancellationToken)	Receive a batch of Cloud Events from a subscription.
Reject(IEnumerable<String>, CancellationToken)	Reject a batch of Cloud Events. The response will include the set of successfully rejected lock tokens, along with other failed lock tokens with their corresponding error information. Successfully rejected events will be dead-lettered and can no longer be received by a consumer.
RejectAsync(IEnumerable<String>, CancellationToken)	Reject a batch of Cloud Events. The response will include the set of successfully rejected lock tokens, along with other failed lock tokens with their corresponding error information. Successfully rejected events will be dead-lettered and can no longer be received by a consumer.
Release(IEnumerable<String>, Nullable<ReleaseDelay>, CancellationToken)	Release a batch of Cloud Events. The response will include the set of successfully released lock tokens, along with other failed lock tokens with their corresponding error information. Successfully released events can be received by consumers.
ReleaseAsync(IEnumerable<String>, Nullable<ReleaseDelay>, CancellationToken)	Release a batch of Cloud Events. The response will include the set of successfully released lock tokens, along with other failed lock tokens with their corresponding error information. Successfully released events can be received by consumers.
RenewLocks(IEnumerable<String>, CancellationToken)	Renew locks for a batch of Cloud Events. The response will include the set of successfully renewed lock tokens, along with other failed lock tokens with their corresponding error information. Successfully renewed locks will ensure that the associated event is only available to the consumer that holds the renewed lock.
RenewLocksAsync(IEnumerable<String>, CancellationToken)	Renew locks for a batch of Cloud Events. The response will include the set of successfully renewed lock tokens, along with other failed lock tokens with their corresponding error information. Successfully renewed locks will ensure that the associated event is only available to the consumer that holds the renewed lock.