SessionMessageProcessor.CompleteProcessingMessageAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.WebJobs.ServiceBus

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

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

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

This method completes processing of the specified message, after the job function has been invoked.

protected internal virtual System.Threading.Tasks.Task CompleteProcessingMessageAsync (Microsoft.Azure.WebJobs.ServiceBus.ServiceBusSessionMessageActions actions, Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, Microsoft.Azure.WebJobs.Host.Executors.FunctionResult result, System.Threading.CancellationToken cancellationToken);

abstract member CompleteProcessingMessageAsync : Microsoft.Azure.WebJobs.ServiceBus.ServiceBusSessionMessageActions * Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteProcessingMessageAsync : Microsoft.Azure.WebJobs.ServiceBus.ServiceBusSessionMessageActions * Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Friend Overridable Function CompleteProcessingMessageAsync (actions As ServiceBusSessionMessageActions, message As ServiceBusReceivedMessage, result As FunctionResult, cancellationToken As CancellationToken) As Task

Parameters

actions: ServiceBusSessionMessageActions

The set of actions that can be performed on a ServiceBusReceivedMessage.

message: ServiceBusReceivedMessage

The ServiceBusReceivedMessage to process.

result: Microsoft.Azure.WebJobs.Host.Executors.FunctionResult

The Microsoft.Azure.WebJobs.Host.Executors.FunctionResult from the job invocation.

cancellationToken: CancellationToken

The CancellationToken to use

Returns

Task

A Task that will complete the message processing.

Remarks

The message is completed by the ServiceBus SDK based on how the AutoCompleteMessages option is configured. E.g. if AutoCompleteMessages is false, it is up to the job function to complete the message.

Applies to

Share via