ServiceBusReceiveActions Class

Definition

Namespace:: Microsoft.Azure.WebJobs.ServiceBus

Assembly:: Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Package:: Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.17.0

Source:: ServiceBusReceiveActions.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.

Represents the set of receive actions that can be taken from within a function invocation.

public class ServiceBusReceiveActions

type ServiceBusReceiveActions = class

Public Class ServiceBusReceiveActions

Inheritance: Object
ServiceBusReceiveActions

Constructors

Name	Description
ServiceBusReceiveActions()	Initializes a new instance of the ServiceBusReceiveActions class for mocking use in testing.

Methods

Name	Description
PeekMessagesAsync(Int32, Nullable<Int64>, CancellationToken)	Fetches a list of active messages without changing the state of the receiver or the message source.
ReceiveDeferredMessagesAsync(IEnumerable<Int64>, CancellationToken)	Receives a list of deferred ServiceBusReceivedMessage identified by `sequenceNumbers`. Messages received using this method are subject to the behavior defined in the AutoCompleteMessages. When this method is used in a single-dispatch functions, messages received are subject to MaxAutoLockRenewalDuration.
ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)	Receives a list of ServiceBusReceivedMessage from the entity. This method doesn't guarantee to return exact `maxMessages` messages, even if there are `maxMessages` messages available in the queue or topic. Messages received using this method are subject to the behavior defined in the AutoCompleteMessages. When this method is used in a single-dispatch functions, messages received are subject to MaxAutoLockRenewalDuration.

Applies to

Feedback

Was this page helpful?